Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Last Updated:

Lastupdatedate

Livesearch
placeholderSearch the Vibes Developer Wiki
typepage



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.

URI

...

XML

...

Request Example

Code Block

...

<?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" />
    

...

Response

Upon validating the request, the server shall respond with appropriate response code.  A successful message processed shall return an Http Server Response of 200.  If the server responds with an Http Server Response of anything other than 200, then there was a system error that occurred and the delivery will be attempted again.  Vibes will continue to attemp delivery of the message for the next 15 minutes before moving the message into an error queue and alerting Vibes Operations staff.  Once the problem has been resolved, the messages can be resent.

Note: The delivery recipient application must handle all message content delivered.  Messages that are considered invalid (ex: Bad keyword), are the responsibility of the client to log and acknowledge with Http Response 200, to keep Vibes delivery service from continually retrying delivery of the message.

<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

...

version

...

 

 

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

...

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

Anchor
QueryMdn
QueryMdn