Skip to main content

User Update SMS Status

Each user API request in TeleCMI platform includes user login token. After getting the user login token, make a PUT request to the below base URL to update the SMS has read.

Base URL​

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

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

Required Parameters​

These are the required PUT method parameters with description

Parameter NameTypeDescription
tokenstringYour user token
msg_idstringA unique identifier of the message
Note
All the above parameters are mandatory.

Sample JSON Request​

Below is the following sample JSON PUT method request

{
"token": "xxxx-xxxx-xxxx-xxxx",
"msg_id": "98267b3-ascse-4bcb53-vsjs-b33dafdgfwebd"
}

Sample Response​

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

{
"msg": "status updated",
"code": 200
}

Properties​

These are the list of properties and its description

PropertyTypeDescription
msgstringThe message has updated to read

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