Send Transactional SMS

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


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

Request Body

  "message": "SMS Content", "mobile_number" : "27823000123” 


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 '' 
--data '{"message": "Hello world", "mobile_number" : "27823000123”}’


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.


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]

  "status": "success",
  "message": "Your message has been sent.",
  "data": {
    "id": “d1gab71d-3a20-4833-a6f1-b934686e0576"

Missing/Invalid credentials [401 Unauthorized]

"Invalid credentials."

Invalid mobile number [403 Forbidden]

    "status": "error",
    "message": "Unable to send transaction. Only valid SA numbers are allowed"