v1

latestOpenAPI 3.0.02026-07-1494623.7 KB
Calls

Get details of your calls

Get details of your calls

get/

Query parameters

status'started' | 'ringing' | 'answered' | 'machine' | 'completed' | 'busy' | 'cancelled' | 'failed' | 'rejected' | 'timeout' | 'unanswered'
Example:started

Filter by call status

date_startstring date-time
Example:2016-11-14T07:45:14Z

Return the records that occurred after this point in time

date_endstring date-time
Example:2016-11-14T07:45:14Z

Return the records that occurred before this point in time

page_sizeinteger

Return this amount of records in the response

record_indexinteger

Return calls from this index in the response

order'asc' | 'desc'

Either ascending or descending order.

conversation_uuidstring uuid

The unique identifier for the conversation this call leg is part of.

Example:CON-f972836a-550f-45fa-956c-12a2ab5b7d22

Return all the records associated with a specific conversation.

Response

OK

countinteger
page_sizeinteger
record_indexinteger

Example response

{
  "_embedded": {
    "calls": [
      {
        "_links": {
          "self": {
            "href": "/calls/63f61863-4a51-4f6b-86e1-46edebcf9356"
          }
        },
        "conversation_uuid": "CON-f972836a-550f-45fa-956c-12a2ab5b7d22",
        "direction": "outbound",
        "duration": "60",
        "end_time": "2020-01-01 12:00:00",
        "from": {
          "number": "447700900001",
          "type": "phone"
        },
        "network": "65512",
        "price": "23.40",
        "rate": "0.39",
        "start_time": "2020-01-01 12:00:00",
        "status": "completed",
        "to": {
          "number": "447700900000",
          "type": "phone"
        },
        "uuid": "63f61863-4a51-4f6b-86e1-46edebcf9356"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "/calls?page_size=10&record_index=20&order=asc"
    }
  },
  "count": 100,
  "page_size": 10
}
All 9 operations