Access control policies listing
Lists the authenticated company's access control policies, including their permission sets. Results can be paginated using a cursor.
ActionTry it
Integrate Dialpad
with your AI CRM
Dialpad is a cloud-based business phone system and contact center platform that enables voice, video, messages and meetings across your existing devices
Explore Triggers and Actions
Add blocked phone numbers
Adds 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
Add operator to office
Adds a user or room as an operator to an office's mainline, with an optional operator or admin role.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
Assign phone number to target
Assigns 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.
ActionTry it
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 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.
ActionTry it
Assign policy to user by id
Assigns an access control policy to a user at company, office, or contact center level. Requires a company admin API key.
ActionTry it
Attach labels to call
Adds labels to a specified call, preserving existing labels. Labels already present are not duplicated.
ActionTry it
Configure call center settings
Creates 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
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 particularly useful for sharing important call information, training materials, or for compliance purposes. The function provides control over the privacy level of the shared content, allowing for secure sharing within an organization or broader distribution as needed.
ActionTry it
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, 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.
ActionTry it
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 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.
ActionTry it
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 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.
ActionTry it
Create custom ivr with audio file
Creates 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.
ActionTry it
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, with some fields restricted to single-line entries for consistency.
ActionTry it
Create new department record
Creates a department in a specified office with optional call handling, operating hours, routing, and voice intelligence settings. Requires a company admin API key.
ActionTry it
Create pin for international room calls
Creates a PIN for protected international calls from Dialpad room phones, optionally associating a customer reference for usage reporting.
ActionTry it
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 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.
ActionTry it
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. 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.
ActionTry it
Create secondary office
Creates 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.
ActionTry it
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 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.
ActionTry it
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-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.
ActionTry it
Create webhook post endpoint
Creates a Dialpad webhook endpoint with a URL and optional signing secret. The resulting webhook ID is used when creating event subscriptions.
ActionTry it
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, 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.
ActionTry it
Delete access control policy by id
Deletes an access control policy by ID, marking it deleted and removing its associated users. Requires a company admin API key.
ActionTry it
Delete agent status by id
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 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.
ActionTry it
Delete call center by id
Deletes a specified Dialpad call center by ID. Requires a company admin API key.
ActionTry it
Delete call subscription by id
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 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.
ActionTry it
Delete callreviewsharelink by id
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 is permanent and should be used when you want to immediately prevent further access to a shared call review, such as when sensitive information was mistakenly shared or when the review is no longer relevant. Once deleted, the share link cannot be recovered, and anyone attempting to use it will receive an error.
ActionTry it
Delete callrouter by id
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 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.
ActionTry it
Delete channel by id
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 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.
ActionTry it
Delete channel member by id
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 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.
ActionTry it
Delete contact by id
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 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.
ActionTry it
Delete customivr by targettype and ivrtype
Unassigns 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.
ActionTry it
Delete department resource
Permanently deletes a Dialpad department by ID, removing the department and all its configuration. Requires a company admin API key.
ActionTry it
Delete deskphone by user id
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 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.
ActionTry it
Delete deskphone in room
Deletes a specific Dialpad room desk phone by room ID and desk phone ID.
ActionTry it
Delete number via api
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 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.
ActionTry it
Delete office operator by id
Removes a specified user or room operator from an office's mainline using the operator ID and type.
ActionTry it
Delete operator from call center
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 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.
ActionTry it
Delete operator from department
Removes 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.
ActionTry it
Delete recording share link by id
Deletes a specific recording share link in the Dialpad system. This endpoint is used to revoke access to a shared recording by removing the associated link. It should be called when you want to prevent further access to a recording through a previously generated share link. This action is permanent and cannot be undone, so use it cautiously. The endpoint is particularly useful for maintaining privacy and controlling access to sensitive or outdated recorded content.
ActionTry it
Delete room by id
Deletes 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.
ActionTry it
Delete schedule report by id
Deletes a scheduled report subscription by ID, stopping its recurring report schedule.
ActionTry it
Delete sms subscription by id
Deletes an SMS event subscription by its subscription ID.
ActionTry it
Delete subscription changelog by id
Deletes a change log event subscription by ID. Requires a company admin API key and the change_log scope.
ActionTry it
Delete subscription contact by id
Deletes a contact event subscription by its subscription ID.
ActionTry it
Delete user by id
Deletes 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.
ActionTry it
Delete webhook by id
Deletes a Dialpad webhook by its ID, stopping delivery to that webhook endpoint.
ActionTry it
Delete websocket connection by id
Closes 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.
ActionTry it
Fetch call byid
Retrieves detailed information for a concluded Dialpad call by ID, including call status, duration, and available recording and transcription information.
ActionTry it
Fetch call transcript by id
Retrieves 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.
ActionTry it
Fetch custom ivrs
Lists custom IVR recordings for a specified Dialpad target, with cursor pagination.
ActionTry it
Fetch operators for office id
Retrieves the mainline operators for a specified Dialpad office, including available operator details and status.
ActionTry it
Fetch scheduled reports
Lists scheduled report subscriptions for the company, with a cursor for pagination. It returns schedule metadata rather than report content.
ActionTry it
Fetch transcript url by call id
Retrieves 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.
ActionTry it
Fetch user details by id
Retrieves 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.
ActionTry it
Format phone numbers
Reformats 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.
ActionTry it
Get available licenses for an office
Retrieves 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.
ActionTry it
Get call center status by id
Retrieves 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.
ActionTry it
Get call labels
Retrieves 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.
ActionTry it
Get call review share link by id
Retrieves an existing call review share link, including its access link and privacy state when available.
ActionTry it
Get call subscription details
Lists Dialpad call event subscriptions for the company or a specified target. Use cursor pagination to review existing subscriptions and their event notification settings.
ActionTry it
Get channel members by id
Retrieves 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.
ActionTry it
Get departments by office id
Retrieves 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.
ActionTry it
Get deskphone by parent id
Retrieves 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.
ActionTry it
Get deskphones for user parent id
Lists deskphones associated with a specified Dialpad user. Returned deskphone entries contain their IDs.
ActionTry it
Get deskphones in rooms
Lists deskphones associated with a specified Dialpad room, including available name, state, and phone number information.
ActionTry it
Get office call centers
Retrieves 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.
ActionTry it
Get operator skills by call center and user
Retrieves an operator's skill level for a specified call center.
ActionTry it
Get phone number details
Retrieves details for a specific Dialpad phone number, including its status and assignment when available. Requires a company admin API key.
ActionTry it
Get recording share link by id
Retrieves a recording share link by ID, including its access link, associated call ID, and privacy state when available.
ActionTry it
Get rooms list
Lists company rooms, optionally filtered by office, with cursor pagination. Returned room information can include names and contact details.
ActionTry it
Get subscription contact by id
Retrieves a contact event subscription by its subscription ID, including its enabled state and available delivery endpoint configuration.
ActionTry it
Get user caller id
Retrieves 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.
ActionTry it
Get user deskphones
Retrieves 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.
ActionTry it
Get user e911 details
Retrieves 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.
ActionTry it
Get webhooks information
Lists webhooks associated with the company, with cursor pagination. The results contain webhook endpoint details and signature settings.
ActionTry it
Hangup call via id
Terminates 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.
ActionTry it
Initiate ivr call api endpoint
Initiates 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.
ActionTry it
Initiate outbound call via api
Initiates 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.
ActionTry it
Initiate user call with group options
Causes 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.
ActionTry it
List channels api
Lists company channels, optionally filtered by state. Results are paginated using a cursor.
ActionTry it
List conference rooms
Lists Dialpad meeting rooms with cursor pagination. Requires the conference:read scope.
ActionTry it
List offices endpoint
Lists 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.
ActionTry it
List users
Retrieves 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.
ActionTry it
Modify contact details using id
Updates 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.
ActionTry it
Modify custom ivr settings
Assigns 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.
ActionTry it
Modify operator skill level
Updates 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.
ActionTry it
Modify webhook configuration
Updates 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.
ActionTry it
Move user to specified office
Moves 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.
ActionTry it
Oauth2 authorize endpoint
Initiates 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.
ActionTry it
Patch access control policy by id
Updates an access control policy by ID, including its name, description, permissions, or state. Requires a company admin API key.
ActionTry it
Patch agent status event subscription
Updates 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.
ActionTry it
Patch call router by id
Updates 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.
ActionTry it
Patch department details by id
Updates 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.
ActionTry it
Patch subscription changelog endpoint
Updates 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.
ActionTry it
Patch user active call recording
Updates 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.
ActionTry it
Patch user status
Updates a user's status message, optionally specifying an expiration time, and returns the user's status if the user exists.
ActionTry it
Patch websocket signature secret
Updates the signature secret for a specified Dialpad WebSocket endpoint, for example to rotate the secret used to verify event payloads.
ActionTry it
Post call event subscription
Creates 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.
ActionTry it
Post recording share link
Creates 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.
ActionTry it
Post subscription change log event
Creates a company change log event subscription for a webhook or websocket endpoint, with an enabled setting. Requires the change_log scope.
ActionTry it
Post users screenpop uri
Triggers 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.
ActionTry it
Post websocket connection secret
Creates a Dialpad websocket endpoint for receiving event notifications, optionally specifying a signature secret. Connect to the returned websocket URL to receive event payloads.
ActionTry it
Reassign phone number to target
Assigns 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.
ActionTry it
Redeem access or refresh token
Sends a request to Dialpad's OAuth token endpoint. The action does not accept an authorization code, refresh token, or grant type as input.
ActionTry it
Remove blocked numbers
Unblocks specified phone numbers company-wide, restoring inbound calls and texts from them. The numbers can be blocked again.
ActionTry it
Retrieve access control policy assignments
Lists users assigned to a specified Dialpad access control policy, along with their associated policy targets. Results can be paginated using a cursor.
ActionTry it
Retrieve access control policy by id
Retrieves 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.
ActionTry it
Retrieve agent status by id
Retrieves an agent status event subscription by ID, including its agent type, enabled state, and webhook or websocket configuration. Requires a company admin API key.
ActionTry it
Retrieve agent status subscription
Lists 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.
ActionTry it
Retrieve app settings
Retrieves OAuth app settings for a specified target, or company app settings when target type and ID are not provided.
ActionTry it
Retrieve blocked number details
Checks 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.
ActionTry it
Retrieve blocked phone numbers
Lists company-wide phone numbers blocked through the Dialpad API. Results are paginated using a cursor; numbers blocked by other means are not included.
ActionTry it
Retrieve call center by id
Retrieves 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.
ActionTry it
Retrieve call centers information
Lists 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.
ActionTry it
Retrieve call information
Lists 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.
ActionTry it
Retrieve call routers v2 api
Retrieves 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.
ActionTry it
Retrieve call subscription by id
Retrieves a call event subscription by ID, including its enabled status and associated webhook or websocket configuration when available.
ActionTry it
Retrieve callcenter operators by id
Retrieves 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.
ActionTry it
Retrieve callrouter by id
Retrieves 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.
ActionTry it
Retrieve channel by id
Retrieves a Dialpad channel by its unique identifier, returning its ID and name.
ActionTry it
Retrieve coaching stats v2
Starts 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.
ActionTry it
Retrieve coaching team by id
Retrieves a coaching team by ID, including its name, associated office and company, and available descriptive metadata.
ActionTry it
Retrieve coaching teams information
Lists coaching teams in the company, with team identifiers, names, office and company identifiers, and available descriptive metadata. Results support cursor pagination.
ActionTry it
Retrieve company data
Retrieves 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.
ActionTry it
Retrieve conference meetings
Lists summaries of past Dialpad meetings for a meeting room, with cursor pagination. Requires the conference:read scope.
ActionTry it
Retrieve contact by id
Retrieves a single Dialpad contact by ID, including available contact details. Only shared and local contacts can currently be retrieved.
ActionTry it
Retrieve contact list
Lists Dialpad company shared contacts or a user's local contacts, with cursor pagination and an option to include local contacts.
ActionTry it
Retrieve department by id
Retrieves a Dialpad department by ID, including its name, company and office IDs, and creation and update timestamps when available.
ActionTry it
Retrieve department operators by id
Retrieves 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.
ActionTry it
Retrieve e911 office details
Retrieves 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.
ActionTry it
Retrieve list of departments
Lists company departments, optionally filtered by office or department name. Results are paginated and include department IDs and available names and office IDs.
ActionTry it
Retrieve members of coaching team by id
Lists members of a specified coaching team, including available user identity, contact, and availability information.
ActionTry it
Retrieve numbers via api v2
Retrieves 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.
ActionTry it
Retrieve off duty status by office id
Lists the off-duty status options configured for a specified office. This retrieves status definitions rather than showing which agents currently use them.
ActionTry it
Retrieve office by id
Retrieves a specified Dialpad office by ID. The returned office model contains the office ID.
ActionTry it
Retrieve office plan by id
Retrieves an office's billing plan, including purchased license counts by line type, remaining calling credit, and the start of the next billing cycle.
ActionTry it
Retrieve operator duty status
Retrieves 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.
ActionTry it
Retrieve room information by id
Retrieves information about a Dialpad room by ID, including its name, state, office, group details, and phone settings when available.
ActionTry it
Retrieve schedule report by id
Retrieves a scheduled report subscription by ID, including its frequency and delivery endpoint ID when available.
ActionTry it
Retrieve sms opt out by company id
Lists a company's external phone numbers filtered by SMS opt-out or opt-back-in state, optionally by A2P campaign. Results are paginated.
ActionTry it
Retrieve sms subscription by id
Retrieves an SMS event subscription by ID, including its direction and available delivery endpoint and target settings.
ActionTry it
Retrieve sms subscriptions
Lists SMS event subscriptions for a company or target, with optional target filtering and cursor pagination.
ActionTry it
Retrieve specific webhook by id
Retrieves a webhook configuration by ID, including its URL and available signature settings.
ActionTry it
Retrieve stat by id
Retrieves the progress and result of a previously initiated statistics request by its request ID.
ActionTry it
Retrieve subscription change log
Lists a company's change log event subscriptions with cursor pagination. Requires a company admin API key and the change_log scope.
ActionTry it
Retrieve subscription change log by id
Retrieves a change log event subscription by ID. Requires a company admin API key and the change_log scope.
ActionTry it
Retrieve subscription contacts
Lists a company's contact event subscriptions, with cursor pagination.
ActionTry it
Retrieve teams for office id
Lists coaching teams associated with a specified Dialpad office, with cursor-based pagination.
ActionTry it
Retrieve user device by id
Retrieves 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.
ActionTry it
Retrieve user devices list
Lists registered user devices, such as desk phones, softphones, and mobile apps. Supports a user ID filter and cursor pagination.
ActionTry it
Retrieve user personas by id
Retrieves 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.
ActionTry it
Retrieve websocket by id
Retrieves 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.
ActionTry it
Retrieve websocket connection
Lists 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.
ActionTry it
Send sms with optional media and group sender
The 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.
ActionTry it
Set user caller id by id
Sets 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.
ActionTry it
Subscribe contact event
Creates 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.
ActionTry it
Toggle user do not disturb status
The 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.
ActionTry it
Toggle vi call for user by id
Turns Voice Intelligence on or off for a user's currently active call. The user must have an active call.
ActionTry it
Transfer call to destination
Transfers 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.
ActionTry it
Unassign access control policy from user
Unassigns one or all target groups associated with a user for a Dialpad access control policy. Requires a company admin API key.
ActionTry it
Unassign office number
Unassigns a phone number from an office mainline. The number returns to the company's reserved pool if one exists; otherwise it is released.
ActionTry it
Unassign room phone number
Unassigns a phone number from a room. The number returns to the company's reserved pool if one exists; otherwise it is released.
ActionTry it
Unassign user phone number
Unassigns a specified phone number from a user. The number returns to the company's reserved block if one exists; otherwise it is released.
ActionTry it
Unpark call by user id
Unparks a call previously parked on an office mainline, routing it to the specified user.
ActionTry it
Update call center settings by id
Updates a call center's settings by ID, including hours, routing, hold queues, alerts, recording, and voice intelligence. Requires a company admin API key.
ActionTry it
Update call review share link privacy
Updates the privacy settings of an existing call review share link in Dialpad. This endpoint allows you to modify the accessibility of a shared call recording, controlling whether it can be viewed only by company members or by anyone with the link. Use this when you need to adjust the visibility of a previously shared call review, either to increase security by limiting access to the company or to allow broader access by making it public. It's particularly useful for managing sensitive information in call recordings or adapting to changing collaboration needs. Note that this endpoint only modifies the privacy settings and does not create new share links or alter the content of the call review itself.
ActionTry it
Update call subscription by id
Updates a call event subscription's call states, active status, logging endpoint and event filters. If enabled is omitted, the request sends it as true.
ActionTry it
Update contact information
Creates 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.
ActionTry it
Update contact subscription by id
Updates 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.
ActionTry it
Update e911 address for office
This 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.
ActionTry it
Update e911 address for user
Updates 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.
ActionTry it
Update ivr details by id
Updates the name and/or description of a custom IVR recording by ID. This changes the recording's metadata, not its assignment or audio.
ActionTry it
Update operator duty status
Updates an operator's duty status and optionally its reason for all call centers the user belongs to.
ActionTry it
Update recording share link privacy
Updates the privacy settings of a specific recording share link in Dialpad. This endpoint allows you to modify who can access a shared call recording by changing its privacy state. Use this when you need to adjust the visibility of a recording, such as making it public for external sharing or restricting it to company-only access. The endpoint requires the ID of the recording share link to be updated, which should be provided in the URL path. Note that this operation only changes the privacy settings and does not create or delete the share link itself.
ActionTry it
Update room details
Updates 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.
ActionTry it
Update schedule report settings
Updates 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.
ActionTry it
Update sms subscription settings
Updates 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.
ActionTry it
Update user information by id
This 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.
ActionTry it
Validate callback request
Validates 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.
ActionTry it
How the Dialpad integration works
The Dialpad integration connects your Dench AI CRM directly to Dialpad, so agents can read and act on your Dialpad data as part of everyday work — answering questions in chat, keeping your CRM in sync, and running automations without anyone copying data between tools.
192 actions are available for agents to invoke on your behalf. Every call runs through Dialpad's own authorization, scoped to the account you connect.
Set up Dialpad in Dench
- 1
Sign in to your Dench workspace and open Integrations.
- 2
Find Dialpad and click Connect — you'll authorize access through Dialpad's own sign-in flow. No API keys or code required.
- 3
Ask an agent to use Dialpad in chat, or call it from an automation.
- 4
Manage or disconnect the connection any time from workspace settings.
Frequently asked questions
How does the Dialpad integration work with Dench?
The Dench Dialpad integration connects your AI CRM to Dialpad, so AI agents can work with your Dialpad data as part of chats, automations, and CRM workflows. You connect your account once, and every agent in your workspace can use it — governed by your workspace permissions.
What actions can AI agents perform with Dialpad via Dench?
The Dialpad integration currently exposes 192 actions, including Access control policies listing, Add blocked phone numbers, Add department operator by id, Add member to channel, Add member to coaching team, and Add operator to call center. Agents invoke them on your behalf from chat or from automations.
Do I need to write code to connect Dialpad to Dench?
No. You connect Dialpad from your Dench workspace using Dialpad's own sign-in and authorization flow — no API keys to copy, no glue code to maintain.
Is the Dialpad integration secure?
Connections are authorized through Dialpad's own authentication flow, and Dench stores only the authorization needed to act on your behalf. You can review and disconnect the Dialpad connection from your workspace settings at any time.