/dialpad-messaging | Type: Application | PCID required: Yes
Tools
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 | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
dialpad_messaging_bulk_messages_list
Bulk Message — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Pagination cursor from previous response. |
limit | integer | No | — | Max results per page (default 20, max 100). |
user_id | integer | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
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 | 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 | 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 | No | — | The ID of the user who should be the sender. Defaults to authenticated user. |
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 | No | — | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
text | string | No | — | Updated message text content. |
user_id | integer | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
dialpad_messaging_channels_delete
Channel — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The channel id. |
dialpad_messaging_channels_get
Channel — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The channel id. |
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. |
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. |
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 |
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. |
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 | No | — | The ID of the user who owns the channel. Just for company level API key. |
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 |
dialpad_messaging_fax_send
Fax — Send Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
from_number | string | 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 | 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 | No | — | The ID of the user who should be the sender of the fax. |
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 |
dialpad_messaging_meetings_create
Dialpad Meeting — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_out | boolean | No | — | Whether or not the meeting should call the participants. |
duration | integer | 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 | 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. |
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). |
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. |
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). |
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. |
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 | No | — | Whether or not the meeting should call the participants. |
duration | integer | No | — | Duration of the meeting in seconds. |
end_datetime | integer | Yes | — | The meeting’s end time (UTC seconds-since-epoch timestamp). |
instance_id | string | No | — | The ID of the scheduled conference instance. |
participants_info | object[] | No | — | The list of users that participate in the meeting. |
recurrence | string | 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. |
dialpad_messaging_schedules_create
Schedule — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_hashtag | string | No | — | [single-line only] The hashtag of the channel which the message is scheduled for. |
from_number | string | No | — | The personal phone number to use as the sender (must belong to the user). |
is_bulk | boolean | No | — | Whether this is a bulk message (affects rate limiting and delivery). Maximum of 50 recipients. |
media | string | No | — | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
start_date | integer | No | — | Unix timestamp for when to send the message (must be 10+ minutes in future). |
text | string | No | — | The message text content. |
timezone | string | 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 | No | — | The ID of the user who should be the sender. If not provided, defaults to the authenticated user. |
dialpad_messaging_schedules_delete
Schedule — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The schedule’s ID (key string). |
user_id | integer | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
dialpad_messaging_schedules_get
Schedule — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The schedule’s ID (key string). |
user_id | integer | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
dialpad_messaging_schedules_list
Schedule — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | Pagination cursor from previous response. |
limit | integer | No | — | Max results per page (default 20, max 100). |
user_id | integer | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
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 | No | — | Optional user ID. If not provided, uses the authenticated user from API key. |
dialpad_messaging_schedules_update
Schedule — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The schedule’s ID (key string). |
channel_hashtag | string | No | — | [single-line only] The hashtag of the channel which the message is scheduled for. |
from_number | string | No | — | The personal phone number to use as the sender (must belong to the user). |
media | string | No | — | Base64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size). |
start_date | integer | No | — | Unix timestamp for when to send the message. |
text | string | No | — | The message text content. |
timezone | string | 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 | No | — | The ID of the user who should be the sender. If not provided, defaults to the authenticated user. |
dialpad_messaging_sms_send
SMS — Send Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_hashtag | string | No | — | [single-line only] The hashtag of the channel which should receive the SMS. |
from_number | string | 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 | 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 | No | — | Base64-encoded media attachment (will cause the message to be sent as MMS). (Max 500 KiB raw file size) |
sender_group_id | integer | No | — | The ID of an office, department, or call center that the User should send the message on behalf of. |
sender_group_type | string | No | — | The sender group’s type (i.e. office, department, or callcenter). |
text | string | 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 | No | — | The ID of the user who should be the sender of the SMS. |

