API Reference

Call -- Initiate

post
https://dialpad.com/api/v2/users//initiate_call

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.

Added on Nov 18, 2019 for API v2.

Rate limit: 5 per minute.

Path Params
string
required

The user's id. ('me' can be used if you are using a user level API key)

Body Params
string | null

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

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:
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 | null

The e164-formatted number to call.

Response

Updated 4 months ago

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