Voice Messaging Callback URL For Delivery Receipts API
During the delivery of Voice Messages, the PaaSoo platform will push the Delivery Report to the Callback URL (USER_CALLBACK_URL) specified in advance by the user. Through this report, you can stay informed about details such as whether the call was successfully connected, whether the recipient rejected or missed the call, the Call Duration, and Billing information.
1. Callback Method
- HTTP Method:
GET - Callback URL:
USER_CALLBACK_URL(The address configured on your server to receive delivery reports). When the callback arrives, it will include the following query parameters.
2. Parameter Description
| Parameter | Type | Description | Example |
|---|---|---|---|
| callId | string | Message ID, the unique identifier for each Voice Message record, which corresponds to the messageid returned upon sending. | 30035c-3ed097-1000 |
| callerId | string | Caller ID (from), up to 20 characters; if you need to customize it, please contact technical support or your account manager. | +12025550188 |
| status | integer | Status value:
| 0 |
| statusCode | string | Status report code:
| completed |
| errorCode | string | Error code. 99 indicates other Operator errors. You can further consult the technical support team (support@paasoo.com). | 99-Other Operator errors |
| receiveTime | string | The time the platform received this status (ISO8601, UTC+0). | 2024-04-26T08:31:49Z |
| statusTime | string | The time the Delivery Report was generated (ISO8601, UTC+0). | 2024-04-26T08:32:49Z |
| startTime | string | Call start time (ISO8601, UTC+0). | 2024-04-26T08:32:49Z |
| endTime | string | Call end time (ISO8601, UTC+0). | 2024-04-26T08:32:49Z |
| hangupCause | string | Hangup Cause description. Please refer to the "[SIP Hang-up Cause Code Reference Table]". | NORMAL_CLEARING |
| hangupCode | string | SIP hangup status code. Please refer to the "[SIP Hang-up Cause Code Reference Table]". | 200 |
| to | string | Destination Number, including the Country Code. | 12025550199 |
| price | number | The amount consumed for this call. | 0.000016 |
| currency | string | The currency used for Billing. | EUR |
| callDuration | integer | Call Duration (billed seconds). | 9 |
| countryIso | string | The ISO code of the country where the Destination Number is located. | US |
| network | string | The Network Code of the Operator network used by the Destination Number. | 310260 |
| charged | string | Whether Billing is applied to this call: yes / no. | yes |
3. Callback Examples
3.1 Success Example
https://USER_CALLBACK_URL?callId=30035c-3ed097-1000&status=0&statusCode=completed&hangupCause=NORMAL_CLEARING&hangupCode=200&to=12025550199&callerId=12025550188&statusTime=2024-04-26T08:32:49Z&price=0.000016&callDuration=9&countryIso=US&network=310260&startTime=2024-04-26T08:32:40Z&endTime=2024-04-26T08:32:49Z&receiveTime=2024-04-26T08:32:49Z&charged=yes¤cy=EUR
3.2 Failure Example
https://USER_CALLBACK_URL?callId=300395-d87d44-4000&errorCode=99&status=0&statusCode=failed&hangupCause=NORMAL_CLEARING&hangupCode=480&to=12025550199&callerId=12025550188&callDuration=0&countryIso=US&network=310260&endTime=2024-10-22T07:31:59Z&statusTime=2024-10-22T07:31:59Z&receiveTime=2024-10-22T07:31:58Z&charged=no¤cy=USD
When you correctly receive and process the callback, please return an HTTP status code 200 to indicate successful reception. If a non-200 status code or no response is returned, it will be considered a reception failure, and the platform will resend it according to a retry interval mechanism of 5/10/30 minutes.
If you encounter any technical issues or have business inquiries during the API integration, please do not hesitate to contact our Support team at support@paasoo.com. We are always here to assist you.