SIsinch
Calls

Get information about a call

You can retrieve information about an ongoing or completed call using a call ID. You can find the call ID of an ongoing call by viewing the response object from a callout request. You can find the call ID of a completed call by looking at your call logs in your Sinch Dashboard.

Note: You can only use this method for calls that terminate to PSTN or SIP networks from an In-app call.

get/calling/v1/calls/id/{callId}

Request

  • Base URL
    https://calling.api.sinch.com
  • URL
    https://calling.api.sinch.com/calling/v1/calls/id/{callId}
  • Auth
    • HTTP basic
    • or API key in header Authorization

Response

A success response, or an Error.

domain'pstn'

Must be pstn for PSTN.

callIdstring

The unique identifier of the call.

durationinteger

The duration of the call in seconds.

status'ONGOING' | 'FINAL'

The status of the call. Either ONGOING or FINAL

result'N/A' | 'ANSWERED' | 'BUSY' | 'NOANSWER' | 'FAILED'

Contains the result of a call.

reason'N/A' | 'TIMEOUT' | 'CALLERHANGUP' | 'CALLEEHANGUP' | 'BLOCKED' | 'NOCREDITPARTNER' | 'MANAGERHANGUP' | 'CANCEL' | 'GENERALERROR' | 'INVALIDSVAMLACTION'

Contains the reason why a call ended.

timestampstring date-time

The date and time of the call.

customstring

A string that can be used to pass custom information related to the call.

Example response

{
  "from": {
    "type": "username",
    "endpoint": "myUserName"
  },
  "to": {
    "type": "username",
    "endpoint": "myUserName"
  },
  "domain": "pstn",
  "status": "ONGOING",
  "result": "ANSWERED"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.