Want to provide feedback?

Write to docs@telesign.com.

Call Query API

Use the TeleSign Call Query API to get information about calls handled by the Voice API that occurred in the last three hours. You must own a call to get information about it using this API.

Contents of this page:

Reference Page

GET /call/{referenceid}

Full technical details for the API, including explanations of each request parameter and response property.

General Requirements

Request Requirements

  • Authentication: Basic (easiest to implement) or Digest
  • Base URL: https://rest-ww.telesign.com/v2/voice
  • Encoding: Accepts only UTF-8 unicode characters as inputs.
  • MIME Type: application/json
  • Required Headers: Content-Type
  • Supported Methods: GET

Response Details

  • MIME Type: application/json

Key Terms

  • Events - Notifications that something occurred related to your use of the Voice API, like an incoming call. These are sent by TeleSign to your specified customer event URL.

Actions

Get Events for a Call

Reference Page: GET /call/{referenceid}

Get all events associated with a call, specified by reference ID. The response also includes when the call was created, answered, and terminated, and the caller IDs used by the originating and destination numbers.

Example

Request
HTTPS
GET /v2/voice/call/B596D7B0D1800164898350B4E71B005C HTTP/1.1
Content-Type: application/json
Authorization: Basic pPF9MAXw9ssP0rkk8sbWf18Fny5Vgqi4F1owcHADr8LXk8PMWIvWqeg419NNXmBtMkaTJi3U5IOhOrNOY1ZXdBv3pLZxn08Rah8mMTGv623wYqmmNRcI5adDVnYbm1ejt2E4JCiMmOFahwcNcy844cpz8dTEWMVo1XthlYf=
Host: rest-ww.telesign.com
Response (body only)
application/json
{
  "reference_id": "B596D7B0D1800164898350B4E71B005C",
  "caller_id": "14645123482",
  "from": "16467740217",
  "to": "16467740229",
  "call_state": "answered",
  "created_on_utc_datetime": "2018-08-07T20:33:38.003718",
  "answered_on_utc_datetime": "2018-08-07T20:33:40.023718",
  "ended_on_utc_datetime": "2018-08-07T20:53:38.009018",
  "events": [
    {
      "event": "incoming_call",
      "reference_id": "B596D7B0D1800164898350B4E71B005C",
      "data": {
        "from": "12674395109",
        "to": "14645123482"
      }
    },
    {
      "event": "speak_completed",
      "reference_id": "B596D7B0D1800164898350B4E71B005C",
      "data": {
        "from": "12674395109",
        "to": "14645123482",
        "status": "speak_successful",
        "collected_digits": "923"
      }
    },
    {
      "event": "call_completed",
      "reference_id": "B596D7B0D1800164898350B4E71B005C",
      "data": {
        "caller_id": "14645123482",
        "from": "12674395109",
        "to": "14645123482",
        "direction": "outbound",
        "created_on_utc": "2018-08-07T20:33:38.003718",
        "answered_on_utc": "2018-08-07T20:33:40.003718",
        "ended_on_utc": "2018-08-07T20:33:44.003718",
        "status": "hangup",
        "duration": 4
      }
    }
  ]
}