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 16 Next »

POST - /MessageApi/mt/messageLists

Invoking this method will queue a list of MT messages for delivery to multiple recipients. The requestor will receive a synchronous response containing the assigned listId. Delivery status can be configured as a callback or requested manually through another API method. 

If any part of the request fails due to invalid schema or values, the request or part of it will return as an error. If access to the Vibes platform system is lost during the request, all of the messages will be failed to enable easier retries.

A maximum of 100 destinations is supported. Requests over 500KB will be rejected.

HTTP Headers

Authorization: Vibes userid:password
X-VibesAPI-SubmitterListId: ListId

Sample XML Request

POST
Authorization: Vibes username:password
X-VibesAPI-SubmitterListId: 234523456252

<?xml version="1.0" encoding="UTF-8"?>
<mtMessageList submitterListId="234523456252">
	<destination carrier="102" address="8475551212" type="MDN" />
	<destination carrier="103" address="9475551212" type="MDN" />
	<source address="98765" type="SC" />
	<text>123857AB12</text>
	<receiptOption callbackUrl="http://www.client.com/callback">ERROR</receiptOption>
	<premium charge="$12.50" currency="USD" type="TBD" />
</mtMessageList>
Success XML Response
<mtMessageListRsp listId="b75fccf3-8f06-4d8f-a282-d1886a4792a1" submitterListId="234523456252"/>
XML Response with Errors

Depending on the type of error, requests may fail partially or entirely. The request may partially fail if there is an error within a dest element. If part of a request fails, the response XML will return as normal with the assigned listId and include an error element for each destination that failed. If the entire request fails, no mtMessageListRsp element will be returned. Instead, a single error element will return as specified in Appendix A.

<mtMessageListRsp listId="b75fccf3-8f06-4d8f-a282-d1886a4792a1" submitterListId="234523456252">
	<error address="8475551212" code="1" description="Error Code Reason" retriable="false" />
</mtMessageListRsp>

Request Header Descriptions

Header

Description

Required

Authorization

Vibes' proprietary authentication string. It must be formatted as 'Vibes <username>:<password>'

Yes

X-VibesAPI-SubmitterListId

A client definable identifier for a message.  This will be stored on the message for reference purposes. Must be 40 characters or less. 
This value has precedence over the submitterListId attribute in the messageList element of the request.

No

Request Element Descriptions

Element

Attribute Name

Description

Data Type

Required

Default

messageList


Identifies all of the information content to deliver an MT message.


Yes



submitterListId

A client definable identifier for a message.  This will be stored on the message for reference purposes. Must be 40 characters or less. 
If the X-VibesAPI-SubmitterListId header is set, the header value will take precedence over this value.

String

No


destination


This element defines the destination to deliver the MT message.


Yes



carrier

The carrier network the Mobile Phone is on.  For replies, the carrier should be the same as the carrier on the original MO message. If it is not specified, the system will query for the correct carrier.

String

No



address

The deliverable address to deliver the message.

String

Yes



type

The address type for delivery.  Currently, the only supported type is MDN for telephone.

String

No

MDN

source

 

This element defines the source (Originating) account for the MT message.

 

Yes

 

 

address

The source address/number that originated the MT request.

String

Yes


 

type

The originating address type.  Currently, the only supported type is SC for Short Code.

String

No

SC

text

 

This defines the message text to be delivered in the message.  This should be URL encoded content.

String

Yes

 

receiptOption

 

This element indicates the receipt notifications that should be sent with this message.  Current allowed values are: NONE, ERROR, ALL, SMSC_ERROR, SMSC_ALL

String

No

NONE

 

callbackUrl

This attribute defines the URL that all receipt notifications should be delivered to. If the receiptOption value is NONE, the value of this attribute will be ignored. The characters will be XML encoded.

URL

Yes, unless NONE

 

premium

 

This element defines the premium charge component for this MT message.  If not defined, then there is no premium message component.

 

No

 

 

charge

The premium currency amount to charge the user for this message.

Numeric

Yes


 

currency

The currency of the charge amount.  Currently, only USD is supported.

String

No

USD

 

type

The charge type used to indicate the reason for the charge.  Valid values will be assigned by Vibes during account setup/configuration.

String

Yes

 

  • No labels