This endpoint is deprecated.

Receive Voice Delivery Reports Webhook

This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.

We strongly advise you to update to new delivery report method.

post

https://{yourDomain}/your/webhook/path

Request Body schema:

collapse all -

results

Array of objects

Arrays of delivery reports, one object for every message.

Array

bulkId

string

The ID that uniquely identifies the bulk of messages.

messageId

string

The ID that uniquely identifies the message sent.

string

Destination address of the voice message.

sentAt

string

Date and time when the voice message was initiated. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

doneAt

string

Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

startTime

string

Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

answerTime

string

Date and time when the voice message was answered. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

endTime

string

Date and time when the voice message was ended. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.

duration

integer <int32>

Duration of the voice message call, in seconds.

fileDuration

number <double>

Duration of the voice message audio file, in seconds.

mccMnc

string

Mobile country and network codes.

callbackData

string

Custom data sent over to the notifyUrl.

dtmfCodes

string

DTMF code entered by user. Can be empty string, if user did not press anything, or null in case of IVR if user did not participate in Collect action.

dtmfCodesAsJson

string

DTMF code entered by user, but in JSON form - including DTMF variable names.

transcribedAudioFileUrl

string

Url to retrieve call transcription that were made by voice messages with the transcribe feature activated.

scenarioId

string

The ID that uniquely identifies the IVR scenario.

scenarioName

string

Name of IVR scenario.

price

object

Sent voice message price.

pricePerSecond	number <double> Price per one second of the Voice message.
currency	string The currency in which the price is expressed.

status

object

Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.

Response status and error codes

groupId	integer <int32> Status group ID.
groupName	string Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
id	integer <int32> Status ID.
name	string Status name.
description	string Human-readable description of the status.

error

object

Indicates whether the error occurred during the query execution.

Response status and error codes

groupId	integer <int32> Error group ID.
groupName	string Error group name.
id	integer <int32> Error ID.
name	string Error name.
description	string Human-readable description of the error.
permanent	boolean Tells if the error is permanent.