Reference

Access control policies listing

Retrieve all access control policies configured for your Dialpad company to manage user permissions and roles. Use this to view existing permission structures before assigning users or creating new policies.

Assign policy to user by id

Grant customized permission policies to specific team members in Dialpad, enabling you to control what settings and features each person can access based on their role.

Create access control policy

Set up granular access controls in Dialpad by creating policies that define which team members can access specific features and settings. This enables you to manage permissions across your communication platform securely and efficiently.

Delete access control policy by id

Removes a specific access control policy from your Dialpad system when it's no longer needed. This permanently deletes custom permission settings that governed user roles and access.

Deauthorize oauth2 session

Securely disconnects your application from Dialpad by invalidating the current access token, ensuring no unauthorized access remains. Use this when ending user sessions or removing integrations that are no longer needed.

Add blocked phone numbers

Block unwanted phone numbers from reaching you in Dialpad, preventing spam calls and messages from specific contacts. This helps you maintain clean communication channels and reduce interruptions from nuisance callers.

Configure call center settings

Set up and customize a new call center in Dialpad with specific settings for call handling, routing, and operational features. This lets you configure how calls are managed, recorded, and distributed across your team.

Delete call center by id

Permanently removes a call center from your Dialpad account, including all associated agents, call logs, and configurations. Use this when you no longer need a specific call center operational in your system.

Create call review share link

Generate a shareable link for call reviews and recordings that you can send to team members, clients, or stakeholders without requiring them to access your Dialpad account directly.

Delete callreviewsharelink by id

Remove access to a previously shared call recording by deleting the share link. This prevents anyone with the link from viewing the call review.

Assign number to call router

Assigns a phone number to a specific call router in Dialpad, enabling you to direct incoming calls to the right team or department. You can choose a specific number or select from available numbers in your preferred area code.

Create call router configuration

Creates a new call router configuration in Dialpad to automatically distribute incoming calls based on custom routing rules and logic you define. This enables you to direct calls to different team members or departments without manual intervention.

Delete callrouter by id

Permanently removes a call router configuration from your Dialpad phone system, allowing you to clean up outdated routing rules or restructure your call flows. Use this when you no longer need a specific call routing setup and have updated any dependent phone numbers or menu systems.

Create callback

Queues a callback request to a customer at a specified phone number through your Dialpad call center, letting agents handle the call when they're available.

Add participant to call

Adds a new participant to an active call, allowing you to quickly bring in team members or external contacts to join ongoing conversations without dropping the current call.

Attach labels to call

Organize and categorize your calls by attaching labels like 'sales,' 'support,' or 'follow-up' to individual call records for better tracking and retrieval. This helps you quickly filter and manage calls based on their purpose or status.

Add member to channel

Adds a team member to a Dialpad channel, expanding who can participate in channel conversations and collaborations. This is useful for managing channel access as your team structure evolves.

Create channel endpoint

Set up dedicated communication channels in Dialpad to organize team conversations by topic, project, or department. This enables solopreneurs and small teams to create structured communication spaces without manual setup.

Delete channel by id

Permanently removes a specific communication channel from your Dialpad account when it's no longer needed. Use this to keep your communication workspace organized and remove obsolete channels.

Delete channel member by id

Removes a specific member from a Dialpad channel, preventing them from accessing channel communications and collaboration. Use this when you need to restrict a team member's access to a particular channel or collaboration space.

Add member to coaching team

Assign a new coach or trainee to an existing coaching team in Dialpad to organize your call center training and quality assurance efforts. This enables you to scale your team management and performance monitoring as your business grows.

Create new contact entry

Adds a new contact to Dialpad with comprehensive information including name, phone number, and email. Useful for building and maintaining your business contact directory without manual entry.

Delete contact by id

Permanently remove a contact from your Dialpad account by ID. This action cannot be undone, so ensure you're deleting the correct contact.

Create new department record

Creates a new department in Dialpad with customizable call handling settings, routing rules, and operating hours to organize your team's phone communications. This lets you establish separate departments with their own call flows, recording policies, and business hours without manual workarounds.

Delete department resource

Removes a department from your Dialpad system when it's no longer needed. This is useful during company restructuring or when cleaning up your organizational hierarchy.

Delete deskphone by user id

Remove a deskphone from a user's Dialpad account when it's no longer needed or being reassigned to another team member. This permanently deletes the device association and keeps your phone system inventory up to date.

Delete deskphone in room

Removes a deskphone from a specific room, unassigning it from that shared space without deleting the device from your Dialpad account entirely. Use this when updating room phone setups or removing devices from active use in particular locations.

Assign fax line to target

Assigns a fax line to a user or department in Dialpad, enabling you to set up new fax capabilities for team members or departments. This is useful when you need to provision fax services for receiving or sending faxes without manual setup.

Create custom ivr with audio file

Sets up an automated phone menu system in Dialpad using your own audio files to greet callers and route them to the right department or person. This lets you handle incoming calls professionally without manual answering.

Delete customivr by targettype and ivrtype

Removes a custom IVR (Interactive Voice Response) configuration from your Dialpad system, allowing you to reset or update how calls are automatically routed and handled.

Create secondary office

Set up a new office location within your Dialpad organization with customized settings, billing information, and communication preferences. This enables you to expand your business presence or create department-specific communication configurations.

Add department operator by id

Assign a user or room as an operator to a department in Dialpad, enabling you to manage call routing and department staffing. This helps you control who handles calls within specific teams or departments.

Add operator to call center

Adds a new team member to your call center with configurable role and skill level settings. Use this to expand your support team and optimize how calls are routed to the right operators.

Add operator to office

Assign new operators or rooms to your office in Dialpad to expand your call handling team. This enables you to designate specific team members or resources to manage incoming calls and communications for your office.

Delete office operator by id

Remove a user or room from an office in Dialpad, allowing you to manage which team members and shared spaces are associated with different office locations or departments.

Delete operator from call center

Removes an operator from your Dialpad call center, allowing you to manage team access and reassign agents without deleting their user accounts.

Assign phone number to office

Assign a phone number to your Dialpad office, either by selecting a specific number or requesting one from a chosen area code. Use this to set up new office lines or change your primary business phone number.

Assign phone number to room

Assigns a phone number to a Dialpad room, either by specifying an exact number or requesting one from a particular area code, with the option to set it as the primary number.

Assign phone number to target

Assign a phone number to users, departments, or call centers in your Dialpad system, with the option to set it as their primary number. This lets you quickly provision new numbers or reallocate existing ones across your organization.

Assign phone number to user

Assign a phone number to a Dialpad user by searching for available numbers in a specific area code or designating a particular number, with the option to set it as their primary line. This streamlines user onboarding and enables team members to have dedicated phone numbers for their roles.

Delete number via api

Remove a phone number from your Dialpad account when it's no longer needed. This action is permanent, so use it only when you're certain the number won't be required again.

Create schedule reports endpoint

Set up automated reports in Dialpad that deliver communication metrics and performance data at regular intervals (daily, weekly, or monthly). This lets you monitor team communication patterns and ensure you have the insights you need without manual report generation.

Create pin for international room calls

Generate a unique PIN to secure and control international calling from a Dialpad room, ensuring only authorized team members can make international calls.

Create room in office via post

Creates a new collaboration space within your Dialpad office, allowing you to organize meeting rooms and communication areas for your team. Use this to set up dedicated spaces for different departments, projects, or meeting types.

Create agent status subscription

Set up real-time notifications to track when your contact center agents change their availability status (available, busy, off-duty, etc.). This enables you to monitor your team's activity and trigger automated actions based on agent status changes.

Create sms event subscription

Set up automated notifications to track incoming and outgoing SMS messages, allowing you to monitor communications and integrate SMS events into your business systems in real-time.

Delete agent status by id

Removes a subscription to real-time agent status updates in Dialpad, stopping notifications about an agent's availability changes. Use this to clean up tracking when you no longer need to monitor a specific agent's status.

Delete call subscription by id

Removes a specific call subscription from your Dialpad account to stop receiving notifications for that event. Use this when you no longer need real-time updates for a particular call activity.

Create user with auto assign

Automatically creates new user accounts in Dialpad and assigns them a phone number, eliminating manual setup steps for new team members. This streamlines onboarding by setting up complete user profiles with office assignments in a single operation.

Create webhook post endpoint

Set up a webhook URL to automatically receive real-time notifications from Dialpad whenever important events occur, like missed calls or completed voicemails, enabling seamless integration with your other business tools.

Delete operator from department

Removes a specified operator from a department in the Dialpad system.

Delete recording share link by id

Deletes a specific recording share link in the Dialpad system.

Delete room by id

Deletes a specific room from the Dialpad system using its unique identifier.

Delete schedule report by id

Deletes a specific scheduled report from the Dialpad system.

Delete sms subscription by id

Deletes a specific SMS subscription from the Dialpad system.

Delete subscription changelog by id

Deletes a specific changelog entry from a subscription in the Dialpad system.

Delete subscription contact by id

Deletes a specific subscription contact from the Dialpad system.

Delete user by id

Deletes a user from the Dialpad system based on the provided user ID.

Delete webhook by id

Deletes a specific webhook subscription from the Dialpad platform using its unique identifier.

Delete websocket connection by id

Closes and removes a specific WebSocket connection in the Dialpad system.

Fetch call byid

Retrieves detailed information about a specific call using its unique identifier.

Fetch call transcript by id

Retrieves the transcript for a specific call in the Dialpad system.

Fetch custom ivrs

Retrieves a list of all custom Interactive Voice Response (IVR) configurations associated with the authenticated Dialpad account.

Fetch operators for office id

Retrieves a list of operators associated with a specific office in Dialpad.

Fetch scheduled reports

Retrieves a list of scheduled reports from the Dialpad system.

Fetch transcript url by call id

Retrieves the URL of a transcript for a specific call in the Dialpad system.

Fetch user details by id

Retrieves detailed information about a specific user in the Dialpad system.

Format phone numbers

The formatphonenumber endpoint is used to standardize and format phone numbers within the Dialpad ecosystem.

Get available licenses for an office

Retrieves the number of available (unused) licenses for a specific office within a Dialpad organization.

Get call center status by id

Retrieves the current operational status of a specific call center in the Dialpad system.

Get call labels

Retrieves a list of all available call labels in the Dialpad system.

Get call review share link by id

Retrieves or generates a share link for a specific call review in the Dialpad system.

Get call subscription details

Retrieves a list of call subscriptions associated with the authenticated user's account in the Dialpad platform.

Get channel members by id

Retrieves a list of members for a specific channel in Dialpad.

Get departments by office id

Retrieves a list of all departments associated with a specific office in the Dialpad system.

Get deskphone by parent id

Retrieves detailed information about a specific deskphone within a designated room or parent entity in the Dialpad system.

Get deskphones for user parent id

Retrieves a list of deskphones associated with a specific user in the Dialpad system.

Get deskphones in rooms

Retrieves a list of deskphones associated with a specific room in the Dialpad system.

Get office call centers

Retrieves a list of call centers associated with a specific office in the Dialpad platform.

Get operator skills by call center and user

Retrieves the skill information for a specific operator within a designated call center.

Get phone number details

Retrieves detailed information about a specific phone number associated with the Dialpad account.

Get recording share link by id

Retrieves detailed information about a specific recording share link in the Dialpad system.

Get rooms list

Retrieves a list of all available meeting rooms or spaces within the Dialpad system.

Get subscription contact by id

Retrieves the subscription information for a specific contact in the Dialpad system.

Get user caller id

Retrieves the caller ID information for a specific user in the Dialpad system.

Get user deskphones

Retrieves detailed information about a specific deskphone associated with a particular user in the Dialpad system.

Get user e911 details

Retrieves the Enhanced 911 (E911) information for a specific user in the Dialpad system.

Get webhooks information

Retrieves a list of all webhooks configured for the authenticated user's Dialpad account.

Hangup call via id

Terminates an active call in the Dialpad system.

Initiate ivr call api endpoint

Initiates an outbound IVR (Interactive Voice Response) call using the Dialpad API.

Initiate outbound call via api

The InitiateOutboundCall endpoint allows you to programmatically initiate an outbound call using the Dialpad API.

Initiate user call with group options

Initiates an outbound call for a specified Dialpad user.

List channels api

Retrieves a list of all available communication channels in the Dialpad platform.

List conference rooms

Retrieves a list of conference rooms available in the Dialpad system.

List offices endpoint

Retrieves a list of offices within the Dialpad platform.

List users

Retrieves a list of users from the Dialpad system.

Modify contact details using id

Updates an existing contact's information in the Dialpad system.

Modify custom ivr settings

Updates a custom Interactive Voice Response (IVR) configuration for a specific target within the Dialpad system.

Modify operator skill level

Updates the skill level of a specific operator in a designated call center.

Modify webhook configuration

Updates an existing webhook configuration in the Dialpad API.

Move user to specified office

Updates a user's office assignment within the Dialpad system.

Oauth2 authorize endpoint

Initiates the OAuth 2.0 authorization process for the Dialpad API.

Patch access control policy by id

This endpoint allows you to update an existing access control policy in the Dialpad system.

Patch agent status event subscription

Updates an existing agent status subscription in the Dialpad system.

Patch call router by id

Updates an existing call router in the Dialpad system.

Patch department details by id

Updates the settings and configuration of a specific department in the Dialpad system.

Patch subscription changelog endpoint

Updates an existing change log event subscription in the Dialpad system.

Patch user active call recording

Updates the call recording settings for an active call of a specific Dialpad user.

Patch user status

Updates the status of a specific user in the Dialpad system.

Patch websocket signature secret

Updates the signature secret for a specific websocket connection in the Dialpad platform.

Post call event subscription

Creates a new call event subscription in the Dialpad system, allowing real-time notifications for various call states and actions.

Post recording share link

Creates a shareable link for a specific recording in Dialpad, such as a call recording or voicemail.

Post subscription change log event

Creates or updates a subscription for changelog events in the Dialpad system.

Post users screenpop uri

Triggers a screen pop for a specific Dialpad user, displaying relevant information during a call or communication event.

Post websocket connection secret

Creates a websocket connection for real-time communication with the Dialpad platform.

Reassign phone number to target

Assigns or reassigns a phone number to a specific target within the Dialpad system.

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.

Remove blocked numbers

Removes specified phone numbers from the blocked list in the Dialpad system.

Retrieve access control policy assignments

Retrieves the assignments of a specific access control policy in Dialpad.

Retrieve access control policy by id

Retrieves detailed information about a specific access control policy in the Dialpad system.

Retrieve agent status by id

Retrieves detailed information about a specific agent status subscription using its unique identifier.

Retrieve agent status subscription

Retrieves a list of agent status subscriptions from the Dialpad system.

Retrieve app settings

Retrieves the current application settings for the authenticated Dialpad account.

Retrieve blocked number details

Retrieves information about a specific blocked number in the Dialpad system.

Retrieve blocked phone numbers

Retrieves a comprehensive list of all phone numbers that have been blocked through the Dialpad API.

Retrieve call center by id

Retrieves detailed information about a specific call center in the Dialpad system.

Retrieve call centers information

Retrieves a list of call centers and their associated information from the Dialpad platform.

Retrieve call information

Retrieves call information from the Dialpad system.

Retrieve call routers v2 api

Retrieves a list of call routers configured in the Dialpad system.

Retrieve call subscription by id

Retrieves detailed information about a specific call subscription in the Dialpad system.

Retrieve callcenter operators by id

Retrieves a list of operators associated with a specific call center in Dialpad.

Retrieve callrouter by id

Retrieves detailed information about a specific call router in the Dialpad system.

Retrieve channel by id

Retrieves detailed information about a specific communication channel in the Dialpad platform using its unique identifier.

Retrieve coaching stats v2

The GetStatistics endpoint retrieves comprehensive statistics for various aspects of Dialpad usage, including calls, customer satisfaction (CSAT),…

Retrieve coaching team by id

Retrieves detailed information about a specific coaching team in Dialpad.

Retrieve coaching teams information

Retrieves information about coaching teams in the Dialpad platform.

Retrieve company data

Retrieves detailed information about a specific company within the Dialpad platform.

Retrieve conference meetings

Retrieves information about conference meetings in the Dialpad platform.

Retrieve contact by id

Retrieves detailed information for a specific contact in your Dialpad account using the contact's unique identifier.

Retrieve contact list

Retrieves a list of contacts from the Dialpad platform.

Retrieve department by id

Retrieves detailed information about a specific department within the Dialpad organization.

Retrieve department operators by id

Retrieves a list of operators associated with a specific department in Dialpad.

Retrieve e911 office details

Retrieves the Enhanced 911 (E911) settings for a specific office within the Dialpad communication platform.

Retrieve list of departments

Retrieves a list of departments for a specified office within the Dialpad organization.

Retrieve members of coaching team by id

Retrieves a list of members belonging to a specific coaching team in Dialpad.

Retrieve numbers via api v2

Retrieves a list of phone numbers associated with the user's Dialpad account.

Retrieve off duty status by office id

Retrieves the list of custom off-duty statuses for a specific office within the Dialpad system.

Retrieve office by id

Retrieves detailed information about a specific office within the Dialpad system.

Retrieve office plan by id

Retrieves the current plan details for a specific office in your Dialpad organization.

Retrieve operator duty status

Retrieves the current duty status of a specific call center operator in Dialpad.

Retrieve room information by id

Retrieves detailed information about a specific room in the Dialpad system.

Retrieve schedule report by id

Retrieves detailed information about a specific scheduled report in the Dialpad system.

Retrieve sms opt out by company id

Retrieves the SMS opt-out list for a specific company within the Dialpad platform.

Retrieve sms subscription by id

Retrieves detailed information about a specific SMS subscription in Dialpad.

Retrieve sms subscriptions

Retrieves a list of SMS subscriptions associated with the authenticated user's Dialpad account.

Retrieve specific webhook by id

Retrieves detailed information about a specific webhook configuration in the Dialpad system.

Retrieve stat by id

Retrieves detailed statistics and analytics data for a specific entity within the Dialpad platform.

Retrieve subscription change log

Retrieves the changelog for Dialpad API subscriptions.

Retrieve subscription change log by id

Retrieves the changelog for a specific subscription in the Dialpad system.

Retrieve subscription contacts

Retrieves subscription information for contacts in the Dialpad system.

Retrieve teams for office id

Retrieves a list of teams associated with a specific office in the Dialpad organization.

Retrieve user device by id

Retrieves detailed information about a specific user device associated with a Dialpad account.

Retrieve user devices list

Retrieves a list of devices associated with users in the Dialpad system.

Retrieve user personas by id

Retrieves all personas associated with a specific user in the Dialpad system.

Retrieve websocket by id

Retrieves detailed information about a specific WebSocket connection using its unique identifier.

Retrieve websocket connection

Retrieves information about WebSocket connections or initiates a WebSocket connection for real-time event subscriptions with Dialpad.

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.

Set user caller id by id

Sets or blocks the Caller ID for a specific Dialpad user.

Subscribe contact event

Creates a new contact event subscription in the Dialpad platform, allowing you to receive real-time updates about changes to contacts.

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.

Toggle vi call for user by id

Toggles the Voice Intelligence (VI) feature for a specific Dialpad user.

Transfer call to destination

Transfers an active call within the Dialpad system to a new destination.

Unassign access control policy from user

This endpoint unassigns a user from a specific access control policy in Dialpad.

Unassign office number

This endpoint unassigns a specific phone number from a Dialpad office.

Unassign room phone number

This endpoint unassigns a phone number from a specific room in the Dialpad system.

Unassign user phone number

Unassigns a specified phone number from a user's Dialpad account.

Unpark call by user id

Unparks a previously parked call in the Dialpad system.

Update call center settings by id

Updates the configuration of an existing call center in the Dialpad platform.

Update call review share link privacy

Updates the privacy settings of an existing call review share link in Dialpad.

Update call subscription by id

Updates an existing call event subscription in the Dialpad system.

Update contact information

Updates an existing contact's information in the Dialpad system.

Update contact subscription by id

Updates an existing contact event subscription in the Dialpad system.

Update e911 address for office

This endpoint updates the Enhanced 911 (E911) address for a specific office in Dialpad.

Update e911 address for user

Updates the E911 address for a specified user in the Dialpad system.

Update ivr details by id

Updates an existing custom Interactive Voice Response (IVR) workflow in the Dialpad system.

Update operator duty status

Updates the duty status of a specific call center operator in Dialpad.

Update recording share link privacy

Updates the privacy settings of a specific recording share link in Dialpad.

Update room details

Updates the configuration of a specific Dialpad room identified by its ID.

Update schedule report settings

The UpdateScheduledReport endpoint allows you to modify the settings of an existing scheduled report in Dialpad.

Update sms subscription settings

Updates an existing SMS event subscription in the Dialpad API.

Update user information by id

This endpoint allows you to update various aspects of a user's profile and settings in the Dialpad system.

Validate callback request

Validates a callback request for the Dialpad system.