Dialpad MCP server

Dialpad Number -- Assign. Assigns a number to a user. The number will automatically be taken from the company's reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute.

users.assign_number

User -- Create. Creates a new user. Rate limit: 1200 per minute.

users.create

User -- Create Batch. Creates up to 25 users in one call, for example to invite a team. Each user is created independently with the same rules as creating a single user, so a failure does not undo the users that were created before it. The response has one result per requested user, in the order sent, with either the created user or the reason it was not created. The reason code no_seats_available means the office has no free license of the type the user would consume. An unexpected server error ends the whole call with a 503 and no per-user results, and the users created before it stay created. Rate limit: 1200 per minute.

users.create_batch

User -- Delete. Deletes a user by id. Rate limit: 1200 per minute.

users.delete

E911 Address -- Get. Gets E911 address of the user by user id. Rate limit: 1200 per minute.

users.e911.get

E911 Address -- Update. Update E911 address of the given user. Rate limit: 1200 per minute.

users.e911.update

User -- Get. Get a user by id. Returns identity (name, email, job_title), contact details (phone_numbers, extension), status (state, do_not_disturb, is_on_duty, on_duty_status), license type, office membership (office_id, group_details), and voicemail settings. Rate limit: 1200 per minute.

users.get

Call -- Initiate. Causes a user's Dialpad application to initiate an outbound call. Note that the user must have at least one active autocallable device (the web or desktop Dialpad app, or a CTI application). The Dialpad mobile apps and physical deskphones do not support this API call. Rate limit: 5 per minute.

users.initiate_call

User -- List. Gets company users, optionally filtering by email. NOTE: The `limit` parameter has been soft-deprecated. Please omit the `limit` parameter, or reduce it to `100` or less. - Limit values of greater than `100` will only produce a page size of `100`, and a `400 Bad Request` response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The `cursor` value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute.

users.list

Persona -- List. Provides a list of personas for a user. A persona is a target that a user can make calls from. The receiver of the call will see the details of the persona rather than the user. Rate limit: 1200 per minute.

users.list_personas

User -- Switch Office. Moves the user to a different office. For international offices only, all of the user's numbers will be unassigned and a new number will be assigned except when the user only has internal numbers starting with 803 -- then the numbers will remain unchanged. Admin can also assign numbers via the user assign number API after. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office. Rate limit: 1200 per minute.

users.move_office

Caller ID -- Set. Set Caller ID for a given user ID. Rate limit: 1200 per minute.

users.set_caller_id

Call Recording -- Toggle. Turns call recording on or off for a user's active call. Rate limit: 1200 per minute.

users.toggle_call_recording

Call VI -- Toggle. Turns Voice Intelligence (live transcription and real-time assist) on or off for the user's currently active call, optionally setting the transcription locale. Fails if the user has no active call. Reversible by calling again. Rate limit: 1200 per minute.

users.toggle_call_vi

Do Not Disturb -- Toggle. Toggle DND status on or off for the given user. Rate limit: 1200 per minute.

users.toggle_dnd

Dialpad Number -- Unassign. Un-assigns a phone number from a user. The number will be returned to the company's reserved block if there is one. Otherwise the number will be released. Rate limit: 1200 per minute.

users.unassign_number

User -- Update. Updates the provided fields for an existing user. Rate limit: 1200 per minute.

users.update

User Status -- Update. Update user's status. Returns the user's status if the user exists. Rate limit: 1200 per minute.

users.update_status

Call Centers -- Create. Create a new call center in the specified office. Requires name and office_id. Requires a company admin API key. Rate limit: 1200 per minute.

callcenters.create

Call Centers -- Delete. Deletes a call center by id. Requires a company admin API key. Rate limit: 1200 per minute.

callcenters.delete

Call Centers -- Get. Gets a call center by id. Rate limit: 1200 per minute.

callcenters.get

Call Centers -- Status. Get live operational metrics for a call center: availability status, available operator count, queued calls, longest wait time, and on-duty operator count. Rate limit: 1200 per minute.

callcenters.get_status

Call Centers -- List. Gets all the call centers for an office. Rate limit: 1200 per minute.

callcenters.list

Call Centers -- List. Gets all the call centers for the company. Rate limit: 1200 per minute.

callcenters.listall

Operator -- Add. Adds an operator to a call center. > Warning > > This API may result in the usage of call center licenses if required and available. If the licenses are required and not available the operation will fail. Licenses are required when adding an operator that does not have a call center license. Rate limit: 1200 per minute.

callcenters.operators.add

Operator -- Remove. Removes an operator from a call center. Note: This API will not change or release any licenses. Rate limit: 1200 per minute.

callcenters.operators.delete

Operator -- Get Duty Status. Gets the operator's on duty status and reason. Rate limit: 1200 per minute.

callcenters.operators.get_duty_status

Operator -- Get Skill Level. Gets the skill level of an operator within a call center. Rate limit: 1200 per minute.

callcenters.operators.get_skill_level

Operators -- List. List all operators (users and rooms) assigned to a call center. Returns operator names, roles, and on-duty status. Rate limit: 1200 per minute.

callcenters.operators.list

Operator -- Update Duty Status. Updates the operator's duty status for all call centers which user belongs to. Rate limit: 1200 per minute.

callcenters.operators.update_duty_status

Operator -- Update Skill Level. Updates the skill level of an operator within a call center. Rate limit: 1200 per minute.

callcenters.operators.update_skill_level

Call Centers -- Queue. List the calls and callbacks currently waiting in a call center's queue, ordered oldest-queued first. Includes calls that are ringing an operator but not yet answered. Rate limit: 30 per minute.

callcenters.queue.list

Call Centers -- Update. Updates a call center by id. Requires a company admin API key. Rate limit: 1200 per minute.

callcenters.update

Label -- Add. Adds labels to a determined call id, keeping any labels already on the call. A label already present is not duplicated. Labels cannot be removed through this endpoint. Rate limit: 250 per minute.

call.add_labels

Call -- Assign Operator. Assigns an operator to a call queued in a contact center. Only contact center calls are eligible for this operation. Currently supports assigning one operator per request. Rate limit: 12 per minute.

call.assign

Call -- Get Ai Recap. Gets the Ai Recap for a call. Requires scope: ``ai_recap`` Rate limit: 12 per minute.

call.get_ai_recap

Call -- Assigned Operators. Get all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Rate limit: 250 per minute.

call.get_assigned_operators

Call -- Get. Get call status and detailed information for a concluded call, including direction, duration, recording URLs, CSAT scores, voicemail metadata, and transcription text. Also returns routing_breadcrumbs, which is only populated for calls routed through a customer-configured API Call Router and is empty for every other call. Rate limit: 10 per minute.

call.get_call_info

Call Actions -- Hang up. Hangs up the call. Rate limit: 1200 per minute.

call.hangup

Call -- Initiate via Ring. Initiates an outbound call to ring all devices (or a single specified device). Note that the user must have at least one active device (a web, desktop or mobile Dialpad app; a CTI application; or a physical deskphone). Rate limit: 5 per minute.

call.initiate

Call -- Initiate IVR Call. Initiates an outbound call to ring an IVR Workflow. Rate limit: 10 per minute per IVR. Rate limit: 1200 per minute.

call.initiate_ivr_call

Call -- List. Provides a paginated list of calls matching the specified filter parameters in reverse-chronological order by call start time (i.e. recent calls first) Note: This API will only include calls that have already concluded. When no target is specified, company-level API keys and company admins list all of the company's calls, and other user-level API keys list the authenticated user's own calls. Requires scope: ``calls:list`` Rate limit: 1200 per minute.

call.list

Call -- Add Participant. Adds another participant to a call. Valid methods to add are by phone or by target. Targets require to have a primary phone Rate limit: 1200 per minute.

call.participants.add

Call -- Transfer. Transfers call to another recipient. Rate limit: 1200 per minute.

call.transfer_call

Call -- Unassign All Call Operators. Unassigns all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation. Rate limit: 12 per minute.

call.unassign_all_call_operators

Call -- Unassign Call Operator. Unassigns an operator from a call queued in a contact center. Only contact center calls are eligible for this operation. Currently supports unassigning one specific operator per request. Rate limit: 12 per minute.

call.unassign_operator

Call -- Unpark. Unparks a call previously parked on an Office mainline, routing it to the specified user. Rate limit: 1200 per minute.

call.unpark

Dialpad Number -- Assign. Assigns a specific phone number to a target. Use this when the number to assign is already known; use the auto-assign endpoint to let Dialpad pick one. Valid targets are a user or department, an office, room, callcenter, callrouter, staffgroup, channel or coachinggroup. Rate limit: 1200 per minute.

numbers.assign

Dialpad Number -- Assign. Assigns a number to a callrouter. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute.

numbers.assign_call_router_number.post

Dialpad Number -- Assign. Assigns a number to a office. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute.

numbers.assign_office_number.post

Dialpad Number -- Assign. Assigns a number to a room. The number will automatically be taken from the company's reserved block if there are reserved numbers, otherwise a number will be auto-assigned from the provided area code. Rate limit: 1200 per minute.

numbers.assign_room_number.post

Dialpad Number -- Auto-Assign. Assigns an automatically selected phone number to a target and returns the number that was chosen. The number is taken from the company's reserved pool if one exists, otherwise a new number is allocated from the provided area code. Use the assign endpoint instead when a specific number is required. Target includes user, department, office, room, callcenter and callrouter, plus staffgroup, channel and coachinggroup. Rate limit: 1200 per minute.

numbers.auto_assign

Dialpad Number -- Get. Gets the details of a single phone number: its type, area code, status, and the target it is assigned to. Requires a company admin API key. Rate limit: 1200 per minute.

numbers.get

Dialpad Number -- List. Lists the phone numbers in your company, each with its type, area code, status and the target it is assigned to. Filter by status to find numbers in a particular state, or by area code to find numbers in a particular region. Requires a company admin API key. Rate limit: 1200 per minute.

numbers.list

Dialpad Number -- Unassign. Un-assigns a phone number from a office mainline. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be released. Rate limit: 1200 per minute.

numbers.office_unassign_number.post

Dialpad Number -- Unassign. Un-assigns a phone number from a room. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be released. Rate limit: 1200 per minute.

numbers.room_unassign_number.post

Dialpad Number -- Swap. Replaces a target's primary phone number with a different one and returns the new number. The old number is released. How the replacement is chosen depends on swap_details: give a specific number to swap to that number (it must already be in the company's reserved pool, and the company must have the reserved_pool experiment enabled), give an area code to take an available number from that area code, or omit swap_details to have one chosen automatically from the reserved pool, falling back to the target's office area code. Rate limit: 1200 per minute.

numbers.swap

Dialpad Number -- Unassign. Un-assigns a phone number from its target. This does not delete the number: it returns to the company's reserved pool if one exists, and can be reassigned later. Pass "release" to give the number up entirely instead, which cannot be undone. Rate limit: 1200 per minute.

numbers.unassign

Office -- Create. Creates a secondary office. This provisions a billed entity: currency, plan period and a billing address are all required, and the new office counts against the company's office limit. There is no corresponding delete endpoint, so an office created here can only be removed by support. Rate limit: 1200 per minute.

offices.create

E911 Address -- Get. Gets E911 address of the office by office id. Rate limit: 1200 per minute.

offices.e911.get

E911 Address -- Update. Update E911 address of the given office. Rate limit: 1200 per minute.

offices.e911.update

Office -- Get. Gets an office by id. Rate limit: 1200 per minute.

offices.get

Office -- List. Gets the offices in the company. The result set depends on the caller: company admins get every office, while a user-level key gets only the offices that user belongs to. Rate limit: 1200 per minute.

offices.list

Off-Duty Status -- List. Lists Off-Duty status values. Rate limit: 1200 per minute.

offices.offdutystatuses.get

Operator -- Remove. Removes an operator from office's mainline. Rate limit: 1200 per minute.

offices.operators.delete

Operator -- List. Gets mainline operators for an office. Rate limit: 1200 per minute.

offices.operators.get

Operator -- Add. Adds an operator into office's mainline. Rate limit: 1200 per minute.

offices.operators.post

Office -- Get Primary. Gets the primary office for the company. Rate limit: 1200 per minute.

offices.primary.get

Office -- Update. Updates an office's business hours. Only the hours-of-operation fields listed below can be changed here -- name, billing and routing settings are not editable through this endpoint. Rate limit: 1200 per minute.

offices.update

Departments -- Create. Create a new department in the specified office. Requires name and office_id. Requires a company admin API key. Rate limit: 1200 per minute.

departments.create

Departments -- Delete. Permanently delete a department. This removes the department and all its configuration. Cannot be undone. Requires a company admin API key. Rate limit: 1200 per minute.

departments.delete

Department -- Get. Gets a department by id. Rate limit: 1200 per minute.

departments.get

Department -- List. Gets all the departments for an office. Rate limit: 1200 per minute.

departments.list

Department -- List. Gets all the departments in the company. Rate limit: 1200 per minute.

departments.listall

Operator -- Add. Add a user or room as an operator to a department. Specify operator_type (user or room) and optional role (operator or admin). Rate limit: 1200 per minute.

departments.operators.add

Operator -- Remove. Remove an operator (user or room) from a department. Specify operator_id and operator_type. Rate limit: 1200 per minute.

departments.operators.delete

Operator -- List. List all operators (users and rooms) assigned to a department. Returns operator names, roles, and on-duty status. Rate limit: 1200 per minute.

departments.operators.list

Departments -- Update. Updates an existing department. Requires a company admin API key. Rate limit: 1200 per minute.

departments.update

Access Control Policies -- Assign. Assigns a user to an access control policy. Requires a company admin API key. Rate limit: 1200 per minute.

accesscontrolpolicies.assign

Access Control Policies -- List Assignments. Lists all users assigned to this access control policy. Rate limit: 1200 per minute.

accesscontrolpolicies.assignments

Access Control Policies -- Create. Creates a new custom access control policy. Requires a company admin API key. Rate limit: 1200 per minute.

accesscontrolpolicies.create

Access Control Policies -- Delete. Deletes a policy by marking the state as deleted, and removing all associated users. Requires a company admin API key. Rate limit: 1200 per minute.

accesscontrolpolicies.delete

Access Control Policies -- Get. Get a specific access control policy's details. Rate limit: 1200 per minute.

accesscontrolpolicies.get

Access Control Policies -- List Policies. Gets all access control policies belonging to the company. Rate limit: 1200 per minute.

accesscontrolpolicies.list

Access Control Policies -- Unassign. Unassigns one or all target groups associated with the user for an access control policy. Requires a company admin API key. Rate limit: 1200 per minute.

accesscontrolpolicies.unassign

Access Control Policies -- Update. Updates the provided fields for an existing access control policy. Requires a company admin API key. Rate limit: 1200 per minute.

accesscontrolpolicies.update

Meeting Summary -- List. Lists summaries of meetings that have occurred in the specified meeting room. Requires scope: ``conference:read`` Rate limit: 1200 per minute.

meetings.conference-meetings.list

Meeting Room -- List. Lists all conference rooms. Requires scope: ``conference:read`` Rate limit: 1200 per minute.

meetings.conference-rooms.list

Dialpad Meeting -- Create. Creates a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.create

Dialpad Meeting -- Delete. Deletes a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.delete

Dialpad Meeting -- Get. Gets a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.get

Dialpad Meeting -- List. Lists all Dialpad meetings for a specified user. Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.list

Meeting Room -- Create. Creates a meeting room (personal or unique meeting). Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.room.create

Dialpad Meeting -- Update. Updates a Dialpad meeting. Requires scope: ``conference:all`` Rate limit: 1200 per minute.

meetings.meetings.update

Channel -- Create. Creates a new channel. Rate limit: 1200 per minute.

channels.create

Channel -- Delete. Deletes a channel by id. Rate limit: 1200 per minute.

channels.delete

Channel -- Get. Get channel by id Rate limit: 1200 per minute.

channels.get

Channel -- List. Lists all channels in the company. Rate limit: 1200 per minute.

channels.list

Member -- Add. Adds a user to a channel. Rate limit: 1200 per minute.

channels.members.add

Member -- Remove. Removes a member from a channel. Rate limit: 1200 per minute.

channels.members.delete

Members -- List. List all the members from a channel Rate limit: 1200 per minute.

channels.members.list

Contact -- Create. Creates a new contact. Rate limit: 100 per minute.

contacts.create

Contact -- Create or Update. Creates a new shared contact with uid. Rate limit: 100 per minute.

contacts.create_with_uid

Contact -- Delete. Deletes a contact by id. Rate limit: 1200 per minute.

contacts.delete

Contact -- Get. Gets a contact by id. Currently, only contacts of type shared and local can be retrieved by this API. Rate limit: 1200 per minute.

contacts.get

Contact -- List. Gets company shared contacts, or user's local contacts if owner_id is provided. NOTE: The `limit` parameter has been soft-deprecated. Please omit the `limit` parameter, or reduce it to `100` or less. - Limit values of greater than `100` will only produce a page size of `100`, and a `400 Bad Request` response will be produced 20% of the time in an effort to raise visibility of side-effects that might otherwise go un-noticed by solutions that had assumed a larger page size. - The `cursor` value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute.

contacts.list

Contact -- Search. Searches local, shared, and lead contacts the API key may read within its company. All filters must match (AND). Contacts sharing an identifier are returned separately. Results may lag behind updates. A short or empty page may still include a next-page cursor. Empty items and external_ids are omitted. The cursor is omitted when the search is complete. Rate limit: 1200 per minute.

contacts.search

Contact -- Update. Updates the provided fields for an existing contact. Rate limit: 1200 per minute.

contacts.update

Room Phone -- Assign PIN. Assigns a PIN for making international calls from rooms When PIN protected international calls are enabled for the company, a PIN is required to make international calls from room phones. Requires a company admin API key. Rate limit: 1200 per minute.

deskphones.rooms.create_international_pin

Room Phone -- Delete. Deletes a room desk phone by id. Rate limit: 1200 per minute.

deskphones.rooms.delete

Room Phone -- Get. Gets a room desk phone by id. Rate limit: 1200 per minute.

deskphones.rooms.get

Room Phone -- List. Gets all desk phones under a room. Rate limit: 1200 per minute.

deskphones.rooms.list

Desk Phone -- Delete. Deletes a user desk phone by id. Rate limit: 1200 per minute.

deskphones.users.delete

Desk Phone -- Get. Gets a user desk phone by id. Rate limit: 1200 per minute.

deskphones.users.get

Desk Phone -- List. Gets all desk phones under a user. Rate limit: 1200 per minute.

deskphones.users.list

Company -- Get. Gets company information: name, primary office, admin contact, plan state and billing address. Rate limit: 1200 per minute.

company.get

Company -- Get AI Settings. Gets the company-level AI settings: whether Call AI is enabled and whether the company allows its data to be used for AI training. Rate limit: 1200 per minute.

company.get_ai_settings

Company -- Get SMS Opt-out List. Lists the external phone numbers that have opted out of (or back in to) SMS from this company, filtered by opt-out state and optionally by A2P campaign. Use this before sending SMS to confirm a recipient has not opted out. Requires a company admin API key. Rate limit: 250 per minute.

company.sms_opt_out

Company -- Update. Updates the company's name. For a company with a single office, the office is renamed too. Only an admin of the company acting as a user can call this: a missing user credential gets a 401, and a user who is not an admin of this company gets a 403. Rate limit: 1200 per minute.

company.update

Company -- Update AI Settings. Updates the company-level AI settings, and syncs the change to the enterprise the same way the admin portal does. Settings that are omitted are left unchanged, and a setting cannot be cleared, so an explicit null is rejected with a 400, as is a request that sets nothing. A company-level API key can call this without a user credential. Any other caller must be a company admin, the admin of a single-office company, or have write access to AI settings: a missing user credential gets a 401, and any other caller gets a 403. Rate limit: 1200 per minute.

company.update_ai_settings

Company -- Update Settings. Updates company settings. Requires a company admin API key. Rate limit: 1200 per minute.

company.update_settings

Schedule -- Create. Creates a new scheduled message that will be sent at the specified time. Messages can be sent to multiple phone numbers OR to a Dialpad channel. Supports both SMS (text only) and MMS (text with media attachments). Rate limit: 1200 per minute.

scheduled_messages.create

Schedule -- Delete. Deletes (cancels) a scheduled message. The message will not be sent. Rate limit: 1200 per minute.

scheduled_messages.delete

Schedule -- Get. Gets a single scheduled message by ID. Rate limit: 1200 per minute.

scheduled_messages.get

Schedule -- List. Lists all active scheduled messages for the authenticated user. Only active (pending) schedules are returned. Deleted or sent schedules are not included. Results can be paginated using the cursor parameter. Rate limit: 1200 per minute.

scheduled_messages.list

Schedule -- Send Now. Immediately sends a scheduled message and deletes the schedule. This is useful for testing or when you want to send a scheduled message before its scheduled time. Rate limit: 1200 per minute.

scheduled_messages.send_now

Schedule -- Update. Updates an existing scheduled message. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Rate limit: 1200 per minute.

scheduled_messages.update

Call Router -- Create. Creates a new API-based call router. Rate limit: 1200 per minute.

callrouters.create

Call Router -- Delete. Deletes the API call router with the given ID. Rate limit: 1200 per minute.

callrouters.delete

Call Router -- Get. Gets the API call router with the given ID. Rate limit: 1200 per minute.

callrouters.get

Call Router -- List. Lists all of the API call routers for a given company or office. Rate limit: 1200 per minute.

callrouters.list

Call Router -- Update. Updates the API call router with the given ID. Rate limit: 1200 per minute.

callrouters.update

Coaching Team -- Get. Get details of a specified coaching team. Rate limit: 1200 per minute.

coaching_team.get

Coaching Team -- List. Get a list of coaching teams of a office. Rate limit: 1200 per minute.

coaching_team.list

Coaching Team -- List. Get a list of all coaching teams in the company. Rate limit: 1200 per minute.

coaching_team.listall

Coaching Team -- Add Member. Add a user to the specified coaching team as trainee or coach. Rate limit: 1200 per minute.

coaching_team.members.add

Coaching Team -- List Members. List all members of a coaching team with their roles (coach or trainee), contact info, and availability status. Rate limit: 1200 per minute.

coaching_team.members.get

Dispositions -- Create. Creates a disposition for an office. Rate limit: 1200 per minute.

dispositions.create

Dispositions -- Delete. Deletes the disposition by id. Rate limit: 1200 per minute.

dispositions.delete

Dispositions -- Get. Gets a disposition by id. Rate limit: 1200 per minute.

dispositions.get

Dispositions -- List. Gets a list of dispositions by a target. Rate limit: 1200 per minute.

dispositions.list

Dispositions -- Update. Updates the disposition by id. Bulk updates for the targets assigned to a disposition is not supported. Rate limit: 1200 per minute.

dispositions.update

Room -- Delete. Deletes a room by id. Rate limit: 1200 per minute.

rooms.delete

Room -- Get. Gets a room by id. Rate limit: 1200 per minute.

rooms.get

Room -- List. Gets all rooms in your company, optionally filtering by office. Rate limit: 1200 per minute.

rooms.list

Room -- Update. Updates room details by id. Rate limit: 1200 per minute.

rooms.patch

Room -- Create. Creates a new room. Rate limit: 1200 per minute.

rooms.post

schedule reports -- Create. Creates a schedule reports subscription for your company. An endpoint_id is required in order to receive the event payload and can be obtained via websockets or webhooks. A schedule reports is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute.

schedule_reports.create

Schedule reports -- Delete. Deletes a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute.

schedule_reports.delete

Schedule reports -- Get. Gets a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute.

schedule_reports.get

Schedule reports -- List. Lists all schedule reports subscription for a company. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute.

schedule_reports.list

Schedule reports -- Update. Updates a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports. Rate limit: 1200 per minute.

schedule_reports.update

Websocket -- Create. Creates a new websocket for your company. A unique websocket ID will be generated when successfully creating a websocket. A websocket ID is to be required when creating event subscriptions. One websocket ID can be shared between multiple event subscriptions. When triggered, events will be accessed through provided websocket_url under websocket. The url will be expired after 1 hour. Please use the GET websocket API to regenerate url rather than creating new ones. If a secret is provided, the websocket events will be encoded and signed in the JWT format using the shared secret with the HS256 algorithm. The JWT payload should be decoded and the signature verified to ensure that the event came from Dialpad. If no secret is provided, unencoded events will be sent in the JSON format. It is recom

websockets.create

Websocket -- Delete. Deletes a websocket by id. Rate limit: 1200 per minute.

websockets.delete

Websocket -- Get. Gets a websocket by id. Rate limit: 1200 per minute.

websockets.get

Websocket -- List. Gets a list of all the websockets that are associated with the company. Rate limit: 1200 per minute.

websockets.list

Websocket -- Update. Updates a websocket by id. Rate limit: 1200 per minute.

websockets.update

Blocked Number -- Add. Blocks the given phone numbers company-wide, so that inbound calls and texts from them are rejected for every user in the company. Returns no content on success. Blocking is reversible via the remove endpoint. Rate limit: 1200 per minute.

blockednumbers.add

Blocked Number -- Get. Checks whether a single phone number is blocked company-wide. Returns the number if it is blocked, and 404s if it is not blocked or was blocked outside the API. Rate limit: 1200 per minute.

blockednumbers.get

Blocked Numbers -- List. Lists the phone numbers blocked company-wide through the API. Numbers blocked by other means are not included. Rate limit: 1200 per minute.

blockednumbers.list

Blocked Number -- Remove. Unblocks the given phone numbers company-wide, restoring inbound calls and texts from them. Returns no content on success. Rate limit: 1200 per minute.

blockednumbers.remove

Bulk Message -- Get. Gets a single bulk message by ID. Rate limit: 1200 per minute.

bulk_messages.get

Bulk Message -- List. Lists all bulk messages for the authenticated user. Results can be paginated using the cursor parameter. Rate limit: 1200 per minute.

bulk_messages.list

Bulk Message -- Send. Sends a bulk message to multiple recipients (up to 50). This endpoint allows you to send the same message to multiple phone numbers. All existing logic (including spam checks, delivery behavior, and visibility in the Bulk Messages UI tab) will remain the same for API-triggered sends. **Important**: Message sending is asynchronous. This endpoint creates the bulk message batch and returns immediately with success=True, indicating the batch was created successfully. Individual messages are sent in the background. To check the delivery status of individual recipients, use the GET /message/bulk/{id} endpoint to retrieve the batch with delivery status information (attempted_send, error_message, delivery_status fields per recipient). Rate limit: 1200 per minute.

bulk_messages.send

Bulk Message -- Update. Updates a bulk message text and/or media. Supports partial updates. Only the fields provided in the request will be updated. Fields not provided will retain their existing values. This follows PATCH semantics. Rate limit: 1200 per minute.

bulk_messages.update

Call Review Sharelink -- Create. Create a call review share link by call id. Rate limit: 250 per minute.

call_review_share_link.create

Call Review Sharelink -- Delete. Delete a call review share link by id. Rate limit: 1200 per minute.

call_review_share_link.delete

Call Review Sharelink -- Get. Gets a call review share link by call id. Rate limit: 1200 per minute.

call_review_share_link.get

Call Review Sharelink -- Update. Update a call review share link by id. Rate limit: 250 per minute.

call_review_share_link.update

Custom IVR -- Assign. Assigns an already-created IVR recording to a target for a given IVR type, replacing whatever was previously assigned. This selects which existing recording plays; it does not change the recording's own name or description. Rate limit: 1200 per minute.

ivr.assign

Custom IVR -- Create. Creates a new custom IVR recording for a target. The audio is supplied in the "file" field as a Base64-encoded MP3. Returns the created IVR, including the id needed to assign it to a target. Rate limit: 1200 per minute.

ivr.create

Custom IVR -- Delete. Un-assigns an IVR recording from a target for a given IVR type and deletes the recording. The target falls back to its default behaviour for that IVR type. Rate limit: 1200 per minute.

ivr.delete

Custom IVR -- Update. Renames an existing IVR recording or changes its description. This edits the recording's own metadata only; it does not change which target the recording is assigned to and does not replace the audio. Rate limit: 1200 per minute.

ivr.update_details

Recording Sharelink -- Create. Creates a recording share link. Rate limit: 100 per minute.

recording_share_link.create

Recording Sharelink -- Delete. Deletes a recording share link by id. Rate limit: 1200 per minute.

recording_share_link.delete

Recording Sharelink -- Get. Gets a recording share link by id. Rate limit: 1200 per minute.

recording_share_link.get

Recording Sharelink -- Update. Updates a recording share link by id. Rate limit: 100 per minute.

recording_share_link.update

Scorecards export -- Initiate Processing. Begins processing a scorecards export asynchronously, returning a request id to get the status and retrieve the results by calling GET /scorecards/export/{request_id}. Scorecards for the whole company will be processed by default. A target_id and target_type can be provided to limit the export to a single target. Rate limit: 250 per minute.

scorecards.export.create

Scorecards export -- Get Result. Gets the progress and result of a scorecards report request. Rate limit: 1200 per minute.

scorecards.export.get

Scorecards -- Get. Gets a scorecard by id. Rate limit: 1200 per minute.

scorecards.get

Scorecards -- List. Gets a list of scorecards of a target. Rate limit: 1200 per minute.

scorecards.list

Call Content -- Delete (Bulk). Removes call recordings, screen recordings, transcripts, and AI data from the specified calls. The call records themselves are preserved. This operation is asynchronous — queues a task and returns a request_id for status polling. Rate limit: 10 per minute.

anonymization.callcontent

Anonymize -- Contacts (Bulk). Anonymizes the specified contacts by removing all PII (name, phone, email, etc). Call recordings and AI data associated with these contacts are also removed. This operation is asynchronous — queues one task per contact and returns a request_id for status polling. Rate limit: 10 per minute.

anonymization.contacts

Anonymization Request -- Get. Returns the current status of an anonymization request. Rate limit: 1200 per minute.

anonymization.requests.get

Admin Call Recording -- Download. Downloads an admin recording through its share-link ID as a bounded base64 result.

recordings.admin_call.download

Call Recording -- Download. Downloads completed call audio as a bounded base64 result; requires recordings_export scope.

recordings.call.download

Voicemail Recording -- Download. Downloads voicemail audio as a bounded base64 result; requires recordings_export scope.

recordings.voicemail.download

Call Back -- Enqueue. Requests a call back to a given number by an operator in a given call center, and returns the request's position in the queue. The call back joins the call center queue like a regular call and dials out when the next operator becomes available, respecting the call center's business and holiday hours and queue settings. International call backs are not supported, and a duplicate call back for the same number and call center is rejected. Rate limit: 1200 per minute.

callback.enqueue

Call Back -- Validate. Performs a dry run of a callback request without adding it to the call center queue and without placing any call. Runs the same validation as enqueuing would, so it reports the same failures (unreachable number, international destination, duplicate request, call center closed) up front. Returns whether the request would succeed. Rate limit: 1200 per minute.

callback.validate

Stats -- Initiate Processing. Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{request_id}. Stats for the whole company will be processed by default. An office_id can be provided to limit stats to a single office. A target_id and target_type can be provided to limit stats to a single target. Rate limit: 200 per hour.

stats.export.create

Stats -- Get Result. Gets the progress and result of a statistics request. Rate limit: 1200 per minute.

stats.export.get

Call Transcript -- Get. Gets the Dialpad AI transcript of a call, including moments. Rate limit: 1200 per minute.

transcripts.get

Call Transcript -- Get URL. Gets the transcript url of a call. Rate limit: 1200 per minute.

transcripts.get_url

User Device -- Get. Get details of a specific device including its type, display name, phone number, and registration dates. Rate limit: 1200 per minute.

userdevices.get

User Device -- List. List registered devices for a user, including desk phones, softphones, and mobile apps. Returns device type, display name, phone number, and registration dates. Rate limit: 1200 per minute.

userdevices.list

Activity Metrics. Returns paginated, activity-level metrics for specified agents. Rate limit: 1200 per minute.

wfm.wfm-metrics-activity.get

Agent Metrics. Returns paginated, detailed agent-level performance metrics. Rate limit: 1200 per minute.

wfm.wfm-metrics-agent.get

Agent Group -- Get. Requires scope: ``agent_groups:read`` Rate limit: 1200 per minute.

agentgroup.get

App Settings -- Get. Gets the app settings of the OAuth app that is associated with the API key for the target, if target_type and target_id are provided. Otherwise, will return the app settings for the company. Rate limit: 1200 per minute.

app_settings.get

Licenses -- List Available. Gets how many licenses of each line type an office has purchased but not yet assigned, so a count of zero for a line type means a new user or room of that type cannot be added without buying more. Rate limit: 1200 per minute.

available_licenses.list

Dialpad Number -- List Available. Searches the phone numbers that are available to assign, in the country of the user's office. Search by area code, city or the first digits of a number, and page through the results with the cursor. The search has these fallbacks: - A toll-free search with no matches returns any available toll-free numbers instead. - For a US search that has run out of results, the response lists overlaying_area_codes: other area codes that serve the same region, to search next. - When nothing matches an international search, set country_fallback to get numbers from the whole country instead; the response then has search_extended_to_country set. Requires a user API key. Rate limit: 1200 per minute.

available_numbers.list

Label -- List. Gets all labels for a determined company. Rate limit: 1200 per minute.

call_labels.list

Call Back -- List. Lists the callback requests waiting in a call center's queue, oldest first, so the first result has been waiting longest. Each callback reports the number to call back, when it was queued, and a status that is either "queued" while the request is still waiting for an operator or "timed_out" once it waited longer than the call center's max_hold_seconds. Queued callbacks carry their position in the queue; timed-out ones do not. The API key must have admin rights on the specified call center; this is a per-call-center check rather than a company-wide admin requirement. Rate limit: 1200 per minute.

callbacks.list

Caller ID -- Get. List all available Caller IDs and the active Caller ID for a given user ID Rate limit: 1200 per minute.

caller_id.users.get

Custom IVR -- List. Lists the custom IVR recordings configured on a target, such as greetings, hold music and menu prompts. A target can have many IVRs of different types, so pass ivr_type to narrow the results to one kind. Rate limit: 1200 per minute.

custom_ivrs.list

Digital -- Sessions -- List. Gets list of digital sessions which are started/ended in the requested period. Requested period must be less than 7 days. Requires scope: ``digital_sessions`` Rate limit: 100 per minute.

digital.sessions.list

Fax -- Send. Sends a fax to a phone number. Rate limit: 250 per minute.

fax.send

Fax Line -- Assign. Assigns a fax line to a target. Target includes user and department. Depending on the chosen line type, the number will be taken from the company's reserved pool if there are available reserved numbers, otherwise numbers can be auto-assigned using a provided area code. Requires a company admin API key. Rate limit: 1200 per minute.

faxline.assign

Number Tags -- Update tags for a phone number.. Sets the contact preferences for a phone number company-wide. "do_not_call" blocks outbound calls to the number and "do_not_text" blocks outbound texts. Returns the resulting preferences. Either preference can be turned back off by sending the opposite value. Requires a company admin API key. Rate limit: 1200 per minute.

number_tags.update

Billing Plan -- Get. Gets an office's billing plan: how many licenses of each line type the office has purchased, its remaining calling-credit balance, and the start of the next billing cycle. This reports licenses that are paid for, not how many are free to assign. Rate limit: 1200 per minute.

office_plan.get

Phone String -- Reformat. Converts a phone number between local and E.164 format. Returns the E.164 number, the formatted local number, the area code, and the ISO country code. Rate limit: 1200 per minute.

phone_number.format

Report Download API -- Download scheduled stats. Downloads the requested scheduled report when available. The official page documents the report type user_voiceline and a YYYY-MM-DD date, but does not publish a success content type or response schema; the plugin returns the report bytes in a validated base64 envelope.

reports.scheduledstats.download

Screen-pop -- Trigger. Opens the given URI on the user's active Dialpad device, so an agent sees the relevant record (CRM contact, ticket, order) without searching for it. Returns the device the pop was delivered to. Requires the `screen_pop` OAuth scope. Requires scope: ``screen_pop`` Rate limit: 5 per minute.

screen_pop.initiate

User -- Search. Searches for users matching a specific criteria. It matches phone numbers, emails, or name. Optionally, it accepts filters to reduce the amount of final results. - The `cursor` value is provided in the response, and can be passed as a parameter to retrieve subsequent pages of results. Rate limit: 1200 per minute.

search.users

SMS -- Send. Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user. Provide either to_numbers or channel_hashtag as the recipient, and either text or media as the content. A channel's hashtag is available from the channel endpoints. Tier 0 Rate limit: 100 per minute. Tier 1 Rate limit: 800 per minute.

sms.send