- Category: communication
- Auth: OAUTH2, API_KEY
- Composio-managed OAuth available? Yes
- Tools: 192
- Triggers: 0
- Slug:
DIALPAD - Version: 20261101_00
Tools
Access control policies listing
Access control policies listing
DIALPAD_ACCESS_CONTROL_POLICIES_LISTINGLists the authenticated company’s access control policies, including their permission sets. Results can be paginated using a cursor.Input Parameters
Output
Add blocked phone numbers
Add blocked phone numbers
Add department operator by id
Add department operator by id
DIALPAD_ADD_DEPARTMENT_OPERATOR_BY_IDAdds a new operator to a specific department in Dialpad. This endpoint allows you to assign either a user or a room as an operator, with the option to specify their role. It’s used to manage call handling and department operations by adding new operators or updating existing ones with different roles. The department ID is specified in the URL path. Use this when setting up new departments, expanding existing ones, or adjusting operator assignments and roles within a department.Input Parameters
Output
Add member to channel
Add member to channel
DIALPAD_ADD_MEMBER_TO_CHANNELAdds a new member to a specified channel within the Dialpad communication platform. This endpoint allows you to expand the membership of a channel by providing the user ID of the person you want to add. It’s particularly useful for programmatically managing channel memberships, such as when onboarding new team members or reorganizing communication structures. The endpoint should be used when you need to include a user in a channel’s conversations and collaborations. Note that this operation only adds the user to the channel; it does not create new users or channels. Ensure that both the channel ID (specified in the URL) and the user ID (provided in the request body) exist in your Dialpad organization before making this call.Input Parameters
Output
Add member to coaching team
Add member to coaching team
DIALPAD_ADD_MEMBER_TO_COACHING_TEAMAdds a new member to a specific coaching team in Dialpad. This endpoint allows you to assign a user to a coaching team with a designated role, enabling effective team management and performance monitoring. Use this when you need to include a new coach or trainee in an existing coaching team. The endpoint requires the coaching team ID in the URL path and the member details in the request body. It’s particularly useful for setting up or expanding coaching teams for call center training and quality assurance purposes.Input Parameters
Output
Add operator to call center
Add operator to call center
DIALPAD_ADD_OPERATOR_TO_CALL_CENTERThis endpoint adds a new operator to a specified call center in the Dialpad system. It allows for the configuration of the operator’s role, skill level, and license type, as well as managing phone number retention when switching to a support license. Use this endpoint when you need to expand your call center team or adjust an existing user’s role within the call center. The endpoint is particularly useful for setting up new operators with specific skill levels and roles, which can help in optimizing call routing and management within the call center. Note that while adding an operator, careful consideration should be given to the license type and role assigned, as these affect the operator’s capabilities and the associated costs.Input Parameters
agents or lite_support_agents). Defaults to agentsOutput
Add operator to office
Add operator to office
Add participant to call
Add participant to call
DIALPAD_ADD_PARTICIPANT_TO_CALLAdds a new participant to an existing call in the Dialpad system. This endpoint allows you to include additional members in an ongoing call by specifying either a phone number or a target within your Dialpad organization. Use this when you need to add someone to a call that is already in progress, such as bringing in an expert or including a manager in a customer service call. The endpoint requires the ID of the existing call and the details of the new participant. It’s important to note that the target, if used, must have a primary number assigned in the Dialpad system.Input Parameters
Output
Assign fax line to target
Assign fax line to target
DIALPAD_ASSIGN_FAX_LINE_TO_TARGETCreates and assigns a new fax line to a specified target (user or department) in the Dialpad system. This endpoint allows you to set up a fax line with various options, including reserved numbers, area code-based searches, or toll-free numbers. Use this when you need to provision a new fax line for a user or department, or when you want to assign an existing number as a fax line. The endpoint is flexible, allowing for different types of fax line assignments based on your specific needs and available numbers. Note that the assignment process is immediate, and the fax line will be ready for use once the API call is successful. However, this endpoint does not handle the actual sending or receiving of faxes; it only sets up the line for future use.Input Parameters
Output
Assign number to call router
Assign number to call router
DIALPAD_ASSIGN_NUMBER_TO_CALL_ROUTERThis endpoint assigns a phone number to a specific call router in the Dialpad system. It allows users to either provide a full phone number for assignment or specify an area code to automatically select an available number within that region. The assigned number can optionally be set as the primary number for the call router. This functionality is crucial for setting up and managing call routing within an organization, enabling efficient distribution of incoming calls to the appropriate departments or individuals.Input Parameters
Output
Assign phone number to office
Assign phone number to office
DIALPAD_ASSIGN_PHONE_NUMBER_TO_OFFICEThis endpoint assigns a phone number to a specific office in the Dialpad system. It allows you to either specify a particular phone number or request an available number from a given area code. The assigned number can optionally be set as the primary number for the office. Use this endpoint when you need to add a new phone number to an office or change the office’s primary number. It’s particularly useful for setting up new offices or modifying existing office phone configurations. Note that this endpoint does not handle number porting or releasing existing numbers; it’s specifically for assigning available numbers within the Dialpad system.Input Parameters
Output
Assign phone number to room
Assign phone number to room
DIALPAD_ASSIGN_PHONE_NUMBER_TO_ROOMAssigns a phone number to a specified room in Dialpad. This endpoint allows you to either assign a specific phone number or request a number from a given area code. It’s useful for setting up new rooms or updating existing ones with additional or primary phone numbers. The assigned number can optionally be set as the primary number for the room. Use this endpoint when you need to manage phone number assignments for Dialpad rooms programmatically.Input Parameters
Output
Assign phone number to target
Assign phone number to target
DIALPAD_ASSIGN_PHONE_NUMBER_TO_TARGETAssigns a specific phone number to a Dialpad target, such as a user or department. The number can be set as the target’s primary number.Input Parameters
Output
Assign phone number to user
Assign phone number to user
DIALPAD_ASSIGN_PHONE_NUMBER_TO_USERThis endpoint assigns a phone number to a specific Dialpad user. It allows for either searching for an available number within a given area code or assigning a specific number to the user. The assigned number can optionally be set as the user’s primary number. Use this endpoint when you need to provide a user with a new phone number or add an additional number to their account. It’s particularly useful for setting up new users or expanding the communication capabilities of existing users. Note that this endpoint doesn’t handle number porting or transferring existing numbers between users.Input Parameters
Output
Assign policy to user by id
Assign policy to user by id
DIALPAD_ASSIGN_POLICY_TO_USER_BY_IDAssigns an access control policy to a user at company, office, or contact center level. Requires a company admin API key.Input Parameters
Output
Attach labels to call
Attach labels to call
Configure call center settings
Configure call center settings
DIALPAD_CONFIGURE_CALL_CENTER_SETTINGSCreates a new call center in a specified office, with options for call handling, routing, hours, recording, queues, alerts and voice intelligence. Requires a company admin API key.Input Parameters
Output
Create access control policy
Create access control policy
DIALPAD_CREATE_ACCESS_CONTROL_POLICYCreates a new access control policy in Dialpad, defining a set of permissions and their application scope. This endpoint allows administrators to establish granular control over various Dialpad features and settings. It’s used to manage user access and configure operational parameters across different levels of the organization. The policy created can encompass a wide range of permissions, from agent settings to AI configurations, enabling customized access control tailored to specific organizational needs. This tool is essential for setting up and maintaining a secure, well-organized communication environment within Dialpad.Input Parameters
Output
Create agent status subscription
Create agent status subscription
DIALPAD_CREATE_AGENT_STATUS_SUBSCRIPTIONCreates or updates an agent status subscription for real-time monitoring of contact center agent statuses in Dialpad. This endpoint allows you to configure event notifications for changes in agent availability, such as when agents become available, busy, or go off-duty. Use this when setting up integrations that require up-to-date information on agent statuses for workforce management, real-time dashboards, or automated workflows. The subscription can be associated with a specific webhook or websocket endpoint for receiving the status updates. Note that this endpoint only configures the subscription; you need to separately set up the webhook or websocket to receive the actual event data.Input Parameters
Output
Create callback
Create callback
DIALPAD_CREATE_CALLBACKCreates a callback request in a Dialpad call center. This endpoint allows you to initiate a callback to a specified phone number through a designated call center. It’s useful for implementing features like “Request a Call” on websites or applications, or for scheduling return calls to customers. The endpoint doesn’t immediately place the call but queues it in the specified call center for an agent to handle. Note that while both parameters are optional, at least one should be provided for a meaningful request. If no call_center_id is specified, the system may use a default or return an error, depending on your account configuration.Input Parameters
Output
Create call router configuration
Create call router configuration
DIALPAD_CREATE_CALL_ROUTER_CONFIGURATIONCreates a new call router in the Dialpad system, allowing for custom call routing logic based on a specified URL. This endpoint configures essential settings for the call router, including its name, default target for fallback scenarios, and the routing URL for decision-making. It’s used when setting up a new automated call distribution system or when implementing custom call routing logic for an office. The call router can be enabled or disabled, and includes an optional security feature through a signature secret. Note that this endpoint only creates the call router; additional setup may be required in the Dialpad interface or through other API calls to fully integrate it into the calling workflow.Input Parameters
Output
Create channel endpoint
Create channel endpoint
DIALPAD_CREATE_CHANNEL_ENDPOINTCreates a new communication channel within the Dialpad platform. This endpoint allows users to set up a dedicated space for team collaboration, discussions, or topic-specific conversations. It’s particularly useful for organizing communication within a company or project. The created channel can be either public or private, providing flexibility in managing access and information sharing. Use this endpoint when you need to programmatically create channels for various teams, projects, or departments, streamlining the process of setting up communication structures within Dialpad.Input Parameters
Output
Create custom ivr with audio file
Create custom ivr with audio file
DIALPAD_CREATE_CUSTOM_IVR_WITH_AUDIO_FILECreates a custom IVR recording for a specified Dialpad target and IVR type using a Base64-encoded MP3. Targets include call centers, departments, offices, coaching teams, and users.Input Parameters
Output
Create new contact entry
Create new contact entry
DIALPAD_CREATE_NEW_CONTACT_ENTRYThe CreateContact endpoint adds a new contact to Dialpad’s system. Use it to create local or shared contacts with comprehensive information. Ideal for user onboarding, data migration, or system integrations. Supports various contact details, with some fields restricted to single-line entries for consistency.Input Parameters
Output
Create new department record
Create new department record
DIALPAD_CREATE_NEW_DEPARTMENT_RECORDCreates a department in a specified office with optional call handling, operating hours, routing, and voice intelligence settings. Requires a company admin API key.Input Parameters
Output
Create pin for international room calls
Create pin for international room calls
DIALPAD_CREATE_PIN_FOR_INTERNATIONAL_ROOM_CALLSCreates a PIN for protected international calls from Dialpad room phones, optionally associating a customer reference for usage reporting.Input Parameters
Output
Create room in office via post
Create room in office via post
DIALPAD_CREATE_ROOM_IN_OFFICE_VIA_POSTCreates a new room within a specified office in the Dialpad system. This endpoint is used to set up physical or virtual spaces for collaboration, meetings, or other communication purposes. It allows you to define a room with a name and associate it with a specific office. This is particularly useful for organizations managing multiple locations or wanting to organize their communication spaces efficiently. The created room can then be used for various purposes such as scheduling meetings, assigning resources, or managing call routing within the Dialpad platform.Input Parameters
Output
Create schedule reports endpoint
Create schedule reports endpoint
DIALPAD_CREATE_SCHEDULE_REPORTS_ENDPOINTCreates a scheduled report in the Dialpad system for various types of communication data. This endpoint allows users to automate the generation and delivery of reports on a regular basis, such as call logs, user statistics, or voicemails. It’s particularly useful for managers, administrators, and analysts who need consistent, periodic insights into communication patterns and performance metrics. The endpoint offers flexible scheduling options, including daily, weekly, or monthly frequencies, and can target specific organizational units or user groups. Use this when you need to set up recurring reports for monitoring, compliance, or analytical purposes. Note that this endpoint creates a new schedule; to modify existing schedules, use the appropriate update endpoint.Input Parameters
Output
Create secondary office
Create secondary office
DIALPAD_CREATE_SECONDARY_OFFICECreates a secondary Dialpad office with billing information and optional operational, routing, and communication settings. The office is a billed entity and counts against the company’s office limit.Input Parameters
Output
Create sms event subscription
Create sms event subscription
DIALPAD_CREATE_SMS_EVENT_SUBSCRIPTIONCreates a new SMS event subscription in the Dialpad API, allowing users to receive notifications for inbound and/or outbound SMS messages. This endpoint enables fine-grained control over SMS event monitoring, including options for filtering by direction, target, and message type. It’s particularly useful for integrating real-time SMS notifications into external systems or applications. The subscription can be configured to include or exclude internal company messages and to provide updates on message delivery statuses. Use this endpoint when setting up new SMS monitoring systems or when adjusting existing subscription parameters.Input Parameters
Output
Create user with auto assign
Create user with auto assign
DIALPAD_CREATE_USER_WITH_AUTO_ASSIGNCreates a new user account in the Dialpad system with the specified details. This endpoint allows you to add a new user to your Dialpad organization, set up their basic profile information, assign them to an office, and optionally auto-assign a phone number. It’s particularly useful for bulk user creation or when integrating Dialpad user management with other systems. The endpoint requires at minimum an email and office ID, with options to further customize the user’s profile and permissions through additional parameters. Note that while a license can be specified, it defaults to ‘talk’ if not provided, ensuring that the new user has basic Dialpad functionality.Input Parameters
Output
Create webhook post endpoint
Create webhook post endpoint
DIALPAD_CREATE_WEBHOOK_POST_ENDPOINTCreates a Dialpad webhook endpoint with a URL and optional signing secret. The resulting webhook ID is used when creating event subscriptions.Input Parameters
Output
Delete access control policy by id
Delete access control policy by id
Delete agent status by id
Delete agent status by id
DIALPAD_DELETE_AGENT_STATUS_BY_IDDeletes a specific agent status subscription identified by its unique ID. This endpoint is used to stop receiving real-time updates about an agent’s status (e.g., Available, Busy, Off-duty) in the Dialpad system. It should be used when you no longer need to track the status changes for a particular agent or when cleaning up unused subscriptions. The operation is irreversible, so care should be taken to ensure the correct subscription ID is provided. This endpoint does not return the deleted subscription details; it typically returns a success status code upon successful deletion.Input Parameters
Output
Delete call center by id
Delete call center by id
Delete callrouter by id
Delete callrouter by id
DIALPAD_DELETE_CALL_ROUTER_BY_IDDeletes a specific call router from the Dialpad system. This endpoint should be used when you need to remove an existing call routing configuration, such as when restructuring your call flow or decommissioning outdated routing rules. The deletion is permanent and cannot be undone, so use with caution. This operation will immediately affect incoming calls that were previously handled by the deleted router, potentially disrupting call flows if not properly managed. Ensure that any dependencies on the call router (e.g., DIDs or mainline menu routings) are updated before deletion to maintain smooth call handling.Input Parameters
Output
Delete call subscription by id
Delete call subscription by id
DIALPAD_DELETE_CALL_SUBSCRIPTION_BY_IDDeletes a specific call subscription from the Dialpad system. This endpoint should be used when an application no longer needs to receive real-time notifications for a particular call-related event or functionality. It allows developers to clean up unused subscriptions, potentially freeing up resources and reducing unnecessary data processing. The deletion is permanent and cannot be undone, so use this endpoint with caution. It’s important to note that this operation only affects the specified subscription and does not impact any other active subscriptions or ongoing calls.Input Parameters
Output
Delete channel by id
Delete channel by id
DIALPAD_DELETE_CHANNEL_BY_IDDeletes a specific channel from the Dialpad communication platform. This endpoint should be used when you need to remove a communication channel that is no longer needed or has become obsolete. It permanently removes the channel and all associated data, so it should be used with caution. This operation cannot be undone, and once a channel is deleted, it cannot be recovered. The endpoint is useful for maintaining a clean and organized communication structure within your Dialpad account.Input Parameters
Output
Delete channel member by id
Delete channel member by id
DIALPAD_DELETE_CHANNEL_MEMBER_BY_IDRemoves a specified member from a Dialpad channel. This endpoint allows you to delete a user from a particular channel, effectively revoking their access and participation in that channel’s communications. It should be used when you need to remove a team member from a specific collaboration space, such as when an employee changes roles or leaves the organization. The endpoint requires the channel ID (specified in the URL path) and the user ID of the member to be removed. Note that this action is irreversible, and the removed member will lose access to the channel’s history and future communications. It’s important to ensure you have the necessary permissions to remove members before using this endpoint.Input Parameters
Output
Delete contact by id
Delete contact by id
DIALPAD_DELETE_CONTACT_BY_IDDeletes a specific contact from the Dialpad system using the provided contact ID. This endpoint should be used when you need to permanently remove a contact’s information from your Dialpad account. It’s important to note that this action is irreversible, and once a contact is deleted, it cannot be recovered through the API. Use this endpoint with caution, ensuring that you have verified the correct contact ID before deletion. This operation affects both shared company contacts and user-specific local contacts, depending on the scope of the provided ID.Input Parameters
Output
Delete customivr by targettype and ivrtype
Delete customivr by targettype and ivrtype
DIALPAD_DELETE_CUSTOM_IVR_BY_TARGET_TYPE_AND_IVRTYPEUnassigns and deletes a custom IVR recording for a specified target and IVR type. For call center auto call recording, the change can be limited to inbound or outbound calls; the target falls back to its default behavior.Input Parameters
Output
Delete department resource
Delete department resource
Delete deskphone by user id
Delete deskphone by user id
DIALPAD_DELETE_DESKPHONE_BY_USER_IDDeletes a specific deskphone associated with a user in the Dialpad system. This endpoint should be used when you need to remove a deskphone from a user’s account, such as when the device is no longer in use or needs to be reassigned. The operation is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful for managing hardware inventory and ensuring that user accounts accurately reflect their current device assignments.Input Parameters
Output
Delete deskphone in room
Delete deskphone in room
Delete number via api
Delete number via api
DIALPAD_DELETE_NUMBER_VIA_APIDeletes a specific phone number from the user’s Dialpad account. This endpoint should be used when a phone number is no longer needed and needs to be removed from the system. It’s important to note that this action is irreversible, and once a number is deleted, it may not be possible to reclaim the same number. This endpoint is particularly useful for managing phone inventory, removing temporary numbers, or cleaning up unused numbers to optimize resource allocation. The deletion process may have implications on call routing, billing, and other phone-related features within Dialpad, so it should be used with caution and only when the user is certain that the number is no longer required.Input Parameters
Output
Delete office operator by id
Delete office operator by id
Delete operator from call center
Delete operator from call center
DIALPAD_DELETE_OPERATOR_FROM_CALL_CENTERRemoves a specified operator from a call center in the Dialpad system. This endpoint should be used when you need to disassociate an agent or user from a particular call center, such as when an employee changes roles or leaves the organization. The operation is permanent and cannot be undone through this API. If you need to re-add the operator to the call center, you would need to use a separate API call. Note that this endpoint only removes the operator’s association with the call center; it does not delete the user account from Dialpad.Input Parameters
Output
Delete operator from department
Delete operator from department
DIALPAD_DELETE_OPERATOR_FROM_DEPARTMENTRemoves a specified operator from a department in the Dialpad system. This endpoint is used to update department operator assignments by removing either a user or a room from the list of operators for a given department. It’s particularly useful for managing call routing and department resources. The endpoint requires both the operator’s unique ID and type (user or room) to ensure accurate removal. Use this when reorganizing department structures, changing operator assignments, or updating call handling workflows. Note that this action is irreversible and may affect ongoing call routing for the department.Input Parameters
Output
Delete room by id
Delete room by id
DIALPAD_DELETE_ROOM_BY_IDDeletes a specific room from the Dialpad system using its unique identifier. This endpoint should be used when you need to remove a room that is no longer in use or has been decommissioned, such as a closed conference room or a removed reception desk. The deletion is permanent and cannot be undone, so use this endpoint with caution. It’s important to note that deleting a room will also remove any associated configurations, such as room phone settings or extensions. This operation is part of Dialpad’s room management functionality and helps maintain an up-to-date inventory of active rooms in your organization.Input Parameters
Output
Delete schedule report by id
Delete schedule report by id
Delete sms subscription by id
Delete sms subscription by id
Delete subscription changelog by id
Delete subscription changelog by id
DIALPAD_DELETE_SUBSCRIPTION_CHANGELOG_BY_IDDeletes a change log event subscription by ID. Requires a company admin API key and the change_log scope.Input Parameters
Output
Delete subscription contact by id
Delete subscription contact by id
Delete user by id
Delete user by id
DIALPAD_DELETE_USER_BY_IDDeletes a user from the Dialpad system based on the provided user ID. This endpoint should be used when permanently removing a user’s account and associated data from Dialpad. It’s important to note that deleted users can be restored for up to 72 hours after deletion, after which their records are anonymized. Use this endpoint with caution as it will remove the user’s access to Dialpad services and may affect team structures or ongoing communications. This operation cannot be undone after the 72-hour restoration period.Input Parameters
Output
Delete webhook by id
Delete webhook by id
Delete websocket connection by id
Delete websocket connection by id
DIALPAD_DELETE_WEBSOCKET_CONNECTION_BY_IDCloses and removes a specific WebSocket connection in the Dialpad system. This endpoint should be used when an application needs to programmatically terminate a real-time event subscription or clean up unused WebSocket connections. It’s particularly useful for managing resources and ensuring that inactive or unnecessary WebSocket connections are properly closed. This operation is irreversible, so it should be used with caution. Once a WebSocket is deleted, any active subscriptions or real-time data streams associated with it will be immediately terminated.Input Parameters
Output
Fetch call byid
Fetch call byid
Fetch call transcript by id
Fetch call transcript by id
DIALPAD_FETCH_CALL_TRANSCRIPT_BY_IDRetrieves the transcript for a specific call in the Dialpad system. This endpoint allows you to fetch the text representation of the spoken content from a particular call or meeting. It’s useful for reviewing conversation details, analyzing call content, or creating searchable records of communications. The transcript is generated using Dialpad’s AI-powered transcription feature, which provides accurate text conversion of audio content. Use this endpoint when you need to access the written record of a call for purposes such as quality assurance, training, or content analysis. Note that the availability and accuracy of transcripts may depend on the audio quality of the original call and the capabilities of the AI transcription system.Input Parameters
Output
Fetch custom ivrs
Fetch custom ivrs
DIALPAD_FETCH_CUSTOM_IVRSLists custom IVR recordings for a specified Dialpad target, with cursor pagination.Input Parameters
Output
Fetch operators for office id
Fetch operators for office id
Fetch scheduled reports
Fetch scheduled reports
DIALPAD_FETCH_SCHEDULED_REPORTSLists scheduled report subscriptions for the company, with a cursor for pagination. It returns schedule metadata rather than report content.Input Parameters
Output
Fetch transcript url by call id
Fetch transcript url by call id
DIALPAD_FETCH_TRANSCRIPT_URL_BY_CALL_IDRetrieves the URL of a transcript for a specific call in the Dialpad system. This endpoint allows developers to access the text version of a call’s audio content by providing the unique identifier of the call. The returned URL can be used to fetch the actual transcript content. This tool is particularly useful when you need to programmatically access call transcripts for analysis, record-keeping, or integration with other systems. It should be used when a user needs to obtain the transcript URL for a known call ID, but not for directly retrieving the transcript content itself.Input Parameters
Output
Fetch user details by id
Fetch user details by id
DIALPAD_FETCH_USER_DETAILS_BY_IDRetrieves detailed information about a specific user in the Dialpad system. This endpoint is used to fetch comprehensive user data, including profile details, account settings, and associated communication information. It’s particularly useful for user management tasks, such as verifying user information, updating records in external systems, or displaying user profiles in integrated applications. The endpoint returns a single user object based on the provided user ID. It should be used when detailed information about a particular user is needed, but it will not provide aggregate data or information about multiple users simultaneously. Note that the specific fields returned may depend on the requester’s permissions and the user’s privacy settings.Input Parameters
Output
Format phone numbers
Format phone numbers
DIALPAD_FORMAT_PHONE_NUMBERSReformats a phone number supplied in local or E.164 format. Provide an ISO country code for a local number; the result includes the E.164 and formatted local number, area code, and country code.Input Parameters
Output
Get available licenses for an office
Get available licenses for an office
DIALPAD_GET_AVAILABLE_LICENSES_FOR_AN_OFFICERetrieves the number of available (unused) licenses for a specific office within a Dialpad organization. This endpoint is used to check the current license capacity and availability before assigning new licenses to users or features. It provides essential information for office administrators to manage their license inventory effectively. The endpoint should be used when planning user onboarding, upgrading subscriptions, or performing license audits. Note that this endpoint only returns information about unassigned licenses and does not provide details about currently assigned licenses or their usage.Input Parameters
Output
Get call center status by id
Get call center status by id
DIALPAD_GET_CALL_CENTER_STATUS_BY_IDRetrieves the current operational status of a specific call center in the Dialpad system. This endpoint allows you to get real-time information about a call center’s state, which can include details such as whether it’s active, the number of agents available, current call volume, or any ongoing issues. It’s particularly useful for monitoring call center performance, making informed decisions about resource allocation, or triggering automated workflows based on the call center’s status. The endpoint should be used when you need up-to-the-minute information about a call center’s operational condition, but it does not provide historical data or detailed analytics.Input Parameters
Output
Get call labels
Get call labels
DIALPAD_GET_CALL_LABELSRetrieves a list of all available call labels in the Dialpad system. This endpoint allows users to fetch the current set of labels that can be applied to calls for categorization and management purposes. It’s particularly useful for applications that need to display or use the full range of call labeling options in their interface or logic. The endpoint returns a collection of call labels, likely including their names and any associated metadata. It should be used when initializing call management interfaces or when needing to synchronize local label data with the current state in Dialpad. Note that this endpoint does not provide information about which labels are applied to specific calls; it only returns the set of available labels.Input Parameters
Output
Get call subscription details
Get call subscription details
DIALPAD_GET_CALL_SUBSCRIPTION_DETAILSLists Dialpad call event subscriptions for the company or a specified target. Use cursor pagination to review existing subscriptions and their event notification settings.Input Parameters
Output
Get channel members by id
Get channel members by id
DIALPAD_GET_CHANNEL_MEMBERS_BY_IDRetrieves a list of members for a specific channel in Dialpad. This endpoint allows you to fetch user information for all members associated with the given channel ID. It’s useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing channel activity. The endpoint should be used when you need to access member details for a particular channel, such as when displaying member lists, checking channel membership, or performing channel-related operations that require knowledge of its members. Note that this endpoint only provides member information and does not modify the channel or its membership.Input Parameters
Output
Get departments by office id
Get departments by office id
DIALPAD_GET_DEPARTMENTS_BY_OFFICE_IDRetrieves a list of all departments associated with a specific office in the Dialpad system. This endpoint is essential for understanding the organizational structure within a company’s Dialpad account. It should be used when there’s a need to view, manage, or analyze the departmental breakdown of a particular office. The endpoint provides a comprehensive overview of the office’s internal structure, which can be valuable for administrative tasks, reporting, or integration with other systems. Note that this endpoint only returns department information and does not provide details about individual users within those departments.Input Parameters
Output
Get deskphone by parent id
Get deskphone by parent id
DIALPAD_GET_DESKPHONE_BY_PARENT_IDRetrieves detailed information about a specific deskphone within a designated room or parent entity in the Dialpad system. This endpoint is useful for obtaining the current configuration, status, and attributes of a particular deskphone device. It should be used when you need to access or verify the details of a single deskphone, such as during troubleshooting, inventory management, or when updating device settings. The endpoint does not modify any data and is intended for read-only operations. Keep in mind that the response will only provide information about the specified deskphone and will not include details about other devices or the parent entity itself.Input Parameters
Output
Get deskphones for user parent id
Get deskphones for user parent id
Get deskphones in rooms
Get deskphones in rooms
Get office call centers
Get office call centers
DIALPAD_GET_OFFICE_CALL_CENTERSRetrieves a list of call centers associated with a specific office in the Dialpad platform. This endpoint allows administrators and developers to fetch information about all call centers within a given office, which is useful for managing and organizing communication resources. Use this endpoint when you need to get an overview of call center units within an office, such as for reporting, resource allocation, or integration purposes. The endpoint returns basic information about each call center, but detailed configuration or real-time status may require additional API calls.Input Parameters
Output
Get operator skills by call center and user
Get operator skills by call center and user
Get phone number details
Get phone number details
Get rooms list
Get rooms list
Get subscription contact by id
Get subscription contact by id
DIALPAD_GET_SUBSCRIPTION_CONTACT_BY_IDRetrieves a contact event subscription by its subscription ID, including its enabled state and available delivery endpoint configuration.Input Parameters
Output
Get user caller id
Get user caller id
DIALPAD_GET_USER_CALLER_IDRetrieves the caller ID information for a specific user in the Dialpad system. This endpoint allows you to fetch the current caller ID settings associated with a user’s account, which may include their display name, phone number, or other identifying information used when making outbound calls. It’s particularly useful for administrators or integrations that need to verify or display a user’s current caller ID configuration. The endpoint should be used when you need to check or display a user’s caller ID settings, but not for modifying these settings. Note that this endpoint only provides read access to the caller ID information and cannot be used to update or change the caller ID settings.Input Parameters
Output
Get user deskphones
Get user deskphones
DIALPAD_GET_USER_DESKPHONESRetrieves detailed information about a specific deskphone associated with a particular user in the Dialpad system. This endpoint is useful when you need to access or verify the configuration, status, or other attributes of a user’s deskphone. It should be used when you have both the user’s ID and the specific deskphone ID, and need to fetch the most up-to-date information about that device. This endpoint does not modify any data and is safe for frequent calls, but consider caching the results if you’re making multiple requests for the same deskphone in a short period.Input Parameters
Output
Get user e911 details
Get user e911 details
DIALPAD_GET_USER_E911_DETAILSRetrieves the Enhanced 911 (E911) information for a specific user in the Dialpad system. This endpoint provides critical location data associated with the user’s account, which is essential for emergency services to accurately locate the caller during an emergency. It should be used when setting up or verifying a user’s emergency contact information, ensuring compliance with E911 regulations for VoIP services. The tool returns the current E911 configuration for the specified user, including registered address and any additional location details. It’s important to note that this endpoint only retrieves information and does not modify any E911 settings.Input Parameters
Output
Get webhooks information
Get webhooks information
DIALPAD_GET_WEBHOOKS_INFORMATIONLists webhooks associated with the company, with cursor pagination. The results contain webhook endpoint details and signature settings.Input Parameters
Output
Hangup call via id
Hangup call via id
DIALPAD_HANGUP_CALL_VIA_IDTerminates an active call in the Dialpad system. This endpoint should be used when you need to programmatically end a specific ongoing call. It’s particularly useful for automated call management, such as in customer service systems or when integrating Dialpad’s functionality into other applications. The endpoint has a rate limit of 1200 requests per minute, allowing for high-volume usage in busy call centers or large-scale communication systems. Note that this action is irreversible; once a call is hung up, it cannot be reinstated, and a new call would need to be initiated if further communication is required.Input Parameters
Output
Initiate ivr call api endpoint
Initiate ivr call api endpoint
DIALPAD_INITIATE_IVR_CALL_API_ENDPOINTInitiates an outbound call to ring an IVR workflow, using a specified phone number and a call center, department, or office target. Optional call data and caller ID can be supplied.Input Parameters
Output
Initiate outbound call via api
Initiate outbound call via api
DIALPAD_INITIATE_OUTBOUND_CALL_VIA_APIInitiates an outbound call on behalf of a Dialpad user by ringing all devices or a specified device. Supports caller ID, group association, custom data, and consult mode; the user must have an active device.Input Parameters
Output
Initiate user call with group options
Initiate user call with group options
DIALPAD_INITIATE_USER_CALL_WITH_GROUP_OPTIONSCauses a specified user’s Dialpad application to initiate an outbound call, with optional caller ID, group, and custom data. The user must have an active autocallable device.Input Parameters
Output
List channels api
List channels api
List conference rooms
List conference rooms
List offices endpoint
List offices endpoint
DIALPAD_LIST_OFFICES_ENDPOINTLists accessible Dialpad offices, optionally filtering for active offices; results may be paginated and office entries contain IDs. Company admins can see every office, while user-level keys see only offices the user belongs to.Input Parameters
Output
List users
List users
DIALPAD_LIST_USERSRetrieves a list of users from the Dialpad system. This endpoint allows you to fetch user account information, which is essential for user management and provisioning tasks. It can be used to sync user data with external systems, perform audits, or gather information for reporting purposes. The endpoint likely supports pagination and filtering options to manage large sets of user data efficiently. However, it does not provide real-time updates or webhook functionality for user changes - separate endpoints or features would be needed for those use cases.Input Parameters
Output
Modify contact details using id
Modify contact details using id
DIALPAD_MODIFY_CONTACT_DETAILS_USING_IDUpdates an existing contact’s information in the Dialpad system. This endpoint allows for partial updates of contact details, including personal information, communication details, and associated URLs. It’s used when you need to modify or add information to an existing contact record. The endpoint supports updating multiple fields simultaneously, making it efficient for bulk changes or comprehensive contact updates. Note that all fields are optional, allowing for targeted updates without affecting other contact information. When updating list-based fields like emails or phones, the provided lists will replace the existing data entirely.Input Parameters
Output
Modify custom ivr settings
Modify custom ivr settings
DIALPAD_MODIFY_CUSTOM_IVR_SETTINGSAssigns an existing IVR recording to a target for a specified IVR type, replacing the previous assignment. For call center auto-recording IVRs, the assignment can be limited to inbound or outbound calls.Input Parameters
Output
Modify operator skill level
Modify operator skill level
DIALPAD_MODIFY_OPERATOR_SKILL_LEVELUpdates the skill level of a specific operator in a designated call center. This endpoint allows administrators to adjust an operator’s proficiency rating, which can be used for call routing, performance tracking, and workforce management. The skill level is represented as an integer from 0 to 100, with higher values indicating greater expertise. Use this endpoint when you need to modify an operator’s skill level based on performance reviews, training completion, or changes in responsibilities. It’s particularly useful for maintaining an up-to-date and accurate representation of your call center team’s capabilities.Input Parameters
Output
Modify webhook configuration
Modify webhook configuration
DIALPAD_MODIFY_WEBHOOK_CONFIGURATIONUpdates an existing webhook configuration in the Dialpad API. This endpoint allows you to modify the destination URL and/or the secret used for request validation of a specific webhook. Use this when you need to change where webhook events are sent or update the security settings of an existing webhook. The endpoint is particularly useful for maintaining webhook configurations as your integration evolves or when you need to rotate security credentials. Note that updating these settings will affect all future events for this webhook, so ensure your receiving endpoint is prepared for the changes before updating.Input Parameters
Output
Move user to specified office
Move user to specified office
Patch access control policy by id
Patch access control policy by id
Patch agent status event subscription
Patch agent status event subscription
DIALPAD_PATCH_AGENT_STATUS_EVENT_SUBSCRIPTIONUpdates an agent status event subscription by ID, including its enabled state and logging endpoint. The agent type defaults to callcenter and enabled defaults to true when omitted.Input Parameters
Output
Patch call router by id
Patch call router by id
DIALPAD_PATCH_CALL_ROUTER_BY_IDUpdates an existing call router in the Dialpad system. This endpoint allows you to modify various settings of a call router, including its default target, enabled state, name, office association, error handling, routing URL, and authentication secret. Use this when you need to change the behavior or configuration of an existing call router. The endpoint is particularly useful for adjusting routing logic, updating fallback options, or managing error states. Note that while all parameters are optional, providing at least one is necessary to make meaningful changes. Be cautious when updating critical parameters like the routing URL or secret, as incorrect values could disrupt call routing.Input Parameters
Output
Patch department details by id
Patch department details by id
DIALPAD_PATCH_DEPARTMENT_DETAILS_BY_IDUpdates the settings and configuration of a specific department in the Dialpad system. This endpoint allows for comprehensive modification of department properties, including operating hours, call routing strategies, hold queue settings, and voice intelligence features. It’s particularly useful for adjusting department behavior to match changing business needs or to optimize call handling efficiency. The endpoint supports partial updates, allowing you to modify only the specific fields you need to change without affecting other settings.Input Parameters
Output
Patch subscription changelog endpoint
Patch subscription changelog endpoint
DIALPAD_PATCH_SUBSCRIPTION_CHANGELOG_ENDPOINTUpdates a change log event subscription’s enabled state and logging endpoint by ID; enabled defaults to true when omitted. Requires a company admin API key and the change_log scope.Input Parameters
Output
Patch user active call recording
Patch user active call recording
DIALPAD_PATCH_USER_ACTIVE_CALL_RECORDINGUpdates recording for a user’s active call, including recording indication playback and recording scope for group calls. The user ID is required; recording message playback defaults to enabled and recording type defaults to user.Input Parameters
Output
Patch user status
Patch user status
Patch websocket signature secret
Patch websocket signature secret
DIALPAD_PATCH_WEBSOCKET_SIGNATURE_SECRETUpdates the signature secret for a specified Dialpad WebSocket endpoint, for example to rotate the secret used to verify event payloads.Input Parameters
Output
Post call event subscription
Post call event subscription
DIALPAD_POST_CALL_EVENT_SUBSCRIPTIONCreates a new call event subscription in the Dialpad system, allowing real-time notifications for various call states and actions. This endpoint enables developers to set up targeted event streams for specific call centers, users, or other entities within Dialpad. Use this when you need to monitor call activities, automate workflows based on call states, or integrate Dialpad’s call data with external systems. The subscription can be fine-tuned to listen for specific call states and target types, making it versatile for various use cases such as call monitoring, analytics, or custom integrations. Note that while the subscription can be created with this endpoint, you’ll need to have a properly configured webhook or websocket to receive the events.Input Parameters
Output
Post subscription change log event
Post subscription change log event
DIALPAD_POST_SUBSCRIPTION_CHANGE_LOG_EVENTCreates a company change log event subscription for a webhook or websocket endpoint, with an enabled setting. Requires the change_log scope.Input Parameters
Output
Post users screenpop uri
Post users screenpop uri
DIALPAD_POST_USERS_SCREENPOP_URITriggers a screen pop for a specific Dialpad user, displaying relevant information during a call or communication event. This endpoint should be used when you need to automatically present contextual data to a user’s screen, such as customer information from a CRM system. It’s particularly useful in contact center scenarios where agents need quick access to caller details. The screen pop URL can be a web page or a custom URI to launch a native application. Note that this endpoint does not retrieve or send any customer data directly; it only initiates the display of the specified URL on the user’s device.Input Parameters
Output
Post websocket connection secret
Post websocket connection secret
DIALPAD_POST_WEBSOCKET_CONNECTION_SECRETCreates a Dialpad websocket endpoint for receiving event notifications, optionally specifying a signature secret. Connect to the returned websocket URL to receive event payloads.Input Parameters
Output
Reassign phone number to target
Reassign phone number to target
DIALPAD_REASSIGN_PHONE_NUMBER_TO_TARGETAssigns or reassigns a phone number to a specific target within the Dialpad system. This endpoint allows you to associate a phone number with various entities such as users, departments, call centers, or other supported target types. Use this when you need to allocate or reallocate phone numbers across your Dialpad organization. The endpoint is particularly useful for managing phone number assignments during user onboarding, department restructuring, or call center setup. Note that this operation may affect existing call routing and should be used cautiously in production environments.Input Parameters
Output
Redeem access or refresh token
Redeem access or refresh token
Remove blocked numbers
Remove blocked numbers
Retrieve access control policy assignments
Retrieve access control policy assignments
DIALPAD_RETRIEVE_ACCESS_CONTROL_POLICY_ASSIGNMENTSLists users assigned to a specified Dialpad access control policy, along with their associated policy targets. Results can be paginated using a cursor.Input Parameters
Output
Retrieve access control policy by id
Retrieve access control policy by id
DIALPAD_RETRIEVE_ACCESS_CONTROL_POLICY_BY_IDRetrieves detailed information about a specific access control policy in the Dialpad system. This endpoint allows administrators to fetch the configuration and settings of a particular policy, which defines custom permissions and access levels for users within the Dialpad platform. Use this endpoint when you need to review or audit the settings of an existing access control policy. It’s particularly useful for verifying policy details before making modifications or when troubleshooting access-related issues. The endpoint returns comprehensive information about the policy but does not allow for modifications; separate endpoints would be used for updating policies.Input Parameters
Output
Retrieve agent status by id
Retrieve agent status by id
DIALPAD_RETRIEVE_AGENT_STATUS_BY_IDRetrieves an agent status event subscription by ID, including its agent type, enabled state, and webhook or websocket configuration. Requires a company admin API key.Input Parameters
Output
Retrieve agent status subscription
Retrieve agent status subscription
DIALPAD_RETRIEVE_AGENT_STATUS_SUBSCRIPTIONLists the company’s agent status event subscriptions for auditing or managing event notifications. Use a cursor to request the next page. A company admin API key is required.Input Parameters
Output
Retrieve app settings
Retrieve app settings
DIALPAD_RETRIEVE_APP_SETTINGSRetrieves OAuth app settings for a specified target, or company app settings when target type and ID are not provided.Input Parameters
Output
Retrieve blocked number details
Retrieve blocked number details
Retrieve blocked phone numbers
Retrieve blocked phone numbers
DIALPAD_RETRIEVE_BLOCKED_PHONE_NUMBERSLists company-wide phone numbers blocked through the Dialpad API. Results are paginated using a cursor; numbers blocked by other means are not included.Input Parameters
Output
Retrieve call center by id
Retrieve call center by id
DIALPAD_RETRIEVE_CALL_CENTER_BY_IDRetrieves detailed information about a specific call center in the Dialpad system. This endpoint allows you to fetch comprehensive data about a call center, including its configuration, associated agents, and operational metrics. Use this when you need to access or review the current state and settings of a particular call center. The endpoint is particularly useful for administrators managing multiple call centers or for integrations that need up-to-date call center information. Note that this endpoint only provides read access and cannot be used to modify call center details.Input Parameters
Output
Retrieve callcenter operators by id
Retrieve callcenter operators by id
DIALPAD_RETRIEVE_CALLCENTER_OPERATORS_BY_IDRetrieves a list of operators associated with a specific call center in Dialpad. This endpoint allows you to fetch detailed information about the operators working in a particular call center, which is essential for managing call center operations, monitoring staff, and optimizing workload distribution. Use this endpoint when you need to view the current roster of operators, check staffing levels, or gather operator details for reporting purposes. The endpoint returns operator information but does not provide real-time status updates or allow modifications to operator data. It’s particularly useful for integrations that require synchronization of call center staff information with external systems or for building custom dashboards to monitor call center composition.Input Parameters
Output
Retrieve call centers information
Retrieve call centers information
DIALPAD_RETRIEVE_CALL_CENTERS_INFORMATIONLists call centers in the company, optionally filtered by office or name. Results are paginated and include call center identifiers, names, and available office, company, and state fields.Input Parameters
Output
Retrieve call information
Retrieve call information
DIALPAD_RETRIEVE_CALL_INFORMATIONLists Dialpad calls in reverse chronological order, optionally filtered by start time or target. Use the response cursor to request the next page of call information for reporting or analysis.Input Parameters
Output
Retrieve callrouter by id
Retrieve callrouter by id
DIALPAD_RETRIEVE_CALL_ROUTER_BY_IDRetrieves detailed information about a specific call router in the Dialpad system. This endpoint allows developers to fetch the configuration and status of a call router by providing its unique identifier. Use this when you need to check the current settings, routing rules, or other properties of a particular call router. It’s particularly useful for auditing your call routing setup or before making changes to an existing router. The endpoint returns read-only data and does not modify any settings.Input Parameters
Output
Retrieve call routers v2 api
Retrieve call routers v2 api
DIALPAD_RETRIEVE_CALL_ROUTERS_V2_APIRetrieves a list of call routers configured in the Dialpad system. This endpoint allows you to fetch information about the call routing setup in your Dialpad account, including details such as router identifiers, associated dedicated DIDs, and routing rules. It’s particularly useful for auditing your current call routing configuration or gathering data for reporting purposes. The endpoint provides read-only access to call router information and does not allow modifications to the routing setup. Use this when you need to review your call routing structure or integrate call routing information into your applications for advanced call management or analytics.Input Parameters
Output
Retrieve call subscription by id
Retrieve call subscription by id
DIALPAD_RETRIEVE_CALL_SUBSCRIPTION_BY_IDRetrieves a call event subscription by ID, including its enabled status and associated webhook or websocket configuration when available.Input Parameters
Output
Retrieve channel by id
Retrieve channel by id
Retrieve coaching stats v2
Retrieve coaching stats v2
DIALPAD_RETRIEVE_COACHING_STATS_V2Starts asynchronous processing of Dialpad statistics for a selected statistics type and export type, with date and target options. The request ID can be used to check progress and retrieve results. Choose aggregated statistics or individual records; CSAT and dispositions require a target and support records only.Input Parameters
Output
Retrieve coaching team by id
Retrieve coaching team by id
Retrieve coaching teams information
Retrieve coaching teams information
DIALPAD_RETRIEVE_COACHING_TEAMS_INFORMATIONLists coaching teams in the company, with team identifiers, names, office and company identifiers, and available descriptive metadata. Results support cursor pagination.Input Parameters
Output
Retrieve company data
Retrieve company data
DIALPAD_RETRIEVE_COMPANY_DATARetrieves detailed information about a specific company within the Dialpad platform. This endpoint allows developers to access various company-level data, such as company name, settings, and other relevant details. It should be used when an application needs to fetch or display company information, update local records, or verify company-specific configurations. The endpoint provides a comprehensive view of a company’s profile in Dialpad but does not modify any data. Note that the specific fields returned may depend on the user’s permissions and the company’s privacy settings.Output
Retrieve conference meetings
Retrieve conference meetings
Retrieve contact by id
Retrieve contact by id
Retrieve contact list
Retrieve contact list
Retrieve department by id
Retrieve department by id
Retrieve department operators by id
Retrieve department operators by id
DIALPAD_RETRIEVE_DEPARTMENT_OPERATORS_BY_IDRetrieves a list of operators associated with a specific department in Dialpad. This endpoint allows you to fetch detailed information about the operators assigned to a particular department, enabling efficient management of department resources and personnel. Use this endpoint when you need to review, audit, or manage the operators within a specific department. The response likely includes operator details such as names, contact information, and roles. Note that this endpoint does not modify any department or operator data; it is for retrieval purposes only. It’s particularly useful for administrative tasks, reporting, and ensuring proper staffing across departments.Input Parameters
Output
Retrieve e911 office details
Retrieve e911 office details
DIALPAD_RETRIEVE_E911_OFFICE_DETAILSRetrieves the Enhanced 911 (E911) settings for a specific office within the Dialpad communication platform. This endpoint allows administrators to fetch crucial emergency service configuration details associated with a particular office location. It should be used when auditing or verifying E911 compliance, updating emergency response information, or integrating office-specific emergency settings into external systems. The endpoint provides read-only access to E911 data and does not allow modifications. It’s important to note that this tool only retrieves settings for a single office at a time and does not provide aggregate data across multiple offices.Input Parameters
Output
Retrieve list of departments
Retrieve list of departments
DIALPAD_RETRIEVE_LIST_OF_DEPARTMENTSLists company departments, optionally filtered by office or department name. Results are paginated and include department IDs and available names and office IDs.Input Parameters
Output
Retrieve members of coaching team by id
Retrieve members of coaching team by id
Retrieve numbers via api v2
Retrieve numbers via api v2
DIALPAD_RETRIEVE_NUMBERS_VIA_API_V2Retrieves a list of phone numbers associated with the user’s Dialpad account. This endpoint allows users to view all the phone numbers they have access to, which may include both assigned and unassigned numbers. It’s useful for inventory management, number allocation, and auditing purposes. The endpoint returns basic information about each number, such as its value, status, and associated user or department. It does not modify any data and is safe for frequent polling. Note that the response may be paginated for large number inventories, and additional calls may be needed to retrieve the full list.Input Parameters
Output
Retrieve off duty status by office id
Retrieve off duty status by office id
Retrieve office by id
Retrieve office by id
Retrieve office plan by id
Retrieve office plan by id
Retrieve operator duty status
Retrieve operator duty status
DIALPAD_RETRIEVE_OPERATOR_DUTY_STATUSRetrieves the current duty status of a specific call center operator in Dialpad. This endpoint allows you to check whether an operator is Active (available to receive inbound calls) or Off-Duty (not available for calls). Use this endpoint when you need to determine an operator’s availability in real-time, such as for load balancing, scheduling, or monitoring operator activity. The endpoint provides a snapshot of the operator’s current status and does not include historical data or future scheduled statuses. It’s particularly useful for systems that need to make routing decisions based on operator availability or for creating dashboards that display team capacity.Input Parameters
Output
Retrieve room information by id
Retrieve room information by id
Retrieve schedule report by id
Retrieve schedule report by id
Retrieve sms opt out by company id
Retrieve sms opt out by company id
DIALPAD_RETRIEVE_SMS_OPT_OUT_BY_COMPANY_IDLists a company’s external phone numbers filtered by SMS opt-out or opt-back-in state, optionally by A2P campaign. Results are paginated.Input Parameters
Output
Retrieve sms subscription by id
Retrieve sms subscription by id
DIALPAD_RETRIEVE_SMS_SUBSCRIPTION_BY_IDRetrieves an SMS event subscription by ID, including its direction and available delivery endpoint and target settings.Input Parameters
Output
Retrieve sms subscriptions
Retrieve sms subscriptions
Retrieve specific webhook by id
Retrieve specific webhook by id
DIALPAD_RETRIEVE_SPECIFIC_WEBHOOK_BY_IDRetrieves a webhook configuration by ID, including its URL and available signature settings.Input Parameters
Output
Retrieve stat by id
Retrieve stat by id
Retrieve subscription change log
Retrieve subscription change log
DIALPAD_RETRIEVE_SUBSCRIPTION_CHANGE_LOGLists a company’s change log event subscriptions with cursor pagination. Requires a company admin API key and the change_log scope.Input Parameters
Output
Retrieve subscription change log by id
Retrieve subscription change log by id
DIALPAD_RETRIEVE_SUBSCRIPTION_CHANGE_LOG_BY_IDRetrieves a change log event subscription by ID. Requires a company admin API key and the change_log scope.Input Parameters
Output
Retrieve subscription contacts
Retrieve subscription contacts
Retrieve teams for office id
Retrieve teams for office id
Retrieve user device by id
Retrieve user device by id
DIALPAD_RETRIEVE_USER_DEVICE_BY_IDRetrieves detailed information about a specific user device associated with a Dialpad account. This endpoint allows developers to fetch the current state and configuration of a particular device by providing its unique identifier. Use this when you need to access up-to-date information about a user’s device, such as its type, status, or associated settings. The endpoint is particularly useful for device management, troubleshooting, or syncing device information across integrated systems. Note that this endpoint only provides read access to device data and cannot be used to modify device settings.Input Parameters
Output
Retrieve user devices list
Retrieve user devices list
DIALPAD_RETRIEVE_USER_DEVICES_LISTLists registered user devices, such as desk phones, softphones, and mobile apps. Supports a user ID filter and cursor pagination.Input Parameters
Output
Retrieve user personas by id
Retrieve user personas by id
DIALPAD_RETRIEVE_USER_PERSONAS_BY_IDRetrieves all personas associated with a specific user in the Dialpad system. This endpoint allows you to fetch the various identities or roles that a user can assume when making calls, providing detailed information about each persona. Use this endpoint when you need to display or manage the different caller identities available to a user. The response will include a list of persona objects, each containing information such as the persona name, phone number, and any associated metadata. This endpoint is particularly useful for applications that need to offer users a choice of outbound caller identities or for administrative purposes to review a user’s available personas.Input Parameters
Output
Retrieve websocket by id
Retrieve websocket by id
DIALPAD_RETRIEVE_WEBSOCKET_BY_IDRetrieves detailed information about a specific WebSocket connection using its unique identifier. This endpoint allows developers to query the status, metadata, and other relevant details of an active or recent WebSocket connection in the Dialpad system. It’s particularly useful for monitoring real-time event subscriptions, troubleshooting connection issues, or auditing WebSocket usage. The endpoint should be used when you need to inspect or verify the state of a particular WebSocket connection, such as checking if it’s still active or retrieving its configuration. Note that this endpoint provides information about the connection itself and may not include the actual event data being transmitted through the WebSocket.Input Parameters
Output
Retrieve websocket connection
Retrieve websocket connection
DIALPAD_RETRIEVE_WEBSOCKET_CONNECTIONLists the company’s Dialpad WebSockets, with cursor pagination. Use the returned connection details to identify WebSockets for receiving event payloads; connecting to a WebSocket is a separate operation.Input Parameters
Output
Send sms with optional media and group sender
Send sms with optional media and group sender
DIALPAD_SEND_SMS_WITH_OPTIONAL_MEDIA_AND_GROUP_SENDERThe SendSMS endpoint allows you to send SMS or MMS messages through the Dialpad platform to one or multiple recipients. This versatile tool supports various sender identification methods, group messaging, and media attachments. Use it to programmatically send text or multimedia messages, integrate with Dialpad channels, and leverage organizational structures for messaging. The endpoint is particularly useful for automating communication workflows, sending notifications, or implementing messaging features within applications integrated with Dialpad. Note that while the endpoint offers flexibility in number formatting and sender identification, proper authorization and adherence to messaging regulations are assumed to be handled separately.Input Parameters
Output
Set user caller id by id
Set user caller id by id
DIALPAD_SET_USER_CALLER_ID_BY_IDSets or blocks the Caller ID for a specific Dialpad user. This endpoint allows you to define the phone number that will be displayed when the user makes outgoing calls, or to block the Caller ID entirely. Use this when you need to customize how a user’s calls appear to recipients or to ensure privacy by blocking the Caller ID. The endpoint is particularly useful for managing professional appearances in business communications or for compliance with privacy regulations. Note that this setting affects all outgoing calls made by the user through the Dialpad platform.Input Parameters
Output
Subscribe contact event
Subscribe contact event
DIALPAD_SUBSCRIBE_CONTACT_EVENTCreates a new contact event subscription in the Dialpad platform, allowing you to receive real-time updates about changes to contacts. This endpoint enables you to subscribe to events for either local (personal) or shared (organization-wide) contacts. Use this when you need to integrate contact management functionalities or automate workflows based on contact updates in your Dialpad-connected application. The subscription can be linked to a specific logging endpoint (webhook or websocket) for event delivery and can be enabled or disabled upon creation. Note that you must have previously set up a logging endpoint to receive the events if you specify an endpoint_id.Input Parameters
Output
Toggle user do not disturb status
Toggle user do not disturb status
DIALPAD_TOGGLE_USER_DO_NOT_DISTURB_STATUSThe ToggleUserDoNotDisturb endpoint allows you to update the Do Not Disturb (DND) status for a specific user in the Dialpad system. This powerful feature enables programmatic control over a user’s availability, helping to manage notifications and improve focus time. The endpoint can be used to enable or disable DND for an individual user, and optionally within the context of a specific group (such as a call center, department, or office). This granular control makes it ideal for implementing custom availability management solutions or integrating with external scheduling systems. Keep in mind that changing a user’s DND status may affect their ability to receive incoming communications, so use this endpoint judiciously and in accordance with your organization’s communication policies.Input Parameters
Output
Toggle vi call for user by id
Toggle vi call for user by id
Transfer call to destination
Transfer call to destination
DIALPAD_TRANSFER_CALL_TO_DESTINATIONTransfers an active call within the Dialpad system to a new destination. This endpoint allows for flexible call routing by enabling transfers to another ongoing call, a specific phone number, or a predefined target within the Dialpad ecosystem (such as a call center, department, office, or user). It provides options to specify the transfer state and attach custom data to the call. Use this endpoint when you need to programmatically redirect an ongoing call, implement call forwarding logic, or integrate Dialpad’s call transfer functionality into your application’s workflow. Note that the success of the transfer may depend on the availability and settings of the destination.Input Parameters
Output
Unassign access control policy from user
Unassign access control policy from user
DIALPAD_UNASSIGN_ACCESS_CONTROL_POLICY_FROM_USERUnassigns one or all target groups associated with a user for a Dialpad access control policy. Requires a company admin API key.Input Parameters
Output
Unassign office number
Unassign office number
Unassign room phone number
Unassign room phone number
Unassign user phone number
Unassign user phone number
Unpark call by user id
Unpark call by user id
Update call center settings by id
Update call center settings by id
DIALPAD_UPDATE_CALL_CENTER_SETTINGS_BY_IDUpdates a call center’s settings by ID, including hours, routing, hold queues, alerts, recording, and voice intelligence. Requires a company admin API key.Input Parameters
Output
Update call subscription by id
Update call subscription by id
DIALPAD_UPDATE_CALL_SUBSCRIPTION_BY_IDUpdates a call event subscription’s call states, active status, logging endpoint and event filters. If enabled is omitted, the request sends it as true.Input Parameters
Output
Update contact information
Update contact information
DIALPAD_UPDATE_CONTACT_INFORMATIONCreates or updates a shared Dialpad contact using a unique identifier. First and last name are required; company, contact information, job details, and URLs can also be supplied.Input Parameters
Output
Update contact subscription by id
Update contact subscription by id
DIALPAD_UPDATE_CONTACT_SUBSCRIPTION_BY_IDUpdates a Dialpad contact event subscription by ID, setting its contact type and enabled status and optionally associating a different logging endpoint. The enabled status defaults to true when omitted.Input Parameters
Output
Update e911 address for office
Update e911 address for office
DIALPAD_UPDATE_E911_ADDRESS_FOR_OFFICEThis endpoint updates the Enhanced 911 (E911) address for a specific office in Dialpad. It allows you to modify crucial location information used by emergency services to accurately locate the office in case of an emergency call. The endpoint can update the address for the office itself and optionally for all users associated with that office. It also provides an option to validate the address using Dialpad’s service, ensuring the highest possible accuracy for emergency response. Use this endpoint when setting up a new office, relocating an existing office, or correcting address information. It’s particularly important for maintaining compliance with E911 regulations and ensuring employee safety.Input Parameters
Output
Update e911 address for user
Update e911 address for user
DIALPAD_UPDATE_E911_ADDRESS_FOR_USERUpdates the E911 address for a specified user in the Dialpad system. This endpoint allows you to modify the emergency location information associated with a user’s account, ensuring accurate dispatch of emergency services if needed. The updated address will be used for E911 services, which provide precise location data to emergency responders. This tool should be used when a user’s physical location changes or when correcting inaccurate E911 address information. It’s crucial for maintaining compliance with E911 regulations and ensuring user safety. The endpoint requires detailed address information and offers an option for address validation to improve accuracy.Input Parameters
Output
Update ivr details by id
Update ivr details by id
Update operator duty status
Update operator duty status
Update room details
Update room details
DIALPAD_UPDATE_ROOM_DETAILSUpdates the configuration of a specific Dialpad room identified by its ID. This endpoint allows you to modify the room’s name and manage its assigned phone numbers. Use this when you need to rename a room, update its phone number assignments, or reorder existing phone numbers. The endpoint is particularly useful for maintaining accurate room information and adjusting telephony settings as your organization’s needs change. Note that this is a partial update operation, so only the fields you provide will be modified. Be cautious when updating phone numbers, as reordering or removing numbers from the list will affect their assignment to the room.Input Parameters
Output
Update schedule report settings
Update schedule report settings
DIALPAD_UPDATE_SCHEDULE_REPORT_SETTINGSUpdates an existing scheduled report subscription’s frequency, timing, type, target, and delivery settings. The request requires the core schedule details and sends enabled and coaching-group values even when omitted.Input Parameters
Output
Update sms subscription settings
Update sms subscription settings
DIALPAD_UPDATE_SMS_SUBSCRIPTION_SETTINGSUpdates an SMS event subscription by ID, including direction, endpoint and target settings. Omitted enabled, include_internal and status values are sent as true, false and false respectively.Input Parameters
Output
Update user information by id
Update user information by id
DIALPAD_UPDATE_USER_INFORMATION_BY_IDThis endpoint allows you to update various aspects of a user’s profile and settings in the Dialpad system. It provides comprehensive control over user management, including personal information, administrative roles, communication settings, and account status. Use this endpoint when you need to modify existing user data, such as changing contact details, adjusting administrative privileges, updating license types, or managing phone numbers and extensions. The endpoint is particularly useful for keeping user information up-to-date and managing user access within the Dialpad platform. Note that some changes, like updating license types or office assignments, may have billing implications. Ensure you have the necessary permissions and understand the impact of changes before using this endpoint.Input Parameters
agents. For a Support license, specify the type as support.default — status message template: “{provider}: {message}” - conference — status message template: “On {provider}: in the {message} meeting” provider and message should be chosen with the message template in mind.Output
Validate callback request
Validate callback request
DIALPAD_VALIDATE_CALLBACK_REQUESTValidates a callback request for the Dialpad system. This endpoint is used to check if a callback can be successfully initiated for a given call center and phone number. It helps ensure that the necessary information is correct and available before actually placing the callback. Use this endpoint when you need to verify the validity of a callback request, such as before scheduling or queuing a callback. The endpoint does not initiate the actual callback; it only performs validation. Note that both parameters are optional, allowing for flexible validation scenarios, but providing both ensures the most comprehensive validation.