Used to send an SMS to a specific destination.
Host:api.sms.mexediaon.com
Url:/outbound/sms
Methods:GET , POST
Formats:JSON , XML
Request parameters
Either as query parameters (when using GET) or in POST body document.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| From | string | x | The sender ID to be used for the SMS. See Sender IDs for restrictions. |
| To | string | x | The receiver MSISDN where the SMS should be sent to. |
| Text | string | x | The content of the SMS. See Text and Encoding Restrictions for further information. |
| Encoding | string | The encoding of the SMS content (Allowed values: GSM7 , Binary , UCS2 ; default: GSM7 ). See Text and Encoding Restrictions for further information. | |
| ReceiveDeliveryStatus | bool | true if you want to receive delivery status information (default: false ; a callback url has to be defined in your account to receive delivery status information). | |
| RefId | string | An optional reference id which will be included in corresponding delivery status information callbacks. | |
| Udh | string | The user data header in hex digits (e.g. 0605040C7242A3 ). Not required for long (concatenated) messages; texts are split automatically. | |
| Flash | bool | true if you want to send the SMS as flash message; it will be displayed instantly on the display of the target device (default: false ). |
Responsive parameters
Beside HTTP Status Codes each successful response will contain:
| Field | Type | Description |
|---|---|---|
| StatusCode | int | The status code for the call. See Status Codes. |
| MessageIds | string[] | An array containing the IDs of all messages which were generated. Willcontain > 1 IDs for long (concatenated) messages. |