Add Agent

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 add the agent in your app.

Base URL

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

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*appidnumberYour app ID
*secretstringYour app secret
*extensionnumberThe three digit extension for agent
*namestringThe name of the agent
*phone_numbernumberThe phone number of the agent
*passwordstringThe password of the agent
start_timenumberThe agent shift time to start receiving the incoming call
end_timenumberThe agent shift time to stop receiving the incoming call
sms_alertstringThe missed call notification for the agent
The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request


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": "success",
"msg": "Saved successfully",
"agent": {
"agent_id": "101_1111112",
"name": "Manish",
"extension": 101


These are the list of properties and its description

agent_idstringThe created agent ID
namestringThe name of the agent
extensionnumberThe three digit extension of the agent

HTTP status codes

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

Status codeStatus TypeDescription
200SuccessWe received the request
400ErrorInvalid app id or secret, authentication failed, Missing parameter, Agent already exists