Team
Shared credential for production and unattended runs.
Connect Dialpad with Hookshot™ and your stack
Dialpad is a cloud-based business phone system and contact center platform that enables voice, video, messages and meetings across your existing devices
Tools and triggers
What Agents can do in Dialpad
Available tools and events after Dialpad is connected.
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
Delete Access Control Policy by Id
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…
-
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…
-
Delete Call Center by Id
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
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…
-
Delete Customivr by Targettype and Ivrtype
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…
-
Delete Department Resource
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…
-
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…
-
Delete Deskphone in Room
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…
-
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…
-
Delete Office Operator by Id
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…
-
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…
-
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…
-
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…
-
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…
-
Delete Schedule Report by Id
Deletes a specific scheduled report from the Dialpad system. This endpoint allows users to permanently remove a previously configured report that was set up for automatic generation and delivery. It should be used when…
-
Delete Sms Subscription by Id
Deletes a specific SMS subscription from the Dialpad system. This endpoint should be used when you want to cancel or remove an existing SMS subscription, such as when a user no longer needs SMS services or wants to…
-
Delete Subscription Changelog by Id
Deletes a specific changelog entry from a subscription in the Dialpad system. This endpoint is used to permanently remove a record of changes made to a subscription, which could include modifications to webhook…
-
Delete Subscription Contact by Id
Deletes a specific subscription contact from the Dialpad system. This endpoint should be used when you need to remove a contact from your subscription list, such as when a user unsubscribes or when cleaning up outdated…
-
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…
-
Delete Webhook by Id
Deletes a specific webhook subscription from the Dialpad platform using its unique identifier. This endpoint should be used when you want to stop receiving real-time event notifications for a particular webhook. It's…
-
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…
-
Fetch Call Byid
Retrieves detailed information about a specific call using its unique identifier. This endpoint allows developers to access comprehensive data about a particular call made through the Dialpad platform. It should be…
-
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…
-
Fetch Custom Ivrs
Retrieves a list of all custom Interactive Voice Response (IVR) configurations associated with the authenticated Dialpad account. This endpoint allows developers to fetch comprehensive details about the custom IVRs set…
-
Fetch Operators for Office Id
Retrieves a list of operators associated with a specific office in Dialpad. This endpoint should be used when you need to get information about the operators managing calls and operations within a particular office…
-
Fetch Scheduled Reports
Retrieves a list of scheduled reports from the Dialpad system. This endpoint allows users to fetch information about reports that have been set up for automatic generation on a regular basis. It's particularly useful…
-
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…
-
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…
-
Format Phone Numbers
The format_phone_number endpoint is used to standardize and format phone numbers within the Dialpad ecosystem. This tool takes a raw phone number input and converts it into a specified or default format, ensuring…
-
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…
-
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…
-
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…
-
Get Call Review Share Link by Id
Retrieves or generates a share link for a specific call review in the Dialpad system. This endpoint allows users to obtain a unique URL that can be used to share call review data, including summaries, transcripts, or…
-
Get Call Subscription Details
Retrieves a list of call subscriptions associated with the authenticated user's account in the Dialpad platform. This endpoint allows developers to fetch details about existing call event subscriptions, which are used…
-
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…
-
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…
-
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…
-
Get Deskphones for User Parent Id
Retrieves a list of deskphones associated with a specific user in the Dialpad system. This endpoint is useful for managing and tracking the deskphone inventory assigned to individual users within an organization. It…
-
Get Deskphones in Rooms
Retrieves a list of deskphones associated with a specific room in the Dialpad system. This endpoint is used to get detailed information about the communication devices deployed in shared spaces such as conference…
-
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…
-
Get Operator Skills by Call Center and User
Retrieves the skill information for a specific operator within a designated call center. This endpoint allows you to access details about an operator's assigned skills, which are crucial for efficient call routing and…
-
Get Phone Number Details
Retrieves detailed information about a specific phone number associated with the Dialpad account. This endpoint allows you to fetch comprehensive data about a single phone number, including its current status, assigned…
-
Get Recording Share Link by Id
Retrieves detailed information about a specific recording share link in the Dialpad system. This endpoint allows you to fetch the current status, settings, and metadata associated with a previously created share link…
-
Get Rooms List
Retrieves a list of all available meeting rooms or spaces within the Dialpad system. This endpoint is essential for managing and organizing video-enabled meetings, allowing users to view and select appropriate meeting…
-
Get Subscription Contact by Id
Retrieves the subscription information for a specific contact in the Dialpad system. This endpoint allows you to access details about a contact's current subscription status, type, and related information. Use this…
-
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…
-
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…
-
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…
-
Get Webhooks Information
Retrieves a list of all webhooks configured for the authenticated user's Dialpad account. This endpoint allows developers to view and manage their existing webhook subscriptions for various communication events such as…
-
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…
-
Initiate Ivr Call Api Endpoint
Initiates an outbound IVR (Interactive Voice Response) call using the Dialpad API. This endpoint allows you to programmatically start a call to a specified phone number from a designated group within your Dialpad…
-
Initiate Outbound Call via Api
The InitiateOutboundCall endpoint allows you to programmatically initiate an outbound call using the Dialpad API. This tool is used to place calls on behalf of a Dialpad user to a specified phone number. It supports…
-
Initiate User Call with Group Options
Initiates an outbound call for a specified Dialpad user. This endpoint allows you to programmatically start a phone call to a given number, with options to customize the call's properties such as the caller ID and…
-
List Channels Api
Retrieves a list of all available communication channels in the Dialpad platform. This endpoint provides an overview of the various channels that can be used for voice, SMS, and other digital engagement methods within…
-
List Conference Rooms
Retrieves a list of conference rooms available in the Dialpad system. This endpoint allows users to fetch information about both virtual and physical conference rooms set up within their Dialpad account. It can be used…
-
List Offices Endpoint
Retrieves a list of offices within the Dialpad platform. This endpoint provides access to office information, which is crucial for managing multiple offices in an organization using Dialpad. It should be used when you…
-
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…
-
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…
-
Modify Custom Ivr Settings
Updates a custom Interactive Voice Response (IVR) configuration for a specific target within the Dialpad system. This endpoint allows you to assign an existing IVR workflow to a particular target (such as a call center…
-
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…
-
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…
-
Move User to Specified Office
Updates a user's office assignment within the Dialpad system. This endpoint allows administrators to move a user from their current office to a different office. It should be used when there's a need to change a user's…
-
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…
-
Patch Access Control Policy by Id
This endpoint allows you to update an existing access control policy in the Dialpad system. It provides the ability to modify various attributes of a policy, including its name, description, associated permissions, and…
-
Patch Agent Status Event Subscription
Updates an existing agent status subscription in the Dialpad system. This endpoint allows you to modify the configuration of a subscription that tracks changes in agent statuses within a contact center environment. Use…
-
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…
-
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…
-
Patch Subscription Changelog Endpoint
Updates an existing change log event subscription in the Dialpad system. This endpoint allows you to modify the status of a subscription and associate it with a specific logging endpoint. Use this when you need to…
-
Patch User Active Call Recording
Updates the call recording settings for an active call of a specific Dialpad user. This endpoint allows real-time management of call recording features during an ongoing call, including enabling or disabling recording…
-
Patch User Status
Updates the status of a specific user in the Dialpad system. This endpoint allows you to set or modify a user's status message and optionally specify an expiration time for that status. It's particularly useful for…
-
Patch Websocket Signature Secret
Updates the signature secret for a specific websocket connection in the Dialpad platform. This endpoint allows you to modify the authentication mechanism used to validate incoming requests to the websocket. Use this…
-
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…
-
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…
-
Post Subscription Change Log Event
Creates or updates a subscription for changelog events in the Dialpad system. This endpoint allows developers to set up real-time notifications for changes and updates within Dialpad, such as API modifications, feature…
-
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…
-
Post Websocket Connection Secret
Creates a websocket connection for real-time communication with the Dialpad platform. This endpoint enables applications to establish a persistent, full-duplex connection for receiving live updates and event…
-
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…
-
Redeem Access or Refresh Token
The OAuth 2.0 token endpoint for Dialpad's API is used to obtain access tokens for authenticating API requests. It supports two grant types: Authorization Code and Refresh Token. For the Authorization Code flow, it…
-
Remove Blocked Numbers
Removes specified phone numbers from the blocked list in the Dialpad system. This endpoint allows you to unblock multiple phone numbers in a single API call, streamlining the process of managing blocked numbers. Use…
-
Retrieve Access Control Policy Assignments
Retrieves the assignments of a specific access control policy in Dialpad. This endpoint allows company administrators to view which users, roles, or groups have been assigned to a particular access control policy. It's…
-
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…
-
Retrieve Agent Status by Id
Retrieves detailed information about a specific agent status subscription using its unique identifier. This endpoint is used to fetch the current configuration and settings of an agent status subscription, which may…
-
Retrieve Agent Status Subscription
Retrieves a list of agent status subscriptions from the Dialpad system. This endpoint allows you to fetch real-time information about the current subscriptions to agent status events. It is useful for monitoring which…
-
Retrieve App Settings
Retrieves the current application settings for the authenticated Dialpad account. This endpoint provides access to various configuration options and preferences set for the Dialpad application. It should be used when…
-
Retrieve Blocked Number Details
Retrieves information about a specific blocked number in the Dialpad system. This endpoint allows users or administrators to check if a particular phone number is currently blocked. It's useful for verifying the status…
-
Retrieve Blocked Phone Numbers
Retrieves a comprehensive list of all phone numbers that have been blocked through the Dialpad API. This endpoint is useful for managing call blocking settings and reviewing the current state of blocked numbers…
-
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…
-
Retrieve Call Centers Information
Retrieves a list of call centers and their associated information from the Dialpad platform. This endpoint allows developers to fetch details about all call centers configured in the Dialpad account, including their…
-
Retrieve Call Information
Retrieves call information from the Dialpad system. This endpoint allows you to fetch details about one or more calls, which may include call duration, participants, timestamps, and other relevant metadata. It can be…
-
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…
-
Retrieve Call Subscription by Id
Retrieves detailed information about a specific call subscription in the Dialpad system. This endpoint allows developers to access the current state and configuration of a call subscription, which is used for tracking…
-
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…
-
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…
-
Retrieve Channel by Id
Retrieves detailed information about a specific communication channel in the Dialpad platform using its unique identifier. This endpoint allows developers to fetch comprehensive data about a particular channel, which…
-
Retrieve Coaching Stats V2
The GetStatistics endpoint retrieves comprehensive statistics for various aspects of Dialpad usage, including calls, customer satisfaction (CSAT), dispositions, on-duty status, recordings, screen shares, texts, and…
-
Retrieve Coaching Team by Id
Retrieves detailed information about a specific coaching team in Dialpad. This endpoint allows users to fetch comprehensive data about a coaching team, including its configuration, members (coaches and trainees)…
-
Retrieve Coaching Teams Information
Retrieves information about coaching teams in the Dialpad platform. This endpoint allows users to fetch details about existing coaching teams, which are essential for managing call monitoring, feedback, and agent…
-
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…
-
Retrieve Conference Meetings
Retrieves information about conference meetings in the Dialpad platform. This endpoint allows users to fetch details about scheduled, ongoing, or past conference meetings, providing valuable data for managing and…
-
Retrieve Contact by Id
Retrieves detailed information for a specific contact in your Dialpad account using the contact's unique identifier. This endpoint allows you to fetch comprehensive data about a single contact, including their name…
-
Retrieve Contact List
Retrieves a list of contacts from the Dialpad platform. This endpoint allows you to fetch contact information, which is crucial for managing user data and communication records within your Dialpad-integrated…
-
Retrieve Department by Id
Retrieves detailed information about a specific department within the Dialpad organization. This endpoint allows you to fetch comprehensive data about a department, including its name, description, member count, and…
-
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…
-
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…
-
Retrieve List of Departments
Retrieves a list of departments for a specified office within the Dialpad organization. This endpoint is essential for obtaining the organizational structure and can be used to populate department selectors, generate…
-
Retrieve Members of Coaching Team by Id
Retrieves a list of members belonging to a specific coaching team in Dialpad. This endpoint allows you to fetch all users assigned to a particular coaching team, including both coaches and trainees. It's useful for…
-
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…
-
Retrieve Off Duty Status by Office Id
Retrieves the list of custom off-duty statuses for a specific office within the Dialpad system. This endpoint is used to fetch and manage the availability statuses of agents assigned to a particular office. It provides…
-
Retrieve Office by Id
Retrieves detailed information about a specific office within the Dialpad system. This endpoint should be used when you need to access comprehensive data about a particular office, such as its name, location, assigned…
-
Retrieve Office Plan by Id
Retrieves the current plan details for a specific office in your Dialpad organization. This endpoint allows you to fetch information about the subscribed features, limitations, and other plan-specific details for a…
-
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…
-
Retrieve Room Information by Id
Retrieves detailed information about a specific room in the Dialpad system. This endpoint allows you to fetch the current state, settings, and properties of a virtual collaboration space identified by its unique ID…
-
Retrieve Schedule Report by Id
Retrieves detailed information about a specific scheduled report in the Dialpad system. This endpoint allows you to fetch the configuration and metadata of a pre-defined report, which may include communication metrics…
-
Retrieve Sms Opt Out by Company Id
Retrieves the SMS opt-out list for a specific company within the Dialpad platform. This endpoint allows you to fetch all phone numbers that have opted out of receiving SMS messages from the specified company. Use this…
-
Retrieve Sms Subscription by Id
Retrieves detailed information about a specific SMS subscription in Dialpad. This endpoint allows developers to fetch the current status, configuration, and other relevant details of an SMS subscription by providing…
-
Retrieve Sms Subscriptions
Retrieves a list of SMS subscriptions associated with the authenticated user's Dialpad account. This endpoint allows users to view and manage their current SMS subscription plans and settings. It should be used when…
-
Retrieve Specific Webhook by Id
Retrieves detailed information about a specific webhook configuration in the Dialpad system. This endpoint allows developers to fetch the current status, settings, and event subscriptions for a particular webhook…
-
Retrieve Stat by Id
Retrieves detailed statistics and analytics data for a specific entity within the Dialpad platform. This endpoint allows you to access performance metrics, communication data, and other relevant statistics for a user…
-
Retrieve Subscription Change Log
Retrieves the changelog for Dialpad API subscriptions. This endpoint provides a historical record of changes and updates made to subscription events and notifications within the Dialpad system. It's useful for tracking…
-
Retrieve Subscription Change Log by Id
Retrieves the changelog for a specific subscription in the Dialpad system. This endpoint allows you to access a historical record of changes made to a particular subscription, including updates, modifications, or…
-
Retrieve Subscription Contacts
Retrieves subscription information for contacts in the Dialpad system. This endpoint allows you to fetch details about contact event subscriptions, which are crucial for receiving real-time notifications about…
-
Retrieve Teams for Office Id
Retrieves a list of teams associated with a specific office in the Dialpad organization. This endpoint is useful for getting an overview of the team structure within a particular office, which can be valuable for…
-
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…
-
Retrieve User Devices List
Retrieves a list of devices associated with users in the Dialpad system. This endpoint allows you to fetch information about various communication devices used within your Dialpad organization, such as desk phones…
-
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…
-
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…
-
Retrieve Websocket Connection
Retrieves information about WebSocket connections or initiates a WebSocket connection for real-time event subscriptions with Dialpad. This endpoint is essential for applications that require live updates and real-time…
-
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…
-
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…
-
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…
-
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…
-
Toggle Vi Call for User by Id
Toggles the Voice Intelligence (VI) feature for a specific Dialpad user. This endpoint allows administrators to enable or disable VI capabilities for individual users, which includes features like real-time…
-
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…
-
Unassign Access Control Policy From User
This endpoint unassigns a user from a specific access control policy in Dialpad. It allows for granular control over policy assignments by supporting unassignment at different target levels (company, office, or call…
-
Unassign Office Number
This endpoint unassigns a specific phone number from a Dialpad office. It is used to remove the association between a phone number and an office, which can be helpful for reorganizing phone number allocations or…
-
Unassign Room Phone Number
This endpoint unassigns a phone number from a specific room in the Dialpad system. It allows you to remove a previously assigned phone number from a room, freeing it up for potential reassignment or to adjust room…
-
Unassign User Phone Number
Unassigns a specified phone number from a user's Dialpad account. This endpoint should be used when you need to remove a phone number association from a particular user, such as when an employee changes roles or leaves…
-
Unpark Call by User Id
Unparks a previously parked call in the Dialpad system. This endpoint allows you to retrieve a call that was temporarily placed on hold (parked) and assign it to a specific user for handling. It's particularly useful…
-
Update Call Center Settings by Id
Updates the configuration of an existing call center in the Dialpad platform. This endpoint allows for comprehensive modifications to call center settings, including operational hours, routing strategies, hold queue…
-
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…
-
Update Call Subscription by Id
Updates an existing call event subscription in the Dialpad system. This endpoint allows you to modify various aspects of a subscription, including the call states to monitor, the subscription's active status…
-
Update Contact Information
Updates an existing contact's information in the Dialpad system. This endpoint allows you to modify various details of a contact, including their name, company, contact information, and job details. It's particularly…
-
Update Contact Subscription by Id
Updates an existing contact event subscription in the Dialpad system. This endpoint allows you to modify the configuration of a subscription, including changing the contact type it listens for, enabling or disabling…
-
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…
-
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…
-
Update Ivr Details by Id
Updates an existing custom Interactive Voice Response (IVR) workflow in the Dialpad system. This endpoint allows you to modify the name and description of a specific IVR identified by its unique ID. Use this when you…
-
Update Operator Duty Status
Updates the duty status of a specific call center operator in Dialpad. This endpoint allows you to change an operator's availability and optionally provide a reason for their status. Use this when you need to manage…
-
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…
-
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…
-
Update Schedule Report Settings
The UpdateScheduledReport endpoint allows you to modify the settings of an existing scheduled report in Dialpad. This powerful tool enables fine-tuning of report generation parameters, including frequency, timing…
-
Update Sms Subscription Settings
Updates an existing SMS event subscription in the Dialpad API. This endpoint allows you to modify various aspects of an SMS subscription, such as its direction, enabled status, associated endpoint, and target settings…
-
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…
-
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…
Setup
Connect Dialpad in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
