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 »

POST - /MessageApi/mt/messageLists

Submit a message list.

Invoking the submit method will queue a message list for delivery to the end recipients. 

A synchronous response containing the assigned listId will be returned to the caller. Delivery status can be configured as a callback (per message) or requested manually through another API method.

HTTP Headers

Authorization: Vibes userid:password
Transactioning: ListId

XML Request

The post body of the request should be the XML <submit> element defined below.

POST
X-VibesAPI-Username: *username*
X-VibesAPI-Password: *password*
X-VibesAPI-ListId: *listid*
content-length: *length*

<?xml version="1.0" encoding="UTF-8"?>
<mtMessageList submitterListId="239487234987234">
	<dest carrier="102" address="8475551212" type="MDN" />
            .
            .
        <dest carrier="103" address="9475551212" type="MDN" />
	<source address="98765" type="SC" />
	<text>123857AB12</text>
	<receiptOption callbackUrl="*" >ERROR</receiptOption>
	<premium charge="$12.50" currency="USD" type="TBD" />
</mtMessageList>

Success XML Response

<mtMessageListRsp listId="234235" submitterListId="235235234" status="Submitted" />
//TODO: What other attributes/elements go on a message list.

POST - /MessageApi/mt/messageLists

Submit a message list with multiple MT messages.

Invoking the submit method will queue a message list of MT messages for delivery to the end recipients. 

Note that you can queue multiple MT messages to multiple MDNs through the single request.

A synchronous response containing the assigned listId will be returned to the caller. Delivery status can be configured as a callback (per message) or requested manually through another API method.

HTTP Headers

Authorization: Vibes userid:password
Transactioning: ListId

XML Request

The post body of the request should be the XML <submit> element defined below.

POST
X-VibesAPI-Username: *username*
X-VibesAPI-Password: *password*
X-VibesAPI-ListId: *listid*
content-length: *length*

<?xml version="1.0" encoding="UTF-8"?>
<mtMessageList submitterListId="234523456252">
	<dest carrier="102" address="8475551212" type="MDN" />
		.
		.
	<dest carrier="103" address="9475551212" type="MDN" />
	<source address="98765" type="SC" />
	<text>123857AB12</text>
	<receiptOption callbackUrl="*" >ERROR</receiptOption>
	<premium charge="$12.50" currency="USD" type="TBD" />
</mtMessageList>

Success XML Response

<mtMessageListRsp listId="234235" submitterListId="235235234" status="Submitted" />
//TODO: What other attributes/elements go on a message list.

Request Element Descriptions

Element

Attribute Name

Description

Data Type

Required

Default

submit

 

The main wrapper element around the submit request.


Yes



version

The submit version being utilized, for compliance and compatibility.

String

No

1.0

account


Identifies the client account that is sending the message. This information will be provided to you by a Vibes account manager during initial setup.


Yes



id

The account identifier (login)

String

Yes



password

The account password

String

Yes


message


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


Yes



submitter-id

A client definable identifier for a message.  This will be stored on the message for reference purposes. Must be 40 characters or less.

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

String

No

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