v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB

Voice Calls

List voice calls

List voice calls matching the given parameters, paginated, and ordered.

get/api/phone/voice-calls

Query parameters

cursorstring

Example:cHJldl9fNl9fMjAyMS0wMy0wMyAwNjowMDowMA==

Value indicating your position in the list of all items. If omitted, the first items of the list will be returned.

limitinteger

Maximum number of items to return.

ticket_idinteger

Response

List of voice calls according to the given criteria.

objectstring required

Describes the object type of the payload.

uristring url required

Contains the URI of the fetched resource list.

Example response

{
  "meta": {
    "next_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0=",
    "prev_cursor": "WyJuZXh0IiwgIjIwMjEtMDEtMDFUMDE6MDA6MDAiLCA1MV0="
  },
  "object": "list",
  "uri": "/api/integrations?limit=100",
  "data": [
    {
      "id": 123,
      "integration_id": 234,
      "ticket_id": 345,
      "phone_number_id": 456,
      "external_id": "CA777a8b2bfef8cdf709896080fe94cd10",
      "provider": "twilio",
      "status": "completed",
      "direction": "inbound",
      "phone_number_source": "+14791234567",
      "country_source": "US",
      "phone_number_destination": "+17201234567",
      "country_destination": "US",
      "duration": 60,
      "started_datetime": "2023-08-31T00:00:00.000000+00:00",
      "created_datetime": "2023-08-31T00:00:00.000000+00:00",
      "updated_datetime": "2023-08-31T00:00:00.000000+00:00",
      "initiated_by_agent_id": 567,
      "last_answered_by_agent_id": 678,
      "customer_id": 789,
      "last_rang_agent_id": 235,
      "has_voicemail": true,
      "summaries": [
        {
          "id": 123,
          "recording_id": 234,
          "summary": "Call from +14791234567",
          "created_datetime": "2023-08-31T00:00:00.000000+00:00"
        }
      ],
      "termination_status": "abandoned",
      "queue_id": 142,
      "status_in_queue": "waiting",
      "answered_by_external_number": "+14791234567",
      "answered_by_external_customer_id": 250,
      "monitoring_status": "listening",
      "last_monitoring_agent_id": 123
    }
  ]
}