Voice Broadcast API

Voice API
Quick Start Guides
Methods
Types
FAQ

OutgoingPostback

Outgoing postbacks describe outgoing calls. To receive postbacks, specify a StatusChangePostUrl URL in the NotifyPhoneAdvanced or NotifyMultiplePhoneAdvanced methods.

Type Properties

Property NameDescriptionData TypeSample
QueueIDThe unique ID of the call.Long4093249
ResponseCodeStatus code for the call.QueueIDStatusCode0
StartTimeThe UTC time when the call started.DateTime2020-08-28T00:53:06.608Z
EndTimeThe UTC time when the call ended.DateTime2020-08-28T00:53:43.654Z
DurationThe total duration of the call, in seconds.Integer37
isWirelessWhether the recipient number is wireless.BooleanFalse
telcoLATALocal Access and Transport Area. This is the recipient telco’s geographical area.252
telcoOCNOperating Company Number. This can tell you which company a call went to.8825
telcoCarrierNameRecipient telco carrier name.String
telcoCarrierTypeRecipient telco carrier type.
telcoLRNLocation Routing Number. The LRN is a unique 10-digit number that represents a telephone switch through which multiple phone numbers are routed.7573740000
telcoSwitchNameRecipient telco switch name.NORFOLK
digitsdialedThe digits pressed while the call was active.String345
incallringcountNumber of audible rings after a connection is made. This variable is only present if at least one ring was detected.Integer3
qasoundidUnique identifier to retrieve a call recording, if a call was recorded.
calleridThe number displayed on the receiving party’s Caller ID.String7575550000
extensionThe extension of the recipient dialed.String
phonenumberThe number that received the call.String7575559999
transfercalleridnameThe 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.)StringEsendex Services
lastrecordlengthThe duration (in seconds) for the call or portion of the call that was recorded.37
qarecordWhether the call was recorded for quality assurance (QA) purposes.BooleanFalse
transfercalleridThe number displayed on the receiving party’s Caller ID, if the call is transferred.String7575550000
calleridnameThe name displayed on the receiving party’s Caller ID. (Most carriers ignore this and use their own directory assistance to display name information.)StringEsendex Services
machinedetectionWhether 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
StringHUMAN

Let’s start sending, together.