Voice Broadcast API
OutgoingPostback
Outgoing postbacks describe outgoing calls. To receive postbacks, specify a StatusChangePostUrl
URL in the NotifyPhoneAdvanced
or NotifyMultiplePhoneAdvanced
methods.
Type Properties
Property Name | Description | Data Type | Sample |
---|---|---|---|
QueueID | The unique ID of the call. | Long | 4093249 |
ResponseCode | Status code for the call. | QueueIDStatusCode | 0 |
StartTime | The UTC time when the call started. | DateTime | 2020-08-28T00:53:06.608Z |
EndTime | The UTC time when the call ended. | DateTime | 2020-08-28T00:53:43.654Z |
Duration | The total duration of the call, in seconds. | Integer | 37 |
isWireless | Whether the recipient number is wireless. | Boolean | False |
telcoLATA | Local Access and Transport Area. This is the recipient telco’s geographical area. | 252 | |
telcoOCN | Operating Company Number. This can tell you which company a call went to. | 8825 | |
telcoCarrierName | Recipient telco carrier name. | String | |
telcoCarrierType | Recipient telco carrier type. | ||
telcoLRN | Location Routing Number. The LRN is a unique 10-digit number that represents a telephone switch through which multiple phone numbers are routed. | 7573740000 | |
telcoSwitchName | Recipient telco switch name. | NORFOLK | |
digitsdialed | The digits pressed while the call was active. | String | 345 |
incallringcount | Number of audible rings after a connection is made. This variable is only present if at least one ring was detected. | Integer | 3 |
qasoundid | Unique identifier to retrieve a call recording, if a call was recorded. | ||
callerid | The number displayed on the receiving party’s Caller ID. | String | 7575550000 |
extension | The extension of the recipient dialed. | String | |
phonenumber | The number that received the call. | String | 7575559999 |
transfercalleridname | The name displayed on the receiving party’s Caller ID, if the call is transferred. (Most carriers ignore this and use their own directory assistance to display name information.) | String | Esendex Services |
lastrecordlength | The duration (in seconds) for the call or portion of the call that was recorded. | 37 | |
qarecord | Whether the call was recorded for quality assurance (QA) purposes. | Boolean | False |
transfercallerid | The number displayed on the receiving party’s Caller ID, if the call is transferred. | String | 7575550000 |
calleridname | The name displayed on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.) | String | Esendex Services |
machinedetection | Whether the call was answered by a human or a machine. HUMAN – The call was answered by a human. MACHINE – The call was answered by a machine. FAX – The call was answered by a fax machine. UNKNOWN | String | HUMAN |
Let’s start sending, together.