Get voice call status

After a voice call, with Dillo API you can easily check the status and all the information related to your request.

https://api.dillo.cloud/api/sendaction/voice/{id}

***Replace {id} with the unique identifier code that is provided in the response body from a POST call
Please note that you have to add the authorization headers to every request you make to the Dillo API.

Request Example

JavaScript

Java

Python

The response object has the following properties:

Schema

Example

Property	Type	Description
Id	String	The request id
Sender	String	The voice sender defined on user account
TelephoneNumber	String	The receiver's phone number
ChannelBehavior	String	Serialized object of type ChannelBehavior Note: ChannelBehavior object from response has additional properties
CreatedOnUtc	String	The UTC date when the request was created
UpdatedOnUtc	String	The UTC date when the request was last updated
AnswerDate	DateTime	The UTC date and time the call was answered
HangupDate	DateTime	The UTC date and time the call ended
CallDuration	double	Call duration in seconds
Price	decimal	The total cost of the voice call
PriceDescription	String	The detailed description of the cost
CustomerCode	String	The customer code that made the request
Status	VoiceRequestStatus (object)	The current status of the voice call request
StatusDescription	String	A status short description
Recordings	Array	The list of VoiceCallRecording with their transcriptions and their prices if any
CollectedDigits	Array	The list of the CollectedDigits
ExternalActions	Array	The list of the VoiceExternalAction that were executed for this voice call request

VoiceRequestStatus has the following properties:

Property	Type	Description
PrimaryStatus	VoiceStatus (object)	The primary status of the request
SecondaryStatus	VoiceStatus (object)	The secondary status of the request
StatusCode	String	The combined values of the PrimaryStatus and SecondaryStatus

VoiceStatus has the following properties:

Property	Type	Description
Code	integer	The status code
Description	string	The status short description

Additional properties on ChannelBehavior:

Property	Type	Description	Object
IsProcessed	bool	Indicates if the node was processed or not	ChannelBehaviorNode
IsPressed	bool	Indicates if the digit was pressed / the word was spoken or not	DigitAction
Timestamp	String	The date when the node was processed, or when the digit was pressed / the word was spoken	ChannelBehaviorNode DigitAction
ExecutionCount	integer	The number of executions of the node within the voice call.	ChannelBehaviorNode
Route	String	The route to this node (comma separated node keys - e.g. 0,2,1,3).	ChannelBehaviorNode

VoiceCallRecording properties:

Property	Type	Description
FileName	String	The recording file name
Url	String	The recordig url
Duration	double	the duration of the recording in seconds
HasTranscription	bool	Indicates if the record has transcription or not
Transcription	String	The recording transcription if exist
FileSize	long	The size of the file in bytes
Price	decimal	The price for the recording
TranscriptionPrice	decimal	The price fir transcription
Interval	integer	The recording interval in seconds for calculating the price
TranscriptionInterval	integer	The transcription interval in seconds for calculating the price
transcriptionNumberOfIntervals	integer	The number of intervals (Duration/ TranscriptionIinterval)
RecordingStoragePeriodCode	String	The recording storage period code selected

CollectedDigits properties:

Property	Type	Description
Digits	String	The digits collected
Node	integer	The key of the node within the channel behavior of the collect action

VoiceExternalAction properties:

Property	Type	Description
Label	The unique-identifier for the external action.	The unique-identifier for the external action.
NodeKey	The key of the node within the channel behavior for which the external action is made	The key of the node within the channel behavior for which the external action is made
ExternalActionId	The id of the SMS/Email request	The id of the SMS/Email request

voice outbound