Skip to main content

User Send SMS

Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a POST request to the below base URL to send SMS.

Base URL

Send your POST method request with valid parameters, to the following base URL.

https://rest.telecmi.com/v2/messages

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
tokenstringYour user token
textstringSMS text message content
tostringThe Phone number to receive message
Note
All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"text": "Your appointment is scheduled at 10 AM",
"to": 19170000000
}

Sample Response

If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below

{
"code": 200,
"msg": "message sent"
}

Properties

These are the list of properties and its description

PropertyTypeDescription
msgstringThe message has been sent

HTTP status codes

TeleCMI API platform represents the following status code to identity the errors.

Status codeStatus TypeDescription
200SuccessWe received the request
404ErrorInvalid user token, Failed to authenticate token
400ErrorParameter missing
401ErrorNot allowed to send US SMS