Skip to main content

Voice Webhooks

We will push a callback receipt for each phone call.

Response Elements

Parameter nameTypeDescriptionDefaultRequired
batchIdstringBatch Submission of ID""Yes
accountIdnumberAcount ID0Yes
initiatedTimestampDateCall Initiation TimeNo
connectedTimestampDateCall Connection TimeNo
disconnectedTimestampDateCall Disconnect TimeNo
destinationstringThe phone number for the callYes
callStatusstringStatus: COMPLETED/FAILEDYes
callDurationnumberCall duration0Yes
errorDetailsErrorDetailsError messageNo

ErrorDetails

Parameter nameTypeDescriptionDefaultRequired
errorCodestringError code0Yes
errorMsgstringError message""Yes

Success Response Example

{
"sessionId": "4cba63df-303c-475f-8a64-14dd638c4668",
"accountId": 60000323,
"initiatedTimestamp": "2024-07-12T02:38:08Z",
"connectedTimestamp": "2024-07-12T02:38:08Z",
"disconnectedTimestamp": "2024-07-12T02:38:33Z",
"destination": "+55xxxxxxxx",
"callStatus": "COMPLETED",
"callDuration": 24,
"errorDetails": {}
}

Failed Response Example

{
"sessionId": "aee0ca6e-d37c-424b-ab45-0a7ddb43c398",
"accountId": 60000323,
"destination": "+5592994955887",
"callStatus": "FAILED",
"errorDetails": {
"errorCode": "NOCHAN",
"errorMsg": "NOCHAN"
}
}