Agent Status Update

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

Base URL

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

https://piopiy.telecmi.com/v1/agent/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 Agent ID
*status	string	The status of the agent, it may be online, offline, break, dialer

Note

The * marked parameter is 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": "cmi-200",
    "status": "online",
    "msg": "status updated successfully"
}

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
400	Error	Invalid app id or secret, authentication failed, Missing parameter, Invalid Agent ID, Invalid status name

Base URL​

Required Parameters​