Skip to main content
Dialpad logo
  • Category: communication
  • Auth: OAUTH2, API_KEY
  • Composio-managed OAuth available? Yes
  • Tools: 192
  • Triggers: 0
  • Slug: DIALPAD
  • Version: 20261101_00

Tools

Slug: DIALPAD_ACCESS_CONTROL_POLICIES_LISTINGLists the authenticated company’s access control policies, including their permission sets. Results can be paginated using a cursor.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_BLOCKED_PHONE_NUMBERSAdds specified phone numbers to the company-wide blocked list, rejecting inbound calls and texts from them for every user. Accepts multiple E.164-formatted numbers.

Input Parameters

array
A list of E164 formatted numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_DEPARTMENT_OPERATOR_BY_IDAdds a new operator to a specific department in Dialpad. This endpoint allows you to assign either a user or a room as an operator, with the option to specify their role. It’s used to manage call handling and department operations by adding new operators or updating existing ones with different roles. The department ID is specified in the URL path. Use this when setting up new departments, expanding existing ones, or adjusting operator assignments and roles within a department.

Input Parameters

string
required
The department”s id.
string ("admin" | "operator")
The role of the new operator. (operator or admin)
integer
required
ID of the operator to add.
string ("room" | "user")
required
Type of the operator to add. (user or room)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_MEMBER_TO_CHANNELAdds a new member to a specified channel within the Dialpad communication platform. This endpoint allows you to expand the membership of a channel by providing the user ID of the person you want to add. It’s particularly useful for programmatically managing channel memberships, such as when onboarding new team members or reorganizing communication structures. The endpoint should be used when you need to include a user in a channel’s conversations and collaborations. Note that this operation only adds the user to the channel; it does not create new users or channels. Ensure that both the channel ID (specified in the URL) and the user ID (provided in the request body) exist in your Dialpad organization before making this call.

Input Parameters

string
required
The channel”s id.
integer
required
The user id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_MEMBER_TO_COACHING_TEAMAdds a new member to a specific coaching team in Dialpad. This endpoint allows you to assign a user to a coaching team with a designated role, enabling effective team management and performance monitoring. Use this when you need to include a new coach or trainee in an existing coaching team. The endpoint requires the coaching team ID in the URL path and the member details in the request body. It’s particularly useful for setting up or expanding coaching teams for call center training and quality assurance purposes.

Input Parameters

string
required
Id of the coaching team
string ("coach" | "trainee")
required
The role of the user added.
string
required
The id of the user added to the coaching team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_OPERATOR_TO_CALL_CENTERThis endpoint adds a new operator to a specified call center in the Dialpad system. It allows for the configuration of the operator’s role, skill level, and license type, as well as managing phone number retention when switching to a support license. Use this endpoint when you need to expand your call center team or adjust an existing user’s role within the call center. The endpoint is particularly useful for setting up new operators with specific skill levels and roles, which can help in optimizing call routing and management within the call center. Note that while adding an operator, careful consideration should be given to the license type and role assigned, as these affect the operator’s capabilities and the associated costs.

Input Parameters

string
required
The call center”s id.
string ("admin" | "operator" | "supervisor")
The role the user should assume.
integer
required
The ID of the user.
integer
Skill level of the operator. Integer value in range 1 - 100. Default 100.
string ("agents" | "lite_support_agents")
The type of license to assign to the new operator if a license is required. (agents or lite_support_agents). Defaults to agents
boolean
Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_OPERATOR_TO_OFFICEAdds a user or room as an operator to an office’s mainline, with an optional operator or admin role.

Input Parameters

string
required
The office”s ID.
string ("admin" | "operator")
The role of the new operator. (operator or admin)
integer
required
ID of the operator to add.
string ("room" | "user")
required
Type of the operator to add. (user or room)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ADD_PARTICIPANT_TO_CALLAdds a new participant to an existing call in the Dialpad system. This endpoint allows you to include additional members in an ongoing call by specifying either a phone number or a target within your Dialpad organization. Use this when you need to add someone to a call that is already in progress, such as bringing in an expert or including a manager in a customer service call. The endpoint requires the ID of the existing call and the details of the new participant. It’s important to note that the target, if used, must have a primary number assigned in the Dialpad system.

Input Parameters

string
required
The call”s id.
object
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_FAX_LINE_TO_TARGETCreates and assigns a new fax line to a specified target (user or department) in the Dialpad system. This endpoint allows you to set up a fax line with various options, including reserved numbers, area code-based searches, or toll-free numbers. Use this when you need to provision a new fax line for a user or department, or when you want to assign an existing number as a fax line. The endpoint is flexible, allowing for different types of fax line assignments based on your specific needs and available numbers. Note that the assignment process is immediate, and the fax line will be ready for use once the API call is successful. However, this endpoint does not handle the actual sending or receiving of faxes; it only sets up the line for future use.

Input Parameters

object
required
Line to assign.
integer
The ID of the target to assign the fax line to.
string ("department" | "user")
Type of the target to assign the fax line to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_NUMBER_TO_CALL_ROUTERThis endpoint assigns a phone number to a specific call router in the Dialpad system. It allows users to either provide a full phone number for assignment or specify an area code to automatically select an available number within that region. The assigned number can optionally be set as the primary number for the call router. This functionality is crucial for setting up and managing call routing within an organization, enabling efficient distribution of incoming calls to the appropriate departments or individuals.

Input Parameters

string
required
The API call router”s ID
string
A phone number to assign. (e164-formatted)
boolean
A boolean indicating whether this should become the primary phone number.
string
An area code in which to find an available phone number for assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_PHONE_NUMBER_TO_OFFICEThis endpoint assigns a phone number to a specific office in the Dialpad system. It allows you to either specify a particular phone number or request an available number from a given area code. The assigned number can optionally be set as the primary number for the office. Use this endpoint when you need to add a new phone number to an office or change the office’s primary number. It’s particularly useful for setting up new offices or modifying existing office phone configurations. Note that this endpoint does not handle number porting or releasing existing numbers; it’s specifically for assigning available numbers within the Dialpad system.

Input Parameters

string
required
The office”s id.
string
A phone number to assign. (e164-formatted)
boolean
A boolean indicating whether this should become the primary phone number.
string
An area code in which to find an available phone number for assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_PHONE_NUMBER_TO_ROOMAssigns a phone number to a specified room in Dialpad. This endpoint allows you to either assign a specific phone number or request a number from a given area code. It’s useful for setting up new rooms or updating existing ones with additional or primary phone numbers. The assigned number can optionally be set as the primary number for the room. Use this endpoint when you need to manage phone number assignments for Dialpad rooms programmatically.

Input Parameters

string
required
The room”s id.
string
A phone number to assign. (e164-formatted)
boolean
A boolean indicating whether this should become the primary phone number.
string
An area code in which to find an available phone number for assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_PHONE_NUMBER_TO_TARGETAssigns a specific phone number to a Dialpad target, such as a user or department. The number can be set as the target’s primary number.

Input Parameters

string
A phone number to assign. (e164-formatted)
boolean
A boolean indicating whether this should become the target”s primary phone number.
string
An area code in which to find an available phone number for assignment.
integer
required
The ID of the target to reassign this number to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
The type of the target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_PHONE_NUMBER_TO_USERThis endpoint assigns a phone number to a specific Dialpad user. It allows for either searching for an available number within a given area code or assigning a specific number to the user. The assigned number can optionally be set as the user’s primary number. Use this endpoint when you need to provide a user with a new phone number or add an additional number to their account. It’s particularly useful for setting up new users or expanding the communication capabilities of existing users. Note that this endpoint doesn’t handle number porting or transferring existing numbers between users.

Input Parameters

integer
required
The user”s id. (“me” can be used if you are using a user level API key)
string
A phone number to assign. (e164-formatted)
boolean
A boolean indicating whether this should become the primary phone number.
string
An area code in which to find an available phone number for assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ASSIGN_POLICY_TO_USER_BY_IDAssigns an access control policy to a user at company, office, or contact center level. Requires a company admin API key.

Input Parameters

string
required
The access control policy”s id.
integer
required
The user”s id to be assigned to the policy.
integer
Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy.
string ("callcenter" | "company" | "office")
Policy permissions applied at this target level. Defaults to company target type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_ATTACH_LABELS_TO_CALLAdds labels to a specified call, preserving existing labels. Labels already present are not duplicated.

Input Parameters

string
required
The call”s id
array
The list of labels to attach to the call

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CONFIGURE_CALL_CENTER_SETTINGSCreates a new call center in a specified office, with options for call handling, routing, hours, recording, queues, alerts and voice intelligence. Requires a company admin API key.

Input Parameters

string
required
[single-line only] The name of the call center. Max 100 characters.
boolean
The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7).
integer
required
The id of the office to which the call center belongs..
array
The Friday hours of operation. Default value is [“08:00”, “18:00”].
array
The Monday hours of operation. To specify when hours_on is set to True. e.g. [“08:00”, “12:00”, “14:00”, “18:00”] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [“08:00”, “18:00”].
integer
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds.
array
The Sunday hours of operation. Default is empty array.
array
The Tuesday hours of operation. Default value is [“08:00”, “18:00”].
array
The Saturday hours of operation. Default is empty array.
array
The Thursday hours of operation. Default value is [“08:00”, “18:00”].
array
The Wednesday hours of operation. Default value is [“08:00”, “18:00”].
string
The description of the call center. Max 256 characters.
integer
Alert supervisors when the service level drops below how many percent. Default is 95%.
array
DTMF menu options.
integer
If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-1000. Default is 50.
boolean
Whether or not to allow callers to be placed in your hold queue when no agents are available. Default is False.
array
DTMF menu options.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Whether or not to let callers know their place in the queue. This option is not available when a maximum queue wait time of less than 2 minutes is selected. Default is True.
integer
Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min).
string
Allow callers to exit the hold queue to voicemail by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is *.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Auto start Vi for this call center. Default is True.
boolean
Allow individual users to start and stop Vi during calls. Default is True.
string
Allow callers to request a callback when the queue has more than queue_callback_threshold number of calls by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is 9.
integer
Inbound calls should be answered within how many seconds. Default is 60.
boolean
Whether or not to allow callers to request a callback. Default is False.
integer
Allow callers to request a callback when the queue has more than this number of calls. Default is 5.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
Include a post-call wrap-up time before agents can receive their next call. Default is 0.
integer
The ID of the Target that inbound calls should be routed to.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
Hold announcement interval wait time. Default is 2 min.
boolean
Whether or not to allow existing calls to stay in queue after the call center has closed. Default is False.
integer
The ID of the Target that inbound calls should be routed to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
boolean
Whether or not inbound calls to this call center get automatically recorded. Default is False.
boolean
Whether or not outbound calls from this call center get automatically recorded. Default is False.
boolean
Allow agents to stop/restart a recording during a call. Default is False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_ACCESS_CONTROL_POLICYCreates a new access control policy in Dialpad, defining a set of permissions and their application scope. This endpoint allows administrators to establish granular control over various Dialpad features and settings. It’s used to manage user access and configure operational parameters across different levels of the organization. The policy created can encompass a wide range of permissions, from agent settings to AI configurations, enabling customized access control tailored to specific organizational needs. This tool is essential for setting up and maintaining a secure, well-organized communication environment within Dialpad.

Input Parameters

string
required
[single-line only] A human-readable display name for the policy. Max 50 characters.
integer
required
Owner for this policy i.e company admin.
string
[single-line only] Optional description for the policy. Max 200 characters.
string ("callcenter" | "company" | "office")
Policy permissions applied at this target level. Defaults to company target type.
array
required
List of permission associated with this policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_AGENT_STATUS_SUBSCRIPTIONCreates or updates an agent status subscription for real-time monitoring of contact center agent statuses in Dialpad. This endpoint allows you to configure event notifications for changes in agent availability, such as when agents become available, busy, or go off-duty. Use this when setting up integrations that require up-to-date information on agent statuses for workforce management, real-time dashboards, or automated workflows. The subscription can be associated with a specific webhook or websocket endpoint for receiving the status updates. Note that this endpoint only configures the subscription; you need to separately set up the webhook or websocket to receive the actual event data.

Input Parameters

boolean
Whether or not the this agent status event subscription is enabled.
string ("callcenter")
required
The agent type this event subscription subscribes to.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_CALLBACKCreates a callback request in a Dialpad call center. This endpoint allows you to initiate a callback to a specified phone number through a designated call center. It’s useful for implementing features like “Request a Call” on websites or applications, or for scheduling return calls to customers. The endpoint doesn’t immediately place the call but queues it in the specified call center for an agent to handle. Note that while both parameters are optional, at least one should be provided for a meaningful request. If no call_center_id is specified, the system may use a default or return an error, depending on your account configuration.

Input Parameters

string
The e164-formatted number to call back
integer
The ID of a call center that will be used to fulfill the callback.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_CALL_ROUTER_CONFIGURATIONCreates a new call router in the Dialpad system, allowing for custom call routing logic based on a specified URL. This endpoint configures essential settings for the call router, including its name, default target for fallback scenarios, and the routing URL for decision-making. It’s used when setting up a new automated call distribution system or when implementing custom call routing logic for an office. The call router can be enabled or disabled, and includes an optional security feature through a signature secret. Note that this endpoint only creates the call router; additional setup may be required in the Dialpad interface or through other API calls to fully integrate it into the calling workflow.

Input Parameters

string
required
[single-line only] A human-readable display name for the router.
string
[single-line only] The call router”s signature secret. This is a plain text string that you should generate with a minimum length of 32 characters.
boolean
If set to False, the call router will skip the routing url and instead forward calls straight to the default target.
integer
required
The ID of the office to which this router belongs.
string
required
The URL that should be used to drive call routing decisions.
integer
required
The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
The entity type of the default target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_CHANNEL_ENDPOINTCreates a new communication channel within the Dialpad platform. This endpoint allows users to set up a dedicated space for team collaboration, discussions, or topic-specific conversations. It’s particularly useful for organizing communication within a company or project. The created channel can be either public or private, providing flexibility in managing access and information sharing. Use this endpoint when you need to programmatically create channels for various teams, projects, or departments, streamlining the process of setting up communication structures within Dialpad.

Input Parameters

string
required
[single-line only] The name of the channel.
integer
The ID of the user who owns the channel. Just for company level API key.
string
required
The description of the channel.
string ("private" | "public")
required
The privacy type of the channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_CUSTOM_IVR_WITH_AUDIO_FILECreates a custom IVR recording for a specified Dialpad target and IVR type using a Base64-encoded MP3. Targets include call centers, departments, offices, coaching teams, and users.

Input Parameters

string
required
An MP3 audio file. The file needs to be Base64-encoded.
string
[single-line only] The name of the new IVR. Max 100 characters.
string ("ASK_FIRST_OPERATOR_NOT_AVAILABLE" | "AUTO_RECORDING" | "CALLAI_AUTO_RECORDING" | "CG_AUTO_RECORDING" | "CLOSED" | "CLOSED_DEPARTMENT_INTRO" | "CLOSED_MENU" | "CLOSED_MENU_OPTION" | "CSAT_INTRO" | "CSAT_OUTRO" | "CSAT_PREAMBLE" | "CSAT_QUESTION" | "DEPARTMENT_INTRO" | "GREETING" | "HOLD_AGENT_READY" | "HOLD_APPREC" | "HOLD_CALLBACK_ACCEPT" | "HOLD_CALLBACK_ACCEPTED" | "HOLD_CALLBACK_CONFIRM" | "HOLD_CALLBACK_CONFIRM_NUMBER" | "HOLD_CALLBACK_DIFFERENT_NUMBER" | "HOLD_CALLBACK_DIRECT" | "HOLD_CALLBACK_FULFILLED" | "HOLD_CALLBACK_INVALID_NUMBER" | "HOLD_CALLBACK_KEYPAD" | "HOLD_CALLBACK_REJECT" | "HOLD_CALLBACK_REJECTED" | "HOLD_CALLBACK_REQUEST" | "HOLD_CALLBACK_REQUESTED" | "HOLD_CALLBACK_SAME_NUMBER" | "HOLD_CALLBACK_TRY_AGAIN" | "HOLD_CALLBACK_UNDIALABLE" | "HOLD_ESCAPE_VM_EIGHT" | "HOLD_ESCAPE_VM_FIVE" | "HOLD_ESCAPE_VM_FOUR" | "HOLD_ESCAPE_VM_NINE" | "HOLD_ESCAPE_VM_ONE" | "HOLD_ESCAPE_VM_POUND" | "HOLD_ESCAPE_VM_SEVEN" | "HOLD_ESCAPE_VM_SIX" | "HOLD_ESCAPE_VM_STAR" | "HOLD_ESCAPE_VM_TEN" | "HOLD_ESCAPE_VM_THREE" | "HOLD_ESCAPE_VM_TWO" | "HOLD_ESCAPE_VM_ZERO" | "HOLD_INTERRUPT" | "HOLD_INTRO" | "HOLD_MUSIC" | "HOLD_POSITION_EIGHT" | "HOLD_POSITION_FIVE" | "HOLD_POSITION_FOUR" | "HOLD_POSITION_MORE" | "HOLD_POSITION_NINE" | "HOLD_POSITION_ONE" | "HOLD_POSITION_SEVEN" | "HOLD_POSITION_SIX" | "HOLD_POSITION_TEN" | "HOLD_POSITION_THREE" | "HOLD_POSITION_TWO" | "HOLD_POSITION_ZERO" | "HOLD_WAIT" | "MENU" | "MENU_OPTION" | "NEXT_TARGET" | "VM_DROP_MESSAGE" | "VM_UNAVAILABLE" | "VM_UNAVAILABLE_CLOSED")
required
Type of IVR.
integer
required
The ID of the target to which you want to assign this IVR.
string
[single-line only] The description of the new IVR. Max 256 characters.
string ("callcenter" | "coachingteam" | "department" | "office" | "user")
required
The type of the target to which you want to assign this IVR.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_NEW_CONTACT_ENTRYThe CreateContact endpoint adds a new contact to Dialpad’s system. Use it to create local or shared contacts with comprehensive information. Ideal for user onboarding, data migration, or system integrations. Supports various contact details, with some fields restricted to single-line entries for consistency.

Input Parameters

array
A list of websites associated with or belonging to this contact.
array
The contact”s emails. The first email in the list is the contact”s primary email.
array
The contact”s phone numbers. The phone number must be in e164 format. The first number in the list is the contact”s primary phone.
string
The id of the user who will own this contact. If provided, a local contact will be created for this user. Otherwise, the contact will be created as a shared contact in your company.
string
The contact”s extension number.
string
[single-line only] The contact”s job title.
string
required
[single-line only] The contact”s last name.
string
required
[single-line only] The contact”s first name.
string
[Deprecated]
string
[single-line only] The contact”s company name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_NEW_DEPARTMENT_RECORDCreates a department in a specified office with optional call handling, operating hours, routing, and voice intelligence settings. Requires a company admin API key.

Input Parameters

string
required
[single-line only] The name of the department. Max 100 characters.
boolean
The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7).
integer
required
The id of the office to which the department belongs..
array
The Friday hours of operation. Default value is [“08:00”, “18:00”].
array
The Monday hours of operation. To specify when hours_on is set to True. e.g. [“08:00”, “12:00”, “14:00”, “18:00”] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [“08:00”, “18:00”].
integer
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds.
array
The Sunday hours of operation. Default is empty array.
array
The Tuesday hours of operation. Default value is [“08:00”, “18:00”].
array
The Saturday hours of operation. Default is empty array.
array
The Thursday hours of operation. Default value is [“08:00”, “18:00”].
array
The Wednesday hours of operation. Default value is [“08:00”, “18:00”].
string
The description of the department. Max 256 characters.
boolean
Whether or not automatically record all calls of this department. Default is False.
boolean
Whether or not send callers to a hold queue, if all operators are busy on other calls. Default is False.
array
DTMF menu options.
integer
If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-50. Default is 50.
array
DTMF menu options.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
integer
Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min).
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Auto start Vi for this call center. Default is True.
boolean
Allow individual users to start and stop Vi during calls. Default is True.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_PIN_FOR_INTERNATIONAL_ROOM_CALLSCreates a PIN for protected international calls from Dialpad room phones, optionally associating a customer reference for usage reporting.

Input Parameters

string
[single-line only] An identifier to be printed in the usage summary. Typically used for identifying the person who requested the PIN.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_ROOM_IN_OFFICE_VIA_POSTCreates a new room within a specified office in the Dialpad system. This endpoint is used to set up physical or virtual spaces for collaboration, meetings, or other communication purposes. It allows you to define a room with a name and associate it with a specific office. This is particularly useful for organizations managing multiple locations or wanting to organize their communication spaces efficiently. The created room can then be used for various purposes such as scheduling meetings, assigning resources, or managing call routing within the Dialpad platform.

Input Parameters

string
required
[single-line only] The name of the room.
integer
required
The office in which this room resides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_SCHEDULE_REPORTS_ENDPOINTCreates a scheduled report in the Dialpad system for various types of communication data. This endpoint allows users to automate the generation and delivery of reports on a regular basis, such as call logs, user statistics, or voicemails. It’s particularly useful for managers, administrators, and analysts who need consistent, periodic insights into communication patterns and performance metrics. The endpoint offers flexible scheduling options, including daily, weekly, or monthly frequencies, and can target specific organizational units or user groups. Use this when you need to set up recurring reports for monitoring, compliance, or analytical purposes. Note that this endpoint creates a new schedule; to modify existing schedules, use the appropriate update endpoint.

Input Parameters

integer
required
Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am.
string
required
[single-line only] The name of the schedule reports.
integer
required
The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30.
boolean
Whether or not this schedule reports event subscription is enabled.
string
Timezone using a tz database name.
string ("daily" | "monthly" | "weekly")
required
How often the report will execute.
integer
The target”s id.
integer
required
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.
string ("call_logs" | "daily_statistics" | "recordings" | "user_statistics" | "voicemails")
required
The type of report that will be generated.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
Target”s type.
boolean
Whether the the statistics should be for trainees of the coach group with the given target_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_SECONDARY_OFFICECreates a secondary Dialpad office with billing information and optional operational, routing, and communication settings. The office is a billed entity and counts against the company’s office limit.

Input Parameters

string
required
[single-line only] The office name.
string ("AR" | "AT" | "AU" | "BD" | "BE" | "BG" | "BH" | "BR" | "CA" | "CH" | "CI" | "CL" | "CN" | "CO" | "CR" | "CY" | "CZ" | "DE" | "DK" | "DO" | "DP" | "EC" | "EE" | "EG" | "ES" | "FI" | "FR" | "GB" | "GH" | "GR" | "GT" | "HK" | "HR" | "HU" | "ID" | "IE" | "IL" | "IN" | "IS" | "IT" | "JP" | "KE" | "KH" | "KR" | "KZ" | "LK" | "LT" | "LU" | "LV" | "MA" | "MD" | "MM" | "MT" | "MX" | "MY" | "NG" | "NL" | "NO" | "NZ" | "PA" | "PE" | "PH" | "PK" | "PL" | "PR" | "PT" | "PY" | "RO" | "RU" | "SA" | "SE" | "SG" | "SI" | "SK" | "SV" | "TH" | "TR" | "TW" | "UA" | "US" | "UY" | "VE" | "VN" | "ZA")
required
The office country.
string ("AUD" | "CAD" | "EUR" | "GBP" | "JPY" | "NZD" | "USD")
required
The office”s billing currency.
boolean
The time frame when the office wants to receive calls. Default value is false, which means the office will always take calls (24/7).
boolean
required
A flag indicating if the payment will be paid by invoice.
string
Timezone using a tz database name.
string ("monthly" | "yearly")
required
The frequency at which the company will be billed.
string ("menu" | "operators")
The desired action when the office receives a call.
array
The Friday hours of operation. Default value is [“08:00”, “18:00”].
array
The Monday hours of operation. To specify when hours_on is set to True. e.g. [“08:00”, “12:00”, “14:00”, “18:00”] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [“08:00”, “18:00”].
integer
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds.
array
The Sunday hours of operation. Default is empty array.
array
The Tuesday hours of operation. Default value is [“08:00”, “18:00”].
array
The Saturday hours of operation. Default is empty array.
array
The Thursday hours of operation. Default value is [“08:00”, “18:00”].
string
The mainline of the office.
boolean
required
A flag indicating if to send a unified invoice.
array
The Wednesday hours of operation. Default value is [“08:00”, “18:00”].
boolean
A flag indicating if the billing address and the emergency address are the same.
string
The description of the office. Max 256 characters.
string
[single-line only] Zip code of the E911 address.
boolean
Whether or not automatically record all calls of this office. Default is False.
string
[single-line only] City of the E911 address.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action to take if there is no one available to answer calls.
string
[single-line only] State or Province of the E911 address.
boolean
A flag indicating if the primary office is able to make international phone calls.
string
[single-line only] The billing address city.
string
[single-line only] The contact name.
string
[single-line only] Line 1 of the E911 address.
string
Country of the E911 address.
string
The contact email.
string
The contact phone number.
string
[single-line only] Line 2 of the E911 address.
string
[single-line only] The billing address region.
string
The billing address country.
array
DTMF menu options.
boolean
required
A flag indicating if the primary office”s plan is categorized as annual commit monthly billing.
string
[single-line only] The billing address postal code.
array
DTMF menu options.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Auto start Vi for this call center. Default is True.
boolean
Allow individual users to start and stop Vi during calls. Default is True.
string
[single-line only] The first line of the billing address.
string
[single-line only] The second line of the billing address.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_SMS_EVENT_SUBSCRIPTIONCreates a new SMS event subscription in the Dialpad API, allowing users to receive notifications for inbound and/or outbound SMS messages. This endpoint enables fine-grained control over SMS event monitoring, including options for filtering by direction, target, and message type. It’s particularly useful for integrating real-time SMS notifications into external systems or applications. The subscription can be configured to include or exclude internal company messages and to provide updates on message delivery statuses. Use this endpoint when setting up new SMS monitoring systems or when adjusting existing subscription parameters.

Input Parameters

boolean
Whether or not to update on each SMS delivery status.
boolean
Whether or not the SMS event subscription is enabled.
string ("all" | "inbound" | "outbound")
required
The SMS direction this event subscription subscribes to.
integer
The ID of the specific target for which events should be sent.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target”s type.
boolean
Whether or not to trigger SMS events for SMS sent between two users from the same company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_USER_WITH_AUTO_ASSIGNCreates a new user account in the Dialpad system with the specified details. This endpoint allows you to add a new user to your Dialpad organization, set up their basic profile information, assign them to an office, and optionally auto-assign a phone number. It’s particularly useful for bulk user creation or when integrating Dialpad user management with other systems. The endpoint requires at minimum an email and office ID, with options to further customize the user’s profile and permissions through additional parameters. Note that while a license can be specified, it defaults to ‘talk’ if not provided, ensuring that the new user has basic Dialpad functionality.

Input Parameters

string
required
The user”s email.
string ("admins" | "agents" | "dpde_all" | "dpde_one" | "lite_lines" | "talk" | "user")
The user”s license type. This affects billing for the user.
string
[single-line only] The user”s last name.
integer
required
The user”s office id.
string
[single-line only] The user”s first name.
boolean
If set to true, a number will be automatically assigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_CREATE_WEBHOOK_POST_ENDPOINTCreates a Dialpad webhook endpoint with a URL and optional signing secret. The resulting webhook ID is used when creating event subscriptions.

Input Parameters

string
[single-line only] Webhook”s signature secret that”s used to confirm the validity of the request.
string
required
The webhook”s URL. Triggered events will be sent to the url provided here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DEAUTHORIZE_OAUTH2_SESSIONDeauthorizes (revokes) an OAuth2 access token, effectively terminating the application’s access to the Dialpad API. This endpoint should be used when an application needs to invalidate its current access token, such as during user logout, when suspending an integration, or in response to potential security threats. It’s an essential security measure to prevent unauthorized access once a token is no longer needed or potentially compromised. Note that after deauthorization, the application will need to re-authenticate to obtain a new access token for future API calls. This endpoint does not return any specific data; a successful call simply invalidates the token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_ACCESS_CONTROL_POLICY_BY_IDDeletes an access control policy by ID, marking it deleted and removing its associated users. Requires a company admin API key.

Input Parameters

string
required
The access control policy”s id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_AGENT_STATUS_BY_IDDeletes a specific agent status subscription identified by its unique ID. This endpoint is used to stop receiving real-time updates about an agent’s status (e.g., Available, Busy, Off-duty) in the Dialpad system. It should be used when you no longer need to track the status changes for a particular agent or when cleaning up unused subscriptions. The operation is irreversible, so care should be taken to ensure the correct subscription ID is provided. This endpoint does not return the deleted subscription details; it typically returns a success status code upon successful deletion.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CALL_CENTER_BY_IDDeletes a specified Dialpad call center by ID. Requires a company admin API key.

Input Parameters

string
required
The call center”s id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CALL_ROUTER_BY_IDDeletes a specific call router from the Dialpad system. This endpoint should be used when you need to remove an existing call routing configuration, such as when restructuring your call flow or decommissioning outdated routing rules. The deletion is permanent and cannot be undone, so use with caution. This operation will immediately affect incoming calls that were previously handled by the deleted router, potentially disrupting call flows if not properly managed. Ensure that any dependencies on the call router (e.g., DIDs or mainline menu routings) are updated before deletion to maintain smooth call handling.

Input Parameters

string
required
The API call router”s ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CALL_SUBSCRIPTION_BY_IDDeletes a specific call subscription from the Dialpad system. This endpoint should be used when an application no longer needs to receive real-time notifications for a particular call-related event or functionality. It allows developers to clean up unused subscriptions, potentially freeing up resources and reducing unnecessary data processing. The deletion is permanent and cannot be undone, so use this endpoint with caution. It’s important to note that this operation only affects the specified subscription and does not impact any other active subscriptions or ongoing calls.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CHANNEL_BY_IDDeletes a specific channel from the Dialpad communication platform. This endpoint should be used when you need to remove a communication channel that is no longer needed or has become obsolete. It permanently removes the channel and all associated data, so it should be used with caution. This operation cannot be undone, and once a channel is deleted, it cannot be recovered. The endpoint is useful for maintaining a clean and organized communication structure within your Dialpad account.

Input Parameters

string
required
The channel id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CHANNEL_MEMBER_BY_IDRemoves a specified member from a Dialpad channel. This endpoint allows you to delete a user from a particular channel, effectively revoking their access and participation in that channel’s communications. It should be used when you need to remove a team member from a specific collaboration space, such as when an employee changes roles or leaves the organization. The endpoint requires the channel ID (specified in the URL path) and the user ID of the member to be removed. Note that this action is irreversible, and the removed member will lose access to the channel’s history and future communications. It’s important to ensure you have the necessary permissions to remove members before using this endpoint.

Input Parameters

string
required
The channel”s id. Example: “5693862015041536”
integer
required
The user id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CONTACT_BY_IDDeletes a specific contact from the Dialpad system using the provided contact ID. This endpoint should be used when you need to permanently remove a contact’s information from your Dialpad account. It’s important to note that this action is irreversible, and once a contact is deleted, it cannot be recovered through the API. Use this endpoint with caution, ensuring that you have verified the correct contact ID before deletion. This operation affects both shared company contacts and user-specific local contacts, depending on the scope of the provided ID.

Input Parameters

string
required
The contact”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_CUSTOM_IVR_BY_TARGET_TYPE_AND_IVRTYPEUnassigns and deletes a custom IVR recording for a specified target and IVR type. For call center auto call recording, the change can be limited to inbound or outbound calls; the target falls back to its default behavior.

Input Parameters

integer
required
The id of the ivr that you want to use for the ivr type. Example: “5693862015041536”
string ("ASK_FIRST_OPERATOR_NOT_AVAILABLE" | "AUTO_RECORDING" | "CALLAI_AUTO_RECORDING" | "CG_AUTO_RECORDING" | "CLOSED" | "CLOSED_DEPARTMENT_INTRO" | "CLOSED_MENU" | "CLOSED_MENU_OPTION" | "CSAT_INTRO" | "CSAT_OUTRO" | "CSAT_PREAMBLE" | "CSAT_QUESTION" | "DEPARTMENT_INTRO" | "GREETING" | "HOLD_AGENT_READY" | "HOLD_APPREC" | "HOLD_CALLBACK_ACCEPT" | "HOLD_CALLBACK_ACCEPTED" | "HOLD_CALLBACK_CONFIRM" | "HOLD_CALLBACK_CONFIRM_NUMBER" | "HOLD_CALLBACK_DIFFERENT_NUMBER" | "HOLD_CALLBACK_DIRECT" | "HOLD_CALLBACK_FULFILLED" | "HOLD_CALLBACK_INVALID_NUMBER" | "HOLD_CALLBACK_KEYPAD" | "HOLD_CALLBACK_REJECT" | "HOLD_CALLBACK_REJECTED" | "HOLD_CALLBACK_REQUEST" | "HOLD_CALLBACK_REQUESTED" | "HOLD_CALLBACK_SAME_NUMBER" | "HOLD_CALLBACK_TRY_AGAIN" | "HOLD_CALLBACK_UNDIALABLE" | "HOLD_ESCAPE_VM_EIGHT" | "HOLD_ESCAPE_VM_FIVE" | "HOLD_ESCAPE_VM_FOUR" | "HOLD_ESCAPE_VM_NINE" | "HOLD_ESCAPE_VM_ONE" | "HOLD_ESCAPE_VM_POUND" | "HOLD_ESCAPE_VM_SEVEN" | "HOLD_ESCAPE_VM_SIX" | "HOLD_ESCAPE_VM_STAR" | "HOLD_ESCAPE_VM_TEN" | "HOLD_ESCAPE_VM_THREE" | "HOLD_ESCAPE_VM_TWO" | "HOLD_ESCAPE_VM_ZERO" | "HOLD_INTERRUPT" | "HOLD_INTRO" | "HOLD_MUSIC" | "HOLD_POSITION_EIGHT" | "HOLD_POSITION_FIVE" | "HOLD_POSITION_FOUR" | "HOLD_POSITION_MORE" | "HOLD_POSITION_NINE" | "HOLD_POSITION_ONE" | "HOLD_POSITION_SEVEN" | "HOLD_POSITION_SIX" | "HOLD_POSITION_TEN" | "HOLD_POSITION_THREE" | "HOLD_POSITION_TWO" | "HOLD_POSITION_ZERO" | "HOLD_WAIT" | "MENU" | "MENU_OPTION" | "NEXT_TARGET" | "VM_DROP_MESSAGE" | "VM_UNAVAILABLE" | "VM_UNAVAILABLE_CLOSED")
required
Type of ivr you want to update.
string
required
The id of the target. Example: “5693862015041536”
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
Target”s type. of the custom ivr to be updated.
string ("inbound" | "outbound")
For call center auto call recording only. Set ivr for inbound or outbound. Default is both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_DEPARTMENT_RESOURCEPermanently deletes a Dialpad department by ID, removing the department and all its configuration. Requires a company admin API key.

Input Parameters

integer
required
The department”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_DESKPHONE_BY_USER_IDDeletes a specific deskphone associated with a user in the Dialpad system. This endpoint should be used when you need to remove a deskphone from a user’s account, such as when the device is no longer in use or needs to be reassigned. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for managing hardware inventory and ensuring that user accounts accurately reflect their current device assignments.

Input Parameters

string
required
The desk phone”s id.
string
required
The user”s id. (“me” can be used if you are using a user level API key). Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_DESKPHONE_IN_ROOMDeletes a specific Dialpad room desk phone by room ID and desk phone ID.

Input Parameters

string
required
The desk phone”s id.
string
required
The room”s id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_NUMBER_VIA_APIDeletes a specific phone number from the user’s Dialpad account. This endpoint should be used when a phone number is no longer needed and needs to be removed from the system. It’s important to note that this action is irreversible, and once a number is deleted, it may not be possible to reclaim the same number. This endpoint is particularly useful for managing phone inventory, removing temporary numbers, or cleaning up unused numbers to optimize resource allocation. The deletion process may have implications on call routing, billing, and other phone-related features within Dialpad, so it should be used with caution and only when the user is certain that the number is no longer required.

Input Parameters

string
required
A phone number (e164 format).
boolean
Releases the number (does not return it to the company reserved pool).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_OFFICE_OPERATOR_BY_IDRemoves a specified user or room operator from an office’s mainline using the operator ID and type.

Input Parameters

string
required
The office”s ID. Example: “5693862015041536”
integer
required
ID of the operator to remove. Example: “5693862015041536”
string ("room" | "user")
required
Type of the operator to remove (user or room).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_OPERATOR_FROM_CALL_CENTERRemoves a specified operator from a call center in the Dialpad system. This endpoint should be used when you need to disassociate an agent or user from a particular call center, such as when an employee changes roles or leaves the organization. The operation is permanent and cannot be undone through this API. If you need to re-add the operator to the call center, you would need to use a separate API call. Note that this endpoint only removes the operator’s association with the call center; it does not delete the user account from Dialpad.

Input Parameters

string
required
The call center”s id. Example: “5693862015041536”
integer
required
ID of the operator to remove. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_OPERATOR_FROM_DEPARTMENTRemoves a specified operator from a department in the Dialpad system. This endpoint is used to update department operator assignments by removing either a user or a room from the list of operators for a given department. It’s particularly useful for managing call routing and department resources. The endpoint requires both the operator’s unique ID and type (user or room) to ensure accurate removal. Use this when reorganizing department structures, changing operator assignments, or updating call handling workflows. Note that this action is irreversible and may affect ongoing call routing for the department.

Input Parameters

string
required
The department”s id. Example: “5693862015041536”
integer
required
ID of the operator to remove. Example: “5693862015041536”
string ("room" | "user")
required
Type of the operator to remove (user or room).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_ROOM_BY_IDDeletes a specific room from the Dialpad system using its unique identifier. This endpoint should be used when you need to remove a room that is no longer in use or has been decommissioned, such as a closed conference room or a removed reception desk. The deletion is permanent and cannot be undone, so use this endpoint with caution. It’s important to note that deleting a room will also remove any associated configurations, such as room phone settings or extensions. This operation is part of Dialpad’s room management functionality and helps maintain an up-to-date inventory of active rooms in your organization.

Input Parameters

string
required
The room”s id. Example: “5693862015041536”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_SCHEDULE_REPORT_BY_IDDeletes a scheduled report subscription by ID, stopping its recurring report schedule.

Input Parameters

string
required
The schedule reports subscription”s ID. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_SMS_SUBSCRIPTION_BY_IDDeletes an SMS event subscription by its subscription ID.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_SUBSCRIPTION_CHANGELOG_BY_IDDeletes a change log event subscription by ID. Requires a company admin API key and the change_log scope.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_SUBSCRIPTION_CONTACT_BY_IDDeletes a contact event subscription by its subscription ID.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_USER_BY_IDDeletes a user from the Dialpad system based on the provided user ID. This endpoint should be used when permanently removing a user’s account and associated data from Dialpad. It’s important to note that deleted users can be restored for up to 72 hours after deletion, after which their records are anonymized. Use this endpoint with caution as it will remove the user’s access to Dialpad services and may affect team structures or ongoing communications. This operation cannot be undone after the 72-hour restoration period.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_WEBHOOK_BY_IDDeletes a Dialpad webhook by its ID, stopping delivery to that webhook endpoint.

Input Parameters

string
required
The webhook”s ID, which is generated after creating a webhook successfully. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_DELETE_WEBSOCKET_CONNECTION_BY_IDCloses and removes a specific WebSocket connection in the Dialpad system. This endpoint should be used when an application needs to programmatically terminate a real-time event subscription or clean up unused WebSocket connections. It’s particularly useful for managing resources and ensuring that inactive or unnecessary WebSocket connections are properly closed. This operation is irreversible, so it should be used with caution. Once a WebSocket is deleted, any active subscriptions or real-time data streams associated with it will be immediately terminated.

Input Parameters

string
required
The websocket”s ID, which is generated after creating a websocket successfully. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_CALL_BY_IDRetrieves detailed information for a concluded Dialpad call by ID, including call status, duration, and available recording and transcription information.

Input Parameters

string
required
The call”s id. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_CALL_TRANSCRIPT_BY_IDRetrieves the transcript for a specific call in the Dialpad system. This endpoint allows you to fetch the text representation of the spoken content from a particular call or meeting. It’s useful for reviewing conversation details, analyzing call content, or creating searchable records of communications. The transcript is generated using Dialpad’s AI-powered transcription feature, which provides accurate text conversion of audio content. Use this endpoint when you need to access the written record of a call for purposes such as quality assurance, training, or content analysis. Note that the availability and accuracy of transcripts may depend on the audio quality of the original call and the capabilities of the AI transcription system.

Input Parameters

string
required
The call”s id. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_CUSTOM_IVRSLists custom IVR recordings for a specified Dialpad target, with cursor pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
required
The target”s id. Example: “5123456789012345”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
Target”s type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_OPERATORS_FOR_OFFICE_IDRetrieves the mainline operators for a specified Dialpad office, including available operator details and status.

Input Parameters

string
required
The office”s id. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_SCHEDULED_REPORTSLists scheduled report subscriptions for the company, with a cursor for pagination. It returns schedule metadata rather than report content.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_TRANSCRIPT_URL_BY_CALL_IDRetrieves the URL of a transcript for a specific call in the Dialpad system. This endpoint allows developers to access the text version of a call’s audio content by providing the unique identifier of the call. The returned URL can be used to fetch the actual transcript content. This tool is particularly useful when you need to programmatically access call transcripts for analysis, record-keeping, or integration with other systems. It should be used when a user needs to obtain the transcript URL for a known call ID, but not for directly retrieving the transcript content itself.

Input Parameters

string
required
The call”s id. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FETCH_USER_DETAILS_BY_IDRetrieves detailed information about a specific user in the Dialpad system. This endpoint is used to fetch comprehensive user data, including profile details, account settings, and associated communication information. It’s particularly useful for user management tasks, such as verifying user information, updating records in external systems, or displaying user profiles in integrated applications. The endpoint returns a single user object based on the provided user ID. It should be used when detailed information about a particular user is needed, but it will not provide aggregate data or information about multiple users simultaneously. Note that the specific fields returned may depend on the requester’s permissions and the user’s privacy settings.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_FORMAT_PHONE_NUMBERSReformats a phone number supplied in local or E.164 format. Provide an ISO country code for a local number; the result includes the E.164 and formatted local number, area code, and country code.

Input Parameters

string
Phone number in local or E.164 format
string
Country code in ISO 3166-1 alpha-2 format such as “US”. Required when sending local formatted phone number

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_AVAILABLE_LICENSES_FOR_AN_OFFICERetrieves the number of available (unused) licenses for a specific office within a Dialpad organization. This endpoint is used to check the current license capacity and availability before assigning new licenses to users or features. It provides essential information for office administrators to manage their license inventory effectively. The endpoint should be used when planning user onboarding, upgrading subscriptions, or performing license audits. Note that this endpoint only returns information about unassigned licenses and does not provide details about currently assigned licenses or their usage.

Input Parameters

string
required
The office”s id. Example: “5123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_CALL_CENTER_STATUS_BY_IDRetrieves the current operational status of a specific call center in the Dialpad system. This endpoint allows you to get real-time information about a call center’s state, which can include details such as whether it’s active, the number of agents available, current call volume, or any ongoing issues. It’s particularly useful for monitoring call center performance, making informed decisions about resource allocation, or triggering automated workflows based on the call center’s status. The endpoint should be used when you need up-to-the-minute information about a call center’s operational condition, but it does not provide historical data or detailed analytics.

Input Parameters

string
required
The call center”s id. Example: “5678901234567890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_CALL_LABELSRetrieves a list of all available call labels in the Dialpad system. This endpoint allows users to fetch the current set of labels that can be applied to calls for categorization and management purposes. It’s particularly useful for applications that need to display or use the full range of call labeling options in their interface or logic. The endpoint returns a collection of call labels, likely including their names and any associated metadata. It should be used when initializing call management interfaces or when needing to synchronize local label data with the current state in Dialpad. Note that this endpoint does not provide information about which labels are applied to specific calls; it only returns the set of available labels.

Input Parameters

integer
The maximum number of results to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_CALL_SUBSCRIPTION_DETAILSLists Dialpad call event subscriptions for the company or a specified target. Use cursor pagination to review existing subscriptions and their event notification settings.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The target”s id. Example: “5678901234567890”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
Target”s type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_CHANNEL_MEMBERS_BY_IDRetrieves a list of members for a specific channel in Dialpad. This endpoint allows you to fetch user information for all members associated with the given channel ID. It’s useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing channel activity. The endpoint should be used when you need to access member details for a particular channel, such as when displaying member lists, checking channel membership, or performing channel-related operations that require knowledge of its members. Note that this endpoint only provides member information and does not modify the channel or its membership.

Input Parameters

string
required
The channel id. Example: “5678901234567890”.
string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_DEPARTMENTS_BY_OFFICE_IDRetrieves a list of all departments associated with a specific office in the Dialpad system. This endpoint is essential for understanding the organizational structure within a company’s Dialpad account. It should be used when there’s a need to view, manage, or analyze the departmental breakdown of a particular office. The endpoint provides a comprehensive overview of the office’s internal structure, which can be valuable for administrative tasks, reporting, or integration with other systems. Note that this endpoint only returns department information and does not provide details about individual users within those departments.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
required
The office”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_DESKPHONE_BY_PARENT_IDRetrieves detailed information about a specific deskphone within a designated room or parent entity in the Dialpad system. This endpoint is useful for obtaining the current configuration, status, and attributes of a particular deskphone device. It should be used when you need to access or verify the details of a single deskphone, such as during troubleshooting, inventory management, or when updating device settings. The endpoint does not modify any data and is intended for read-only operations. Keep in mind that the response will only provide information about the specified deskphone and will not include details about other devices or the parent entity itself.

Input Parameters

string
required
The desk phone”s id.
string
required
The room”s id. Example: “5678901234567890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_DESKPHONES_FOR_USER_PARENT_IDLists deskphones associated with a specified Dialpad user. Returned deskphone entries contain their IDs.

Input Parameters

integer
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_DESKPHONES_IN_ROOMSLists deskphones associated with a specified Dialpad room, including available name, state, and phone number information.

Input Parameters

string
required
The room”s id. Example: “5678901234567890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_OFFICE_CALL_CENTERSRetrieves a list of call centers associated with a specific office in the Dialpad platform. This endpoint allows administrators and developers to fetch information about all call centers within a given office, which is useful for managing and organizing communication resources. Use this endpoint when you need to get an overview of call center units within an office, such as for reporting, resource allocation, or integration purposes. The endpoint returns basic information about each call center, but detailed configuration or real-time status may require additional API calls.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
required
The office”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_OPERATOR_SKILLS_BY_CALL_CENTER_AND_USERRetrieves an operator’s skill level for a specified call center.

Input Parameters

string
required
The operator”s ID. Example: “5678901234567890”.
string
required
The call center”s ID. Example: “5678901234567890”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_PHONE_NUMBER_DETAILSRetrieves details for a specific Dialpad phone number, including its status and assignment when available. Requires a company admin API key.

Input Parameters

string
required
A phone number (e164 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_ROOMS_LISTLists company rooms, optionally filtered by office, with cursor pagination. Returned room information can include names and contact details.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
The office”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_SUBSCRIPTION_CONTACT_BY_IDRetrieves a contact event subscription by its subscription ID, including its enabled state and available delivery endpoint configuration.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: ‘123456789012345’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_USER_CALLER_IDRetrieves the caller ID information for a specific user in the Dialpad system. This endpoint allows you to fetch the current caller ID settings associated with a user’s account, which may include their display name, phone number, or other identifying information used when making outbound calls. It’s particularly useful for administrators or integrations that need to verify or display a user’s current caller ID configuration. The endpoint should be used when you need to check or display a user’s caller ID settings, but not for modifying these settings. Note that this endpoint only provides read access to the caller ID information and cannot be used to update or change the caller ID settings.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_USER_DESKPHONESRetrieves detailed information about a specific deskphone associated with a particular user in the Dialpad system. This endpoint is useful when you need to access or verify the configuration, status, or other attributes of a user’s deskphone. It should be used when you have both the user’s ID and the specific deskphone ID, and need to fetch the most up-to-date information about that device. This endpoint does not modify any data and is safe for frequent calls, but consider caching the results if you’re making multiple requests for the same deskphone in a short period.

Input Parameters

string
required
The desk phone”s id.
integer
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_USER_E911_DETAILSRetrieves the Enhanced 911 (E911) information for a specific user in the Dialpad system. This endpoint provides critical location data associated with the user’s account, which is essential for emergency services to accurately locate the caller during an emergency. It should be used when setting up or verifying a user’s emergency contact information, ensuring compliance with E911 regulations for VoIP services. The tool returns the current E911 configuration for the specified user, including registered address and any additional location details. It’s important to note that this endpoint only retrieves information and does not modify any E911 settings.

Input Parameters

string
required
The office”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_GET_WEBHOOKS_INFORMATIONLists webhooks associated with the company, with cursor pagination. The results contain webhook endpoint details and signature settings.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_HANGUP_CALL_VIA_IDTerminates an active call in the Dialpad system. This endpoint should be used when you need to programmatically end a specific ongoing call. It’s particularly useful for automated call management, such as in customer service systems or when integrating Dialpad’s functionality into other applications. The endpoint has a rate limit of 1200 requests per minute, allowing for high-volume usage in busy call centers or large-scale communication systems. Note that this action is irreversible; once a call is hung up, it cannot be reinstated, and a new call would need to be initiated if further communication is required.

Input Parameters

string
required
The call”s id. Example: “4986480873062400”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_INITIATE_IVR_CALL_API_ENDPOINTInitiates an outbound call to ring an IVR workflow, using a specified phone number and a call center, department, or office target. Optional call data and caller ID can be supplied.

Input Parameters

integer
required
The ID of a group that will be used to initiate the call.
string
Extra data to associate with the call. This will be passed through to any subscribed call events.
string ("callcenter" | "department" | "office")
required
The type of a group that will be used to initiate the call.
string
required
The e164-formatted number to call.
string
The e164-formatted number shown to the call recipient (or “blocked”).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_INITIATE_OUTBOUND_CALL_VIA_APIInitiates an outbound call on behalf of a Dialpad user by ringing all devices or a specified device. Supports caller ID, group association, custom data, and consult mode; the user must have an active device.

Input Parameters

integer
required
The id of the user who should make the outbound call.
integer
The ID of a group that will be used to initiate the call.
string
The device”s id.
string ("callcenter" | "department" | "office")
The type of a group that will be used to initiate the call.
boolean
Enables the creation of a second call. If there is an ongoing call, it puts it on hold.
string
Extra data to associate with the call. This will be passed through to any subscribed call events.
string
required
The e164-formatted number to call.
string
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_INITIATE_USER_CALL_WITH_GROUP_OPTIONSCauses a specified user’s Dialpad application to initiate an outbound call, with optional caller ID, group, and custom data. The user must have an active autocallable device.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
integer
The ID of a group that will be used to initiate the call.
string ("callcenter" | "department" | "office")
The type of a group that will be used to initiate the call.
string
Extra data to associate with the call. This will be passed through to any subscribed call events.
string
The e164-formatted number to call.
string
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_LIST_CHANNELS_APILists company channels, optionally filtered by state. Results are paginated using a cursor.

Input Parameters

string
The state of the channel.
string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_LIST_CONFERENCE_ROOMSLists Dialpad meeting rooms with cursor pagination. Requires the conference:read scope.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_LIST_OFFICES_ENDPOINTLists accessible Dialpad offices, optionally filtering for active offices; results may be paginated and office entries contain IDs. Company admins can see every office, while user-level keys see only offices the user belongs to.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
boolean
Whether we only return active offices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_LIST_USERSRetrieves a list of users from the Dialpad system. This endpoint allows you to fetch user account information, which is essential for user management and provisioning tasks. It can be used to sync user data with external systems, perform audits, or gather information for reporting purposes. The endpoint likely supports pagination and filtering options to manage large sets of user data efficiently. However, it does not provide real-time updates or webhook functionality for user changes - separate endpoints or features would be needed for those use cases.

Input Parameters

string
The user”s email.
string ("active" | "all" | "cancelled" | "deleted" | "pending" | "suspended")
Filter results by the specified user state (e.g. active, suspended, deleted)
string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The user”s phone number.
boolean
If provided, filter results by the specified value to return only company admins or only non-company admins.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_MODIFY_CONTACT_DETAILS_USING_IDUpdates an existing contact’s information in the Dialpad system. This endpoint allows for partial updates of contact details, including personal information, communication details, and associated URLs. It’s used when you need to modify or add information to an existing contact record. The endpoint supports updating multiple fields simultaneously, making it efficient for bulk changes or comprehensive contact updates. Note that all fields are optional, allowing for targeted updates without affecting other contact information. When updating list-based fields like emails or phones, the provided lists will replace the existing data entirely.

Input Parameters

string
required
The contact”s id.
array
A list of websites associated with or belonging to this contact.
array
The contact”s emails. The first email in the list is the contact”s primary email.
array
The contact”s phone numbers. The phone number must be in e164 format. The first number in the list is the contact”s primary phone.
string
The contact”s extension number.
string
[single-line only] The contact”s job title.
string
[single-line only] The contact”s last name.
string
[single-line only] The contact”s first name.
string
[Deprecated]
string
[single-line only] The contact”s company name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_MODIFY_CUSTOM_IVR_SETTINGSAssigns an existing IVR recording to a target for a specified IVR type, replacing the previous assignment. For call center auto-recording IVRs, the assignment can be limited to inbound or outbound calls.

Input Parameters

integer
required
The id of the ivr that you want to use for the ivr type.
string ("ASK_FIRST_OPERATOR_NOT_AVAILABLE" | "AUTO_RECORDING" | "CALLAI_AUTO_RECORDING" | "CG_AUTO_RECORDING" | "CLOSED" | "CLOSED_DEPARTMENT_INTRO" | "CLOSED_MENU" | "CLOSED_MENU_OPTION" | "CSAT_INTRO" | "CSAT_OUTRO" | "CSAT_PREAMBLE" | "CSAT_QUESTION" | "DEPARTMENT_INTRO" | "GREETING" | "HOLD_AGENT_READY" | "HOLD_APPREC" | "HOLD_CALLBACK_ACCEPT" | "HOLD_CALLBACK_ACCEPTED" | "HOLD_CALLBACK_CONFIRM" | "HOLD_CALLBACK_CONFIRM_NUMBER" | "HOLD_CALLBACK_DIFFERENT_NUMBER" | "HOLD_CALLBACK_DIRECT" | "HOLD_CALLBACK_FULFILLED" | "HOLD_CALLBACK_INVALID_NUMBER" | "HOLD_CALLBACK_KEYPAD" | "HOLD_CALLBACK_REJECT" | "HOLD_CALLBACK_REJECTED" | "HOLD_CALLBACK_REQUEST" | "HOLD_CALLBACK_REQUESTED" | "HOLD_CALLBACK_SAME_NUMBER" | "HOLD_CALLBACK_TRY_AGAIN" | "HOLD_CALLBACK_UNDIALABLE" | "HOLD_ESCAPE_VM_EIGHT" | "HOLD_ESCAPE_VM_FIVE" | "HOLD_ESCAPE_VM_FOUR" | "HOLD_ESCAPE_VM_NINE" | "HOLD_ESCAPE_VM_ONE" | "HOLD_ESCAPE_VM_POUND" | "HOLD_ESCAPE_VM_SEVEN" | "HOLD_ESCAPE_VM_SIX" | "HOLD_ESCAPE_VM_STAR" | "HOLD_ESCAPE_VM_TEN" | "HOLD_ESCAPE_VM_THREE" | "HOLD_ESCAPE_VM_TWO" | "HOLD_ESCAPE_VM_ZERO" | "HOLD_INTERRUPT" | "HOLD_INTRO" | "HOLD_MUSIC" | "HOLD_POSITION_EIGHT" | "HOLD_POSITION_FIVE" | "HOLD_POSITION_FOUR" | "HOLD_POSITION_MORE" | "HOLD_POSITION_NINE" | "HOLD_POSITION_ONE" | "HOLD_POSITION_SEVEN" | "HOLD_POSITION_SIX" | "HOLD_POSITION_TEN" | "HOLD_POSITION_THREE" | "HOLD_POSITION_TWO" | "HOLD_POSITION_ZERO" | "HOLD_WAIT" | "MENU" | "MENU_OPTION" | "NEXT_TARGET" | "VM_DROP_MESSAGE" | "VM_UNAVAILABLE" | "VM_UNAVAILABLE_CLOSED")
required
Type of ivr you want to update
string
required
The target”s id. Example: “4986480873062400”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
Target”s type.
string ("inbound" | "outbound")
For call center auto call recording only. Set ivr for inbound or outbound. Default is both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_MODIFY_OPERATOR_SKILL_LEVELUpdates the skill level of a specific operator in a designated call center. This endpoint allows administrators to adjust an operator’s proficiency rating, which can be used for call routing, performance tracking, and workforce management. The skill level is represented as an integer from 0 to 100, with higher values indicating greater expertise. Use this endpoint when you need to modify an operator’s skill level based on performance reviews, training completion, or changes in responsibilities. It’s particularly useful for maintaining an up-to-date and accurate representation of your call center team’s capabilities.

Input Parameters

string
required
The operator”s ID
integer
required
New skill level to set the operator in the call center. It must be an integer value between 0 and 100.
string
required
The call center”s ID. Example: “4986480873062400”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_MODIFY_WEBHOOK_CONFIGURATIONUpdates an existing webhook configuration in the Dialpad API. This endpoint allows you to modify the destination URL and/or the secret used for request validation of a specific webhook. Use this when you need to change where webhook events are sent or update the security settings of an existing webhook. The endpoint is particularly useful for maintaining webhook configurations as your integration evolves or when you need to rotate security credentials. Note that updating these settings will affect all future events for this webhook, so ensure your receiving endpoint is prepared for the changes before updating.

Input Parameters

string
required
The webhook”s ID, which is generated after creating a webhook successfully.
string
[single-line only] Webhook”s signature secret that”s used to confirm the validity of the request.
string
The webhook”s URL. Triggered events will be sent to the url provided here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_MOVE_USER_TO_SPECIFIED_OFFICEMoves a Dialpad user to a different office. For international offices, the user’s numbers are unassigned and a new number assigned, except when the user has only internal numbers.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
integer
The user”s office id. When provided, the user will be moved to this office.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_OAUTH2_AUTHORIZE_ENDPOINTInitiates the OAuth 2.0 authorization process for the Dialpad API. This endpoint is the entry point for obtaining user consent and generating an authorization code, which can later be exchanged for an access token. It should be used when an application needs to request permission to access a user’s Dialpad resources. The endpoint will redirect the user to Dialpad’s login and consent page. After the user grants permission, they will be redirected back to the specified redirect_uri with an authorization code. This endpoint is crucial for implementing secure, user-authorized access to Dialpad’s API features.

Input Parameters

string
Space-separated list of additional scopes that should be granted to the vended token.
string
Unpredictable token to prevent CSRF.
string
required
The client_id of the OAuth app.
string
required
The URI the user should be redirected back to after granting consent to the app.
string ("code")
The OAuth flow to perform. Must be “code” (authorization code flow).
string
PKCE challenge value (hash commitment).
string ("S256" | "plain")
PKCE challenge method (hashing algorithm).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_ACCESS_CONTROL_POLICY_BY_IDUpdates an access control policy by ID, including its name, description, permissions, or state. Requires a company admin API key.

Input Parameters

integer
required
The access control policy”s id.
string
[single-line only] A human-readable display name for the policy.
string ("active" | "deleted")
Restore a deleted policy.
integer
user id updating this policy. Must be a company admin
string
[single-line only] Optional description for the policy.
array
List of permission associated with this policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_AGENT_STATUS_EVENT_SUBSCRIPTIONUpdates an agent status event subscription by ID, including its enabled state and logging endpoint. The agent type defaults to callcenter and enabled defaults to true when omitted.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully.
boolean
Whether or not the this agent status event subscription is enabled.
string ("callcenter")
The agent type this event subscription subscribes to.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_CALL_ROUTER_BY_IDUpdates an existing call router in the Dialpad system. This endpoint allows you to modify various settings of a call router, including its default target, enabled state, name, office association, error handling, routing URL, and authentication secret. Use this when you need to change the behavior or configuration of an existing call router. The endpoint is particularly useful for adjusting routing logic, updating fallback options, or managing error states. Note that while all parameters are optional, providing at least one is necessary to make meaningful changes. Be cautious when updating critical parameters like the routing URL or secret, as incorrect values could disrupt call routing.

Input Parameters

string
required
The API call router”s ID
string
[single-line only] A human-readable display name for the router.
string
[single-line only] The call router”s signature secret. This is a plain text string that you should generate with a minimum length of 32 characters.
boolean
If set to False, the call router will skip the routing url and instead forward calls straight to the default target.
integer
The ID of the office to which this router belongs.
string
The URL that should be used to drive call routing decisions.
integer
The ID of the target that should be used as a fallback destination for calls if the call router is disabled or fails.
boolean
Sets the auto-disablement routing error count back to zero. Call routers maintain a count of the number of errors that have occured within the past hour, and automatically become disabled when that count exceeds 10. Setting enabled to true via the API will not reset that count, which means that the router will likely become disabled again after one more error. In most cases, this will be useful for testing fixes in your routing API, but in some circumstances it may be desirable to reset that counter.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The entity type of the default target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_DEPARTMENT_DETAILS_BY_IDUpdates the settings and configuration of a specific department in the Dialpad system. This endpoint allows for comprehensive modification of department properties, including operating hours, call routing strategies, hold queue settings, and voice intelligence features. It’s particularly useful for adjusting department behavior to match changing business needs or to optimize call handling efficiency. The endpoint supports partial updates, allowing you to modify only the specific fields you need to change without affecting other settings.

Input Parameters

integer
required
The call center”s id.
string
[single-line only] The name of the department. Max 100 characters.
boolean
The time frame when the department wants to receive calls. Default value is false, which means the call center will always take calls (24/7).
array
The Friday hours of operation. Default value is [“08:00”, “18:00”].
array
The Monday hours of operation. To specify when hours_on is set to True. e.g. [“08:00”, “12:00”, “14:00”, “18:00”] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [“08:00”, “18:00”].
integer
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds.
array
The Sunday hours of operation. Default is empty array.
array
The Tuesday hours of operation. Default value is [“08:00”, “18:00”].
array
The Saturday hours of operation. Default is empty array.
array
The Thursday hours of operation. Default value is [“08:00”, “18:00”].
array
The Wednesday hours of operation. Default value is [“08:00”, “18:00”].
string
The description of the department. Max 256 characters.
boolean
Whether or not automatically record all calls of this department. Default is False.
boolean
Whether or not send callers to a hold queue, if all operators are busy on other calls. Default is False.
array
DTMF menu options.
integer
If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-50. Default is 50.
array
DTMF menu options.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
integer
Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min).
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Auto start Vi for this call center. Default is True.
boolean
Allow individual users to start and stop Vi during calls. Default is True.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
The ID of the Target that inbound calls should be routed to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_SUBSCRIPTION_CHANGELOG_ENDPOINTUpdates a change log event subscription’s enabled state and logging endpoint by ID; enabled defaults to true when omitted. Requires a company admin API key and the change_log scope.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully.
boolean
Whether or not the change log event subscription is enabled.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_USER_ACTIVE_CALL_RECORDINGUpdates recording for a user’s active call, including recording indication playback and recording scope for group calls. The user ID is required; recording message playback defaults to enabled and recording type defaults to user.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
boolean
Whether or not recording should be enabled.
boolean
Whether or not to play a message to indicate the call is being recorded (or recording has stopped).
string ("all" | "group" | "user")
Whether or not to toggle recording for the operator call (personal recording), the group call (department recording), or both. Only applicable for group calls (call centers, departments, etc.)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_USER_STATUSUpdates a user’s status message, optionally specifying an expiration time, and returns the user’s status if the user exists.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
integer
The expiration of this status. None for no expiration.
string
The status message for the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_PATCH_WEBSOCKET_SIGNATURE_SECRETUpdates the signature secret for a specified Dialpad WebSocket endpoint, for example to rotate the secret used to verify event payloads.

Input Parameters

string
required
The websocket”s ID, which is generated after creating a websocket successfully.
string
[single-line only] Websocket”s signature secret that”s used to confirm the validity of the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_POST_CALL_EVENT_SUBSCRIPTIONCreates a new call event subscription in the Dialpad system, allowing real-time notifications for various call states and actions. This endpoint enables developers to set up targeted event streams for specific call centers, users, or other entities within Dialpad. Use this when you need to monitor call activities, automate workflows based on call states, or integrate Dialpad’s call data with external systems. The subscription can be fine-tuned to listen for specific call states and target types, making it versatile for various use cases such as call monitoring, analytics, or custom integrations. Note that while the subscription can be created with this endpoint, you’ll need to have a properly configured webhook or websocket to receive the events.

Input Parameters

boolean
Whether or not the call event subscription is enabled.
integer
The ID of the specific target for which events should be sent. Example: “5676480932184064”.
array
The call event subscription”s list of call states.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target type.
boolean
Call event subscription for group calls only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_POST_RECORDING_SHARE_LINKCreates a shareable link for a specific recording in Dialpad, such as a call recording or voicemail. This endpoint allows users to generate a link that can be used to share recordings with others, with customizable privacy settings. It should be used when you need to create a URL for sharing a recording outside of the Dialpad interface. The endpoint requires specifying the recording ID and type, and optionally allows setting the privacy level of the share link. Note that this endpoint only creates the share link; it does not modify the recording itself or its storage location.

Input Parameters

string ("admin" | "company" | "owner" | "public")
The privacy state of the recording share link.
string
required
The recording entity”s ID.
string ("admincallrecording" | "callrecording" | "voicemail")
required
The type of the recording entity shared via the link.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_POST_SUBSCRIPTION_CHANGE_LOG_EVENTCreates a company change log event subscription for a webhook or websocket endpoint, with an enabled setting. Requires the change_log scope.

Input Parameters

boolean
Whether or not the this change log event subscription is enabled.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. Example: “5676480932184064”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_POST_USERS_SCREENPOP_URITriggers a screen pop for a specific Dialpad user, displaying relevant information during a call or communication event. This endpoint should be used when you need to automatically present contextual data to a user’s screen, such as customer information from a CRM system. It’s particularly useful in contact center scenarios where agents need quick access to caller details. The screen pop URL can be a web page or a custom URI to launch a native application. Note that this endpoint does not retrieve or send any customer data directly; it only initiates the display of the specified URL on the user’s device.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key). Example: “5676480932184064”.
string
required
The screen pop”s url. Most Url should start with scheme name such as http or https. Be aware that url with userinfo subcomponent, such as “https://username:password@www.example.com” is not supported for security reasons. Launching native apps is also supported through a format such as “customuri://domain.com”

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_POST_WEBSOCKET_CONNECTION_SECRETCreates a Dialpad websocket endpoint for receiving event notifications, optionally specifying a signature secret. Connect to the returned websocket URL to receive event payloads.

Input Parameters

string
[single-line only] Websocket”s signature secret that”s used to confirm the validity of the request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_REASSIGN_PHONE_NUMBER_TO_TARGETAssigns or reassigns a phone number to a specific target within the Dialpad system. This endpoint allows you to associate a phone number with various entities such as users, departments, call centers, or other supported target types. Use this when you need to allocate or reallocate phone numbers across your Dialpad organization. The endpoint is particularly useful for managing phone number assignments during user onboarding, department restructuring, or call center setup. Note that this operation may affect existing call routing and should be used cautiously in production environments.

Input Parameters

string
required
A specific number to assign
boolean
A boolean indicating whether this should become the target”s primary phone number.
integer
required
The ID of the target to reassign this number to. Example: “5676480932184064”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
required
The type of the target.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_REDEEM_ACCESS_OR_REFRESH_TOKENSends a request to Dialpad’s OAuth token endpoint. The action does not accept an authorization code, refresh token, or grant type as input.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_REMOVE_BLOCKED_NUMBERSUnblocks specified phone numbers company-wide, restoring inbound calls and texts from them. The numbers can be blocked again.

Input Parameters

array
A list of E164 formatted numbers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_ACCESS_CONTROL_POLICY_ASSIGNMENTSLists users assigned to a specified Dialpad access control policy, along with their associated policy targets. Results can be paginated using a cursor.

Input Parameters

string
required
The access control policy”s id. Example: “5676480932184064”.
string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_ACCESS_CONTROL_POLICY_BY_IDRetrieves detailed information about a specific access control policy in the Dialpad system. This endpoint allows administrators to fetch the configuration and settings of a particular policy, which defines custom permissions and access levels for users within the Dialpad platform. Use this endpoint when you need to review or audit the settings of an existing access control policy. It’s particularly useful for verifying policy details before making modifications or when troubleshooting access-related issues. The endpoint returns comprehensive information about the policy but does not allow for modifications; separate endpoints would be used for updating policies.

Input Parameters

string
required
The access control policy”s id. Example: “5676480932184064”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_AGENT_STATUS_BY_IDRetrieves an agent status event subscription by ID, including its agent type, enabled state, and webhook or websocket configuration. Requires a company admin API key.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5676480932184064”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_AGENT_STATUS_SUBSCRIPTIONLists the company’s agent status event subscriptions for auditing or managing event notifications. Use a cursor to request the next page. A company admin API key is required.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_APP_SETTINGSRetrieves OAuth app settings for a specified target, or company app settings when target type and ID are not provided.

Input Parameters

string
The target”s id. Example: “5676480932184064”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target”s type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_BLOCKED_NUMBER_DETAILSChecks whether a phone number is blocked company-wide. It returns the number if blocked, and returns 404 if it is not blocked or was blocked outside the API.

Input Parameters

string
required
A phone number (e164 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_BLOCKED_PHONE_NUMBERSLists company-wide phone numbers blocked through the Dialpad API. Results are paginated using a cursor; numbers blocked by other means are not included.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_CENTER_BY_IDRetrieves detailed information about a specific call center in the Dialpad system. This endpoint allows you to fetch comprehensive data about a call center, including its configuration, associated agents, and operational metrics. Use this when you need to access or review the current state and settings of a particular call center. The endpoint is particularly useful for administrators managing multiple call centers or for integrations that need up-to-date call center information. Note that this endpoint only provides read access and cannot be used to modify call center details.

Input Parameters

string
required
The call center”s id. Example: “5676480932184064”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALLCENTER_OPERATORS_BY_IDRetrieves a list of operators associated with a specific call center in Dialpad. This endpoint allows you to fetch detailed information about the operators working in a particular call center, which is essential for managing call center operations, monitoring staff, and optimizing workload distribution. Use this endpoint when you need to view the current roster of operators, check staffing levels, or gather operator details for reporting purposes. The endpoint returns operator information but does not provide real-time status updates or allow modifications to operator data. It’s particularly useful for integrations that require synchronization of call center staff information with external systems or for building custom dashboards to monitor call center composition.

Input Parameters

string
required
The call center”s id. Example: “5047447224311808”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_CENTERS_INFORMATIONLists call centers in the company, optionally filtered by office or name. Results are paginated and include call center identifiers, names, and available office, company, and state fields.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
search call center by office.
search call centers by name or search by the substring of the name. If input example is “Cool”, output example can be a list of call centers whose name contains the string “Cool” - [“Cool call center 1”, “Cool call center 2049”]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_INFORMATIONLists Dialpad calls in reverse chronological order, optionally filtered by start time or target. Use the response cursor to request the next page of call information for reporting or analysis.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The ID of a target to filter against. Example: “5047447224311808”.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target type associated with the target ID.
integer
Only includes calls that started more recently than the specified timestamp. (UTC ms-since-epoch timestamp)
integer
Only includes calls that started prior to the specified timestamp. (UTC ms-since-epoch timestamp)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_ROUTER_BY_IDRetrieves detailed information about a specific call router in the Dialpad system. This endpoint allows developers to fetch the configuration and status of a call router by providing its unique identifier. Use this when you need to check the current settings, routing rules, or other properties of a particular call router. It’s particularly useful for auditing your call routing setup or before making changes to an existing router. The endpoint returns read-only data and does not modify any settings.

Input Parameters

string
required
The API call router”s ID. Example: “5047447224311808”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_ROUTERS_V2_APIRetrieves a list of call routers configured in the Dialpad system. This endpoint allows you to fetch information about the call routing setup in your Dialpad account, including details such as router identifiers, associated dedicated DIDs, and routing rules. It’s particularly useful for auditing your current call routing configuration or gathering data for reporting purposes. The endpoint provides read-only access to call router information and does not allow modifications to the routing setup. Use this when you need to review your call routing structure or integrate call routing information into your applications for advanced call management or analytics.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
The office”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CALL_SUBSCRIPTION_BY_IDRetrieves a call event subscription by ID, including its enabled status and associated webhook or websocket configuration when available.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Example: “5047447224311808”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CHANNEL_BY_IDRetrieves a Dialpad channel by its unique identifier, returning its ID and name.

Input Parameters

string
required
The channel id. Example: “5047447224311808”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_COACHING_STATS_V2Starts asynchronous processing of Dialpad statistics for a selected statistics type and export type, with date and target options. The request ID can be used to check progress and retrieve results. Choose aggregated statistics or individual records; CSAT and dispositions require a target and support records only.

Input Parameters

string ("date" | "group" | "user")
This param is only applicable when the stat_type is specified as call. For call stats, group calls by user per day (default), get total metrics by day, or break down by department and call center (office only).
boolean
Whether or not the statistics are for the current day. NOTE: days_ago_start and days_ago_end are ignored if this is passed in.
string
Timezone using a tz database name.
integer
ID of the office to get statistics for. If a target_id and target_type are passed in this value is ignored and instead the target is used. Example: “5047447224311808”.
string ("calls" | "csat" | "dispositions" | "onduty" | "recordings" | "screenshare" | "texts" | "voicemails")
required
The type of statistics to be returned. NOTE: if the value is “csat” or “dispositions”, target_id and target_type must be specified.
integer
The target”s id. Example: “5047447224311808”.
string ("records" | "stats")
required
Whether to return aggregated statistics (stats), or individual rows for each record (records). NOTE: For stat_type “csat” or “dispositions”, only “records” is supported.
string ("callcenter" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
Target”s type.
integer
End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_start to specify a range.
boolean
Whether or not the the statistics should be for trainees of the coach team with the given target_id.
boolean
Whether or not the the statistics should be for trainees of the coach group with the given target_id.
integer
Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_end to specify a range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_COACHING_TEAM_BY_IDRetrieves a coaching team by ID, including its name, associated office and company, and available descriptive metadata.

Input Parameters

string
required
Id of the coaching team. Example: “5047447224311808”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_COACHING_TEAMS_INFORMATIONLists coaching teams in the company, with team identifiers, names, office and company identifiers, and available descriptive metadata. Results support cursor pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_COMPANY_DATARetrieves detailed information about a specific company within the Dialpad platform. This endpoint allows developers to access various company-level data, such as company name, settings, and other relevant details. It should be used when an application needs to fetch or display company information, update local records, or verify company-specific configurations. The endpoint provides a comprehensive view of a company’s profile in Dialpad but does not modify any data. Note that the specific fields returned may depend on the user’s permissions and the company’s privacy settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CONFERENCE_MEETINGSLists summaries of past Dialpad meetings for a meeting room, with cursor pagination. Requires the conference:read scope.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The meeting room”s ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CONTACT_BY_IDRetrieves a single Dialpad contact by ID, including available contact details. Only shared and local contacts can currently be retrieved.

Input Parameters

string
required
The contact”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_CONTACT_LISTLists Dialpad company shared contacts or a user’s local contacts, with cursor pagination and an option to include local contacts.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The id of the user who owns the contact.
boolean
If set to True company local contacts will be included. default False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_DEPARTMENT_BY_IDRetrieves a Dialpad department by ID, including its name, company and office IDs, and creation and update timestamps when available.

Input Parameters

string
required
The department”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_DEPARTMENT_OPERATORS_BY_IDRetrieves a list of operators associated with a specific department in Dialpad. This endpoint allows you to fetch detailed information about the operators assigned to a particular department, enabling efficient management of department resources and personnel. Use this endpoint when you need to review, audit, or manage the operators within a specific department. The response likely includes operator details such as names, contact information, and roles. Note that this endpoint does not modify any department or operator data; it is for retrieval purposes only. It’s particularly useful for administrative tasks, reporting, and ensuring proper staffing across departments.

Input Parameters

string
required
The department”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_E911_OFFICE_DETAILSRetrieves the Enhanced 911 (E911) settings for a specific office within the Dialpad communication platform. This endpoint allows administrators to fetch crucial emergency service configuration details associated with a particular office location. It should be used when auditing or verifying E911 compliance, updating emergency response information, or integrating office-specific emergency settings into external systems. The endpoint provides read-only access to E911 data and does not allow modifications. It’s important to note that this tool only retrieves settings for a single office at a time and does not provide aggregate data across multiple offices.

Input Parameters

string
required
The office”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_LIST_OF_DEPARTMENTSLists company departments, optionally filtered by office or department name. Results are paginated and include department IDs and available names and office IDs.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
filter departments by office.
string
search departments by name or search by the substring of the name. If input example is “Happy”, output example can be a list of departments whose name contains the string Happy - [“Happy department 1”, “Happy department 2”]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_MEMBERS_OF_COACHING_TEAM_BY_IDLists members of a specified coaching team, including available user identity, contact, and availability information.

Input Parameters

string
required
Id of the coaching team. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_NUMBERS_VIA_API_V2Retrieves a list of phone numbers associated with the user’s Dialpad account. This endpoint allows users to view all the phone numbers they have access to, which may include both assigned and unassigned numbers. It’s useful for inventory management, number allocation, and auditing purposes. The endpoint returns basic information about each number, such as its value, status, and associated user or department. It does not modify any data and is safe for frequent polling. Note that the response may be paginated for large number inventories, and additional calls may be needed to retrieve the full list.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
Status to filter by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_OFF_DUTY_STATUS_BY_OFFICE_IDLists the off-duty status options configured for a specified office. This retrieves status definitions rather than showing which agents currently use them.

Input Parameters

string
required
The office”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_OFFICE_BY_IDRetrieves a specified Dialpad office by ID. The returned office model contains the office ID.

Input Parameters

string
required
The office”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_OFFICE_PLAN_BY_IDRetrieves an office’s billing plan, including purchased license counts by line type, remaining calling credit, and the start of the next billing cycle.

Input Parameters

string
required
The office”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_OPERATOR_DUTY_STATUSRetrieves the current duty status of a specific call center operator in Dialpad. This endpoint allows you to check whether an operator is Active (available to receive inbound calls) or Off-Duty (not available for calls). Use this endpoint when you need to determine an operator’s availability in real-time, such as for load balancing, scheduling, or monitoring operator activity. The endpoint provides a snapshot of the operator’s current status and does not include historical data or future scheduled statuses. It’s particularly useful for systems that need to make routing decisions based on operator availability or for creating dashboards that display team capacity.

Input Parameters

string
required
The operator”s user id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_ROOM_INFORMATION_BY_IDRetrieves information about a Dialpad room by ID, including its name, state, office, group details, and phone settings when available.

Input Parameters

string
required
The room”s id. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SCHEDULE_REPORT_BY_IDRetrieves a scheduled report subscription by ID, including its frequency and delivery endpoint ID when available.

Input Parameters

string
required
The schedule reports subscription”s ID. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SMS_OPT_OUT_BY_COMPANY_IDLists a company’s external phone numbers filtered by SMS opt-out or opt-back-in state, optionally by A2P campaign. Results are paginated.

Input Parameters

string
required
ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key.
string
Optional token used to return the next page of a previous request. Use the cursor provided in the previous response.
string ("opted_back_in" | "opted_out")
required
Required opt-out state to filter results by. Only results matching this state will be returned.
string
Optional company A2P campaign entity id to filter results by. Note, if set, then the parameter “opt_out_state” must be also set to the value “opted_out”. Example: “123456789012345”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SMS_SUBSCRIPTION_BY_IDRetrieves an SMS event subscription by ID, including its direction and available delivery endpoint and target settings.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Provided as string to avoid JS Number precision loss (IDs may exceed 2^53). Example: “1234567890123456”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SMS_SUBSCRIPTIONSLists SMS event subscriptions for a company or target, with optional target filtering and cursor pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The target”s id. Provided as string to avoid JS Number precision loss (IDs may exceed 2^53).
string
Target”s type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SPECIFIC_WEBHOOK_BY_IDRetrieves a webhook configuration by ID, including its URL and available signature settings.

Input Parameters

string
required
The webhook”s ID, which is generated after creating a webhook successfully. Provided as string to avoid JS Number precision loss (IDs may exceed 2^53).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_STAT_BY_IDRetrieves the progress and result of a previously initiated statistics request by its request ID.

Input Parameters

string
required
Request ID returned by a POST /stats request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SUBSCRIPTION_CHANGE_LOGLists a company’s change log event subscriptions with cursor pagination. Requires a company admin API key and the change_log scope.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SUBSCRIPTION_CHANGE_LOG_BY_IDRetrieves a change log event subscription by ID. Requires a company admin API key and the change_log scope.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully. Provided as string to avoid JS Number precision loss (IDs may exceed 2^53).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_SUBSCRIPTION_CONTACTSLists a company’s contact event subscriptions, with cursor pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_TEAMS_FOR_OFFICE_IDLists coaching teams associated with a specified Dialpad office, with cursor-based pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
integer
required
The office”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_USER_DEVICE_BY_IDRetrieves detailed information about a specific user device associated with a Dialpad account. This endpoint allows developers to fetch the current state and configuration of a particular device by providing its unique identifier. Use this when you need to access up-to-date information about a user’s device, such as its type, status, or associated settings. The endpoint is particularly useful for device management, troubleshooting, or syncing device information across integrated systems. Note that this endpoint only provides read access to device data and cannot be used to modify device settings.

Input Parameters

string
required
The device”s id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_USER_DEVICES_LISTLists registered user devices, such as desk phones, softphones, and mobile apps. Supports a user ID filter and cursor pagination.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.
string
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_USER_PERSONAS_BY_IDRetrieves all personas associated with a specific user in the Dialpad system. This endpoint allows you to fetch the various identities or roles that a user can assume when making calls, providing detailed information about each persona. Use this endpoint when you need to display or manage the different caller identities available to a user. The response will include a list of persona objects, each containing information such as the persona name, phone number, and any associated metadata. This endpoint is particularly useful for applications that need to offer users a choice of outbound caller identities or for administrative purposes to review a user’s available personas.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_WEBSOCKET_BY_IDRetrieves detailed information about a specific WebSocket connection using its unique identifier. This endpoint allows developers to query the status, metadata, and other relevant details of an active or recent WebSocket connection in the Dialpad system. It’s particularly useful for monitoring real-time event subscriptions, troubleshooting connection issues, or auditing WebSocket usage. The endpoint should be used when you need to inspect or verify the state of a particular WebSocket connection, such as checking if it’s still active or retrieving its configuration. Note that this endpoint provides information about the connection itself and may not include the actual event data being transmitted through the WebSocket.

Input Parameters

string
required
The websocket”s ID, which is generated after creating a websocket successfully. Provided as string to avoid JS Number precision loss (IDs may exceed 2^53).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_RETRIEVE_WEBSOCKET_CONNECTIONLists the company’s Dialpad WebSockets, with cursor pagination. Use the returned connection details to identify WebSockets for receiving event payloads; connecting to a WebSocket is a separate operation.

Input Parameters

string
A token used to return the next page of a previous request. Use the cursor provided in the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_SEND_SMS_WITH_OPTIONAL_MEDIA_AND_GROUP_SENDERThe SendSMS endpoint allows you to send SMS or MMS messages through the Dialpad platform to one or multiple recipients. This versatile tool supports various sender identification methods, group messaging, and media attachments. Use it to programmatically send text or multimedia messages, integrate with Dialpad channels, and leverage organizational structures for messaging. The endpoint is particularly useful for automating communication workflows, sending notifications, or implementing messaging features within applications integrated with Dialpad. Note that while the endpoint offers flexibility in number formatting and sender identification, proper authorization and adherence to messaging regulations are assumed to be handled separately.

Input Parameters

string
The contents of the message that should be sent.
string
Base64-encoded media attachment (will cause the message to be sent as MMS).
integer
The ID of the user who should be the sender of the SMS.
array
Up to 10 E164-formatted phone numbers who should receive the SMS.
string
The number of who sending the SMS. The number must be assigned to user or a user group. It will override user_id and sender_group_id.
string
[single-line only] The hashtag of the channel which should receive the SMS.
integer
The ID of an office, department, or call center that the User should send the message on behalf of.
string ("callcenter" | "department" | "office")
The sender group”s type (i.e. office, department, or callcenter).
boolean
If true, to_numbers will be assumed to be from the specified user”s country, and the E164 format requirement will be relaxed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_SET_USER_CALLER_ID_BY_IDSets or blocks the Caller ID for a specific Dialpad user. This endpoint allows you to define the phone number that will be displayed when the user makes outgoing calls, or to block the Caller ID entirely. Use this when you need to customize how a user’s calls appear to recipients or to ensure privacy by blocking the Caller ID. The endpoint is particularly useful for managing professional appearances in business communications or for compliance with privacy regulations. Note that this setting affects all outgoing calls made by the user through the Dialpad platform.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
string
required
Phone number (e164 formatted) that will be defined as a Caller ID for the target. Use “blocked” to block the Caller ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_SUBSCRIBE_CONTACT_EVENTCreates a new contact event subscription in the Dialpad platform, allowing you to receive real-time updates about changes to contacts. This endpoint enables you to subscribe to events for either local (personal) or shared (organization-wide) contacts. Use this when you need to integrate contact management functionalities or automate workflows based on contact updates in your Dialpad-connected application. The subscription can be linked to a specific logging endpoint (webhook or websocket) for event delivery and can be enabled or disabled upon creation. Note that you must have previously set up a logging endpoint to receive the events if you specify an endpoint_id.

Input Parameters

boolean
Whether or not the contact event subscription is enabled.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.
string ("local" | "shared")
required
The contact type this event subscription subscribes to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_TOGGLE_USER_DO_NOT_DISTURB_STATUSThe ToggleUserDoNotDisturb endpoint allows you to update the Do Not Disturb (DND) status for a specific user in the Dialpad system. This powerful feature enables programmatic control over a user’s availability, helping to manage notifications and improve focus time. The endpoint can be used to enable or disable DND for an individual user, and optionally within the context of a specific group (such as a call center, department, or office). This granular control makes it ideal for implementing custom availability management solutions or integrating with external scheduling systems. Keep in mind that changing a user’s DND status may affect their ability to receive incoming communications, so use this endpoint judiciously and in accordance with your organization’s communication policies.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
integer
The ID of the group which the user”s DND status will be updated for.
string ("callcenter" | "department" | "office")
The type of the group which the user”s DND status will be updated for.
boolean
required
Determines if DND is ON or OFF.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_TOGGLE_VI_CALL_FOR_USER_BY_IDTurns Voice Intelligence on or off for a user’s currently active call. The user must have an active call.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
boolean
Whether or not call vi should be enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_TRANSFER_CALL_TO_DESTINATIONTransfers an active call within the Dialpad system to a new destination. This endpoint allows for flexible call routing by enabling transfers to another ongoing call, a specific phone number, or a predefined target within the Dialpad ecosystem (such as a call center, department, office, or user). It provides options to specify the transfer state and attach custom data to the call. Use this endpoint when you need to programmatically redirect an ongoing call, implement call forwarding logic, or integrate Dialpad’s call transfer functionality into your application’s workflow. Note that the success of the transfer may depend on the availability and settings of the destination.

Input Parameters

string
required
The call”s id.
object
Destination of the call that will be transfer. It can be a single option between a number, an existing call or a target
string
Extra data to associate with the call. This will be passed through to any subscribed call events.
string ("hold" | "parked" | "preanswer" | "voicemail")
The state which the call should take when it”s transferred to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UNASSIGN_ACCESS_CONTROL_POLICY_FROM_USERUnassigns one or all target groups associated with a user for a Dialpad access control policy. Requires a company admin API key.

Input Parameters

integer
required
The access control policy”s id.
integer
required
The user”s id to be assigned to the policy.
integer
Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy or if unassign_all is True.
string ("callcenter" | "company" | "office")
Policy permissions applied at this target level. Defaults to company target type.
boolean
Unassign all associated target groups from the user for a policy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UNASSIGN_OFFICE_NUMBERUnassigns a phone number from an office mainline. The number returns to the company’s reserved pool if one exists; otherwise it is released.

Input Parameters

string
required
The office”s id.
string
required
A phone number to unassign. (e164-formatted)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UNASSIGN_ROOM_PHONE_NUMBERUnassigns a phone number from a room. The number returns to the company’s reserved pool if one exists; otherwise it is released.

Input Parameters

string
required
The room”s id.
string
required
A phone number to unassign. (e164-formatted)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UNASSIGN_USER_PHONE_NUMBERUnassigns a specified phone number from a user. The number returns to the company’s reserved block if one exists; otherwise it is released.

Input Parameters

integer
required
The user”s id. (“me” can be used if you are using a user level API key)
string
required
A phone number to unassign. (e164-formatted)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UNPARK_CALL_BY_USER_IDUnparks a call previously parked on an office mainline, routing it to the specified user.

Input Parameters

string
required
The call”s id.
integer
required
The id of the user who should unpark the call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_CALL_CENTER_SETTINGS_BY_IDUpdates a call center’s settings by ID, including hours, routing, hold queues, alerts, recording, and voice intelligence. Requires a company admin API key.

Input Parameters

integer
required
The call center”s id.
string
[single-line only] The name of the call center. Max 100 characters.
boolean
The time frame when the call center wants to receive calls. Default value is false, which means the call center will always take calls (24/7).
array
The Friday hours of operation. Default value is [“08:00”, “18:00”].
array
The Monday hours of operation. To specify when hours_on is set to True. e.g. [“08:00”, “12:00”, “14:00”, “18:00”] => open from 8AM to Noon, and from 2PM to 6PM. Default value is [“08:00”, “18:00”].
integer
The number of seconds to allow the group line to ring before going to voicemail. Choose from 10 seconds to 45 seconds. Default is 30 seconds.
array
The Sunday hours of operation. Default is empty array.
array
The Tuesday hours of operation. Default value is [“08:00”, “18:00”].
array
The Saturday hours of operation. Default is empty array.
array
The Thursday hours of operation. Default value is [“08:00”, “18:00”].
array
The Wednesday hours of operation. Default value is [“08:00”, “18:00”].
string
The description of the call center. Max 256 characters.
integer
Alert supervisors when the service level drops below how many percent. Default is 95%.
array
DTMF menu options.
integer
If all operators are busy on other calls, send callers to a hold queue. This is to specify your queue size. Choose from 1-1000. Default is 50.
boolean
Whether or not to allow callers to be placed in your hold queue when no agents are available. Default is False.
array
DTMF menu options.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Whether or not to let callers know their place in the queue. This option is not available when a maximum queue wait time of less than 2 minutes is selected. Default is True.
integer
Maximum queue wait time in seconds. Choose from 30s to 18000s (3 hours). Default is 900s (15 min).
string
Allow callers to exit the hold queue to voicemail by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is *.
string ("bridge_target" | "company_directory" | "department" | "directory" | "disabled" | "extension" | "menu" | "message" | "operator" | "person" | "scripted_ivr" | "voicemail")
The action that should be taken if no operators are available.
boolean
Auto start Vi for this call center. Default is True.
boolean
Allow individual users to start and stop Vi during calls. Default is True.
string
Allow callers to request a callback when the queue has more than queue_callback_threshold number of calls by pressing one of the followings: [0,1,2,3,4,5,6,7,8,9,*,#]. Default is 9.
integer
Inbound calls should be answered within how many seconds. Default is 60.
boolean
Whether or not to allow callers to request a callback. Default is False.
integer
Allow callers to request a callback when the queue has more than this number of calls. Default is 5.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
Include a post-call wrap-up time before agents can receive their next call. Default is 0.
integer
The ID of the Target that inbound calls should be routed to.
string ("fixedorder" | "longestidle" | "mostskilled" | "random" | "roundrobin" | "simultaneous")
The routing strategy that should be used when dialing operators.
integer
Hold announcement interval wait time. Default is 2 min.
boolean
Whether or not to allow existing calls to stay in queue after the call center has closed. Default is False.
integer
The ID of the Target that inbound calls should be routed to.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "contact" | "contactgroup" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The type of the Target that inbound calls should be routed to.
boolean
Whether operators should be dialed on inbound calls.
boolean
Whether or not inbound calls to this call center get automatically recorded. Default is False.
boolean
Whether or not outbound calls from this call center get automatically recorded. Default is False.
boolean
Allow agents to stop/restart a recording during a call. Default is False.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_CALL_SUBSCRIPTION_BY_IDUpdates a call event subscription’s call states, active status, logging endpoint and event filters. If enabled is omitted, the request sends it as true.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully.
boolean
Whether or not the call event subscription is enabled.
integer
The ID of the specific target for which events should be sent.
array
The call event subscription”s list of call states.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target type.
boolean
Call event subscription for group calls only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_CONTACT_INFORMATIONCreates or updates a shared Dialpad contact using a unique identifier. First and last name are required; company, contact information, job details, and URLs can also be supplied.

Input Parameters

string
required
The unique id to be included as part of the contact”s generated id.
array
A list of websites associated with or belonging to this contact.
array
The contact”s emails. The first email in the list is the contact”s primary email.
array
The contact”s phone numbers. The phone number must be in e164 format. The first number in the list is the contact”s primary phone.
string
The contact”s extension number.
string
[single-line only] The contact”s job title.
string
required
[single-line only] The contact”s last name.
string
required
[single-line only] The contact”s first name.
string
[Deprecated]
string
[single-line only] The contact”s company name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_CONTACT_SUBSCRIPTION_BY_IDUpdates a Dialpad contact event subscription by ID, setting its contact type and enabled status and optionally associating a different logging endpoint. The enabled status defaults to true when omitted.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully.
boolean
Whether or not the contact event subscription is enabled.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
string ("local" | "shared")
required
The contact type this event subscription subscribes to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_E911_ADDRESS_FOR_OFFICEThis endpoint updates the Enhanced 911 (E911) address for a specific office in Dialpad. It allows you to modify crucial location information used by emergency services to accurately locate the office in case of an emergency call. The endpoint can update the address for the office itself and optionally for all users associated with that office. It also provides an option to validate the address using Dialpad’s service, ensuring the highest possible accuracy for emergency response. Use this endpoint when setting up a new office, relocating an existing office, or correcting address information. It’s particularly important for maintaining compliance with E911 regulations and ensuring employee safety.

Input Parameters

string
required
The office”s id.
string
required
[single-line only] Zip code of the new E911 address.
string
required
[single-line only] City of the new E911 address.
string
required
[single-line only] State or Province of the new E911 address.
string
required
[single-line only] Line 1 of the new E911 address.
string
required
Country of the new E911 address.
string
[single-line only] Line 2 of the new E911 address.
boolean
Update E911 for all users in this office.
boolean
Whether to use the validated address option from our service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_E911_ADDRESS_FOR_USERUpdates the E911 address for a specified user in the Dialpad system. This endpoint allows you to modify the emergency location information associated with a user’s account, ensuring accurate dispatch of emergency services if needed. The updated address will be used for E911 services, which provide precise location data to emergency responders. This tool should be used when a user’s physical location changes or when correcting inaccurate E911 address information. It’s crucial for maintaining compliance with E911 regulations and ensuring user safety. The endpoint requires detailed address information and offers an option for address validation to improve accuracy.

Input Parameters

integer
required
The user”s id. (“me” can be used if you are using a user level API key)
string
required
[single-line only] Zip of the new E911 address.
string
required
[single-line only] City of the new E911 address.
string
required
[single-line only] State or Province of the new E911 address.
string
required
[single-line only] Line 1 of the new E911 address.
string
required
Country of the new E911 address.
string
[single-line only] Line 2 of the new E911 address.
boolean
Whether to use the validated address option from our service.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_IVR_DETAILS_BY_IDUpdates the name and/or description of a custom IVR recording by ID. This changes the recording’s metadata, not its assignment or audio.

Input Parameters

string
[single-line only] The name of this IVR.
string
required
The ID of the custom ivr to be updated.
string
[single-line only] The description of the IVR.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_OPERATOR_DUTY_STATUSUpdates an operator’s duty status and optionally its reason for all call centers the user belongs to.

Input Parameters

integer
required
The operator”s user id.
boolean
required
True if this status message indicates an “on-duty” status.
string
[single-line only] A description of this status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_ROOM_DETAILSUpdates the configuration of a specific Dialpad room identified by its ID. This endpoint allows you to modify the room’s name and manage its assigned phone numbers. Use this when you need to rename a room, update its phone number assignments, or reorder existing phone numbers. The endpoint is particularly useful for maintaining accurate room information and adjusting telephony settings as your organization’s needs change. Note that this is a partial update operation, so only the fields you provide will be modified. Be cautious when updating phone numbers, as reordering or removing numbers from the list will affect their assignment to the room.

Input Parameters

string
required
The room”s id.
string
[single-line only] The name of the room.
array
A list of all phone numbers assigned to the room. Numbers can be re-ordered or removed from this list to unassign them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_SCHEDULE_REPORT_SETTINGSUpdates an existing scheduled report subscription’s frequency, timing, type, target, and delivery settings. The request requires the core schedule details and sends enabled and coaching-group values even when omitted.

Input Parameters

integer
required
Hour of the day when the report will execute considering the frequency and timezones between 0 and 23 e.g. 10 will be 10:00 am.
string
required
The schedule reports subscription”s ID.
string
required
[single-line only] The name of the schedule reports.
integer
required
The day of the week or month when the report will execute considering the frequency. daily=0, weekly=0-6, monthly=0-30.
boolean
Whether or not this schedule reports event subscription is enabled.
string
Timezone using a tz database name.
string ("daily" | "monthly" | "weekly")
required
How often the report will execute.
integer
The target”s id.
integer
required
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully.
string ("call_logs" | "daily_statistics" | "recordings" | "user_statistics" | "voicemails")
required
The type of report that will be generated.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
Target”s type.
boolean
Whether the the statistics should be for trainees of the coach group with the given target_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_SMS_SUBSCRIPTION_SETTINGSUpdates an SMS event subscription by ID, including direction, endpoint and target settings. Omitted enabled, include_internal and status values are sent as true, false and false respectively.

Input Parameters

string
required
The event subscription”s ID, which is generated after creating an event subscription successfully.
boolean
Whether or not to update on each SMS delivery status.
boolean
Whether or not the SMS event subscription is enabled.
string ("all" | "inbound" | "outbound")
The SMS direction this event subscription subscribes to.
integer
The ID of the specific target for which events should be sent.
integer
The logging endpoint”s ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.
string ("callcenter" | "callrouter" | "channel" | "coachinggroup" | "coachingteam" | "department" | "office" | "room" | "staffgroup" | "unknown" | "user")
The target”s type.
boolean
Whether or not to trigger SMS events for SMS sent between two users from the same company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_UPDATE_USER_INFORMATION_BY_IDThis endpoint allows you to update various aspects of a user’s profile and settings in the Dialpad system. It provides comprehensive control over user management, including personal information, administrative roles, communication settings, and account status. Use this endpoint when you need to modify existing user data, such as changing contact details, adjusting administrative privileges, updating license types, or managing phone numbers and extensions. The endpoint is particularly useful for keeping user information up-to-date and managing user access within the Dialpad platform. Note that some changes, like updating license types or office assignments, may have billing implications. Ensure you have the necessary permissions and understand the impact of changes before using this endpoint.

Input Parameters

string
required
The user”s id. (“me” can be used if you are using a user level API key)
string ("active" | "suspended" | "cancelled" | "deleted" | "pending")
The user”s state. This is used to suspend or re-activate a user.
array
The user”s emails. This can be used to add, remove, or re-order emails. The first email in the list is the user”s primary email.
string ("admins" | "agents" | "dpde_all" | "dpde_one" | "lite_lines" | "lite_support_agents" | "magenta_lines" | "talk" | "user")
The user”s license type. Changing this affects billing for the user. For a Sell license, specify the type as agents. For a Support license, specify the type as support.
string
The user”s new extension number. Extensions are optional in Dialpad and turned off by default. If you want extensions please contact support to enable them.
string
[single-line only] The user”s job title.
string
[single-line only] The user”s last name.
integer
The user”s office id. If provided, the user will be moved to this office. For international offices, the user must not have phone numbers assigned. Once the transfer is complete, your admin can add the phone numbers via the user assign number API. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office. Example: “123”.
string
[single-line only] The user”s first name.
array
A list of the phone number(s) assigned to this user. This can be used to re-order or remove numbers. To assign a new number, use the assign number API instead.
boolean
Whether or not the user is a super admin. (company level administrator)
array
The list of admin office IDs. This is used to set the user as an office admin for the offices with the provided IDs. Example: [“123”, “456”].
boolean
Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license.
array
A list of phone numbers that should be dialed in addition to the user”s Dialpad number(s) upon receiving a call.
string ("conference" | "default")
Predefined templates will be only used for the supported types. Accepts the following types: - default — status message template: “{provider}: {message}” - conference — status message template: “On {provider}: in the {message} meeting” provider and message should be chosen with the message template in mind.
string
The presence status message to be updated.
string
The provider requesting the presence status update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: DIALPAD_VALIDATE_CALLBACK_REQUESTValidates a callback request for the Dialpad system. This endpoint is used to check if a callback can be successfully initiated for a given call center and phone number. It helps ensure that the necessary information is correct and available before actually placing the callback. Use this endpoint when you need to verify the validity of a callback request, such as before scheduling or queuing a callback. The endpoint does not initiate the actual callback; it only performs validation. Note that both parameters are optional, allowing for flexible validation scenarios, but providing both ensures the most comprehensive validation.

Input Parameters

string
The e164-formatted number to call back
integer
The ID of a call center that will be used to fulfill the callback. Example: “123”.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not