Skip to content
Changelog

Report a bug

Dialpad integration: operations for AI agents

Dialpad connects to Type.com as an integration. This page lists the 386 operations documented for Claude and Codex in Type.com: 176 read, 152 write, 58 destructive.

About Dialpad

Dialpad is a cloud-based business phone system and contact center platform that enables voice, video, messages and meetings across your existing devices

Categories: Email & Messaging

How to connect Dialpad to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
Selected AI voice-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

386 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

386 operations listed.

Accesscontrolpolicies

  • Read

    Access Control Policies -- List Policies

    Gets all access control policies belonging to the company. Rate limit: 1200 per minute.

  • Read

    Access Control Policies -- Get

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

  • Read

    Access Control Policies -- List Assignments

    Lists all users assigned to this access control policy. Rate limit: 1200 per minute.

  • Write

    Access Control Policies -- Assign

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

  • Write

    Access Control Policies -- Create

    Creates a new custom access control policy. Requires a company admin API key. Rate limit: 1200 per minute.

  • Write

    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.

  • Write

    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.

  • Destructive

    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.

Agent groups

  • Read

    Agent Group -- Get

    Requires scope: agentgroups:read Rate limit: 1200 per minute.

Anonymization

  • Read

    Anonymization Request -- Get

    Returns the current status of an anonymization request. Rate limit: 1200 per minute.

  • Write

    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 requestid for status polling.

  • Write

    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 requestid for status polling. Rate limit: 10 per minute.

App

  • Read

    App Settings -- Get

    Gets the app settings of the OAuth app that is associated with the API key for the target, if targettype and targetid are provided. Otherwise, will return the app settings for the company. Rate limit: 1200 per minute.

Blockednumbers

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Write

    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.

Call

  • Read

    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.

  • Read

    Call -- Get

    Get call status and detailed information for a concluded call, including direction, duration, recording URLs, CSAT scores, voicemail metadata, and transcription text.

  • Read

    Call -- Get Ai Recap

    Gets the Ai Recap for a call. Requires scope: airecap Rate limit: 12 per minute.

  • Read

    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.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    Call -- Transfer

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

  • Write

    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.

  • Write

    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.

  • Write

    Call -- Unpark

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

  • Destructive

    Call Actions -- Hang up

    Hangs up the call. Rate limit: 1200 per minute.

  • Destructive

    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.

Callback

  • Read

    Call Back -- List

    Lists the callback requests waiting in a call center's queue, oldest first, so the first result has been waiting longest.

  • Write

    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.

  • Write

    Call Back -- Validate

    Performs a dry run of a callback request without adding it to the call center queue and without placing any call.

Callcenters

  • Read

    Call Centers -- List

    Gets all the call centers for the company. Rate limit: 1200 per minute.

  • Read

    Call Centers -- Get

    Gets a call center by id. Rate limit: 1200 per minute.

  • Read

    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.

  • Read

    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.

  • Read

    Operator -- Get Duty Status

    Gets the operator's on duty status and reason. Rate limit: 1200 per minute.

  • Read

    Operator -- Get Skill Level

    Gets the skill level of an operator within a call center. Rate limit: 1200 per minute.

  • Read

    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.

  • Write

    Call Centers -- Create

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

  • Write

    Call Centers -- Update

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

  • Write

    Operator -- Update Duty Status

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

  • Write

    Operator -- Update Skill Level

    Updates the skill level of an operator within a call center. Rate limit: 1200 per minute.

  • Write

    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.

  • Destructive

    Call Centers -- Delete

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

  • Destructive

    Operator -- Remove

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

Calllabels

  • Read

    Label -- List

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

Callreviewsharelink

  • Read

    Call Review Sharelink -- Get

    Gets a call review share link by call id. Rate limit: 1200 per minute.

  • Write

    Call Review Sharelink -- Create

    Create a call review share link by call id. Rate limit: 250 per minute.

  • Destructive

    Call Review Sharelink -- Update

    Update a call review share link by id. Rate limit: 250 per minute.

  • Destructive

    Call Review Sharelink -- Delete

    Delete a call review share link by id. Rate limit: 1200 per minute.

Callrouters

  • Read

    Call Router -- List

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

  • Read

    Call Router -- Get

    Gets the API call router with the given ID. Rate limit: 1200 per minute.

  • Write

    Call Router -- Create

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

  • Write

    Call Router -- Update

    Updates the API call router with the given ID. Rate limit: 1200 per minute.

  • Write

    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.

  • Destructive

    Call Router -- Delete

    Deletes the API call router with the given ID. Rate limit: 1200 per minute.

Channels

  • Read

    Channel -- Get

    Get channel by id Rate limit: 1200 per minute.

  • Read

    Channel -- List

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

  • Read

    Members -- List

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

  • Write

    Channel -- Create

    Creates a new channel. Rate limit: 1200 per minute.

  • Write

    Member -- Add

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

  • Destructive

    Channel -- Delete

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

  • Destructive

    Member -- Remove

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

Coachingteams

  • Read

    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.

  • Read

    Coaching Team -- Get

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

  • Read

    Coaching Team -- List

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

  • Write

    Coaching Team -- Add Member

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

Company

  • Read

    Company -- Get

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

  • Read

    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.

  • Destructive

    Company -- Update Settings

    Updates company settings. Requires a company admin API key. Rate limit: 1200 per minute.

Contacts

  • Read

    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.

  • Read

    Contact -- List

    Gets company shared contacts, or user's local contacts if ownerid is provided. NOTE: The limit parameter has been soft-deprecated. Please omit the limit parameter, or reduce it to 100 or less.

  • Write

    Contact -- Update

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

  • Write

    Contact -- Create

    Creates a new contact. Rate limit: 100 per minute.

  • Destructive

    Contact -- Delete

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

  • Destructive

    Contact -- Create or Update

    Creates a new shared contact with uid. Rate limit: 100 per minute.

Customivrs

  • Read

    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 ivrtype to narrow the results to one kind. Rate limit: 1200 per minute.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Destructive

    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.

Departments

  • Read

    Department -- Get

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

  • Read

    Department -- List

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

  • Read

    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.

  • Write

    Departments -- Update

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

  • Write

    Departments -- Create

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

  • Write

    Operator -- Add

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

  • Destructive

    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.

  • Destructive

    Operator -- Remove

    Remove an operator (user or room) from a department. Specify operatorid and operatortype. Rate limit: 1200 per minute.

Digital

  • Read

    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: digitalsessions Rate limit: 100 per minute.

Dispositions

  • Read

    Dispositions -- Get

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

  • Read

    Dispositions -- List

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

  • Write

    Dispositions -- Update

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

  • Write

    Dispositions -- Create

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

  • Destructive

    Dispositions -- Delete

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

Fax

  • Write

    Fax -- Send

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

Faxline

  • Write

    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.

Message

  • Read

    Bulk Message -- Get

    Gets a single bulk message by ID. Rate limit: 1200 per minute.

  • Read

    Bulk Message -- List

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

  • Read

    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.

  • Read

    Schedule -- Get

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

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Destructive

    Schedule -- Delete

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

Numbers

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Write

    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.

  • Write

    Dialpad Number -- Swap

    Replaces a target's primary phone number with a different one and returns the new number. The old number is released.

  • Write

    Number Tags -- Update tags for a phone number.

    Sets the contact preferences for a phone number company-wide. "donotcall" blocks outbound calls to the number and "donottext" blocks outbound texts. Returns the resulting preferences. Either preference can be turned back off by sending the opposite value.

  • Write

    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.

  • Destructive

    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.

Offices

  • Read

    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.

  • Read

    Call Centers -- List

    Gets all the call centers for an office. Rate limit: 1200 per minute.

  • Read

    Coaching Team -- List

    Get a list of coaching teams of a office. Rate limit: 1200 per minute.

  • Read

    Department -- List

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

  • Read

    E911 Address -- Get

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

  • Read

    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.

  • Read

    Off-Duty Status -- List

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

  • Read

    Office -- Get

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

  • Read

    Office -- Get Primary

    Gets the primary office for the company. Rate limit: 1200 per minute.

  • Read

    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.

  • Read

    Operator -- List

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

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Write

    Operator -- Add

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

  • Destructive

    E911 Address -- Update

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

  • Destructive

    Operator -- Remove

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

Recordingsharelink

  • Read

    Recording Sharelink -- Get

    Gets a recording share link by id. Rate limit: 1200 per minute.

  • Write

    Recording Sharelink -- Create

    Creates a recording share link. Rate limit: 100 per minute.

  • Destructive

    Recording Sharelink -- Update

    Updates a recording share link by id. Rate limit: 100 per minute.

  • Destructive

    Recording Sharelink -- Delete

    Deletes a recording share link by id. Rate limit: 1200 per minute.

Rooms

  • Read

    Room -- Get

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

  • Read

    Room -- List

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

  • Read

    Room Phone -- Get

    Gets a room desk phone by id. Rate limit: 1200 per minute.

  • Read

    Room Phone -- List

    Gets all desk phones under a room. Rate limit: 1200 per minute.

  • Write

    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.

  • Write

    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.

  • Write

    Room -- Update

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

  • Write

    Room -- Create

    Creates a new room. Rate limit: 1200 per minute.

  • Write

    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.

  • Destructive

    Room -- Delete

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

  • Destructive

    Room Phone -- Delete

    Deletes a room desk phone by id. Rate limit: 1200 per minute.

Schedulereports

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Write

    schedule reports -- Create

    Creates a schedule reports subscription for your company. An endpointid 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.

  • Destructive

    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.

Scorecards

  • Read

    Scorecards -- Get

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

  • Read

    Scorecards -- List

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

  • Read

    Scorecards export -- Get Result

    Gets the progress and result of a scorecards report request. Rate limit: 1200 per minute.

  • Write

    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/{requestid}. Scorecards for the whole company will be processed by default.

Sms

  • Write

    SMS -- Send

    Sends an SMS message to a phone number or to a Dialpad channel on behalf of a user. Provide either tonumbers or channelhashtag as the recipient, and either text or media as the content. A channel's hashtag is available from the channel endpoints.

Stats

  • Read

    Stats -- Get Result

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

  • Write

    Stats -- Initiate Processing

    Begins processing statistics asynchronously, returning a request id to get the status and retrieve the results by calling GET /stats/{requestid}. Stats for the whole company will be processed by default. An officeid can be provided to limit stats to a single office.

Subscriptions

  • Read

    Agent Status -- List

    Gets a list of all the agent status event subscriptions of a company. Requires a company admin API key. Rate limit: 1200 per minute.

  • Read

    Agent Status -- Get

    Gets an agent status event subscription by id. Requires a company admin API key. Rate limit: 1200 per minute.

  • Read

    Call Event -- List

    Gets a list of all the call event subscriptions of a company or of a target. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Read

    Call Event -- Get

    Gets a call event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Read

    Change Log -- List

    Gets a list of all the change log event subscriptions of a company. Requires a company admin API key. Requires scope: changelog Rate limit: 1200 per minute.

  • Read

    Change Log -- Get

    Gets a change log event subscription by id. Requires a company admin API key. Requires scope: changelog Rate limit: 1200 per minute.

  • Read

    Channel Event -- List

    Gets a list of all the Channel event subscriptions of a company or of a target. Rate limit: 1200 per minute.

  • Read

    Channel Event -- Get

    Gets a channel event subscription by id. Rate limit: 1200 per minute.

  • Read

    Contact Event -- List

    Gets a list of all the contact event subscriptions of a company. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute.

  • Read

    Contact Event -- Get

    Gets a contact event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute.

  • Read

    Fax Event -- List

    Gets a list of all the fax event subscriptions of a company or of a target. Requires scope: faxmessage Rate limit: 1200 per minute.

  • Read

    Fax Event -- Get

    Gets a fax event subscription by id. Requires scope: faxmessage Rate limit: 1200 per minute.

  • Read

    SMS Event -- List

    Gets a list of all the SMS event subscriptions of a company or of a target. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Read

    SMS Event -- Get

    Gets an SMS event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Write

    Agent Status -- Create

    Creates an agent status event subscription for your company. A webhookid is required so that we know to which url the events shall be sent. Please be aware that only call center agent is supported for agent event subscription now.

  • Write

    Agent Status -- Update

    Updates an agent status event subscription by id. Requires a company admin API key. Rate limit: 1200 per minute.

  • Write

    Call Event -- Create

    Creates a call event subscription. A webhookid is required so that we know to which url the events shall be sent. Call states can be used to limit the states for which call events are sent.

  • Write

    Call Event -- Update

    Updates a call event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Write

    Change Log -- Create

    Creates a change log event subscription for your company. An endpointid is required so that we know to which url the events shall be sent.

  • Write

    Change Log -- Update

    Updates change log event subscription by id. Requires a company admin API key. Requires scope: changelog Rate limit: 1200 per minute.

  • Write

    Channel Event -- Create

    Creates a Channel event subscription. An endpointid is required so that we know to which url the events shall be sent. A channel direction is also required in order to limit the direction for which events are sent. Use 'all' to get channel events for all directions.

  • Write

    Channel Event -- Update

    Updates a channel event subscription by id. Rate limit: 1200 per minute.

  • Write

    Contact Event -- Create

    Creates a contact event subscription for your company. A webhookid is required so that we know to which url the events shall be sent.

  • Write

    Contact Event -- Update

    Updates a contact event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute.

  • Write

    Fax Event -- Create

    Creates a fax event subscription. An endpointid is required so that we know to which url the events shall be sent. A fax direction is also required in order to limit the direction for which fax events are sent. Use 'all' to get fax events for all directions.

  • Write

    Fax Event -- Update

    Updates a fax event subscription by id. Requires scope: faxmessage Rate limit: 1200 per minute.

  • Write

    SMS Event -- Create

    Creates an SMS event subscription. A webhookid is required so that we know to which url the events shall be sent. An SMS direction is also required in order to limit the direction for which SMS events are sent. Use 'all' to get SMS events for all directions.

  • Write

    SMS Event -- Update

    Updates an SMS event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Destructive

    Agent Status -- Delete

    Deletes an agent status event subscription by id. Requires a company admin API key. Rate limit: 1200 per minute.

  • Destructive

    Call Event -- Delete

    Deletes a call event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

  • Destructive

    Change Log -- Delete

    Deletes a change log event subscription by id. Requires a company admin API key. Requires scope: changelog Rate limit: 1200 per minute.

  • Destructive

    Channel Event -- Delete

    Deletes a Channel event subscription by id. Rate limit: 1200 per minute.

  • Destructive

    Contact Event -- Delete

    Deletes a contact event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Requires a company admin API key. Rate limit: 1200 per minute.

  • Destructive

    Fax Event -- Delete

    Deletes a fax event subscription by id. Requires scope: faxmessage Rate limit: 1200 per minute.

  • Destructive

    SMS Event -- Delete

    Deletes an SMS event subscription by id. NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs. Rate limit: 1200 per minute.

Transcripts

  • Read

    Call Transcript -- Get

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

  • Read

    Call Transcript -- Get URL

    Gets the transcript url of a call. Rate limit: 1200 per minute.

Userdevices

  • Read

    User Device -- Get

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

  • Read

    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.

Users

  • Read

    Caller ID -- Get

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

  • Read

    Desk Phone -- Get

    Gets a user desk phone by id. Rate limit: 1200 per minute.

  • Read

    Desk Phone -- List

    Gets all desk phones under a user. Rate limit: 1200 per minute.

  • Read

    E911 Address -- Get

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

  • Read

    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.

  • Read

    User -- Get

    Get a user by id. Returns identity (name, email, jobtitle), contact details (phonenumbers, extension), status (state, donotdisturb, isonduty, ondutystatus), license type, office membership (officeid, groupdetails), and voicemail settings. Rate limit: 1200 per minute.

  • Read

    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.

  • Read

    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.

  • Write

    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.

  • Write

    Call Recording -- Toggle

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

  • Write

    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.

  • Write

    Caller ID -- Set

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

  • Write

    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.

  • Write

    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.

  • Write

    Do Not Disturb -- Toggle

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

  • Write

    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 screenpop OAuth scope.

  • Write

    User -- Update

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

  • Write

    User -- Create

    Creates a new user. Rate limit: 1200 per minute.

  • Write

    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.

  • Write

    User Status -- Update

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

  • Destructive

    Desk Phone -- Delete

    Deletes a user desk phone by id. Rate limit: 1200 per minute.

  • Destructive

    E911 Address -- Update

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

  • Destructive

    User -- Delete

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

Webhooks

  • Read

    Webhook -- List

    Gets a list of all the webhooks that are associated with the company. Rate limit: 1200 per minute.

  • Read

    Webhook -- Get

    Gets a webhook by id. Rate limit: 1200 per minute.

  • Write

    Webhook -- Create

    Creates a new webhook for your company. A unique webhook ID will be generated when successfully creating a webhook. A webhook ID is to be required when creating event subscriptions. One webhook ID can be shared between multiple event subscriptions.

  • Write

    Webhook -- Update

    Updates a webhook by id. Rate limit: 1200 per minute.

  • Destructive

    Webhook -- Delete

    Deletes a webhook by id. Rate limit: 1200 per minute.

Websockets

  • Read

    Websocket -- List

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

  • Read

    Websocket -- Get

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

  • Write

    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.

  • Write

    Websocket -- Update

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

  • Destructive

    Websocket -- Delete

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

Conference

  • Read

    Meeting Room -- List

    Lists all conference rooms. Requires scope: conference:read Rate limit: 1200 per minute.

  • Read

    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

  • Read

    Dialpad Meeting -- Get

    Gets a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute.

  • Read

    Dialpad Meeting -- List

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

  • Write

    Dialpad Meeting -- Create

    Creates a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute.

  • Write

    Meeting Room -- Create

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

  • Destructive

    Dialpad Meeting -- Update

    Updates a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute.

  • Destructive

    Dialpad Meeting -- Delete

    Deletes a Dialpad meeting. Requires scope: conference:all Rate limit: 1200 per minute.

Oauth2

  • Read

    Token -- Authorize

    Initiate the OAuth flow to grant an application access to Dialpad resources on behalf of a user.

  • Write

    Token -- Deauthorize

    Revokes oauth2 tokens for a given oauth app.

  • Write

    Token -- Redeem

    Exchanges a temporary oauth code for an authorized access token.

Powerdialer

  • Read

    Ably Auth Endpoint

    Auth endpoint for ably js client

  • Read

    Bulk fetch entities by short keys

    Bulk fetch entity short keys by comma-delimited url params

  • Read

    Bulk fetch entities of a single kind by short keys

    Bulk fetch entities of a single kind by a list of ids or short keys

  • Read

    Get a Contact

    Get a Contact

  • Read

    List Custom Properties

    Get a list of custom properties for the company

  • Read

    Get Custom Property

    Get a single custom property by id

  • Read

    Get Dialpad OAuth Service

    Get a Dialpad OAuth Service record by service name

  • Read

    Get EventLogs

    Get a list of EventLog's for a Campaign

  • Read

    Get Company GlobalSettings

    Get company GlobalSettings with only modified fields

  • Read

    List Jobs

    Get all background Jobs for the company, newest first

  • Read

    Get Job

    Get a single Job by ID, including its reduced results

  • Read

    List API Keys

    List the keys issued for the company. Tokens are never returned - each key is identified by id (the token's hash) and token is its tail. Admins see every key, everyone else only keys acting as themselves

  • Read

    Get API Key

    Get a key by its id (the token's hash). The token itself is not returned

  • Read

    Initial endpoint to hit after oauth

    Returns all initial values for user, company, config, etc

  • Read

    Get Operator

    Get a list of Operators

  • Read

    List Service Accounts

    Get the company's service accounts - non-human principals that api keys can be issued for and that author the entities they create

  • Read

    Get Service Account

    Get a single service account by id

  • Read

    Get Sms List for a Target

    DEBUG: Get a list of recent sms given a Target

  • Read

    The Current User

    JSON representation of the logged in user

  • Read

    Get Workers

    Get a list of Workers for a Campaign

  • Read

    Get a Worker

    Get a Worker

  • Write

    Create or Update Custom Properties

    Create or update custom properties in bulk. Uses upsert semantics: if a property with the same name already exists, it will be updated with the new values. Otherwise, a new property will be created. Property names must contain only alphanumeric characters and underscores.

  • Write

    Update Custom Property

    Update a custom property

  • Write

    Update Company GlobalSettings

    Update company GlobalSettings entity

  • Write

    External Hook Endpoint

    Generic hook for receiving requests from Hubspot etc

  • Write

    Create API Key

    Issue a key acting as the caller, or as a service account (admins only). This is the only response that ever includes the secret, as tokenfull - store it

  • Write

    Update API Key

    Rename a key

  • Write

    Login with a Dialpad access token

    Establishes a browser session from a Dialpad access token bearer: sets the session cookie and returns the login json (Dialpad's raw payload with raw=1)

  • Write

    Create Service Account

    Create a service account with a role ('admin' or 'readonly'). Company admins only

  • Write

    Update Service Account

    Rename a service account or change its role. Company admins only

  • Write

    Send SMS

    DEBUG: Send a text message through dialpad for a given LeadListItem

  • Write

    Update Worker

    Update a Worker

  • Destructive

    Bulk delete entities of a single kind by short keys

    Bulk delete entities of a single kind by a list of ids or short keys

  • Destructive

    Delete Custom Property

    Delete a custom property

  • Destructive

    Delete API Key

    Revoke a key

  • Destructive

    Delete Service Account

    Delete a service account and revoke every key issued for it. The company's default account cannot be deleted. Company admins only

Audiences

  • Read

    Get Audiences

    Get a list of Audiences

  • Read

    Get Audience

    Get a single Audience by id

  • Write

    Create an Audience

    Create an Audience

  • Write

    Duplicate an Audience

    Create a new audience from an existing one

  • Write

    Update an Audience

    Update an Audience name and/or query

  • Destructive

    Delete an Audience

    Delete a Audience

Bots

  • Read

    List Bots

    Get all Bots (kare widgets) for the company

  • Read

    Get Bot

    Get a single Bot by ID

  • Read

    List Bot Dialogs

    Get all BotDialogs for the company, optionally filtered by botid

  • Read

    Get Bot Dialog

    Get a single BotDialog by ID

  • Read

    List Bot Messages

    Get the transcript of a BotDialog, oldest message first

  • Read

    Get Bot Message

    Get a single BotMessage by ID

  • Write

    Create Bot

    Create a new Bot representing a kare widget

  • Write

    Update Bot

    Update a Bot's name or kare ids

  • Write

    Create Bot Dialog

    Create a pending BotDialog and start the dialog job: init a kare converse conversation, connect its websocket, and send text as the first message

  • Write

    Update Bot Dialog

    Perform an action on a BotDialog, e.g. end it without deleting

  • Write

    Create Bot Message

    Queue a new user message on an open BotDialog. The dialog job sends pending messages into the socket and marks them sent.

  • Destructive

    Delete Bot

    Delete a Bot

  • Destructive

    Delete Bot Dialog

    Delete a BotDialog and all of its messages

  • Destructive

    Delete Bot Message

    Delete a BotMessage

Campaigns

  • Read

    List of Campaigns

    Fetch a list of Campaign entities assoicated with the company

  • Read

    Search Campaigns with POST

    POST version of /api/campaign - supports large lists and date range filtering

  • Read

    Get Campaign

    Get an individual Campaign

  • Read

    Get campaign result export url

    Get a presigned url to download campaign result export

  • Read

    List Campaign Groups

    List Campaign Groups

  • Read

    Get A Campaign Group

    Get A Campaign Group

  • Read

    Get a Campaign Settings object

    Settings for a Campaign

  • Read

    Get auto-complete variable info

    Auto-complete variable info belonging to a campaign with campaign id

  • Write

    Create Campaign

    Create a new Campaign associated with a Dialpad Target

  • Write

    Duplicate a Campaign

    Create a new campaign from an existing one

  • Write

    Update Campaign

    Update a Campaign like starting, resetting, etc

  • Write

    Start a campaign result export job

    Start a campaign result export job

  • Write

    Create Campaign Group

    Create Campaign Group

  • Write

    Update Campaign Group

    Update Campaign Group

  • Write

    Edit Settings for a Campaign

    Edit a Campaign Settings object

  • Destructive

    Delete Campaign

    Delete a campaign entity

  • Destructive

    Delete Campaign Group, unlink member campaigns

    Delete Campaign Group, unlink member campaigns

CSV

  • Read

    Get List of CSVs

    Get a list of Csv entities

  • Read

    Get CSV

    Get an individual CSV entity

  • Read

    Generate a presigned url to download a CSV file with TTL=30s

    Generate a presigned url to download a CSV file with TTL=30s

  • Read

    Get List of Phone CSVs

    Get a list of PhoneCsv entities

  • Read

    Get Phone CSV

    Get an individual Phone CSV entity

  • Write

    Upload CSV

    Upload a CSV and create a Csv entity

  • Write

    Update CSV

    Update a CSV with a mapping, labels, name, etc

  • Write

    Upload Phone CSV

    Upload a CSV to update Phone table and create a PhoneCsv entity

  • Write

    Update Phone CSV

    Update a Phone CSV with a mapping, labels, name, etc

  • Destructive

    Delete CSV

    Delete a Csv Entity

  • Destructive

    Delete Phone CSV

    Delete a Phone Csv Entity

Lead Lists

  • Read

    List of LeadListItem

    List of LeadListItem belonging to a Campaign

  • Read

    Get a LeadListItem

    Get a single LeadListItem by id

  • Read

    List of LeadList

    Get a list of LeadLists

  • Read

    Get a LeadList

    Get a LeadList

  • Read

    Get Combined List View

    Get a combined list of Csv, Audience, and StaticList entities

  • Read

    Get Static Lists

    Get a list of Static Lists

  • Read

    Get Static List

    Get a single Static List by id

  • Write

    Create a shared LeadList

    Create a new shared LeadList

  • Write

    Duplicate a LeadList

    Create a new shared LeadList from an existing one, including duplicating its Audiences and StaticLists

  • Write

    Update LeadList

    Update a LeadList with csvids, audienceids, etc. Supports actions: setaudience, removeaudience, createstaticlist, addleads, removeleads, addsnapshot, refreshsnapshot, clearsnapshot, clearmanual, refreshaudience

  • Write

    Create a Static List

    Create a Static List

  • Write

    Duplicate a Static List

    Create a new static list from an existing one

  • Write

    Update Static List

    Update a Static List with leads

  • Destructive

    Delete a LeadListItem

    Delete a LeadListItem

  • Destructive

    Delete a LeadList

    Delete a shared LeadList and its associated Audiences and StaticLists

  • Destructive

    Delete a Static List

    Delete a Static List

Leads

  • Read

    List of Leads

    Get a list of Leads, including searching for leads by filter, sql, and ai

  • Read

    List of Leads by Query

    Get a list of Leads based on complex Queries

  • Read

    Get Lead

    Get an individual lead

  • Read

    List of LeadCompanies

    Get a list of LeadCompany entities, with optional search and ordering

  • Read

    Get LeadCompany

    Get an individual LeadCompany

  • Read

    Get a Lead CSV export

    Poll an export started with POST /api/leadexport. While it is still running there is no 'url'; on success 'url' is a short-lived signed download link; on failure 'error' says why.

  • Read

    Search shared LeadLists

    Search shared LeadLists with optional campaign counts

  • Read

    Get a LeadList view

    Get a single LeadList with optional campaign counts

  • Read

    List of LeadListItem + Lead

    A mashup api to return a sortable, searchable list for campaign details

  • Read

    Get LeadItem

    Get a LeadItem

  • Write

    Create Lead

    Create a Lead, and optionally add it to a campaign

  • Write

    Update Lead

    Update a Lead

  • Write

    Start a Lead CSV export

    Start a CSV export of this company's Leads and return the export record. The export runs in the background: a BigQuery query job plus an extract job routinely takes longer than a request can wait. Poll GET /api/leadexport/ until it returns a 'url'.

  • Write

    Bulk update LeadListItems

    Update multiple LeadListItems in a single operation. Only updates items in 'pending' state.

  • Write

    Update LeadItem

    Update a LeadItem

Phones

  • Read

    List of Phones

    Get a list of phone table for company DNC/DNT

  • Read

    Get Phone

    Get an individual Phone entity

  • Write

    Create a Phone

    Create a Phone entry to the company DNC/DNT table

  • Write

    Update Phone

    Update a Phone DNC/DNT statuses

  • Destructive

    Soft Delete Phone

    Soft Delete a Phone Entity

Salesforce

  • Read

    Get List Views from Salesforce

    Fetch list views from Salesforce

  • Read

    Get Object Fields from Salesforce

    Fetch field metadata for a Salesforce object via sObject Describe API

  • Read

    Get Salesforce List View by ID

    Retrieve a specific list view from Dialbunny database

  • Read

    List Salesforce ListView Imports

    Get all Salesforce ListView Import records for a campaign

  • Read

    Get Salesforce ListView Import

    Get a Salesforce ListView Import record by ID

  • Read

    List Salesforce Object Mappings

    Get all Salesforce object mappings for the company, optionally filtered by campaign or sobject type

  • Read

    Get Salesforce Object Mapping

    Get a specific Salesforce object mapping by ID

  • Write

    Update Salesforce List View

    Perform actions on a Salesforce list view (e.g. refreshcount)

  • Write

    Import Salesforce ListView records into Leads

    Import a Salesforce list view into Dialbunny database

  • Write

    Update Salesforce ListView Import

    Update a Salesforce ListView Import, e.g., start the import job

  • Write

    Create Salesforce Object Mapping

    Create a new Salesforce object mapping for the company or a specific campaign

  • Write

    Update Salesforce Object Mapping

    Update an existing Salesforce object mapping

  • Destructive

    Delete Salesforce Object Mapping

    Delete a Salesforce object mapping

Rules

  • Read

    List of rules for a campaign

    List of rules belonging to a campaign with campaign id

  • Read

    Get Rule

    Get a Rule

  • Write

    Create rule for a campaign

    Create a rule for a campaign

  • Write

    Update a rule for a campaign

    Update a rule for a campaign

  • Destructive

    Delete a rule

    Delete a rule belonging to a campaign with campaignid

Metrics

  • Read

    Activity Metrics

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

  • Read

    Agent Metrics

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

See How connections work for access and permissions, or browse all integrations.