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.

https://piopiy.telecmi.com/v1/agent/add

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
*extension	number	The three digit extension for agent
*name	string	The name of the agent
*phone_number	number	The phone number of the agent
*password	string	The password of the agent
start_time	number	The agent shift time to start receiving the incoming call
end_time	number	The agent shift time to stop receiving the incoming call
sms_alert	string	The missed call notification for the agent

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",
	"extension":101,
	"name":"Manish",
	"phone_number":967755XXXX,
	"password":"123456",
	"start_time":1,
	"end_time":24,
	"sms_alert":true
} 

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
    }
}

Properties

These are the list of properties and its description

Property	Type	Description
agent_id	string	The created agent ID
name	string	The name of the agent
extension	number	The three digit extension of the agent

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, Agent already exists