The deliver callback is a vibes initiated request to the client to attempt delivery of an MO message to the client. The client endpoint should properly store/record the message and then return an HttpResponse; 200 to acknowledge receipt. The client process should keep actual processing/logic as small as possible, for throughput and performance.
XML Request
<?xml version="1.0" encoding="UTF-8"?> <deliver version="1.0" > <source address="8475551212" carrier="103" type="MDN" /> <destination address="12345" type="SC" /> <message text="123857AB12" /> <transaction id="234723487234234" /> <passthrough> <param key="moMessageId">6439376297230</param> </passthrough> </deliver>
Request Element Descriptions
Element |
Attribute Name |
Description |
Data Type |
Required |
Default |
---|---|---|---|---|---|
deliver |
|
Main wrapper element indicating that this is a deliver request. |
|
Yes |
|
|
version |
The Vibes XML version of the deliver request. |
String |
Yes |
|
source |
|
Element identifying the source/originator of the message. |
|
Yes |
|
|
address |
The originating address (ex: MDN) of the message. |
String |
Yes |
|
|
carrier |
The carrier network the Mobile Phone is on. This carrier code will need to be specified for any MT messages for the address. |
String |
Yes |
|
|
type |
The source address type of the originator. Currently, only MDN for telephone is supported. |
String |
Yes |
|
destination |
|
Element that identifies the recipience/destination for the message. |
|
Yes |
|
|
address |
The destination address (ex: Short Code) for the message. |
String |
Yes |
|
|
type |
The destination address type of the originator. Currently, only SC for "Short Code" is supported. |
String |
Yes |
|
message |
|
Element identifying the body/content of the message. |
|
Yes |
|
|
text |
The text body of the message. |
String |
Yes |
|
transaction |
id |
A unique identifier for each message. A transaction ID will only be created/returned for successful submission of an MT message. |
String |
Yes |
|