User Status Update

Each API request in TeleCMI platform includes App id and secret. Get your App id and secret in TeleCMI dashboard. After getting the app id and secret, make a POST request to the below base URL to update the user status in your app.

Base URL

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

https://rest.telecmi.com/v2/user/status

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
appid	number	Your app ID
secret	string	Your app secret
id	string	The User ID
status	string	The status of the user, it may be online, offline, break, dialer

Note

All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
    "appid":1111112,
    "secret":"xxxx-xxxx-xxxx-xxxx",
    "id":"101_1111112",
    "status":"online",
} 

Sample Response

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

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

Properties

These are the list of properties and its description

Property	Type	Description
status	string	The status of the user like online, offline, dialer, break
msg	string	The message information of the request

HTTP status codes

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

Status code	Status Type	Description
200	Success	We received the request
401	Error	Invalid user token, authentication failed, Invalid Status
400	Error	Parameter missing