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

Tools

ToolDescription
dialpad_calls_call_actions_hangupCall Actions — Hang up
dialpad_calls_call_ai_recapCall — Get Ai Recap
dialpad_calls_call_assignCall — Assign Operator
dialpad_calls_call_assignedCall — Assigned Operators
dialpad_calls_call_callCall — Initiate via Ring
dialpad_calls_call_callbackCall Back — Enqueue
dialpad_calls_call_get_call_infoCall — Get
dialpad_calls_call_initiate_ivr_callCall — Initiate IVR Call
dialpad_calls_call_listCall — List
dialpad_calls_call_list_callbacksCall Back — List
dialpad_calls_call_participants_addCall — Add Participant
dialpad_calls_call_put_call_labelsLabel — Set
dialpad_calls_call_review_share_link_createCall Review Sharelink — Create
dialpad_calls_call_review_share_link_deleteCall Review Sharelink — Delete
dialpad_calls_call_review_share_link_getCall Review Sharelink — Get
dialpad_calls_call_review_share_link_updateCall Review Sharelink — Update
dialpad_calls_call_transfer_callCall — Transfer
dialpad_calls_call_unassignCall — Unassign Operator
dialpad_calls_call_unassign_allCall — Unassign All Operators
dialpad_calls_call_unparkCall — Unpark
dialpad_calls_call_validate_callbackCall Back — Validate
dialpad_calls_calllabel_listLabel — List
dialpad_calls_conference_meetings_listMeeting Summary — List
dialpad_calls_conference_rooms_listMeeting Room — List
dialpad_calls_recording_share_link_createRecording Sharelink — Create
dialpad_calls_recording_share_link_deleteRecording Sharelink — Delete
dialpad_calls_recording_share_link_getRecording Sharelink — Get
dialpad_calls_recording_share_link_updateRecording Sharelink — Update
dialpad_calls_transcripts_getCall Transcript — Get
dialpad_calls_transcripts_get_urlCall Transcript — Get URL

dialpad_calls_call_actions_hangup

Call Actions — Hang up Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.

dialpad_calls_call_ai_recap

Call — Get Ai Recap Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
summary_formatstringNoThe format of the summary to retrieve e.g. short, medium, long, bullet.

dialpad_calls_call_assign

Call — Assign Operator Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
operator_idsinteger[]NoOperator 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.

dialpad_calls_call_call

Call — Initiate via Ring Parameters:
ParameterTypeRequiredDefaultDescription
custom_datastringNoExtra data to associate with the call. This will be passed through to any subscribed call events.
device_idstringNoThe device’s id.
group_idintegerNoThe ID of a group that will be used to initiate the call.
group_typestringNoThe type of a group that will be used to initiate the call.
is_consultbooleanNoEnables the creation of a second call. If there is an ongoing call, it puts it on hold.
outbound_caller_idstringNoThe 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_numberstringYesThe e164-formatted number to call.
user_idintegerYesThe id of the user who should make the outbound call.

dialpad_calls_call_callback

Call Back — Enqueue Parameters:
ParameterTypeRequiredDefaultDescription
call_center_idintegerNoThe ID of a call center that will be used to fulfill the callback.
phone_numberstringNoThe e164-formatted number to call back

dialpad_calls_call_get_call_info

Call — Get Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.

dialpad_calls_call_initiate_ivr_call

Call — Initiate IVR Call Parameters:
ParameterTypeRequiredDefaultDescription
custom_datastringNoExtra data to associate with the call. This will be passed through to any subscribed call events.
outbound_caller_idstringNoThe e164-formatted number shown to the call recipient (or “blocked”).
phone_numberstringYesThe e164-formatted number to call.
target_idintegerYesThe ID of a group that will be used to initiate the call.
target_typestringYesThe type of a group that will be used to initiate the call.

dialpad_calls_call_list

Call — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
include_anonymizedbooleanNoIf set to true, includes call records that have been anonymized (e.g., calls associated with deleted users). Defaults to false.
started_afterintegerNoOnly includes calls that started more recently than the specified timestamp. (UTC ms-since-epoch timestamp)
started_beforeintegerNoOnly includes calls that started prior to the specified timestamp. (UTC ms-since-epoch timestamp)
target_idintegerNoThe ID of a target to filter against.
target_typestringNoThe target type associated with the target ID.

dialpad_calls_call_list_callbacks

Call Back — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of results.
limitintegerNoMaximum results per page (default: 20, max: 100).
call_center_idintegerYesThe call center ID to query. Required.

dialpad_calls_call_participants_add

Call — Add Participant Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
participantobjectYesNew 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id
labelsstring[]NoThe list of labels to attach to the call

Call Review Sharelink — Create Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerNoThe call’s id.
privacystringNoThe privacy state of the recording share link, ‘company’ will be set as default.

Call Review Sharelink — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe share link’s id.

Call Review Sharelink — Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe share link’s id.

Call Review Sharelink — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe share link’s id.
privacystringYesThe privacy state of the recording share link

dialpad_calls_call_transfer_call

Call — Transfer Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
custom_datastringNoExtra data to associate with the call. This will be passed through to any subscribed call events.
toobjectNoDestination of the call that will be transferred. It can be a single option between a number, an existing call or a target
transfer_statestringNoThe state which the call should take when it’s transferred to.

dialpad_calls_call_unassign

Call — Unassign Operator Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
operator_idsinteger[]NoOperator 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.

dialpad_calls_call_unpark

Call — Unpark Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe call’s id.
user_idintegerYesThe id of the user who should unpark the call.

dialpad_calls_call_validate_callback

Call Back — Validate Parameters:
ParameterTypeRequiredDefaultDescription
call_center_idintegerNoThe ID of a call center that will be used to fulfill the callback.
phone_numberstringNoThe e164-formatted number to call back

dialpad_calls_calllabel_list

Label — List Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of results to return.

dialpad_calls_conference_meetings_list

Meeting Summary — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.
room_idstringNoThe meeting room’s ID.

dialpad_calls_conference_rooms_list

Meeting Room — List Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA token used to return the next page of a previous request. Use the cursor provided in the previous response.

Recording Sharelink — Create Parameters:
ParameterTypeRequiredDefaultDescription
privacystringNoThe privacy state of the recording share link.
recording_idstringYesThe recording entity’s ID.
recording_typestringYesThe type of the recording entity shared via the link.

Recording Sharelink — Delete Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe recording share link’s ID.

Recording Sharelink — Get Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe recording share link’s ID.

Recording Sharelink — Update Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe recording share link’s ID.
privacystringYesThe privacy state of the recording share link.

dialpad_calls_transcripts_get

Call Transcript — Get Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe call’s id.

dialpad_calls_transcripts_get_url

Call Transcript — Get URL Parameters:
ParameterTypeRequiredDefaultDescription
call_idintegerYesThe call’s id.