API Message Parameters

The page will give you all required parameters for sending MT messages via HTTP.

When sending text SMS MT messages, the following parameters should be sent as part of the HTTP GET request:

ParameterRequired?Description

USER_NAME/Account_ID

Yes

Username / Account_ID are interchangeable and will be provided to you by Mobivate

PASSWORD/API_Key

Yes

Password / API_Key are interchangeable and will be provided to you by Mobivate

ORIGINATOR

Yes

Phone number of the Originator / Sender of the message. Valid originator strings are:

• Numeric originators: Numbers starting with 614xxxxxxxx

• Shortcode originators: Numbers starting with 13, 18 or 19

• Alphanumeric originators: Up to 11 characters, where at least one of the 11 must be a letter (Alpha) For example:

• MYCOMPANY

• 44700000000

• 1300123

RECIPIENT

Yes

Phone number of the recipient (mobile phone) in international format (MSISDN) For example: 44700000000.

MESSAGE_TEXT

Yes

The SMS message to be delivered to the recipient. This field must be URL Encoded to ensure accurate interpretation of the message. For example:

• “&” à “%36”

• “ “ à “%20”

PROVIDER

No

Identifies the telco provider (Telstra/Optus…) for Premium SMS Messages only For standard SMS messages, the field value must set to DEFAULT or left blank. For example: Telstra

VALUE

No

Specifies the value of a Premium SMS message, in cents (this applies to all currencies). To be used only in conjunction with the PROVIDER field. For example: 300 à $3.00 250 à $2.50

REFERENCE

No

Used by the sender to identify sent messages. Setting this field allows senders to easily track their messages For example: ABC123. Cannot be used for WEB Connections.

URL

No

When specified, the message will be sent as WAP Push. A link will appear on the handset showing the MESSAGE_TEXT parameter, and upon clicking the handset will be forwarded to the specified URL. This field must be URL Encoded. For example: http%3A%2F%2Fdomain.com%2Ffolder%2Fwap%2Ffile.wml

STARTED

Yes (In Kenya & South Africa)

Contains the date of when the Subscription first started (YYYY-MM-DD HH:MM:SS). To unsubscribe you also need to pass 'STOP' within this message parameter.

KEYWORD

Yes (In Kenya, South Africa, Ghana and UK)

Contains the product id (on the network side) to which the subscriber was subscribed. See Keyword Requirements below.

DR_ENDPOINT

No

The URL that the delivery notifications should be sent to for this message. We still suggest using a globaly defined DR endpoint. This one overrides it.

MESSAGE_CLASS

Yes

Declare the Message class. For unsubscription MT's this class is required to send unsubscription messages, ie. WELCOME MESSAGE, WELCOME CONTENT, CONTENT, STOP, PAUSE.

Last updated