# API Message Parameters

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

<table><thead><tr><th width="218">Parameter</th><th width="133">Required?</th><th>Description</th></tr></thead><tbody><tr><td><strong>USER_NAME/Account_ID</strong></td><td>Yes</td><td>Username / Account_ID are interchangeable and will be provided to you by Mobivate</td></tr><tr><td><strong>PASSWORD/API_Key</strong></td><td>Yes</td><td>Password / API_Key are interchangeable and will be provided to you by Mobivate</td></tr><tr><td><strong>ORIGINATOR</strong></td><td>Yes</td><td><p>Phone number of the Originator / Sender of the message. Valid originator strings are: </p><p>• Numeric originators: Numbers starting with 614xxxxxxxx </p><p>• Shortcode originators: Numbers starting with 13, 18 or 19 </p><p>• Alphanumeric originators: Up to 11 characters, where at least one of the 11 must be a letter (Alpha) For example: </p><p>• <code>MYCOMPANY</code> </p><p>• <code>44700000000</code> </p><p>• <code>1300123</code></p></td></tr><tr><td><strong>RECIPIENT</strong></td><td>Yes</td><td>Phone number of the recipient (mobile phone) in international format (MSISDN) For example: <code>44700000000.</code></td></tr><tr><td><strong>MESSAGE_TEXT</strong></td><td>Yes</td><td><p>The SMS message to be delivered to the recipient. This field must be URL Encoded to ensure accurate interpretation of the message. For example: </p><p><code>• “&#x26;” à “%36”</code> </p><p><code>• “ “ à “%20”</code></p></td></tr><tr><td><strong>PROVIDER</strong></td><td>No</td><td>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: <code>Telstra</code></td></tr><tr><td><strong>VALUE</strong></td><td>No</td><td>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: <code>300 à $3.00 250 à $2.50</code></td></tr><tr><td><strong>REFERENCE</strong></td><td>No</td><td>Used by the sender to identify sent messages. Setting this field allows senders to easily track their messages For example: <code>ABC123</code>. Cannot be used for WEB Connections.</td></tr><tr><td><strong>URL</strong></td><td>No</td><td>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: <code>http%3A%2F%2Fdomain.com%2Ffolder%2Fwap%2Ffile.wml</code></td></tr><tr><td><strong>STARTED</strong></td><td>Yes (In Kenya &#x26; South Africa)</td><td>Contains the date of when the Subscription first started (<code>YYYY-MM-DD HH:MM:SS</code>). To unsubscribe you also need to pass 'STOP' within this message parameter.</td></tr><tr><td><strong>KEYWORD</strong></td><td>Yes (In Kenya, South Africa, Ghana and UK)</td><td>Contains the product id (on the network side) to which the subscriber was subscribed. See Keyword Requirements below.</td></tr><tr><td><strong>DR_ENDPOINT</strong></td><td>No</td><td>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.</td></tr><tr><td><strong>MESSAGE_CLASS</strong></td><td>Yes</td><td>Declare the Message class. For unsubscription MT's this class is required to send unsubscription messages, ie. <code>WELCOME MESSAGE</code>, <code>WELCOME CONTENT</code>, <code>CONTENT, STOP, PAUSE.</code></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://wiki.mobivate.com/api-message-paramaters/api-message-parameters.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.