Skip to end of metadata
Go to start of metadata

Last Updated: Friday, January 26, 2018



The deliver callback is a vibes-initiated request to the client to attempt delivery of a Mobile Originated (MO) message. 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 good throughput and performance.

XML Request Example

<?xml version="1.0" encoding="UTF-8"?>
<moMessage messageId="234723487234234" receiptDate="YYYY-MM-DD HH:MM:SS Z" attemptNumber="1">
    <source address="+18475551212" carrier="103" type="MDN" />
    <destination address="12345" type="SC" />
    <message>123857AB12</message>
</moMessage>

Request Element Descriptions

Element

Attribute Name

Description

Data Type

Required

Default

moMessage

 

Main wrapper element indicating that this is a deliver request.

 

Yes

 

 

messageId

A unique identifier for each message.

String

Yes

 

 

receiptDate

Receipt Date in standard XML format.

String

Yes

 

 attemptNumberAn index assigned to each attempt made to deliver the MO message.IntegerYes 

source

 

Element identifying the source/originator of the message.

 

Yes

 

 

address

The originating address, such as a Mobile Directory Number (MDN), of the message. This must be specified in e.164 international format with a leading +.

String

Yes

 

 

carrier

The carrier network the Mobile Phone is on. This carrier code will need to be specified for any Mobile Terminated (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

 

The element that identifies the recipient/destination for the message.

 

Yes

 

 

address

The destination address, such as 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

 

  • No labels