Skip to main content
Server path: /dialpad-messaging | Type: Application | PCID required: Yes

Tools


dialpad_messaging_bulk_messages_get

Bulk Message — Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe bulk message’s ID (key string).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_bulk_messages_list

Bulk Message — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoPagination cursor from previous response.
limitintegerNoMax results per page (default 20, max 100).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_bulk_messages_send

Bulk Message — Send Parameters:
ParameterTypeRequiredDefaultDescription
from_numberstringYesThe phone number to use as sender (must belong to the user and be A2P-registered).
mediastringNoBase64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).
textstringYesThe message text content (required).
titlestringNoOptional title for the bulk message batch.
to_numbersstring[]YesList of phone numbers in E.164 format (max 50).
user_idintegerNoThe ID of the user who should be the sender. Defaults to authenticated user.

dialpad_messaging_bulk_messages_update

Bulk Message — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe bulk message’s ID (key string).
mediastringNoBase64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).
textstringNoUpdated message text content.
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_channels_delete

Channel — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe channel id.

dialpad_messaging_channels_get

Channel — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe channel id.

dialpad_messaging_channels_list

Channel — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
statestringNoThe state of the channel.

dialpad_messaging_channels_members_delete

Member — Remove Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe channel’s id.
user_idintegerYesThe user id.

dialpad_messaging_channels_members_list

Members — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
idintegerYesThe channel id

dialpad_messaging_channels_members_post

Member — Add Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe channel’s id.
user_idintegerYesThe user id.

dialpad_messaging_channels_post

Channel — Create Parameters:
ParameterTypeRequiredDefaultDescription
descriptionstringYesThe description of the channel.
namestringYes[single-line only] The name of the channel.
privacy_typestringYesThe privacy type of the channel.
user_idintegerNoThe ID of the user who owns the channel. Just for company level API key.

dialpad_messaging_digital_sessionsdata_list

Digital — Sessions — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
end_datestringYesEnd 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_idintegerNoOptional. The numeric ID of the target to filter by. Must be provided together with target_type.
target_typestringNoOptional. The type of the target to filter by. One of: department, office, callcenter.
start_datestringYesStart 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:
ParameterTypeRequiredDefaultDescription
from_numberstringNoThe 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_codebooleanNoIf true, to_number will be assumed to be from the sender’s country, and the E164 format requirement will be relaxed.
to_numberstringYesThe E164-formatted phone number of the recipient.
user_idintegerNoThe ID of the user who should be the sender of the fax.

dialpad_messaging_faxline_create

Fax Line — Assign Parameters:
ParameterTypeRequiredDefaultDescription
lineobjectYesLine to assign.
targetobjectYesThe target value

dialpad_messaging_meetings_create

Dialpad Meeting — Create Parameters:
ParameterTypeRequiredDefaultDescription
call_outbooleanNoWhether or not the meeting should call the participants.
durationintegerNoDuration of the meeting in seconds.
end_datetimeintegerYesThe meeting’s end time (UTC seconds-since-epoch timestamp).
meeting_typestringYesThe meeting’s type.
participants_infoobject[]NoThe list of users that participate in the meeting.
recurrencestringNoHow often the meeting should be repeated.
start_datetimeintegerYesThe meeting’s start time (UTC seconds-since-epoch timestamp).
titlestringYesThe meeting’s title.
user_idintegerYesThe Dialpad user’s id.

dialpad_messaging_meetings_delete

Dialpad Meeting — Delete Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerNoThe Dialpad user’s id.
scheduled_conference_idintegerYesThe meeting room’s ID.
instance_timestampintegerNoThe timestamp of the meeting instance to be deleted (UTC seconds-since-epoch timestamp).

dialpad_messaging_meetings_get

Dialpad Meeting — Get Parameters:
ParameterTypeRequiredDefaultDescription
user_idintegerNoThe Dialpad user’s id.
scheduled_conference_idintegerYesThe meeting room’s ID.

dialpad_messaging_meetings_list

Dialpad Meeting — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
user_idintegerYesThe Dialpad user’s id.
end_datetimeintegerNoThe meeting’s end time (UTC seconds-since-epoch timestamp).
start_datetimeintegerYesThe meeting’s start time (UTC seconds-since-epoch timestamp).

dialpad_messaging_meetings_room_create

Meeting Room — Create Parameters:
ParameterTypeRequiredDefaultDescription
meeting_idstringNoOptional custom meeting ID (for unique meetings).
meeting_typestringNoOptional meeting type (‘UNIQUE_MEETING’ or ‘PERSONAL’). If not specified, Dialpad will create based on user preferences.
user_idintegerYesThe Dialpad user’s id.

dialpad_messaging_meetings_update

Dialpad Meeting — Update Parameters:
ParameterTypeRequiredDefaultDescription
scheduled_conference_idintegerYesThe meeting room’s ID.
call_outbooleanNoWhether or not the meeting should call the participants.
durationintegerNoDuration of the meeting in seconds.
end_datetimeintegerYesThe meeting’s end time (UTC seconds-since-epoch timestamp).
instance_idstringNoThe ID of the scheduled conference instance.
participants_infoobject[]NoThe list of users that participate in the meeting.
recurrencestringNoHow often the meeting should be repeated.
start_datetimeintegerYesThe meeting’s start time (UTC seconds-since-epoch timestamp).
titlestringYesThe meeting’s title.
user_idintegerYesThe Dialpad user’s id.

dialpad_messaging_schedules_create

Schedule — Create Parameters:
ParameterTypeRequiredDefaultDescription
channel_hashtagstringNo[single-line only] The hashtag of the channel which the message is scheduled for.
from_numberstringNoThe personal phone number to use as the sender (must belong to the user).
is_bulkbooleanNoWhether this is a bulk message (affects rate limiting and delivery). Maximum of 50 recipients.
mediastringNoBase64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).
start_dateintegerNoUnix timestamp for when to send the message (must be 10+ minutes in future).
textstringNoThe message text content.
timezonestringNoTimezone name (e.g., ‘America/Los_Angeles’).
to_numbersstring[]NoList of up to 50 E.164-formatted phone numbers to send messages to.
user_idintegerNoThe ID of the user who should be the sender. If not provided, defaults to the authenticated user.

dialpad_messaging_schedules_delete

Schedule — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe schedule’s ID (key string).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_schedules_get

Schedule — Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe schedule’s ID (key string).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_schedules_list

Schedule — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoPagination cursor from previous response.
limitintegerNoMax results per page (default 20, max 100).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_schedules_send_now

Schedule — Send Now Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe schedule’s ID (key string).
user_idintegerNoOptional user ID. If not provided, uses the authenticated user from API key.

dialpad_messaging_schedules_update

Schedule — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe schedule’s ID (key string).
channel_hashtagstringNo[single-line only] The hashtag of the channel which the message is scheduled for.
from_numberstringNoThe personal phone number to use as the sender (must belong to the user).
mediastringNoBase64-encoded media attachment for MMS (images/videos, max 500 KiB raw file size).
start_dateintegerNoUnix timestamp for when to send the message.
textstringNoThe message text content.
timezonestringNoTimezone name (e.g., ‘America/Los_Angeles’).
to_numbersstring[]NoList of phone numbers to schedule to send messages to.
user_idintegerNoThe ID of the user who should be the sender. If not provided, defaults to the authenticated user.

dialpad_messaging_sms_send

SMS — Send Parameters:
ParameterTypeRequiredDefaultDescription
channel_hashtagstringNo[single-line only] The hashtag of the channel which should receive the SMS.
from_numberstringNoThe 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_codebooleanNoIf true, to_numbers will be assumed to be from the specified user’s country, and the E164 format requirement will be relaxed.
mediastringNoBase64-encoded media attachment (will cause the message to be sent as MMS). (Max 500 KiB raw file size)
sender_group_idintegerNoThe ID of an office, department, or call center that the User should send the message on behalf of.
sender_group_typestringNoThe sender group’s type (i.e. office, department, or callcenter).
textstringNoThe contents of the message that should be sent.
to_numbersstring[]NoUp to 10 E164-formatted phone numbers who should receive the SMS.
user_idintegerNoThe ID of the user who should be the sender of the SMS.