Send SMS

To send a message to a mobile device, you'll need to use the POST method with this API, which will allow you to define the destination of the message, the source, the body of the message, and other key details. Upon receiving the call, our system will respond with a unique messageID and a few other details.

All Vibes calls and responses are written in XML.

Remember that to make a call to any of Vibes' APIs, you'll need to include Authentication and all required headers.

Example of a Call

To start, here's an example of a call. The required elements are detailed below.

POST

<?xml version="1.0" encoding="UTF-8"?>

<mtMessage submitterMessageId="239487234987234" splitLongMessage="true">
    <destination carrier="102" address="+18475551212" type="MDN" />
    <source address="98765" type="SC" />
    <text>123857AB12</text>
    <receiptOption callbackUrl="http://www.client.com/callback" >ERROR</receiptOption>
    <transaction id="6439376297230"/>
</mtMessage>

Elements and Attributes of a Call

Required

mtMessage

This is the main wrapper for your submit request.

destination

This element defines the destination to deliver the outgoing message.

source

• If sending from a short or long code, the value should be SC.
• If sending from an international alpha code, the value should be ANC. | String |

text

This element defines the text of the message you'd like to send. The message must be encoded in XML. If splitLongMessage is NOT set to True in mtMessage, then the message must be 160 characters or less.

Optional

Each of the following elements are optional.

receiptOption

This element indicates the receipt notifications that should be sent as a callback for this message.

Available values are as follows:

• NONE - send no notifications.
• ERROR - send only error notifications (includes error deliver receipts).
• ALL - send all notifications (includes DLRs).
• SMSC_ERROR - send only error notifications that come from the carrier (next Hop) upon send (does not include delivery receipts).
• SMSC_ALL - send only notifications that from the carrier (next Hop) upon send (does not include delivery receipts).

transaction

This element references the message (if any) that started this conversation. If this MT message is an alert, this element should be omitted.

companyId

The Company ID this message is being sent for.

Response

mtMessageRsp is the main wrapper for a response.

Reference Table

The reference tables below contain the same information as above, but in a quick-reference table form.

Request

• If sending from a short or long code, the value should be SC.
• If sending from an international alpha code, the value should be ANC. | String | | | SC | | | | | ANC | | | | text | | The text of the message you'd like to send. The characters must be encoded in XML. Must be 160 characters or less if the splitLongMessage is NOT set to True, and 900 characters or less if splitLongMessage is set to True (unencoded). | String | | receiptOption | | This element indicates the receipt notifications that should be sent as a callback for this message. Available values are as follows:
• NONE - send no notifications.
• ERROR - send only error notifications (includes error DLRs).
• ALL - send all notifications (includes DLRs).
• SMSC_ERROR - send only error notifications that come from the carrier (next Hop) upon send (does not include DLRs).
• SMSC_ALL - send only notifications that from the carrier (next Hop) upon send (does not include DLRs). | String | | | 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 must be encoded in XML. | | | transaction | | This element references the message (if any) that started this conversation. If this MT message is an alert, this element should be omitted. | | | | id | The value of the transaction ID provided with the MO message that started this conversation. The value may be up to 40 characters. | String | | companyId | | The Company ID this message is being sent for. | Long |

Response

Example success response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<mtMessageRsp submitterMessageId="AnyValue" messageId="e9efe523-aa57-4fdb-8f57-f15a4b06c91e" splitLongMessage="true"/>

Example failure response

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<error code="1031" description="Unable to resolve Carrier for MDN: 5125551212, Reason Unsupported MDN: 15125551212" retriable="false"/>