Below is a list of all required arguments that needs to be sent in the POST request:
Parameter | Required | Description |
text | YES | A not less than 5-character value that will be delivered to phone/s attached |
numbers | YES |
Phone numbers can be in local(10 chars) or international (13 chars) format without plus(+) sign.
For bulk sms, numbers can be separated by a comma(,) e.g xxx,xxx,xxx |
api_key | YES | The value of api_key identifies the user within the system when interacting with the api.
You obtain this by registering on https://doc.smstoday.net.
Register here |
password | YES | Your SMS TODAY account password |
Schedule | NO |
If you may wish to send your sms at a specific time rather once the sms pushed to the gateway,
you may need to specify the bellow values to indicate the time of sending sms.
date: a day to send the sms - e.g 2024-11-21 |
from | YES | This is a sender id which appears on a receivers phone as a sender of the sms, as of version 1.2+ SMS TODAY requires that users register their sender id's to avoid fraud |
REQUEST RESPONSE
Response is always on json format where you're required to decode into your workspace languagejson string which the server reply to your call
json string explained
Parameter | Description | Example |
type |
Their are number of request type response
success indicated that the request was made successful |
success, info, danger, warning |
msg | This contains the response message in a human readable | sent, messages not sent, wrong login information |
code | Depending on the que status the api can replay with number of request codes, these codes indicates that the request succeed the messages were sent and billed successfully or not |
100 Invalid sender Id |
feedback |
Contains detailed description of each message pushed to the gateway
status
indicates the current status of the message by the time of pushing in the gateway
|
status 2 |