> ## 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.

# CallPage API reference

> API reference for the CallPage plugin in Corsair: every `callpage.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Calls

### get

`calls.get`

Get a CallPage call by ID.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.calls.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `callId` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `to` | `string \| null` | No | — |
| `to_formatted` | `string \| null` | No | — |
| `human_status` | `string \| null` | No | — |
| `created_at` | `string \| null` | No | — |
| `scheduled_at` | `string \| null` | No | — |
| `cancelled_at` | `string \| null` | No | — |
| `scheduled_success` | `boolean \| null` | No | — |
| `leadable_id` | `number \| null` | No | — |
| `leadable_type` | `string \| null` | No | — |
| `leadable_description` | `string \| null` | No | — |
| `utm` | `object` | No | — |
| `referer` | `object` | No | — |
| `request` | `object` | No | — |
| `call` | `object` | No | — |

> [accordion] utm full type
>
> ```ts theme={null}
> {
>   utm_medium?: string | null,
>   utm_source?: string | null,
>   utm_content?: string | null,
>   utm_campaign?: string | null
> }
> ```

> [accordion] referer full type
>
> ```ts theme={null}
> {
>   medium?: string | null,
>   source?: string | null
> }
> ```

> [accordion] request full type
>
> ```ts theme={null}
> {
>   id?: number,
>   ip?: string | null,
>   url?: string | null,
>   locale?: string | null,
>   geo_city?: string | null,
>   geo_country_code?: string | null,
>   geo_country_name?: string | null,
>   user_agent_device?: string | null,
>   user_agent_device_type?: string | null
> }
> ```

> [accordion] call full type
>
> ```ts theme={null}
> {
>   id?: number,
>   sid?: string | null,
>   type?: number | null,
>   transcribed?: boolean | null,
>   billing_time?: number | null
> }
> ```

***

### history

`calls.history`

List and filter CallPage call history.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.calls.history({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `display_hidden` | `number` | No | — |
| `call_id` | `number[]` | No | — |
| `phone_number` | `string` | No | — |
| `user_ids` | `number[]` | No | — |
| `statuses` | `string[]` | No | — |
| `tag_ids` | `number[]` | No | — |
| `date_from` | `number` | No | — |
| `date_to` | `number` | No | — |
| `widget_ids` | `number[]` | No | — |
| `limit` | `number` | No | — |
| `offset` | `number` | No | — |
| `url` | `string` | No | — |
| `incoming_number_ids` | `number[]` | No | — |
| `tel` | `string` | No | — |
| `widget_id` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: number,
>   to?: string | null,
>   to_formatted?: string | null,
>   human_status?: string | null,
>   created_at?: string | null,
>   scheduled_at?: string | null,
>   cancelled_at?: string | null,
>   scheduled_success?: boolean | null,
>   leadable_id?: number | null,
>   leadable_type?: string | null,
>   leadable_description?: string | null,
>   utm?: {
>     utm_medium?: string | null,
>     utm_source?: string | null,
>     utm_content?: string | null,
>     utm_campaign?: string | null
>   },
>   referer?: {
>     medium?: string | null,
>     source?: string | null
>   },
>   request?: {
>     id?: number,
>     ip?: string | null,
>     url?: string | null,
>     locale?: string | null,
>     geo_city?: string | null,
>     geo_country_code?: string | null,
>     geo_country_name?: string | null,
>     user_agent_device?: string | null,
>     user_agent_device_type?: string | null
>   },
>   call?: {
>     id?: number,
>     sid?: string | null,
>     type?: number | null,
>     transcribed?: boolean | null,
>     billing_time?: number | null
>   }
> }[]
> ```

***

## Managers

### create

`managers.create`

Create a CallPage manager for a widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.managers.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_id` | `number` | Yes | — |
| `widget_id` | `number` | Yes | — |
| `enabled` | `boolean` | Yes | — |
| `business_times` | `object[]` | No | — |

> [accordion] business\_times full type
>
> ```ts theme={null}
> {
>   day_of_week: number,
>   enabled: boolean,
>   start_time: string | null,
>   end_time: string | null
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### delete

`managers.delete`

Delete a CallPage manager from a widget.

**Risk:** `destructive`

```ts theme={null}
await corsair.callpage.api.managers.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_id` | `number` | Yes | — |
| `widget_id` | `number` | Yes | — |

**Output:** `null`

***

### get

`managers.get`

Get a CallPage manager by user and widget.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.managers.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_id` | `number` | Yes | — |
| `widget_id` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `widget_id` | `number` | No | — |
| `user_id` | `number` | No | — |
| `enabled` | `boolean` | No | — |
| `user` | `object` | No | — |
| `departments` | `object[]` | No | — |
| `business_times` | `object[]` | No | — |

> [accordion] user full type
>
> ```ts theme={null}
> {
>   id: number,
>   name?: string | null,
>   tel?: string | null,
>   email?: string | null,
>   avatar?: string | null
> }
> ```

> [accordion] departments full type
>
> ```ts theme={null}
> {
>   id: number,
>   name: string
> }[]
> ```

> [accordion] business\_times full type
>
> ```ts theme={null}
> {
>   day_of_week: number,
>   enabled: boolean,
>   timezone?: string | null,
>   start_time: string | null,
>   end_time: string | null
> }[]
> ```

***

### list

`managers.list`

List managers for a CallPage widget with pagination.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.managers.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `offset` | `number` | No | — |
| `limit` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: number,
>   widget_id?: number,
>   user_id?: number,
>   enabled?: boolean,
>   user?: {
>     id: number,
>     name?: string | null,
>     tel?: string | null,
>     email?: string | null,
>     avatar?: string | null
>   },
>   departments?: {
>     id: number,
>     name: string
>   }[],
>   business_times?: {
>     day_of_week: number,
>     enabled: boolean,
>     timezone?: string | null,
>     start_time: string | null,
>     end_time: string | null
>   }[]
> }[]
> ```

***

### statusStatistics

`managers.statusStatistics`

Count enabled and disabled managers for a CallPage widget.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.managers.statusStatistics({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `total` | `number` | Yes | — |
| `enabled` | `number` | Yes | — |
| `disabled` | `number` | Yes | — |

***

### update

`managers.update`

Update a CallPage manager.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.managers.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_id` | `number` | Yes | — |
| `widget_id` | `number` | Yes | — |
| `enabled` | `boolean` | Yes | — |
| `business_times` | `object[]` | No | — |

> [accordion] business\_times full type
>
> ```ts theme={null}
> {
>   day_of_week: number,
>   enabled: boolean,
>   start_time: string | null,
>   end_time: string | null
> }[]
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

## Root

### get

`root.get`

Get the CallPage API root greeting to verify connectivity.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.root.get({});
```

**Input:** *empty object*

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `message` | `string` | Yes | — |

***

## Sms

### create

`sms.create`

Create a custom SMS message for a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.sms.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | Yes | — |
| `text` | `string` | Yes | — |
| `enabled` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### list

`sms.list`

List SMS messages for a CallPage widget.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.sms.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   widget_id?: number,
>   message_id: string,
>   text: string,
>   enabled?: boolean | number,
>   updated_at?: string | null
> }[]
> ```

***

### reset

`sms.reset`

Reset CallPage widget SMS messages to defaults.

**Risk:** `destructive`

```ts theme={null}
await corsair.callpage.api.sms.reset({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | No | — |

**Output:** `null`

***

### update

`sms.update`

Update a custom SMS message for a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.sms.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | Yes | — |
| `text` | `string` | Yes | — |
| `enabled` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

## Users

### create

`users.create`

Create a CallPage user.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.users.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `name` | `string` | Yes | — |
| `tel` | `string` | Yes | — |
| `email` | `string` | No | — |
| `role` | `admin \| manager` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### delete

`users.delete`

Delete a CallPage user.

**Risk:** `destructive`

```ts theme={null}
await corsair.callpage.api.users.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

**Output:** `null`

***

### get

`users.get`

Get a CallPage user.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.users.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `email` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `name` | `string \| null` | No | — |
| `email` | `string \| null` | No | — |
| `tel` | `string \| null` | No | — |
| `tel_formatted` | `string \| null` | No | — |
| `tel_extension` | `string \| null` | No | — |
| `last_online` | `string \| null` | No | — |
| `parent_id` | `number \| null` | No | — |
| `activated_at` | `string \| null` | No | — |
| `role` | `object \| null` | No | — |
| `avatar` | `string \| null` | No | — |
| `caller_id` | `object \| null` | No | — |

> [accordion] role full type
>
> ```ts theme={null}
> {
>   slug: string
> } | null
> ```

> [accordion] caller\_id full type
>
> ```ts theme={null}
> {
>   id?: number,
>   tel?: string | null,
>   activated_at?: string | null,
>   updated_at?: string | null,
>   tel_formatted?: string | null
> } | null
> ```

***

### list

`users.list`

List CallPage users.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.users.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `offset` | `number` | No | — |
| `limit` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: number,
>   name?: string | null,
>   email?: string | null,
>   tel?: string | null,
>   tel_formatted?: string | null,
>   tel_extension?: string | null,
>   last_online?: string | null,
>   parent_id?: number | null,
>   activated_at?: string | null,
>   role?: {
>     slug: string
>   } | null,
>   avatar?: string | null,
>   caller_id?: {
>     id?: number,
>     tel?: string | null,
>     activated_at?: string | null,
>     updated_at?: string | null,
>     tel_formatted?: string | null
>   } | null
> }[]
> ```

***

### update

`users.update`

Update a CallPage user.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.users.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `name` | `string` | Yes | — |
| `tel` | `string` | Yes | — |
| `email` | `string` | No | — |
| `role` | `admin \| manager` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

## Voice Messages

### create

`voiceMessages.create`

Create a custom voice message for a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.voiceMessages.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | Yes | — |
| `enabled` | `boolean` | Yes | — |
| `file` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### list

`voiceMessages.list`

List voice messages for a CallPage widget.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.voiceMessages.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   widget_id?: number,
>   message_id: string,
>   enabled?: boolean | number,
>   updated_at?: string | null,
>   recording?: {
>     full_url: string
>   } | null
> }[]
> ```

***

### reset

`voiceMessages.reset`

Reset CallPage widget voice messages to defaults.

**Risk:** `destructive`

```ts theme={null}
await corsair.callpage.api.voiceMessages.reset({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | No | — |

**Output:** `null`

***

### update

`voiceMessages.update`

Update a custom voice message for a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.voiceMessages.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `widget_id` | `number` | Yes | — |
| `message_id` | `string` | Yes | — |
| `enabled` | `boolean` | Yes | — |
| `file` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

## Widgets

### addUsers

`widgets.addUsers`

Add users to a CallPage widget as managers.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.widgets.addUsers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `user_id` | `number \| number[]` | Yes | — |
| `business_times` | `object[]` | No | — |

> [accordion] business\_times full type
>
> ```ts theme={null}
> {
>   day_of_week: number,
>   enabled: boolean,
>   start_time: string | null,
>   end_time: string | null
> }[] | {
>   day_of_week: number,
>   enabled: boolean,
>   start_time: string | null,
>   end_time: string | null
> }[][]
> ```

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   user_id: number,
>   manager_id: number
> }[]
> ```

***

### call

`widgets.call`

Initiate a CallPage widget call.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.widgets.call({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `tel` | `string` | Yes | — |
| `department_id` | `number` | No | — |
| `manager_id` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### callOrSchedule

`widgets.callOrSchedule`

Initiate or schedule a CallPage widget call.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.widgets.callOrSchedule({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `tel` | `string` | Yes | — |
| `department_id` | `number` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### create

`widgets.create`

Create a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.widgets.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `url` | `string` | Yes | — |
| `description` | `string` | No | — |
| `settings` | `Record<string, any>` | No | — |
| `locale_code` | `string` | No | — |
| `enabled` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***

### delete

`widgets.delete`

Delete a CallPage widget.

**Risk:** `destructive`

```ts theme={null}
await corsair.callpage.api.widgets.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

**Output:** `null`

***

### get

`widgets.get`

Get a CallPage widget.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.widgets.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | No | — |
| `widget_id` | `number` | No | — |
| `encrypted_id` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `description` | `string \| null` | No | — |
| `url` | `string \| null` | No | — |
| `enabled` | `boolean` | No | — |
| `locale_code` | `string \| null` | No | — |
| `installation_status` | `number \| null` | No | — |
| `installed_at` | `string \| null` | No | — |
| `company_sms_name` | `string \| null` | No | — |
| `call_requests_count` | `number \| null` | No | — |
| `managers` | `object[]` | No | — |

> [accordion] managers full type
>
> ```ts theme={null}
> {
>   id: number,
>   widget_id?: number,
>   user_id?: number,
>   enabled?: boolean,
>   user?: {
>     id: number,
>     name?: string | null,
>     tel?: string | null,
>     email?: string | null,
>     avatar?: string | null
>   },
>   departments?: {
>     id: number,
>     name: string
>   }[],
>   business_times?: {
>     day_of_week: number,
>     enabled: boolean,
>     timezone?: string | null,
>     start_time: string | null,
>     end_time: string | null
>   }[]
> }[]
> ```

***

### list

`widgets.list`

List CallPage widgets with pagination.

**Risk:** `read`

```ts theme={null}
await corsair.callpage.api.widgets.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `offset` | `number` | No | — |
| `limit` | `number` | No | — |

**Output:** `object[]`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   id: number,
>   description?: string | null,
>   url?: string | null,
>   enabled?: boolean,
>   locale_code?: string | null,
>   installation_status?: number | null,
>   installed_at?: string | null,
>   company_sms_name?: string | null,
>   call_requests_count?: number | null,
>   managers?: {
>     id: number,
>     widget_id?: number,
>     user_id?: number,
>     enabled?: boolean,
>     user?: {
>       id: number,
>       name?: string | null,
>       tel?: string | null,
>       email?: string | null,
>       avatar?: string | null
>     },
>     departments?: {
>       id: number,
>       name: string
>     }[],
>     business_times?: {
>       day_of_week: number,
>       enabled: boolean,
>       timezone?: string | null,
>       start_time: string | null,
>       end_time: string | null
>     }[]
>   }[]
> }[]
> ```

***

### update

`widgets.update`

Update a CallPage widget.

**Risk:** `write`

```ts theme={null}
await corsair.callpage.api.widgets.update({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |
| `url` | `string` | Yes | — |
| `description` | `string` | No | — |
| `settings` | `Record<string, any>` | No | — |
| `locale_code` | `string` | No | — |
| `enabled` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `id` | `number` | Yes | — |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.