Send Transactional SMS

Call this endpoint with a POST request to send an SMS with the provided details in the body.

Endpoint

Method URL Parameters
POST https://[Your URL]/api/2.0/production/sms/message [Your URL] – Your Everlytic Install URL, e.g. live1.everlytic.net

Request Body



Properties








Property
Description
Data type
Required






message
Content of the message to be sent. Maximum 459 characters.
string
Yes




mobile_number
The mobile number to be sent to. Only valid SA numbers allowed.
string
Yes








Example Request


curl --location 'https://live0.everlytic.net/api/2.0/production/sms/message' 
--data ''


Response
Status codes








Status
Explanation






200 OK
SMS was sent successfully




401 Unauthorized
Invalid or missing authorization credentials




403 Forbidden
Mobile number provided is not a valid South African number.








Properties








Property
Description
Data type
Parameters






status
Status of response from API
enum (string)


    

  • success
    • 

  • error
    • 







message
Description of the response
string





data
Array containing the ID assigned to this transaction. Only present if status is “success”.
JSON


    

  • id
    • 









    

  • id
    • 



The ID assigned to this transaction.
string









Example responses
SMS was sent successfully [200 OK]






Missing/Invalid credentials [401 Unauthorized]




"Invalid credentials."


Invalid mobile number [403 Forbidden]