Get Voice Delivery Reports
This method allows you to get delivery reports for sent Voice messages, outbound IVR or Click-to-call (without notifyUrl request parameter). Delivery reports are returned only once. Additional delivery report request will return an empty collection.
Please log in to see full path URL. Learn why.
get
/voice/1/reports
Authorizations:
query Parameters
bulkId | string The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses. |
messageId | string The ID that uniquely identifies the message sent. |
limit | integer The maximum number of returned delivery reports. Default value is 50. |
Responses
default
successful response
401
Unauthorized
403
Forbidden
4XX
Error responses
500
Internal Server Error
5XX
Error responses
Request samples
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Example
cURL
Copy
curl -L -g 'https://{baseUrl}/voice/1/reports' \ -H 'Authorization: {authorization}' \ -H 'Accept: application/json'
Response samples
- default
- 401
- 403
- 4XX
- 500
- 5XX
Content type
application/json
Copy
Collapse all {- "results": [
- {
- "bulkId": "8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb",
- "messageId": "ff4804ef-6ab6-4abd-984d-ab3b1387e852",
- "from": "385333444",
- "to": "385981178",
- "sentAt": "2018-06-25T13:38:14.730+0000",
- "mccMnc": "21901",
- "callbackData": "DLR callback data",
- "voiceCall": {
- "feature": "Voice-message",
- "startTime": "2018-06-25T13:38:15.000+0000",
- "answerTime": "2018-06-25T13:38:25.000+0000",
- "endTime": "2018-06-25T13:38:28.316+0000",
- "duration": 10,
- "chargedDuration": 30,
- "fileDuration": 19.3,
- "dtmfCodes": "3, 9",
- "ivr": {
- "scenarioId": "333",
- "scenarioName": "Scenario name",
- "collectedDtmfs": "{\"myFirstVar\":\"3\",\"mySecondVar\":\"9\"}",
- "collectedMappedDtmfs": null,
- "spokenInput": null,
- "matchedSpokenInput": null
}
}, - "price": {
- "pricePerSecond": 0.01,
- "currency": "EUR"
}, - "status": {
- "groupId": 3,
- "groupName": "DELIVERED",
- "id": 5,
- "name": "DELIVERED_TO_HANDSET",
- "description": "Message delivered to handset"
}, - "error": {
- "groupId": 0,
- "groupName": "OK",
- "id": 5000,
- "name": "VOICE_ANSWERED",
- "description": "Call answered by human",
- "permanent": true
}
}
]
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See