Access control policies listingLists the authenticated company's access control policies, including their permission sets.
Add blocked phone numbersAdds specified phone numbers to the company-wide blocked list, rejecting inbound calls and texts from them for every user.
Add department operator by idAdds a new operator to a specific department in Dialpad.
Add member to channelAdds a new member to a specified channel within the Dialpad communication platform.
Add member to coaching teamAdds a new member to a specific coaching team in Dialpad.
Add operator to call centerThis endpoint adds a new operator to a specified call center in the Dialpad system.
Add operator to officeAdds a user or room as an operator to an office's mainline, with an optional operator or admin role.
Add participant to callAdds a new participant to an existing call in the Dialpad system.
Assign fax line to targetCreates and assigns a new fax line to a specified target (user or department) in the Dialpad system.
Assign number to call routerThis endpoint assigns a phone number to a specific call router in the Dialpad system.
Assign phone number to officeThis endpoint assigns a phone number to a specific office in the Dialpad system.
Assign phone number to roomAssigns a phone number to a specified room in Dialpad.
Assign phone number to targetAssigns a specific phone number to a Dialpad target, such as a user or department.
Assign phone number to userThis endpoint assigns a phone number to a specific Dialpad user.
Assign policy to user by idAssigns an access control policy to a user at company, office, or contact center level.
Attach labels to callAdds labels to a specified call, preserving existing labels.
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.
Create access control policyCreates a new access control policy in Dialpad, defining a set of permissions and their application scope.
Create agent status subscriptionCreates or updates an agent status subscription for real-time monitoring of contact center agent statuses in Dialpad.
Create callbackCreates a callback request in a Dialpad call center.
Create call review share linkCreates a shareable link for a specific call review in the Dialpad platform.
Create call router configurationCreates a new call router in the Dialpad system, allowing for custom call routing logic based on a specified URL.
Create channel endpointCreates a new communication channel within the Dialpad platform.
Create custom ivr with audio fileCreates a custom IVR recording for a specified Dialpad target and IVR type using a Base64-encoded MP3.
Create new contact entryThe CreateContact endpoint adds a new contact to Dialpad's system.
Create new department recordCreates a department in a specified office with optional call handling, operating hours, routing, and voice intelligence settings.
Create pin for international room callsCreates a PIN for protected international calls from Dialpad room phones, optionally associating a customer reference for usage reporting.
Create room in office via postCreates a new room within a specified office in the Dialpad system.
Create schedule reports endpointCreates a scheduled report in the Dialpad system for various types of communication data.
Create secondary officeCreates a secondary Dialpad office with billing information and optional operational, routing, and communication settings.
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.
Create user with auto assignCreates a new user account in the Dialpad system with the specified details.
Create webhook post endpointCreates a Dialpad webhook endpoint with a URL and optional signing secret.
Deauthorize oauth2 sessionDeauthorizes (revokes) an OAuth2 access token, effectively terminating the application's access to the Dialpad API.
Delete access control policy by idDeletes an access control policy by ID, marking it deleted and removing its associated users.
Delete agent status by idDeletes a specific agent status subscription identified by its unique ID.
Delete call center by idDeletes a specified Dialpad call center by ID.
Delete callreviewsharelink by idThis endpoint deletes a specific call review share link in the Dialpad system.
Delete callrouter by idDeletes a specific call router from the Dialpad system.
Delete call subscription by idDeletes a specific call subscription from the Dialpad system.
Delete channel by idDeletes a specific channel from the Dialpad communication platform.
Delete channel member by idRemoves a specified member from a Dialpad channel.
Delete contact by idDeletes a specific contact from the Dialpad system using the provided contact ID.
Delete customivr by targettype and ivrtypeUnassigns and deletes a custom IVR recording for a specified target and IVR type.
Delete department resourcePermanently deletes a Dialpad department by ID, removing the department and all its configuration.
Delete deskphone by user idDeletes a specific deskphone associated with a user in the Dialpad system.
Delete deskphone in roomDeletes a specific Dialpad room desk phone by room ID and desk phone ID.
Delete number via apiDeletes a specific phone number from the user's Dialpad account.
Delete office operator by idRemoves a specified user or room operator from an office's mainline using the operator ID and type.
Delete operator from call centerRemoves a specified operator from a call center in the Dialpad system.
Delete operator from departmentRemoves a specified operator from a department in the Dialpad system.
Delete recording share link by idDeletes a specific recording share link in the Dialpad system.
Delete room by idDeletes a specific room from the Dialpad system using its unique identifier.
Delete schedule report by idDeletes a scheduled report subscription by ID, stopping its recurring report schedule.
Delete sms subscription by idDeletes an SMS event subscription by its subscription ID.
Delete subscription changelog by idDeletes a change log event subscription by ID.
Delete subscription contact by idDeletes a contact event subscription by its subscription ID.
Delete user by idDeletes a user from the Dialpad system based on the provided user ID.
Delete webhook by idDeletes a Dialpad webhook by its ID, stopping delivery to that webhook endpoint.
Delete websocket connection by idCloses and removes a specific WebSocket connection in the Dialpad system.
Fetch call byidRetrieves detailed information for a concluded Dialpad call by ID, including call status, duration, and available recording and transcription information.
Fetch call transcript by idRetrieves the transcript for a specific call in the Dialpad system.
Fetch custom ivrsLists custom IVR recordings for a specified Dialpad target, with cursor pagination.
Fetch operators for office idRetrieves the mainline operators for a specified Dialpad office, including available operator details and status.
Fetch scheduled reportsLists scheduled report subscriptions for the company, with a cursor for pagination.
Fetch transcript url by call idRetrieves the URL of a transcript for a specific call in the Dialpad system.
Fetch user details by idRetrieves detailed information about a specific user in the Dialpad system.
Format phone numbersReformats a phone number supplied in local or E.
Get available licenses for an officeRetrieves the number of available (unused) licenses for a specific office within a Dialpad organization.
Get call center status by idRetrieves the current operational status of a specific call center in the Dialpad system.
Get call labelsRetrieves a list of all available call labels in the Dialpad system.
Get call review share link by idRetrieves an existing call review share link, including its access link and privacy state when available.
Get call subscription detailsLists Dialpad call event subscriptions for the company or a specified target.
Get channel members by idRetrieves a list of members for a specific channel in Dialpad.
Get departments by office idRetrieves a list of all departments associated with a specific office in the Dialpad system.
Get deskphone by parent idRetrieves detailed information about a specific deskphone within a designated room or parent entity in the Dialpad system.
Get deskphones for user parent idLists deskphones associated with a specified Dialpad user.
Get deskphones in roomsLists deskphones associated with a specified Dialpad room, including available name, state, and phone number information.
Get office call centersRetrieves a list of call centers associated with a specific office in the Dialpad platform.
Get operator skills by call center and userRetrieves an operator's skill level for a specified call center.
Get phone number detailsRetrieves details for a specific Dialpad phone number, including its status and assignment when available.
Get recording share link by idRetrieves a recording share link by ID, including its access link, associated call ID, and privacy state when available.
Get rooms listLists company rooms, optionally filtered by office, with cursor pagination.
Get subscription contact by idRetrieves a contact event subscription by its subscription ID, including its enabled state and available delivery endpoint configuration.
Get user caller idRetrieves the caller ID information for a specific user in the Dialpad system.
Get user deskphonesRetrieves detailed information about a specific deskphone associated with a particular user in the Dialpad system.
Get user e911 detailsRetrieves the Enhanced 911 (E911) information for a specific user in the Dialpad system.
Get webhooks informationLists webhooks associated with the company, with cursor pagination.
Hangup call via idTerminates an active call in the Dialpad system.
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.
Initiate outbound call via apiInitiates an outbound call on behalf of a Dialpad user by ringing all devices or a specified device.
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.
List channels apiLists company channels, optionally filtered by state.
List conference roomsLists Dialpad meeting rooms with cursor pagination.
List offices endpointLists accessible Dialpad offices, optionally filtering for active offices; results may be paginated and office entries contain IDs.
List usersRetrieves a list of users from the Dialpad system.
Modify contact details using idUpdates an existing contact's information in the Dialpad system.
Modify custom ivr settingsAssigns an existing IVR recording to a target for a specified IVR type, replacing the previous assignment.
Modify operator skill levelUpdates the skill level of a specific operator in a designated call center.
Modify webhook configurationUpdates an existing webhook configuration in the Dialpad API.
Move user to specified officeMoves a Dialpad user to a different office.
Oauth2 authorize endpointInitiates the OAuth 2.
Patch access control policy by idUpdates an access control policy by ID, including its name, description, permissions, or state.
Patch agent status event subscriptionUpdates an agent status event subscription by ID, including its enabled state and logging endpoint.
Patch call router by idUpdates an existing call router in the Dialpad system.
Patch department details by idUpdates the settings and configuration of a specific department in the Dialpad system.
Patch subscription changelog endpointUpdates a change log event subscription's enabled state and logging endpoint by ID; enabled defaults to true when omitted.
Patch user active call recordingUpdates recording for a user's active call, including recording indication playback and recording scope for group calls.
Patch user statusUpdates a user's status message, optionally specifying an expiration time, and returns the user's status if the user exists.
Patch websocket signature secretUpdates the signature secret for a specified Dialpad WebSocket endpoint, for example to rotate the secret used to verify event payloads.
Post call event subscriptionCreates a new call event subscription in the Dialpad system, allowing real-time notifications for various call states and actions.
Post recording share linkCreates a shareable link for a specific recording in Dialpad, such as a call recording or voicemail.
Post subscription change log eventCreates a company change log event subscription for a webhook or websocket endpoint, with an enabled setting.
Post users screenpop uriTriggers a screen pop for a specific Dialpad user, displaying relevant information during a call or communication event.
Post websocket connection secretCreates a Dialpad websocket endpoint for receiving event notifications, optionally specifying a signature secret.
Reassign phone number to targetAssigns or reassigns a phone number to a specific target within the Dialpad system.
Redeem access or refresh tokenSends a request to Dialpad's OAuth token endpoint.
Remove blocked numbersUnblocks specified phone numbers company-wide, restoring inbound calls and texts from them.
Retrieve access control policy assignmentsLists users assigned to a specified Dialpad access control policy, along with their associated policy targets.
Retrieve access control policy by idRetrieves detailed information about a specific access control policy in the Dialpad system.
Retrieve agent status by idRetrieves an agent status event subscription by ID, including its agent type, enabled state, and webhook or websocket configuration.
Retrieve agent status subscriptionLists the company's agent status event subscriptions for auditing or managing event notifications.
Retrieve app settingsRetrieves OAuth app settings for a specified target, or company app settings when target type and ID are not provided.
Retrieve blocked number detailsChecks whether a phone number is blocked company-wide.
Retrieve blocked phone numbersLists company-wide phone numbers blocked through the Dialpad API.
Retrieve call center by idRetrieves detailed information about a specific call center in the Dialpad system.
Retrieve callcenter operators by idRetrieves a list of operators associated with a specific call center in Dialpad.
Retrieve call centers informationLists call centers in the company, optionally filtered by office or name.
Retrieve call informationLists Dialpad calls in reverse chronological order, optionally filtered by start time or target.
Retrieve callrouter by idRetrieves detailed information about a specific call router in the Dialpad system.
Retrieve call routers v2 apiRetrieves a list of call routers configured in the Dialpad system.
Retrieve call subscription by idRetrieves a call event subscription by ID, including its enabled status and associated webhook or websocket configuration when available.
Retrieve channel by idRetrieves a Dialpad channel by its unique identifier, returning its ID and name.
Retrieve coaching stats v2Starts asynchronous processing of Dialpad statistics for a selected statistics type and export type, with date and target options.
Retrieve coaching team by idRetrieves a coaching team by ID, including its name, associated office and company, and available descriptive metadata.
Retrieve coaching teams informationLists coaching teams in the company, with team identifiers, names, office and company identifiers, and available descriptive metadata.
Retrieve company dataRetrieves detailed information about a specific company within the Dialpad platform.
Retrieve conference meetingsLists summaries of past Dialpad meetings for a meeting room, with cursor pagination.
Retrieve contact by idRetrieves a single Dialpad contact by ID, including available contact details.
Retrieve contact listLists Dialpad company shared contacts or a user's local contacts, with cursor pagination and an option to include local contacts.
Retrieve department by idRetrieves a Dialpad department by ID, including its name, company and office IDs, and creation and update timestamps when available.
Retrieve department operators by idRetrieves a list of operators associated with a specific department in Dialpad.
Retrieve e911 office detailsRetrieves the Enhanced 911 (E911) settings for a specific office within the Dialpad communication platform.
Retrieve list of departmentsLists company departments, optionally filtered by office or department name.
Retrieve members of coaching team by idLists members of a specified coaching team, including available user identity, contact, and availability information.
Retrieve numbers via api v2Retrieves a list of phone numbers associated with the user's Dialpad account.
Retrieve off duty status by office idLists the off-duty status options configured for a specified office.
Retrieve office by idRetrieves a specified Dialpad office by ID.
Retrieve office plan by idRetrieves an office's billing plan, including purchased license counts by line type, remaining calling credit, and the start of the next billing cycle.
Retrieve operator duty statusRetrieves the current duty status of a specific call center operator in Dialpad.
Retrieve room information by idRetrieves information about a Dialpad room by ID, including its name, state, office, group details, and phone settings when available.
Retrieve schedule report by idRetrieves a scheduled report subscription by ID, including its frequency and delivery endpoint ID when available.
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.
Retrieve sms subscription by idRetrieves an SMS event subscription by ID, including its direction and available delivery endpoint and target settings.
Retrieve sms subscriptionsLists SMS event subscriptions for a company or target, with optional target filtering and cursor pagination.
Retrieve specific webhook by idRetrieves a webhook configuration by ID, including its URL and available signature settings.
Retrieve stat by idRetrieves the progress and result of a previously initiated statistics request by its request ID.
Retrieve subscription change logLists a company's change log event subscriptions with cursor pagination.
Retrieve subscription change log by idRetrieves a change log event subscription by ID.
Retrieve subscription contactsLists a company's contact event subscriptions, with cursor pagination.
Retrieve teams for office idLists coaching teams associated with a specified Dialpad office, with cursor-based pagination.
Retrieve user device by idRetrieves detailed information about a specific user device associated with a Dialpad account.
Retrieve user devices listLists registered user devices, such as desk phones, softphones, and mobile apps.
Retrieve user personas by idRetrieves all personas associated with a specific user in the Dialpad system.
Retrieve websocket by idRetrieves detailed information about a specific WebSocket connection using its unique identifier.
Retrieve websocket connectionLists the company's Dialpad WebSockets, with cursor pagination.
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.
Set user caller id by idSets or blocks the Caller ID for a specific Dialpad user.
Subscribe contact eventCreates 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 statusThe 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 idTurns Voice Intelligence on or off for a user's currently active call.
Transfer call to destinationTransfers an active call within the Dialpad system to a new destination.
Unassign access control policy from userUnassigns one or all target groups associated with a user for a Dialpad access control policy.
Unassign office numberUnassigns a phone number from an office mainline.
Unassign room phone numberUnassigns a phone number from a room.
Unassign user phone numberUnassigns a specified phone number from a user.
Unpark call by user idUnparks a call previously parked on an office mainline, routing it to the specified user.
Update call center settings by idUpdates a call center's settings by ID, including hours, routing, hold queues, alerts, recording, and voice intelligence.
Update call review share link privacyUpdates the privacy settings of an existing call review share link in Dialpad.
Update call subscription by idUpdates a call event subscription's call states, active status, logging endpoint and event filters.
Update contact informationCreates or updates a shared Dialpad contact using a unique identifier.
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.
Update e911 address for officeThis endpoint updates the Enhanced 911 (E911) address for a specific office in Dialpad.
Update e911 address for userUpdates the E911 address for a specified user in the Dialpad system.
Update ivr details by idUpdates the name and/or description of a custom IVR recording by ID.
Update operator duty statusUpdates an operator's duty status and optionally its reason for all call centers the user belongs to.
Update recording share link privacyUpdates the privacy settings of a specific recording share link in Dialpad.
Update room detailsUpdates the configuration of a specific Dialpad room identified by its ID.
Update schedule report settingsUpdates an existing scheduled report subscription's frequency, timing, type, target, and delivery settings.
Update sms subscription settingsUpdates an SMS event subscription by ID, including direction, endpoint and target settings.
Update user information by idThis endpoint allows you to update various aspects of a user's profile and settings in the Dialpad system.
Validate callback requestValidates a callback request for the Dialpad system.
