Send SMS

Endpoint URL
The end-point for sending SMS via HTTP (POST) calls is the following:
https://sms.liveall.eu/apiext/Sendout/SendSMS
curl example
curl --location --request POST 'https://sms.liveall.eu/apiext/Sendout/SendSMS' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'apitoken=7ace3e49cae13ae4f5ccb8a6a8a0d6a8fe120aa82ae46ad6ee4c9d8' \
--data-urlencode 'destination=306912345678' \
--data-urlencode 'senderid=mySender' \
--data-urlencode 'message=This is a test message from me!'
Variables
- apitoken
string
a unique hash code for each account that authorizes each web request. That code you can find it on your account’s page- destination
string
the cell’s number (without leading zeros or + sign), for example for Greece: 306912345678. In case you need to send the same message to more than one recipients, then you may supply that variable with these numbers delimited by one of the following characters;.^
It is recommended to send batches with a single request instead of making multiple requests, in case you want to send the same text to multiple destinations- senderid
string
the sender name of the SMS. There is a limit to 11 characters (latin characters). Allowed characters are:[A-Za-z0-9\-\.\!\#\%\&\(\)\<\>]
- message
string
the SMS text- sendon
(optional) - unsigned integer
an optional scheduling parameter. You can define a future datetime a message to be sent. This variable is a type of unsigned integer - unix timestamp. You can find more reference on https://dev.mysql.com/doc/refman/5.5/en/date-and-time-functions.html#function_unix-timestamp That is, in case you want to send the message on 2016-07-06 12:17:45 you must provide the value 1467796665- user_ref_id
(optional) - string
this property is used when you schedule a Single SMS to be sent in a later time and you need to have a reference to it. When scheduling a message by using thesendon
property SMS is not stored on the final log table, but in an intermediate table. That’s the reason the API is returning the schedule datetime and not the SMS id. You can specify a custom unique SMS id that can be used when you need to get the SMS status as illustrated in the Check the status of a submitted message page.- pricecat
(deprecated) - unsigned integer
by setting that parameter you can choose between normal and low cost price category (where applicable). Set 1 in case you want to send the message with low cost, or ignore it or set the value to 0, in case you want to send with normal cost
Note
If you want to test the API we recommend to use the Postman.
Error Response
- In case of error, the result could be like the following:
Error: <Error code> - <Error message>
where:
<Error code> |
is the request’s error code as shown below |
<Error message> |
is the error message, describing the problem with the request |
Successful Response
- In case of success, for a single destination number, we get the below result, where ID is the SMS id:
OK ID:123456789
- (ID: is the submitted SMS id number) and in case of multiple destinations we get something like the below:
OK ID:123456787|OK ID:123456788|OK ID:123456789