> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> API reference for Waboxapp: every `waboxapp.api.*` operation with input and output types.

Every `waboxapp.api.*` operation is listed below with parameter shapes and return types from the plugin Zod schemas.

<Info>
  **New to Corsair?** See [API access](/concepts/api), [authentication](/concepts/auth), and [error handling](/concepts/error-handling).
</Info>

## Accounts

### getStatus

`accounts.getStatus`

Get WhatsApp session status

**Risk:** `read`

```ts theme={null}
await corsair.waboxapp.api.accounts.getStatus({});
```

**Input**

| Name  | Type     | Required | Description |
| ----- | -------- | -------- | ----------- |
| `uid` | `string` | No       | —           |

**Output**

| Name       | Type      | Required | Description |
| ---------- | --------- | -------- | ----------- |
| `success`  | `boolean` | Yes      | —           |
| `uid`      | `string`  | No       | —           |
| `hook_url` | `string`  | No       | —           |
| `alias`    | `string`  | No       | —           |
| `platform` | `string`  | No       | —           |
| `battery`  | `string`  | No       | —           |
| `plugged`  | `string`  | No       | —           |
| `locale`   | `string`  | No       | —           |
| `error`    | `string`  | No       | —           |

***

## Messages

### sendChat

`messages.sendChat`

Send a WhatsApp text message

**Risk:** `write`

```ts theme={null}
await corsair.waboxapp.api.messages.sendChat({});
```

**Input**

| Name         | Type     | Required | Description |
| ------------ | -------- | -------- | ----------- |
| `uid`        | `string` | No       | —           |
| `to`         | `string` | Yes      | —           |
| `custom_uid` | `string` | No       | —           |
| `text`       | `string` | Yes      | —           |

**Output**

| Name         | Type               | Required | Description |
| ------------ | ------------------ | -------- | ----------- |
| `success`    | `boolean`          | Yes      | —           |
| `custom_uid` | `string \| number` | No       | —           |
| `error`      | `string`           | No       | —           |

***

### sendImage

`messages.sendImage`

Send a WhatsApp image by URL

**Risk:** `write`

```ts theme={null}
await corsair.waboxapp.api.messages.sendImage({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `uid`         | `string` | No       | —           |
| `to`          | `string` | Yes      | —           |
| `custom_uid`  | `string` | No       | —           |
| `url`         | `string` | Yes      | —           |
| `caption`     | `string` | No       | —           |
| `description` | `string` | No       | —           |

**Output**

| Name         | Type               | Required | Description |
| ------------ | ------------------ | -------- | ----------- |
| `success`    | `boolean`          | Yes      | —           |
| `custom_uid` | `string \| number` | No       | —           |
| `error`      | `string`           | No       | —           |

***

### sendLink

`messages.sendLink`

Send a WhatsApp link preview

**Risk:** `write`

```ts theme={null}
await corsair.waboxapp.api.messages.sendLink({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `uid`         | `string` | No       | —           |
| `to`          | `string` | Yes      | —           |
| `custom_uid`  | `string` | No       | —           |
| `url`         | `string` | Yes      | —           |
| `caption`     | `string` | No       | —           |
| `description` | `string` | No       | —           |
| `url_thumb`   | `string` | No       | —           |

**Output**

| Name         | Type               | Required | Description |
| ------------ | ------------------ | -------- | ----------- |
| `success`    | `boolean`          | Yes      | —           |
| `custom_uid` | `string \| number` | No       | —           |
| `error`      | `string`           | No       | —           |

***

### sendMedia

`messages.sendMedia`

Send a WhatsApp media file by URL

**Risk:** `write`

```ts theme={null}
await corsair.waboxapp.api.messages.sendMedia({});
```

**Input**

| Name          | Type     | Required | Description |
| ------------- | -------- | -------- | ----------- |
| `uid`         | `string` | No       | —           |
| `to`          | `string` | Yes      | —           |
| `custom_uid`  | `string` | No       | —           |
| `url`         | `string` | Yes      | —           |
| `caption`     | `string` | No       | —           |
| `description` | `string` | No       | —           |
| `url_thumb`   | `string` | No       | —           |

**Output**

| Name         | Type               | Required | Description |
| ------------ | ------------------ | -------- | ----------- |
| `success`    | `boolean`          | Yes      | —           |
| `custom_uid` | `string \| number` | No       | —           |
| `error`      | `string`           | No       | —           |

***