Retrieve a call status
GET/calls/:call_control_id
Returns the status of a call (data is available 10 minutes after call ended).
Request
Path Parameters
Unique identifier and token for controlling the call
Responses
200: Successful response with details about a call status.
- application/json
- Schema
- Example (from schema)
Schema
data
object
Possible values: [call
]
ID that is unique to the call session and can be used to correlate webhook events. Call session is a group of related call legs that logically belong to the same phone call, e.g. an inbound and outbound leg of a transferred call
ID that is unique to the call and can be used to correlate webhook events
Unique identifier and token for controlling the call.
Indicates whether the call is alive or not. For Dial command it will always be false
(dialing is asynchronous).
State received from a command.
Indicates the duration of the call in seconds
{
"data": {
"call_control_id": "v3:MdI91X4lWFEs7IgbBEOT9M4AigoY08M0WWZFISt1Yw2axZ_IiE4pqg",
"call_leg_id": "2dc6fc34-f9e0-11ea-b68e-02420a0f7768",
"call_session_id": "2dc1b3c8-f9e0-11ea-bc5a-02420a0f7768",
"client_state": "aGF2ZSBhIG5pY2UgZGF5ID1d",
"is_alive": false,
"call_duration": 50,
"record_type": "call"
}
}
default: Unexpected error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
Error[]
source
object
JSON pointer (RFC6901) to the offending entity.
Indicates which query parameter caused the error.
{
"errors": [
{
"code": "string",
"title": "string",
"detail": "string",
"source": {
"pointer": "string",
"parameter": "string"
},
"meta": {}
}
]
}