To use the "Send Single SMS" API, users need to construct a URL with the required parameters, including the API key, sender ID, destination number, message content, and DLT Template ID. Upon making the request, the system processes the message and returns a response indicating the status of the SMS delivery. The response includes a status code and message, providing clarity on the success or failure of the message transmission.
GET
https://api.msg4.cloud.robeeta.com/sms.aspx?apikey=xxx&tmpid=aaaa&sid=xxxx&to=989403&msg=Test
Authorization: Api key
Request Body
- apikey: string - (required) User msg4 account API key.
- tmpid: string - (required) Registered DLT template ID.
- sid: string - (required) The sender ID parameter refers to the message dispatcher or from clause (THE SENDER), from whom the message is sent. The sender ID can either be a valid international number up to fifteen characters long or an eleven-character alphanumeric string.
- to: string - (required) The destination mobile number to which the message is to be sent. The mobile number must include the country code at the beginning and should not contain any symbols (+) or 00.
- msg: string - (required) The actual message to be sent. It can include up to 160 characters, with the following rules:
- Supports characters: A-Z, a-z, 0-9, blank spaces, and the line feed character (\).
- Special characters must be URL-encoded:
Character |
Hexadecimal Encoded String |
& |
%26 |
+ |
%2B |
% |
%25 |
# |
%23 |
= |
%3D |
- For Unicode messages, up to 70 characters are allowed (each character can be 4 Unicode digits).
- For binary messages, a maximum of 140 characters is allowed (one SMS). Concatenated SMS can be used for larger data like ringtones, logos, and pictures.
Response Body
- MESSAGE: string - A message indicating the outcome of the request. This field will contain an appropriate message detailing the success or failure of the operation. For successful messages, it will confirm the delivery, while in case of an error, it will describe the issue encountered.
- STATUS: integer - A status code representing the result of the operation. A status of "OK" indicates that the message was sent successfully. Any other status will denote an error, with accompanying information in the MESSAGE field to clarify the issue.
Note: Ensure that the message parameter adheres to the format and character limitations described to avoid message delivery issues. Incorrect parameters will lead to non-delivery of the message.
Response Example:
<STATUS>OK</STATUS><MESSAGE>SMS SENT</MESSAGE>