Dialpad

Tools

• Access control policies listing

  Retrieves a list of access control policies for the authenticated dialpad company. this endpoint allows company administrators to view all custom sets of permissions defined for ai contact center settings. it should be used when auditing ex

• Add blocked phone numbers

  Adds specified phone numbers to the blocked list in dialpad. this endpoint allows users to block unwanted or spam numbers, preventing incoming calls or messages from these numbers. it accepts a list of e.164 formatted phone numbers and adds

• Add department operator by id

  Adds 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

• Add member to channel

  Adds 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 programm

• Add member to coaching team

  Adds 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

• Add operator to call center

  This 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 suppor

• Add operator to office

  This endpoint adds a new operator to a specific office within the dialpad system. it allows administrators to assign users or rooms as operators, enhancing the office's communication capabilities. the endpoint requires the office id (specif

• Add participant to call

  Adds 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

• Assign fax line to target

  Creates 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 numb

• Assign number to call router

  This 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 regio

• Assign phone number to office

  This 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 t

• Assign phone number to room

  Assigns 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 additio

• Assign phone number to target

  Assigns a phone number to a specified target within the dialpad system. this endpoint allows you to either assign a specific number or request a number from a given area code. it can be used to add new numbers to various entities such as us

• Assign phone number to user

  This 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 us

• Assign policy to user by id

  Assigns an access control policy to a specific user within the dialpad system. this endpoint allows administrators to grant customized settings permissions to users at various levels of the organization: company-wide, for specific offices,

• Attach labels to call

  Creates or updates labels for a specific call in the dialpad system. this endpoint allows you to attach one or more labels to a call, which can be used for categorization, filtering, or tracking purposes. the function takes a call id and an

• Configure call center settings

  This endpoint creates a new call center within the dialpad system with customizable settings for call handling, routing, operational hours, and advanced features. it allows for detailed configuration of call center behavior, including auto-

• Create access control policy

  Creates 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 use

• Create agent status subscription

  Creates 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 av

• Create callback

  Creates 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 ap

• Create call review share link

  Creates a shareable link for a specific call review in the dialpad platform. this endpoint allows users to generate a url that can be used to share call recordings or summaries with others, either within the company or publicly. it's partic

• Create call router configuration

  Creates 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, an

• Create channel endpoint

  Creates 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 communicat

• Create custom ivr with audio file

  Creates a new custom interactive voice response (ivr) system within the dialpad platform. this endpoint allows you to define and configure an ivr workflow by specifying its type, associated audio file, and target assignment. use this when s

• Create new contact entry

  The 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

• Create new department record

  Creates a new department within the dialpad system with customizable settings for call handling, operating hours, and advanced features. this endpoint allows for detailed configuration of department properties, including automatic call reco

• Create pin for international room calls

  Creates a pin for protected international calls from a dialpad room. this endpoint generates a unique pin that can be used to authenticate and authorize international calls made from a specific dialpad room. it's particularly useful for bus

• Create room in office via post

  Creates 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 asso

• Create schedule reports endpoint

  Creates 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. i

• Create secondary office

  Creates a new office within the dialpad system with specified configurations and settings. this endpoint allows you to set up a new office location or entity, including its billing information, operational hours, routing options, and variou

• Create sms event subscription

  Creates 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

• Create user with auto assign

  Creates 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-assi

• Create webhook post endpoint

  Creates a new webhook integration for receiving real-time event notifications from dialpad. this endpoint allows you to specify a url where dialpad will send event data when specific actions occur within the dialpad system. it's essential f

• Deauthorize oauth2 session

  Deauthorizes (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, w

• Delete access control policy by id

  destructive

  Deletes a specific access control policy from the dialpad system. this endpoint allows company administrators to remove custom permission settings that were previously created for managing user roles and access within the dialpad platform.

• Delete agent status by id

  destructive

  Deletes 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

• Delete call center by id

  destructive

  Deletes a specific call center from the dialpad system. this endpoint should be used when you need to permanently remove a call center from your dialpad account. it's important to note that this action is irreversible and will affect all as

• Delete callreviewsharelink by id

  destructive

  This endpoint deletes a specific call review share link in the dialpad system. it's used to revoke access to a previously shared call review, ensuring that the link can no longer be used to view the associated call information. this action

• Delete callrouter by id

  destructive

  Deletes 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 de

• Delete call subscription by id

  destructive

  Deletes 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

• Delete channel by id

  destructive

  Deletes 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 ass

• Delete channel member by id

  destructive

  Removes 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

• Delete contact by id

  destructive

  Deletes 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

• Delete customivr by targettype and ivrtype

  destructive

  Deletes a custom interactive voice response (ivr) configuration from a specified target in the dialpad system. this endpoint is used to remove ivr settings, allowing for the reset or reconfiguration of call routing and automated response sy

• Delete department resource

  destructive

  Deletes a specific department from the dialpad system. this endpoint should be used when you need to remove a department that is no longer needed or has been deprecated within your organization's structure. the operation is irreversible, so

• Delete deskphone by user id

  destructive

  Deletes 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 op

• Delete deskphone in room

  destructive

  This endpoint removes a specific deskphone from a designated room within the dialpad system. it's used to unassign or decommission a deskphone from a particular shared space, such as a conference room or reception area. the operation is per

• Delete number via api

  destructive

  Deletes 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

• Delete office operator by id

  destructive

  Removes a specified operator (user or room) from a particular office in the dialpad system. this endpoint is used to manage the association between operators and offices, allowing administrators to control access and permissions within the

• Delete operator from call center

  destructive

  Removes 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 organizat

Works well with

How Switchy teams use it

Starter prompts

@Dialpad show me the most recent 20 inbound calls, including caller ID and call duration for each.

@Dialpad add +1-555-0142 to the blocked numbers list and confirm once it's saved.

@Dialpad add user ID 78234 as an operator in the Support call center with skill level 3 and a standard license.

@Dialpad list all coaching teams in our account, showing team names and current member counts.

@Dialpad add user ID 91056 as a backup operator for the Sales department and set their role to secondary.

Example outputs

Illustrative - representative of the model's voice and quality, not literal recordings.

Use-case deep-dives

Frequently asked