Compatibility REST APICalls

Retrieve a Call

View as Markdown

Retrieve a call.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

AccountSidstringRequiredformat: "uuid"
The Project ID that uniquely identifies the Account.
SidstringRequiredformat: "uuid"
The unique identifier for the call.

Response

The request has succeeded.
sidstringformat: "uuid"
The unique identifier for the call.
account_sidstringformat: "uuid"
The unique identifier for the account that created this call.
date_createdstring
The date, in RFC 2822 GMT format, this call was created.
date_updatedstring
The date, in RFC 2822 GMT format, this call was updated.
parent_call_sidstring or nullformat: "uuid"
The unique identifier for the call that created this call.
tostring
The address that received the call.
formatted_tostring
The formatted number that received the call.
to_formattedstring

The formatted number that received the call. Alias for formatted_to.

fromstring
The address that initiated the call.
formatted_fromstring
The formatted number that initiated the call.
from_formattedstring

The formatted number that initiated the call. Alias for formatted_from.

phone_number_sidstring or nullformat: "uuid"
The unique identifier for the phone number.
statusenum
The status of the call.
start_timestring or null
The time, in RFC 2822 GMT format, on which the call began.
end_timestring or null
The time, in RFC 2822 GMT format, on which the call was terminated.
durationinteger
The duration, in seconds, of the call.
pricedouble or null
The charge for the call.
price_unitstring
The currency, in ISO 4127 format, for the price of the call.
directionenum
The direction of the call.
Allowed values:
answered_byenum or null

Who/what the call was answered by.

Allowed values:
api_versionstring
The version of the SignalWire API.
forwarded_fromstring or null
The number this call was forwarded from. Always null.
caller_namestring or null
The caller name. Always null.
uristring
The URI for the call.
subresource_urisobject

A Map of available sub-resources.

annotationstring or null
The annotation for the call. Always null.
group_sidstring or null
The group SID for the call. Always null.
audio_in_mosdouble or null

The Mean Opinion Score for audio quality (1.0-5.0).

sip_result_codestring or null
The SIP result code for the call.
audio_rtt_avginteger or null

The average round-trip time for audio in milliseconds.

audio_rtt_mininteger or null

The minimum round-trip time for audio in milliseconds.

audio_rtt_maxinteger or null

The maximum round-trip time for audio in milliseconds.

audio_out_jitter_mininteger or null
The minimum outbound audio jitter in milliseconds.
audio_out_jitter_maxinteger or null
The maximum outbound audio jitter in milliseconds.
audio_out_jitter_avginteger or null
The average outbound audio jitter in milliseconds.
audio_out_lostinteger or null
The number of outbound audio packets lost.

Errors