Returns information about an active or completed call. Specify the required call in the query string parameter, callGuid. Use during the call or for up to 24 hours after the call.
Request Scheme
HTTPS
Request Uri
GET v{v#}/{accountKey}/calls/{callGuid}
Request Headers
Authorization (required)
This header requires an OAuth bearer token. For information on the bearer token, see How to use your bearer access token.
Accept (required)
application/json;version=3
Indicates that the media type required from the server is JavaScript Object Notation (JSON) and that version 3 of the API should be used.
Examples
Most URLs in the example code use the following values:Region URL subdomain Base URL EMEA emea https://emea.newvoicemedia.com USA nam https://nam.newvoicemedia.com APAC apac https://apac.newvoicemedia.com
Get call details for a valid call identifier
curl -X GET
"https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/94e5928c-7f7e-4645-ad72-61010f906449" -H "Authorization: Bearer <ACCESS_TOKEN>" -H "Accept: application/json; version=3"
Returns HTTP status code of 200, containing the following message.
{
"id": "94e5928c-7f7e-4645-ad72-61010f906449",
"links": [
{
"href": "https://***.newvoicemedia.com/v0/a1b2c3d4e5/Calls/94e5928c-7f7e-4645-ad72-61010f906449",
"rel": "_self"
}
],
"from": {
"telephoneNumber": "02072068888",
"agentId": "10"
},
"to": {
"telephoneNumber": "02072068888"
},
"status": null,
"recordingStatus": null,
"result": {
"code": "Failure",
"party": "Originator",
"reason": "NoAnswer"
},
"dispositionCode": "Wrong Number"
}
Get call details for a call with a specified Presented CLID
curl -X GET
"https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/94e5928c-7f7e-4645-ad72-61010f906449" -H "Authorization: Bearer <ACCESS_TOKEN>
" -H "Accept: application/json;version=3"
Returns HTTP Status 200 and the following response:
{
"id": "94e5928c-7f7e-4645-ad72-61010f906449",
"links": [
{
"href": "https://***.newvoicemedia.com/v0/a1b2c3d4e5/Calls/94e5928c-7f7e-4645-ad72-61010f906449",
"rel": "_self"
}
],
"from": {
"presentedCLID": "08008888888",
"agentId": "10"
},
"to": {
"telephoneNumber": "02072068888"
},
"status": null,
"recordingStatus": null,
"dispositionCode": "Wrong Number"
}
Get call details for an invalid call identifier
curl -X GET "https://***.newvoicemedia.com/v0/a1b2c3d4e5/calls/24e5948c-4f4e-6646-cd77-91010f903889" -H "Authorization: Bearer <ACCESS_TOKEN>" -H "Accept: application/json; version=3"
Returns HTTP status code of 404, containing the following message.
{
"message": "The requested resource was not found."
}
Description of fields
status
Call status. Either "Active" or null if the call is disconnected.
recordingStatus
On an active call this can be "Started", "Stopped" or "Paused". This is null on an inactive call.
result
Included only when a call fault is recorded.
result.code
Overall result. "Failure" or "Success".
result.party
Which party in the call raised the result."Originator" if the fault occurred requesting the call. "Recipient" if the destination triggered the fault.
result.reason
Reasons: "CallFailed", "CallRejected", "NoAnswer", "Normal", "NumberBusy", "NumberChanged", "Unknown".
dispositionCode
The disposition code set for the call. dispositionCode is null if no disposition code is set.