/dialpad-calls | Type: Application | PCID required: Yes
Tools
dialpad_calls_call_actions_hangup
Call Actions — Hang up Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
dialpad_calls_call_ai_recap
Call — Get Ai Recap Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
summary_format | string | No | — | The format of the summary to retrieve e.g. short, medium, long, bullet. |
dialpad_calls_call_assign
Call — Assign Operator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
operator_ids | integer[] | No | — | Operator IDs to assign to or unassign from the Contact Center call. For assign operations, only assigned operators will be eligible to receive the call. |
dialpad_calls_call_assigned
Call — Assigned Operators Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
dialpad_calls_call_call
Call — Initiate via Ring Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_data | string | No | — | Extra data to associate with the call. This will be passed through to any subscribed call events. |
device_id | string | No | — | The device’s id. |
group_id | integer | No | — | The ID of a group that will be used to initiate the call. |
group_type | string | No | — | The type of a group that will be used to initiate the call. |
is_consult | boolean | No | — | Enables the creation of a second call. If there is an ongoing call, it puts it on hold. |
outbound_caller_id | string | No | — | The e164-formatted number shown to the call recipient (or “blocked”). If set to “blocked”, the recipient will receive a call from “unknown caller”. The number can be the caller’s number, or the caller’s group number if the group is provided, or the caller’s company reserved number. |
phone_number | string | Yes | — | The e164-formatted number to call. |
user_id | integer | Yes | — | The id of the user who should make the outbound call. |
dialpad_calls_call_callback
Call Back — Enqueue Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_center_id | integer | No | — | The ID of a call center that will be used to fulfill the callback. |
phone_number | string | No | — | The e164-formatted number to call back |
dialpad_calls_call_get_call_info
Call — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
dialpad_calls_call_initiate_ivr_call
Call — Initiate IVR Call Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
custom_data | string | No | — | Extra data to associate with the call. This will be passed through to any subscribed call events. |
outbound_caller_id | string | No | — | The e164-formatted number shown to the call recipient (or “blocked”). |
phone_number | string | Yes | — | The e164-formatted number to call. |
target_id | integer | Yes | — | The ID of a group that will be used to initiate the call. |
target_type | string | Yes | — | The type of a group that will be used to initiate the call. |
dialpad_calls_call_list
Call — 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. |
include_anonymized | boolean | No | — | If set to true, includes call records that have been anonymized (e.g., calls associated with deleted users). Defaults to false. |
started_after | integer | No | — | Only includes calls that started more recently than the specified timestamp. (UTC ms-since-epoch timestamp) |
started_before | integer | No | — | Only includes calls that started prior to the specified timestamp. (UTC ms-since-epoch timestamp) |
target_id | integer | No | — | The ID of a target to filter against. |
target_type | string | No | — | The target type associated with the target ID. |
dialpad_calls_call_list_callbacks
Call Back — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
cursor | string | No | — | A token used to return the next page of results. |
limit | integer | No | — | Maximum results per page (default: 20, max: 100). |
call_center_id | integer | Yes | — | The call center ID to query. Required. |
dialpad_calls_call_participants_add
Call — Add Participant Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
participant | object | Yes | — | New member of the call to add. Can be a number or a Target. In case of a target, it must have a primary number assigned. |
dialpad_calls_call_put_call_labels
Label — Set Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id |
labels | string[] | No | — | The list of labels to attach to the call |
dialpad_calls_call_review_share_link_create
Call Review Sharelink — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_id | integer | No | — | The call’s id. |
privacy | string | No | — | The privacy state of the recording share link, ‘company’ will be set as default. |
dialpad_calls_call_review_share_link_delete
Call Review Sharelink — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The share link’s id. |
dialpad_calls_call_review_share_link_get
Call Review Sharelink — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The share link’s id. |
dialpad_calls_call_review_share_link_update
Call Review Sharelink — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The share link’s id. |
privacy | string | Yes | — | The privacy state of the recording share link |
dialpad_calls_call_transfer_call
Call — Transfer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
custom_data | string | No | — | Extra data to associate with the call. This will be passed through to any subscribed call events. |
to | object | No | — | Destination of the call that will be transferred. It can be a single option between a number, an existing call or a target |
transfer_state | string | No | — | The state which the call should take when it’s transferred to. |
dialpad_calls_call_unassign
Call — Unassign Operator Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
operator_ids | integer[] | No | — | Operator IDs to assign to or unassign from the Contact Center call. For assign operations, only assigned operators will be eligible to receive the call. |
dialpad_calls_call_unassign_all
Call — Unassign All Operators Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
dialpad_calls_call_unpark
Call — Unpark Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The call’s id. |
user_id | integer | Yes | — | The id of the user who should unpark the call. |
dialpad_calls_call_validate_callback
Call Back — Validate Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_center_id | integer | No | — | The ID of a call center that will be used to fulfill the callback. |
phone_number | string | No | — | The e164-formatted number to call back |
dialpad_calls_calllabel_list
Label — List Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of results to return. |
dialpad_calls_conference_meetings_list
Meeting Summary — 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. |
room_id | string | No | — | The meeting room’s ID. |
dialpad_calls_conference_rooms_list
Meeting Room — 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. |
dialpad_calls_recording_share_link_create
Recording Sharelink — Create Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
privacy | string | No | — | The privacy state of the recording share link. |
recording_id | string | Yes | — | The recording entity’s ID. |
recording_type | string | Yes | — | The type of the recording entity shared via the link. |
dialpad_calls_recording_share_link_delete
Recording Sharelink — Delete Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The recording share link’s ID. |
dialpad_calls_recording_share_link_get
Recording Sharelink — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The recording share link’s ID. |
dialpad_calls_recording_share_link_update
Recording Sharelink — Update Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The recording share link’s ID. |
privacy | string | Yes | — | The privacy state of the recording share link. |
dialpad_calls_transcripts_get
Call Transcript — Get Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_id | integer | Yes | — | The call’s id. |
dialpad_calls_transcripts_get_url
Call Transcript — Get URL Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
call_id | integer | Yes | — | The call’s id. |

