Voice Webhooks

We will push a callback receipt for each phone call.

Response Elements

Parameter name	Type	Description	Default	Required
batchId	string	Batch Submission of ID	""	Yes
accountId	number	Acount ID	0	Yes
initiatedTimestamp	Date	Call Initiation Time		No
connectedTimestamp	Date	Call Connection Time		No
disconnectedTimestamp	Date	Call Disconnect Time		No
destination	string	The phone number for the call		Yes
callStatus	string	Status: COMPLETED/FAILED		Yes
callDuration	number	Call duration	0	Yes
errorDetails	ErrorDetails	Error message		No

ErrorDetails

Parameter name	Type	Description	Default	Required
errorCode	string	Error code	0	Yes
errorMsg	string	Error 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"
  }
}