# Dialpad integration

> Cloud-based business phone, SMS, video, and contact center platform — manage users, calls, SMS, contacts, offices, and call routing

- Authentication: oauth2

## Tools (240)

- **Add Blocked Number**: Blocks the specified numbers company-wide.
- **Add Call Center Operator**: Adds an operator to a call center.
- **Add Call Participant**: Adds another participant to a call. Valid methods to add are by phone or by target. Targets require to have a primary phone Added on Nov 11, 2021 f...
- **Add Channel Member**: Adds a user to a channel.
- **Add Coaching Team Member**: Add a user to the specified coaching team as trainee or coach.
- **Add Department Operator**: Adds an operator to a department.
- **Add Office Operator**: Adds an operator into office's mainline.
- **Assign Access Control Policy**: Assigns a user to an access control policy.
- **Assign Custom IVR**: Sets an existing Ivr for a target.
- **Assign Fax Line**: 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...
- **Assign Number**: Assigns a number to a target. Target includes user, department, office, room, callcenter,
- **Assign Number to Call Router**: Assigns a number to a callrouter. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise...
- **Assign Number to Office**: 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 nu...
- **Assign Number to Room**: 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 num...
- **Assign Number to User**: 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 num...
- **Assign Operator to Call**: Assigns an operator to a call queued in a contact center. Only contact center calls are eligible for this operation. Currently, this endpoint suppo...
- **Assign Room Desk Phone PIN**: Assigns a PIN for making international calls from rooms
- **Auto-Assign Number**: Assigns a number to a target. The number will automatically be taken from the company's reserved pool if there are reserved numbers, otherwise a nu...
- **Create Access Control Policy**: Creates a new custom access control policy.
- **Create Agent Status Event Subscription**: Creates an agent status event subscription for your company. A webhook_id is required so that we know to which url the events shall be sent. Please...
- **Create Callback**: Queues a callback in a call center for a customer who requested a return call.
- **Create Call Center**: Creates a new call center.
- **Create Call Event Subscription**: Creates a call event subscription. A webhook_id is required so that we know to which url the events shall be sent. Call states can be used to limit...
- **Create Call Review Share Link**: Create a call review share link by call id.
- **Create Call Router**: Creates a new API-based call router.
- **Create Change Log Event Subscription**: Creates a change log event subscription for your company. An endpoint_id is required so that we know to which url the events shall be sent.
- **Create Channel**: Creates a new channel.
- **Create Channel Event Subscription**: Creates a Channel event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A channel direction is also...
- **Create Contact**: Creates a new contact. Omit owner_id for a shared company contact; include it for a per-user local contact.
- **Create Contact Event Subscription**: Creates a contact event subscription for your company. A webhook_id is required so that we know to which url the events shall be sent.
- **Create Custom IVR**: Creates a new custom IVR for a target.
- **Create Department**: Creates a new department.
- **Create Disposition**: Creates a disposition for an office.
- **Create Fax Event Subscription**: Creates a fax event subscription. An endpoint_id is required so that we know to which url the events shall be sent. A fax direction is also require...
- **Create Meeting**: Creates a Dialpad meeting.
- **Create Meeting Room**: Creates a meeting room (personal or unique meeting).
- **Create Office**: Creates a secondary office.
- **Create or Update Contact**: Creates a new shared contact with uid. Added on Jun 11, 2020 for API v2.
- **Create Recording Share Link**: Creates a recording share link.
- **Create Room**: Creates a new room.
- **Create Scheduled Message**: Creates a new scheduled message that will be sent at the specified time.
- **Create Schedule Report**: 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...
- **Create SMS Event Subscription**: Creates an SMS event subscription. A webhook_id is required so that we know to which url the events shall be sent. An SMS direction is also require...
- **Create User**: Creates a new user in a specified office, optionally auto-assigning a phone number.
- **Create Webhook**: Registers a webhook URL that receives Dialpad events. The optional secret is used to sign payloads as JWT (HS256).
- **Create Websocket**: Creates a new websocket for your company.
- **Delete Access Control Policy**: Deletes a policy by marking the state as deleted, and removing all associated users.
- **Delete Agent Status Event Subscription**: Deletes an agent status event subscription by id.
- **Delete Call Center**: Deletes a call center by id.
- **Delete Call Event Subscription**: Deletes a call event subscription by id.
- **Delete Call Review Share Link**: Delete a call review share link by id.
- **Delete Call Router**: Deletes the API call router with the given ID.
- **Delete Change Log Event Subscription**: Deletes a change log event subscription by id.
- **Delete Channel**: Deletes a channel by id.
- **Delete Channel Event Subscription**: Deletes a Channel event subscription by id.
- **Delete Contact**: Permanently deletes a contact by id.
- **Delete Contact Event Subscription**: Deletes a contact event subscription by id.
- **Delete Custom IVR**: Delete and un-assign an Ivr from a target.
- **Delete Department**: Deletes a department by id.
- **Delete Disposition**: Deletes the disposition by id.
- **Delete Fax Event Subscription**: Deletes a fax event subscription by id.
- **Delete Meeting**: Deletes a Dialpad meeting.
- **Delete Recording Share Link**: Deletes a recording share link by id.
- **Delete Room**: Deletes a room by id.
- **Delete Room Desk Phone**: Deletes a room desk phone by id. Added on May 17, 2018 for API v2.
- **Delete Scheduled Message**: Deletes (cancels) a scheduled message. The message will not be sent.
- **Delete Schedule Report**: Deletes a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports.
- **Delete SMS Event Subscription**: Deletes an SMS event subscription by id.
- **Delete User**: Deletes a Dialpad user. Recoverable for 72 hours, after which the record is anonymized.
- **Delete User Desk Phone**: Deletes a user desk phone by id. Added on May 17, 2018 for API v2.
- **Delete Webhook**: Deletes a webhook by id.
- **Delete Websocket**: Deletes a websocket by id.
- **Get Access Control Policy**: Get a specific access control policy's details.
- **Get Agent Group**: Agent Group -- Get
- **Get Agent Status Event Subscription**: Gets an agent status event subscription by id.
- **Get App Settings**: 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, wi...
- **Get Blocked Number**: Gets the specified blocked number.
- **Get Bulk Message**: Gets a single bulk message by ID.
- **Get Call**: Retrieves a single call by id including recordings, transcripts, recap, and routing breadcrumbs.
- **Get Call AI Recap**: Gets the Ai Recap for a call.
- **Get Call Center**: Gets a call center by id. Added on May 1, 2018 for API v2.
- **Get Call Center Operator Duty Status**: Gets the operator's on duty status and reason.
- **Get Call Center Operator Skill Level**: Gets the skill level of an operator within a call center.
- **Get Call Center Status**: Gets live status information on the corresponding Call Center.
- **Get Call Event Subscription**: Gets a call event subscription by id.
- **Get Call Review Share Link**: Gets a call review share link by call id.
- **Get Call Router**: Gets the API call router with the given ID.
- **Get Call Transcript**: Retrieves the AI-generated transcript and detected moments for a completed call.
- **Get Call Transcript URL**: Gets the transcript url of a call.
- **Get Change Log Event Subscription**: Gets a change log event subscription by id.
- **Get Channel**: Get channel by id
- **Get Channel Event Subscription**: Gets a channel event subscription by id.
- **Get Coaching Team**: Get details of a specified coaching team. Added on Jul 30th, 2021 for API v2.
- **Get Company**: Returns top-level company information including name, country, account tier, and office count.
- **Get Company SMS Opt-out List**: Company -- Get SMS Opt-out List
- **Get Contact**: Retrieves a single contact by id with all phone numbers, emails, URLs, and custom data.
- **Get Contact Event Subscription**: Gets a contact event subscription by id.
- **Get Custom IVRs**: Gets all the custom IVRs for a target.
- **Get Department**: Gets a department by id. Added on May 1, 2018 for API v2.
- **Get Disposition**: Gets a disposition by id.
- **Get Fax Event Subscription**: Gets a fax event subscription by id.
- **Get Meeting**: Gets a Dialpad meeting.
- **Get Number**: Gets number details by number.
- **Get Office**: Retrieves detailed information about a specific office.
- **Get Office Billing Plan**: Gets the plan for an office.
- **Get Office E911 Address**: Gets E911 address of the office by office id.
- **Get Primary Office**: Gets the primary office for the company associated with the API key.
- **Get Recording Share Link**: Gets a recording share link by id.
- **Get Room**: Gets a room by id.
- **Get Room Desk Phone**: Gets a room desk phone by id. Added on May 17, 2018 for API v2.
- **Get Scheduled Message**: Gets a single scheduled message by ID.
- **Get Schedule Report**: Gets a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports.
- **Get Scorecard**: Gets a scorecard by id.
- **Get Scorecards Export Result**: Gets the progress and result of a scorecards report request.
- **Get SMS Event Subscription**: Gets an SMS event subscription by id.
- **Get Stats Result**: Gets the progress and result of a statistics request.
- **Get User**: Retrieves detailed information about a specific user by id (or `me` for the authenticated user).
- **Get User Caller ID**: List all available Caller IDs and the active Caller ID for a given user ID
- **Get User Desk Phone**: Gets a user desk phone by id. Added on May 17, 2018 for API v2.
- **Get User Device**: Gets a device by ID.
- **Get User E911 Address**: Gets E911 address of the user by user id.
- **Get Webhook**: Gets a webhook by id.
- **Get Websocket**: Gets a websocket by id.
- **Get WFM Activity Metrics**: Returns paginated, activity-level metrics for specified agents.
- **Get WFM Agent Metrics**: Returns paginated, detailed agent-level performance metrics.
- **Hang Up Call**: Programmatically ends an active call by id.
- **Initiate Call via Ring**: Initiates an outbound call to ring all devices (or a single specified device).
- **Initiate IVR Call**: Initiates an outbound call to ring an IVR Workflow.
- **Initiate Outbound Call**: Causes a specific Dialpad user's app to place an outbound call to a phone number.
- **Initiate Scorecards Export**: Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /scorecards/export/{r...
- **Initiate Stats Processing**: Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{request_id}.
- **List Access Control Policies**: Gets all access control policies belonging to the company.
- **List Access Control Policy Assignments**: Lists all users assigned to this access control policy.
- **List Agent Status Event Subscriptions**: Gets a list of all the agent status event subscriptions of a company.
- **List Blocked Numbers**: Lists all numbers that have been blocked via the API.
- **List Bulk Messages**: Lists all bulk messages for the authenticated user.
- **List Call Assigned Operators**: Get all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation.
- **List Callbacks**: Lists callback requests for a specific call center.
- **List Call Center Operators**: Gets operators for a call center. Added on May 1, 2018 for API v2.
- **List Call Centers**: Lists call centers configured for the company, optionally filtered by office or name.
- **List Call Event Subscriptions**: Gets a list of all the call event subscriptions of a company or of a target.
- **List Call Labels**: Gets all labels for a determined company.
- **List Call Routers**: Lists all of the API call routers for a given company or office.
- **List Calls**: Lists calls in reverse-chronological order, optionally filtered by target, time range, and direction.
- **List Change Log Event Subscriptions**: Gets a list of all the change log event subscriptions of a company.
- **List Channel Event Subscriptions**: Gets a list of all the Channel event subscriptions of a company or of a target.
- **List Channel Members**: List all the members from a channel
- **List Channels**: Lists Dialpad team-messaging channels.
- **List Coaching Team Members**: Get a list of members of a coaching team. Added on Jul 30th, 2021 for API v2.
- **List Coaching Teams**: Get a list of all coaching teams in the company. Added on Feb 3rd, 2022 for API v2.
- **List Contact Event Subscriptions**: Gets a list of all the contact event subscriptions of a company.
- **List Contacts**: Returns a paginated list of contacts — shared company contacts and (optionally) per-user local contacts.
- **List Department Operators**: Gets operators for a department. Added on May 1, 2018 for API v2.
- **List Departments**: Lists departments, optionally filtered by office or name search.
- **List Digital Sessions**: Gets list of digital sessions which are started/ended in the requested period
- **List Dispositions**: Gets a list of dispositions by a target.
- **List Fax Event Subscriptions**: Gets a list of all the fax event subscriptions of a company or of a target.
- **List Meeting Rooms**: Lists all conference rooms.
- **List Meetings**: Lists all Dialpad meetings for a specified user.
- **List Meeting Summaries**: Lists summaries of meetings that have occurred in the specified meeting room.
- **List Numbers**: Gets all numbers in your company.
- **List Office Available Licenses**: Gets the available licenses for an office.
- **List Office Call Centers**: Gets all the call centers for an office. Added on May 1, 2018 for API v2.
- **List Office Coaching Teams**: Get a list of coaching teams of a office. Added on Jul 30th, 2021 for API v2.
- **List Office Departments**: Gets all the departments for an office. Added on May 1, 2018 for API v2.
- **List Office Off-Duty Statuses**: Lists Off-Duty status values.
- **List Office Operators**: Gets mainline operators for an office. Added on May 1, 2018 for API v2.
- **List Offices**: Returns a paginated list of offices in the company.
- **List Room Desk Phones**: Gets all desk phones under a room. Added on May 17, 2018 for API v2.
- **List Rooms**: Gets all rooms in your company, optionally filtering by office.
- **List Scheduled Messages**: Lists all active scheduled messages for the authenticated user.
- **List Schedule Reports**: Lists all schedule reports subscription for a company. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics...
- **List Scorecards**: Gets a list of scorecards of a target.
- **List SMS Event Subscriptions**: Gets a list of all the SMS event subscriptions of a company or of a target.
- **List User Desk Phones**: Gets all desk phones under a user. Added on May 17, 2018 for API v2.
- **List User Devices**: Lists the devices for a specific user.
- **List User Personas**: Provides a list of personas for a user.
- **List Users**: Retrieves a paginated list of users in the company, optionally filtered by email, phone number, state, or admin flag.
- **List Webhooks**: Lists webhooks configured for the authenticated company.
- **List Websockets**: Gets a list of all the websockets that are associated with the company.
- **Reformat Phone Number**: Used to convert local number to E.164 or E.164 to local format.
- **Remove Blocked Number**: Unblocks the specified numbers company-wide.
- **Remove Call Center Operator**: Removes an operator from a call center.
- **Remove Channel Member**: Removes a member from a channel.
- **Remove Department Operator**: Removes an operator from a department.
- **Remove Office Operator**: Removes an operator from office's mainline.
- **Send Bulk Message**: Sends a bulk message to multiple recipients (up to 50).
- **Send Fax**: Sends a fax to a phone number.
- **Send Scheduled Message Now**: Immediately sends a scheduled message and deletes the schedule.
- **Send SMS**: Sends an SMS or MMS (with base64 media) from a Dialpad user or group to up to 10 recipients.
- **Set Call Labels**: Set Labels for a determined call id.
- **Set User Caller ID**: Set Caller ID for a given user ID.
- **Swap Number**: Swaps a target's primary number with a new one.
- **Switch User 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 assigne...
- **Toggle Call Recording**: Turns call recording on or off for a user's active call.
- **Toggle Call VI**: Turns call vi on or off for a user's active call. Added on May 4, 2021 for API v2.
- **Toggle Do Not Disturb**: Toggle DND status on or off for the given user.
- **Transfer Call**: Transfers an active call to another number, an existing call, or a Dialpad target.
- **Trigger Screen Pop**: Initiates screen pop for user device.
- **Unassign Access Control Policy**: Unassigns one or all target groups associated with the user for an access control policy.
- **Unassign All Operators from Call**: Unassigns all assigned operators from a call queued in a contact center. Only contact center calls are eligible for this operation.
- **Unassign Number**: Un-assigns a phone number from a target. The number will be returned to the company's reserved pool if there is one. Otherwise the number will be r...
- **Unassign Number from Office**: 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...
- **Unassign Number from Room**: 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 rel...
- **Unassign Number from User**: 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 re...
- **Unassign Operator from Call**: Unassigns an operator from a call queued in a contact center. Only contact center calls are eligible for this operation. This endpoint supports una...
- **Unpark Call**: Unparks call from Office mainline. Added on Nov 11, 2024 for API v2.
- **Update Access Control Policy**: Updates the provided fields for an existing access control policy.
- **Update Agent Status Event Subscription**: Updates an agent status event subscription by id.
- **Update Bulk Message**: Updates a bulk message text and/or media. Supports partial updates.
- **Update Call Center**: Updates a call center by id.
- **Update Call Center Operator Duty Status**: Updates the operator's duty status for all call centers which user belongs to.
- **Update Call Center Operator Skill Level**: Updates the skill level of an operator within a call center.
- **Update Call Event Subscription**: Updates a call event subscription by id.
- **Update Call Review Share Link**: Update a call review share link by id.
- **Update Call Router**: Updates the API call router with the given ID.
- **Update Change Log Event Subscription**: Updates change log event subscription by id.
- **Update Channel Event Subscription**: Updates a channel event subscription by id.
- **Update Company Settings**: Updates company settings.
- **Update Contact**: Updates an existing contact. Arrays (emails, phones, urls) replace rather than merge.
- **Update Contact Event Subscription**: Updates a contact event subscription by id.
- **Update Custom IVR**: Update the name or description of an existing custom ivr.
- **Update Department**: Updates an existing department.
- **Update Disposition**: Updates the disposition by id. Bulk updates for the targets assigned to a disposition is not supported.
- **Update Fax Event Subscription**: Updates a fax event subscription by id.
- **Update Meeting**: Updates a Dialpad meeting.
- **Update Number Tags**: Update tags for a phone number.
- **Update Office**: Updates an office
- **Update Office E911 Address**: Update E911 address of the given office.
- **Update Recording Share Link**: Updates a recording share link by id.
- **Update Room**: Updates room details by id.
- **Update Scheduled Message**: Updates an existing scheduled message. Supports partial updates.
- **Update Schedule Report**: Updates a schedule report subscription by id. A schedule report is a mechanism to schedule daily, weekly or monthly record and statistics reports.
- **Update SMS Event Subscription**: Updates an SMS event subscription by id.
- **Update User**: Updates an existing user — profile fields, license, office assignment, admin flags, status, and forwarding numbers.
- **Update User E911 Address**: Update E911 address of the given user.
- **Update User Status**: Update user's status. Returns the user's status if the user exists.
- **Update Webhook**: Updates a webhook by id.
- **Update Websocket**: Updates a websocket by id.
- **Validate Callback**: Performs a dry-run of creating a callback request, without adding it to the call center queue.

## Related prompts

- [Daily sales call debrief digest in Slack from Dialpad](https://www.generalinput.com/prompts/daily-sales-call-debrief-digest-in-slack-from-dialpad.md)
- [Recover missed Dialpad calls with a personalized text-back](https://www.generalinput.com/prompts/recover-missed-dialpad-calls-with-a-personalized-text-back.md)
- [Every Monday, log last week's Dialpad calls to Sheets](https://www.generalinput.com/prompts/every-monday-log-last-weeks-dialpad-calls-to-sheets.md)
- [Turn Dialpad voicemails into triaged Zendesk tickets](https://www.generalinput.com/prompts/turn-dialpad-voicemails-into-triaged-zendesk-tickets.md)

Connect Dialpad in General Input: https://www.generalinput.com/apps/dialpad