Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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.

URI

The uri endpoint invoked will be defined during client setup, but typical endpoint is /deliver.  The method will be an Http POST with the entire body of the post consisting of the XML deliver content.

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

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.

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


  • No labels