API Reference

Call -- Initiate via Ring

post
https://dialpad.com/api/v2/call

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).

Added on Feb 20, 2020 for API v2.

Rate limit: 5 per minute.

Body Params
string | null

Extra data to associate with the call. This will be passed through to any subscribed call events.

string | null

The device's id.

int64 | null

The ID of a group that will be used to initiate the call.

string | null
enum

The type of a group that will be used to initiate the call.

Allowed:
boolean
Defaults to false

Enables the creation of a second call. If there is an ongoing call, it puts it on hold.

string | null

The e164-formatted number shown to the call recipient (or "blocked").

If set to "blocked", the recipient will receive a call from "unknown caller". The number can be the caller's number, or the caller's group number if the group is provided, or the caller's company reserved number.

string
required

The e164-formatted number to call.

int64
required

The id of the user who should make the outbound call.

Response

Updated about 1 month ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago