List calls

Page through calls, filtered by status, direction, agent, number, or date range.

GET/v1/calls

Authorization

bearerAuth

AuthorizationBearer <token>

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

In: header

Query Parameters

status?string

direction?string

Value in"inbound" | "outbound"

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

phoneNumberId?string

Filters to calls that ran on the agent(s) wired to this org-owned phone number.

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

startedAfter?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

startedBefore?string

Match

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Formatdate-time

limit?integer

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value <= 9007199254740991

Response Body

`application/json`

cURL

curl -X GET "https://example.com/calls"

{
  "success": true,
  "calls": [
    {
      "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"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "hasMore": true
  }
}

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

{
  "error": "unauthorized"
}

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

`application/json`

`application/json`

`application/json`