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

# dialpad-messaging

> Messaging & Channels

**Server path:** `/dialpad-messaging` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                                                          | Description                 |
| --------------------------------------------------------------------------------------------- | --------------------------- |
| [`dialpad_messaging_bulk_messages_get`](#dialpad_messaging_bulk_messages_get)                 | Bulk Message -- Get         |
| [`dialpad_messaging_bulk_messages_list`](#dialpad_messaging_bulk_messages_list)               | Bulk Message -- List        |
| [`dialpad_messaging_bulk_messages_send`](#dialpad_messaging_bulk_messages_send)               | Bulk Message -- Send        |
| [`dialpad_messaging_bulk_messages_update`](#dialpad_messaging_bulk_messages_update)           | Bulk Message -- Update      |
| [`dialpad_messaging_channels_delete`](#dialpad_messaging_channels_delete)                     | Channel -- Delete           |
| [`dialpad_messaging_channels_get`](#dialpad_messaging_channels_get)                           | Channel -- Get              |
| [`dialpad_messaging_channels_list`](#dialpad_messaging_channels_list)                         | Channel -- List             |
| [`dialpad_messaging_channels_members_delete`](#dialpad_messaging_channels_members_delete)     | Member -- Remove            |
| [`dialpad_messaging_channels_members_list`](#dialpad_messaging_channels_members_list)         | Members -- List             |
| [`dialpad_messaging_channels_members_post`](#dialpad_messaging_channels_members_post)         | Member -- Add               |
| [`dialpad_messaging_channels_post`](#dialpad_messaging_channels_post)                         | Channel -- Create           |
| [`dialpad_messaging_digital_sessionsdata_list`](#dialpad_messaging_digital_sessionsdata_list) | Digital -- Sessions -- List |
| [`dialpad_messaging_fax_send`](#dialpad_messaging_fax_send)                                   | Fax -- Send                 |
| [`dialpad_messaging_faxline_create`](#dialpad_messaging_faxline_create)                       | Fax Line -- Assign          |
| [`dialpad_messaging_meetings_create`](#dialpad_messaging_meetings_create)                     | Dialpad Meeting -- Create   |
| [`dialpad_messaging_meetings_delete`](#dialpad_messaging_meetings_delete)                     | Dialpad Meeting -- Delete   |
| [`dialpad_messaging_meetings_get`](#dialpad_messaging_meetings_get)                           | Dialpad Meeting -- Get      |
| [`dialpad_messaging_meetings_list`](#dialpad_messaging_meetings_list)                         | Dialpad Meeting -- List     |
| [`dialpad_messaging_meetings_room_create`](#dialpad_messaging_meetings_room_create)           | Meeting Room -- Create      |
| [`dialpad_messaging_meetings_update`](#dialpad_messaging_meetings_update)                     | Dialpad Meeting -- Update   |
| [`dialpad_messaging_schedules_create`](#dialpad_messaging_schedules_create)                   | Schedule -- Create          |
| [`dialpad_messaging_schedules_delete`](#dialpad_messaging_schedules_delete)                   | Schedule -- Delete          |
| [`dialpad_messaging_schedules_get`](#dialpad_messaging_schedules_get)                         | Schedule -- Get             |
| [`dialpad_messaging_schedules_list`](#dialpad_messaging_schedules_list)                       | Schedule -- List            |
| [`dialpad_messaging_schedules_send_now`](#dialpad_messaging_schedules_send_now)               | Schedule -- Send Now        |
| [`dialpad_messaging_schedules_update`](#dialpad_messaging_schedules_update)                   | Schedule -- Update          |
| [`dialpad_messaging_sms_send`](#dialpad_messaging_sms_send)                                   | SMS -- Send                 |

***

## dialpad\_messaging\_bulk\_messages\_get

Bulk Message -- Get

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |                                                                              |
| --------- | ------- | -------- | ------- | ----------------------------------- | ---------------------------------------------------------------------------- |
| `id`      | string  | Yes      | —       | The bulk message's ID (key string). |                                                                              |
| `user_id` | integer | null     | No      | —                                   | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The bulk message's ID (key string)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_bulk\_messages\_list

Bulk Message -- List

**Parameters:**

| Parameter | Type    | Required | Default | Description |                                                                              |
| --------- | ------- | -------- | ------- | ----------- | ---------------------------------------------------------------------------- |
| `cursor`  | string  | null     | No      | —           | Pagination cursor from previous response.                                    |
| `limit`   | integer | null     | No      | —           | Max results per page (default 20, max 100).                                  |
| `user_id` | integer | null     | No      | —           | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": [
          "string",
          "null"
        ],
        "description": "Pagination cursor from previous response."
      },
      "limit": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Max results per page (default 20, max 100)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_bulk\_messages\_send

Bulk Message -- Send

**Parameters:**

| Parameter     | Type      | Required | Default | Description                                                                        |                                                                                     |
| ------------- | --------- | -------- | ------- | ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `from_number` | string    | Yes      | —       | The phone number to use as sender (must belong to the user and be A2P-registered). |                                                                                     |
| `media`       | string    | null     | No      | —                                                                                  | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
| `text`        | string    | Yes      | —       | The message text content (required).                                               |                                                                                     |
| `title`       | string    | null     | No      | —                                                                                  | Optional title for the bulk message batch.                                          |
| `to_numbers`  | string\[] | Yes      | —       | List of phone numbers in E.164 format (max 50).                                    |                                                                                     |
| `user_id`     | integer   | null     | No      | —                                                                                  | The ID of the user who should be the sender. Defaults to authenticated user.        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "from_number": {
        "type": "string",
        "description": "The phone number to use as sender (must belong to the user and be A2P-registered)."
      },
      "media": {
        "type": [
          "string",
          "null"
        ],
        "description": "Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size)."
      },
      "text": {
        "type": "string",
        "description": "The message text content (required)."
      },
      "title": {
        "type": [
          "string",
          "null"
        ],
        "description": "Optional title for the bulk message batch."
      },
      "to_numbers": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of phone numbers in E.164 format (max 50)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who should be the sender. Defaults to authenticated user."
      }
    },
    "required": [
      "PCID",
      "from_number",
      "text",
      "to_numbers"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_bulk\_messages\_update

Bulk Message -- Update

**Parameters:**

| Parameter | Type    | Required | Default | Description                         |                                                                                     |
| --------- | ------- | -------- | ------- | ----------------------------------- | ----------------------------------------------------------------------------------- |
| `id`      | string  | Yes      | —       | The bulk message's ID (key string). |                                                                                     |
| `media`   | string  | null     | No      | —                                   | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
| `text`    | string  | null     | No      | —                                   | Updated message text content.                                                       |
| `user_id` | integer | null     | No      | —                                   | Optional user ID. If not provided, uses the authenticated user from API key.        |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The bulk message's ID (key string)."
      },
      "media": {
        "type": [
          "string",
          "null"
        ],
        "description": "Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size)."
      },
      "text": {
        "type": [
          "string",
          "null"
        ],
        "description": "Updated message text content."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_delete

Channel -- Delete

**Parameters:**

| Parameter | Type    | Required | Default | Description     |
| --------- | ------- | -------- | ------- | --------------- |
| `id`      | integer | Yes      | —       | The channel id. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The channel id."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_get

Channel -- Get

**Parameters:**

| Parameter | Type    | Required | Default | Description     |
| --------- | ------- | -------- | ------- | --------------- |
| `id`      | integer | Yes      | —       | The channel id. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The channel id."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_list

Channel -- List

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                   |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor`  | string | No       | —       | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `state`   | string | No       | —       | The state of the channel.                                                                                     |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": "string",
        "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
      },
      "state": {
        "type": "string",
        "description": "The state of the channel."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_members\_delete

Member -- Remove

**Parameters:**

| Parameter | Type    | Required | Default | Description       |
| --------- | ------- | -------- | ------- | ----------------- |
| `id`      | integer | Yes      | —       | The channel's id. |
| `user_id` | integer | Yes      | —       | The user id.      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The channel's id."
      },
      "user_id": {
        "type": "integer",
        "description": "The user id."
      }
    },
    "required": [
      "PCID",
      "id",
      "user_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_members\_list

Members -- List

**Parameters:**

| Parameter | Type    | Required | Default | Description                                                                                                   |
| --------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor`  | string  | No       | —       | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `id`      | integer | Yes      | —       | The channel id                                                                                                |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": "string",
        "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
      },
      "id": {
        "type": "integer",
        "description": "The channel id"
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_members\_post

Member -- Add

**Parameters:**

| Parameter | Type    | Required | Default | Description       |
| --------- | ------- | -------- | ------- | ----------------- |
| `id`      | integer | Yes      | —       | The channel's id. |
| `user_id` | integer | Yes      | —       | The user id.      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "integer",
        "description": "The channel's id."
      },
      "user_id": {
        "type": "integer",
        "description": "The user id."
      }
    },
    "required": [
      "PCID",
      "id",
      "user_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_channels\_post

Channel -- Create

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                   |                                                                          |
| -------------- | ------- | -------- | ------- | --------------------------------------------- | ------------------------------------------------------------------------ |
| `description`  | string  | Yes      | —       | The description of the channel.               |                                                                          |
| `name`         | string  | Yes      | —       | \[single-line only]  The name of the channel. |                                                                          |
| `privacy_type` | string  | Yes      | —       | The privacy type of the channel.              |                                                                          |
| `user_id`      | integer | null     | No      | —                                             | The ID of the user who owns the channel. Just for company level API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "description": {
        "type": "string",
        "description": "The description of the channel."
      },
      "name": {
        "type": "string",
        "description": "[single-line only]  The name of the channel."
      },
      "privacy_type": {
        "type": "string",
        "description": "The privacy type of the channel.",
        "enum": [
          "private",
          "public"
        ]
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who owns the channel. Just for company level API key."
      }
    },
    "required": [
      "PCID",
      "description",
      "name",
      "privacy_type"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_digital\_sessionsdata\_list

Digital -- Sessions -- List

**Parameters:**

| Parameter     | Type    | Required | Default | Description                                                                                                                    |
| ------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `cursor`      | string  | No       | —       | A token used to return the next page of a previous request. Use the cursor provided in the previous response.                  |
| `end_date`    | string  | Yes      | —       | End date of the date range to be queried. E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00  |
| `target_id`   | integer | No       | —       | Optional. The numeric ID of the target to filter by. Must be provided together with target\_type.                              |
| `target_type` | string  | No       | —       | Optional. The type of the target to filter by. One of: department, office, callcenter.                                         |
| `start_date`  | string  | Yes      | —       | Start date of the date range to be queried E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": "string",
        "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
      },
      "end_date": {
        "type": "string",
        "description": "End date of the date range to be queried. E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00"
      },
      "target_id": {
        "type": "integer",
        "description": "Optional. The numeric ID of the target to filter by. Must be provided together with target_type."
      },
      "target_type": {
        "type": "string",
        "description": "Optional. The type of the target to filter by. One of: department, office, callcenter.",
        "enum": [
          "callcenter",
          "department",
          "office"
        ]
      },
      "start_date": {
        "type": "string",
        "description": "Start date of the date range to be queried E.g. 2024-09-25T00:00:00Z or 2024-09-25T00:00:00+04:00 or 2024-09-25T00:00:00-04:00"
      }
    },
    "required": [
      "PCID",
      "end_date",
      "start_date"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_fax\_send

Fax -- Send

**Parameters:**

| Parameter            | Type    | Required | Default | Description                                       |                                                                                                                                                                          |
| -------------------- | ------- | -------- | ------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `from_number`        | string  | null     | No      | —                                                 | The E164-formatted phone number of the sender. The number must be assigned to a user or a group. If a group is assigned to the from\_number, user\_id must be specified. |
| `infer_country_code` | boolean | null     | No      | —                                                 | If true, to\_number will be assumed to be from the sender's country, and the E164 format requirement will be relaxed.                                                    |
| `to_number`          | string  | Yes      | —       | The E164-formatted phone number of the recipient. |                                                                                                                                                                          |
| `user_id`            | integer | null     | No      | —                                                 | The ID of the user who should be the sender of the fax.                                                                                                                  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "from_number": {
        "type": [
          "string",
          "null"
        ],
        "description": "The E164-formatted phone number of the sender. The number must be assigned to a user or a group. If a group is assigned to the from_number, user_id must be specified."
      },
      "infer_country_code": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "If true, to_number will be assumed to be from the sender's country, and the E164 format requirement will be relaxed."
      },
      "to_number": {
        "type": "string",
        "description": "The E164-formatted phone number of the recipient."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who should be the sender of the fax."
      }
    },
    "required": [
      "PCID",
      "to_number"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_faxline\_create

Fax Line -- Assign

**Parameters:**

| Parameter | Type   | Required | Default | Description      |
| --------- | ------ | -------- | ------- | ---------------- |
| `line`    | object | Yes      | —       | Line to assign.  |
| `target`  | object | Yes      | —       | The target value |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "line": {
        "description": "Line to assign."
      },
      "target": {
        "type": "object",
        "description": "The target value",
        "properties": {
          "target_id": {
            "type": "integer",
            "description": "The ID of the target to assign the fax line to."
          },
          "target_type": {
            "type": "string",
            "description": "Type of the target to assign the fax line to.",
            "enum": [
              "department",
              "user"
            ]
          }
        },
        "required": [
          "target_id",
          "target_type"
        ]
      }
    },
    "required": [
      "PCID",
      "line",
      "target"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_create

Dialpad Meeting -- Create

**Parameters:**

| Parameter           | Type      | Required | Default | Description                                                   |                                                          |
| ------------------- | --------- | -------- | ------- | ------------------------------------------------------------- | -------------------------------------------------------- |
| `call_out`          | boolean   | null     | No      | —                                                             | Whether or not the meeting should call the participants. |
| `duration`          | integer   | null     | No      | —                                                             | Duration of the meeting in seconds.                      |
| `end_datetime`      | integer   | Yes      | —       | The meeting's end time (UTC seconds-since-epoch timestamp).   |                                                          |
| `meeting_type`      | string    | Yes      | —       | The meeting's type.                                           |                                                          |
| `participants_info` | object\[] | No       | —       | The list of users that participate in the meeting.            |                                                          |
| `recurrence`        | string    | null     | No      | —                                                             | How often the meeting should be repeated.                |
| `start_datetime`    | integer   | Yes      | —       | The meeting's start time (UTC seconds-since-epoch timestamp). |                                                          |
| `title`             | string    | Yes      | —       | The meeting's title.                                          |                                                          |
| `user_id`           | integer   | Yes      | —       | The Dialpad user's id.                                        |                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "call_out": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether or not the meeting should call the participants."
      },
      "duration": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Duration of the meeting in seconds."
      },
      "end_datetime": {
        "type": "integer",
        "description": "The meeting's end time (UTC seconds-since-epoch timestamp)."
      },
      "meeting_type": {
        "type": "string",
        "description": "The meeting's type.",
        "enum": [
          "CUSTOM_UNIQUE_MEETING",
          "LARGE_MEETING",
          "PERSONAL",
          "UNIQUE_MEETING"
        ]
      },
      "participants_info": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "call_in_method": {
              "type": "string",
              "description": "The method this participant used to joined the meeting."
            },
            "display_name": {
              "type": "string",
              "description": "Name of the meeting participant."
            },
            "email": {
              "type": "string",
              "description": "The email address of the participant. (if applicable)"
            },
            "is_organizer": {
              "type": "boolean",
              "description": "Whether or not the participant is the meeting's organizer."
            },
            "name": {
              "type": "string",
              "description": "Name of the meeting participant."
            },
            "phone": {
              "type": "string",
              "description": "The number that the participant dialed in from. (if applicable)"
            },
            "phone_number": {
              "type": "string",
              "description": "The number that the participant dialed in from. (if applicable)"
            },
            "talk_time": {
              "type": "integer",
              "format": "int64",
              "description": "The amount of time this participant was speaking. (in milliseconds)"
            }
          }
        },
        "description": "The list of users that participate in the meeting."
      },
      "recurrence": {
        "type": [
          "string",
          "null"
        ],
        "description": "How often the meeting should be repeated."
      },
      "start_datetime": {
        "type": "integer",
        "description": "The meeting's start time (UTC seconds-since-epoch timestamp)."
      },
      "title": {
        "type": "string",
        "description": "The meeting's title."
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      }
    },
    "required": [
      "PCID",
      "end_datetime",
      "meeting_type",
      "start_datetime",
      "title",
      "user_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_delete

Dialpad Meeting -- Delete

**Parameters:**

| Parameter                 | Type    | Required | Default | Description                                                                              |
| ------------------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `user_id`                 | integer | No       | —       | The Dialpad user's id.                                                                   |
| `scheduled_conference_id` | integer | Yes      | —       | The meeting room's ID.                                                                   |
| `instance_timestamp`      | integer | No       | —       | The timestamp of the meeting instance to be deleted (UTC seconds-since-epoch timestamp). |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      },
      "scheduled_conference_id": {
        "type": "integer",
        "description": "The meeting room's ID."
      },
      "instance_timestamp": {
        "type": "integer",
        "description": "The timestamp of the meeting instance to be deleted (UTC seconds-since-epoch timestamp)."
      }
    },
    "required": [
      "PCID",
      "scheduled_conference_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_get

Dialpad Meeting -- Get

**Parameters:**

| Parameter                 | Type    | Required | Default | Description            |
| ------------------------- | ------- | -------- | ------- | ---------------------- |
| `user_id`                 | integer | No       | —       | The Dialpad user's id. |
| `scheduled_conference_id` | integer | Yes      | —       | The meeting room's ID. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      },
      "scheduled_conference_id": {
        "type": "integer",
        "description": "The meeting room's ID."
      }
    },
    "required": [
      "PCID",
      "scheduled_conference_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_list

Dialpad Meeting -- List

**Parameters:**

| Parameter        | Type    | Required | Default | Description                                                                                                   |
| ---------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| `cursor`         | string  | No       | —       | A token used to return the next page of a previous request. Use the cursor provided in the previous response. |
| `user_id`        | integer | Yes      | —       | The Dialpad user's id.                                                                                        |
| `end_datetime`   | integer | No       | —       | The meeting's end time (UTC seconds-since-epoch timestamp).                                                   |
| `start_datetime` | integer | Yes      | —       | The meeting's start time (UTC seconds-since-epoch timestamp).                                                 |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": "string",
        "description": "A token used to return the next page of a previous request. Use the cursor provided in the previous response."
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      },
      "end_datetime": {
        "type": "integer",
        "description": "The meeting's end time (UTC seconds-since-epoch timestamp)."
      },
      "start_datetime": {
        "type": "integer",
        "description": "The meeting's start time (UTC seconds-since-epoch timestamp)."
      }
    },
    "required": [
      "PCID",
      "user_id",
      "start_datetime"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_room\_create

Meeting Room -- Create

**Parameters:**

| Parameter      | Type    | Required | Default | Description                                                                                                               |
| -------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------- |
| `meeting_id`   | string  | No       | —       | Optional custom meeting ID (for unique meetings).                                                                         |
| `meeting_type` | string  | No       | —       | Optional meeting type ('UNIQUE\_MEETING' or 'PERSONAL'). If not specified, Dialpad will create based on user preferences. |
| `user_id`      | integer | Yes      | —       | The Dialpad user's id.                                                                                                    |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "meeting_id": {
        "type": "string",
        "description": "Optional custom meeting ID (for unique meetings)."
      },
      "meeting_type": {
        "type": "string",
        "description": "Optional meeting type ('UNIQUE_MEETING' or 'PERSONAL'). If not specified, Dialpad will create based on user preferences."
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      }
    },
    "required": [
      "PCID",
      "user_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_meetings\_update

Dialpad Meeting -- Update

**Parameters:**

| Parameter                 | Type      | Required | Default | Description                                                   |                                                          |
| ------------------------- | --------- | -------- | ------- | ------------------------------------------------------------- | -------------------------------------------------------- |
| `scheduled_conference_id` | integer   | Yes      | —       | The meeting room's ID.                                        |                                                          |
| `call_out`                | boolean   | null     | No      | —                                                             | Whether or not the meeting should call the participants. |
| `duration`                | integer   | null     | No      | —                                                             | Duration of the meeting in seconds.                      |
| `end_datetime`            | integer   | Yes      | —       | The meeting's end time (UTC seconds-since-epoch timestamp).   |                                                          |
| `instance_id`             | string    | null     | No      | —                                                             | The ID of the scheduled conference instance.             |
| `participants_info`       | object\[] | No       | —       | The list of users that participate in the meeting.            |                                                          |
| `recurrence`              | string    | null     | No      | —                                                             | How often the meeting should be repeated.                |
| `start_datetime`          | integer   | Yes      | —       | The meeting's start time (UTC seconds-since-epoch timestamp). |                                                          |
| `title`                   | string    | Yes      | —       | The meeting's title.                                          |                                                          |
| `user_id`                 | integer   | Yes      | —       | The Dialpad user's id.                                        |                                                          |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "scheduled_conference_id": {
        "type": "integer",
        "description": "The meeting room's ID."
      },
      "call_out": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether or not the meeting should call the participants."
      },
      "duration": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Duration of the meeting in seconds."
      },
      "end_datetime": {
        "type": "integer",
        "description": "The meeting's end time (UTC seconds-since-epoch timestamp)."
      },
      "instance_id": {
        "type": [
          "string",
          "null"
        ],
        "description": "The ID of the scheduled conference instance."
      },
      "participants_info": {
        "type": "array",
        "items": {
          "type": "object",
          "properties": {
            "call_in_method": {
              "type": "string",
              "description": "The method this participant used to joined the meeting."
            },
            "display_name": {
              "type": "string",
              "description": "Name of the meeting participant."
            },
            "email": {
              "type": "string",
              "description": "The email address of the participant. (if applicable)"
            },
            "is_organizer": {
              "type": "boolean",
              "description": "Whether or not the participant is the meeting's organizer."
            },
            "name": {
              "type": "string",
              "description": "Name of the meeting participant."
            },
            "phone": {
              "type": "string",
              "description": "The number that the participant dialed in from. (if applicable)"
            },
            "phone_number": {
              "type": "string",
              "description": "The number that the participant dialed in from. (if applicable)"
            },
            "talk_time": {
              "type": "integer",
              "format": "int64",
              "description": "The amount of time this participant was speaking. (in milliseconds)"
            }
          }
        },
        "description": "The list of users that participate in the meeting."
      },
      "recurrence": {
        "type": [
          "string",
          "null"
        ],
        "description": "How often the meeting should be repeated."
      },
      "start_datetime": {
        "type": "integer",
        "description": "The meeting's start time (UTC seconds-since-epoch timestamp)."
      },
      "title": {
        "type": "string",
        "description": "The meeting's title."
      },
      "user_id": {
        "type": "integer",
        "description": "The Dialpad user's id."
      }
    },
    "required": [
      "PCID",
      "scheduled_conference_id",
      "end_datetime",
      "start_datetime",
      "title",
      "user_id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_create

Schedule -- Create

**Parameters:**

| Parameter         | Type      | Required | Default | Description                                                         |                                                                                                   |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `channel_hashtag` | string    | null     | No      | —                                                                   | \[single-line only]  The hashtag of the channel which the message is scheduled for.               |
| `from_number`     | string    | null     | No      | —                                                                   | The personal phone number to use as the sender (must belong to the user).                         |
| `is_bulk`         | boolean   | null     | No      | —                                                                   | Whether this is a bulk message (affects rate limiting and delivery). Maximum of 50 recipients.    |
| `media`           | string    | null     | No      | —                                                                   | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).               |
| `start_date`      | integer   | null     | No      | —                                                                   | Unix timestamp for when to send the message (must be 10+ minutes in future).                      |
| `text`            | string    | null     | No      | —                                                                   | The message text content.                                                                         |
| `timezone`        | string    | null     | No      | —                                                                   | Timezone name (e.g., 'America/Los\_Angeles').                                                     |
| `to_numbers`      | string\[] | No       | —       | List of up to 50 E.164-formatted phone numbers to send messages to. |                                                                                                   |
| `user_id`         | integer   | null     | No      | —                                                                   | The ID of the user who should be the sender. If not provided, defaults to the authenticated user. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "channel_hashtag": {
        "type": [
          "string",
          "null"
        ],
        "description": "[single-line only]  The hashtag of the channel which the message is scheduled for."
      },
      "from_number": {
        "type": [
          "string",
          "null"
        ],
        "description": "The personal phone number to use as the sender (must belong to the user)."
      },
      "is_bulk": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "Whether this is a bulk message (affects rate limiting and delivery). Maximum of 50 recipients."
      },
      "media": {
        "type": [
          "string",
          "null"
        ],
        "description": "Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size)."
      },
      "start_date": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Unix timestamp for when to send the message (must be 10+ minutes in future)."
      },
      "text": {
        "type": [
          "string",
          "null"
        ],
        "description": "The message text content."
      },
      "timezone": {
        "type": [
          "string",
          "null"
        ],
        "description": "Timezone name (e.g., 'America/Los_Angeles')."
      },
      "to_numbers": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of up to 50 E.164-formatted phone numbers to send messages to."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who should be the sender. If not provided, defaults to the authenticated user."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_delete

Schedule -- Delete

**Parameters:**

| Parameter | Type    | Required | Default | Description                     |                                                                              |
| --------- | ------- | -------- | ------- | ------------------------------- | ---------------------------------------------------------------------------- |
| `id`      | string  | Yes      | —       | The schedule's ID (key string). |                                                                              |
| `user_id` | integer | null     | No      | —                               | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The schedule's ID (key string)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_get

Schedule -- Get

**Parameters:**

| Parameter | Type    | Required | Default | Description                     |                                                                              |
| --------- | ------- | -------- | ------- | ------------------------------- | ---------------------------------------------------------------------------- |
| `id`      | string  | Yes      | —       | The schedule's ID (key string). |                                                                              |
| `user_id` | integer | null     | No      | —                               | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The schedule's ID (key string)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_list

Schedule -- List

**Parameters:**

| Parameter | Type    | Required | Default | Description |                                                                              |
| --------- | ------- | -------- | ------- | ----------- | ---------------------------------------------------------------------------- |
| `cursor`  | string  | null     | No      | —           | Pagination cursor from previous response.                                    |
| `limit`   | integer | null     | No      | —           | Max results per page (default 20, max 100).                                  |
| `user_id` | integer | null     | No      | —           | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "cursor": {
        "type": [
          "string",
          "null"
        ],
        "description": "Pagination cursor from previous response."
      },
      "limit": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Max results per page (default 20, max 100)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_send\_now

Schedule -- Send Now

**Parameters:**

| Parameter | Type    | Required | Default | Description                     |                                                                              |
| --------- | ------- | -------- | ------- | ------------------------------- | ---------------------------------------------------------------------------- |
| `id`      | string  | Yes      | —       | The schedule's ID (key string). |                                                                              |
| `user_id` | integer | null     | No      | —                               | Optional user ID. If not provided, uses the authenticated user from API key. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The schedule's ID (key string)."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Optional user ID. If not provided, uses the authenticated user from API key."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_schedules\_update

Schedule -- Update

**Parameters:**

| Parameter         | Type      | Required | Default | Description                                            |                                                                                                   |
| ----------------- | --------- | -------- | ------- | ------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| `id`              | string    | Yes      | —       | The schedule's ID (key string).                        |                                                                                                   |
| `channel_hashtag` | string    | null     | No      | —                                                      | \[single-line only]  The hashtag of the channel which the message is scheduled for.               |
| `from_number`     | string    | null     | No      | —                                                      | The personal phone number to use as the sender (must belong to the user).                         |
| `media`           | string    | null     | No      | —                                                      | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).               |
| `start_date`      | integer   | null     | No      | —                                                      | Unix timestamp for when to send the message.                                                      |
| `text`            | string    | null     | No      | —                                                      | The message text content.                                                                         |
| `timezone`        | string    | null     | No      | —                                                      | Timezone name (e.g., 'America/Los\_Angeles').                                                     |
| `to_numbers`      | string\[] | No       | —       | List of phone numbers to schedule to send messages to. |                                                                                                   |
| `user_id`         | integer   | null     | No      | —                                                      | The ID of the user who should be the sender. If not provided, defaults to the authenticated user. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "id": {
        "type": "string",
        "description": "The schedule's ID (key string)."
      },
      "channel_hashtag": {
        "type": [
          "string",
          "null"
        ],
        "description": "[single-line only]  The hashtag of the channel which the message is scheduled for."
      },
      "from_number": {
        "type": [
          "string",
          "null"
        ],
        "description": "The personal phone number to use as the sender (must belong to the user)."
      },
      "media": {
        "type": [
          "string",
          "null"
        ],
        "description": "Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size)."
      },
      "start_date": {
        "type": [
          "integer",
          "null"
        ],
        "description": "Unix timestamp for when to send the message."
      },
      "text": {
        "type": [
          "string",
          "null"
        ],
        "description": "The message text content."
      },
      "timezone": {
        "type": [
          "string",
          "null"
        ],
        "description": "Timezone name (e.g., 'America/Los_Angeles')."
      },
      "to_numbers": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of phone numbers to schedule to send messages to."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who should be the sender. If not provided, defaults to the authenticated user."
      }
    },
    "required": [
      "PCID",
      "id"
    ]
  }
  ```
</Expandable>

***

## dialpad\_messaging\_sms\_send

SMS -- Send

**Parameters:**

| Parameter            | Type      | Required | Default | Description                                                       |                                                                                                                                    |
| -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `channel_hashtag`    | string    | null     | No      | —                                                                 | \[single-line only]  The hashtag of the channel which should receive the SMS.                                                      |
| `from_number`        | string    | null     | No      | —                                                                 | The sender's phone number. The number must be assigned to a user or a user group. It will override user\_id and sender\_group\_id. |
| `infer_country_code` | boolean   | null     | No      | —                                                                 | If true, to\_numbers will be assumed to be from the specified user's country, and the E164 format requirement will be relaxed.     |
| `media`              | string    | null     | No      | —                                                                 | Base64-encoded media attachment (will cause the message to be sent as MMS). (Max 500 KiB raw file size)                            |
| `sender_group_id`    | integer   | null     | No      | —                                                                 | The ID of an office, department, or call center that the User should send the message on behalf of.                                |
| `sender_group_type`  | string    | null     | No      | —                                                                 | The sender group's type (i.e. office, department, or callcenter).                                                                  |
| `text`               | string    | null     | No      | —                                                                 | The contents of the message that should be sent.                                                                                   |
| `to_numbers`         | string\[] | No       | —       | Up to 10 E164-formatted phone numbers who should receive the SMS. |                                                                                                                                    |
| `user_id`            | integer   | null     | No      | —                                                                 | The ID of the user who should be the sender of the SMS.                                                                            |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "channel_hashtag": {
        "type": [
          "string",
          "null"
        ],
        "description": "[single-line only]  The hashtag of the channel which should receive the SMS."
      },
      "from_number": {
        "type": [
          "string",
          "null"
        ],
        "description": "The sender's phone number. The number must be assigned to a user or a user group. It will override user_id and sender_group_id."
      },
      "infer_country_code": {
        "type": [
          "boolean",
          "null"
        ],
        "description": "If true, to_numbers will be assumed to be from the specified user's country, and the E164 format requirement will be relaxed."
      },
      "media": {
        "type": [
          "string",
          "null"
        ],
        "description": "Base64-encoded media attachment (will cause the message to be sent as MMS). (Max 500 KiB raw file size)"
      },
      "sender_group_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of an office, department, or call center that the User should send the message on behalf of."
      },
      "sender_group_type": {
        "type": [
          "string",
          "null"
        ],
        "description": "The sender group's type (i.e. office, department, or callcenter).",
        "enum": [
          "callcenter",
          "department",
          "office"
        ]
      },
      "text": {
        "type": [
          "string",
          "null"
        ],
        "description": "The contents of the message that should be sent."
      },
      "to_numbers": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "Up to 10 E164-formatted phone numbers who should receive the SMS."
      },
      "user_id": {
        "type": [
          "integer",
          "null"
        ],
        "description": "The ID of the user who should be the sender of the SMS."
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>