Create a call

POST/v1/calls

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

agentId*string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

toNumber*string

E.164, e.g. +15558675309.

phoneNumberId?string

Your org-owned phone number to dial from. Provide this OR fromNumber, not both.

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

fromNumber?string

E.164 form of an org-owned number, as an alternative to phoneNumberId.

contactId?string

Attaches the call to a CRM contact. Do-not-call contacts are refused (409).

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

metadata?

Response Body

`application/json`

cURL

curl -X POST "https://example.com/calls" \  -H "Content-Type: application/json" \  -d '{    "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",    "toNumber": "string"  }'

{
  "success": true,
  "call": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "agentId": "bc309ecf-5f66-4057-93c5-6611cc9cb7b2",
    "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
    "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
    "phoneNumber": "string",
    "direction": "inbound",
    "status": "queued",
    "duration": -9007199254740991,
    "cost": 0,
    "endedReason": "string",
    "provider": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "unauthorized"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "success": false,
  "error": "API key lacks write permission"
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

{
  "error": "validation_failed",
  "message": "string",
  "issues": null
}

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`