List Agents

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 get the list of the agents available in your app.

Base URL

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

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

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
*page	number	The Number of page per 10 record.
*limit	number	The Number of record for each request, Maximum limit is 10

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",
	"page": 1,
	"limit": 10
}

Sample Response

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

{
    "code": "cmi-2000",
    "status": "success",
    "count": 4,
    "agents": [
        {
            "agent_id": "101_1111112",
            "name": "Manish",
            "extension": 101,
            "password": "123456",
            "notify": false,
            "phone": "967755XXXX",
            "start_time": 1,
            "end_time": 24
        },
        {
            "agent_id": "102_1111112",
            "name": "Abhisek",
            "extension": 102,
            "password": "123456",
            "notify": true,
            "phone": "989439XXXX",
            "end_time": 21,
            "start_time": 7
        },
        {
            "agent_id": "103_1111112",
            "name": "Magesh",
            "extension": 103,
            "password": "123456",
            "notify": false,
            "phone": "978985XXXX",
            "end_time": 15,
            "start_time": 7
        },
        {
            "agent_id": "104_1111112",
            "name": "Nitin",
            "extension": 104,
            "password": "123456",
            "notify": false,
            "phone": "994482XXXX",
            "start_time": 1,
            "end_time": 24
        }
    ]
}

Properties

These are the list of properties and its description

Property	Type	Description
agent_id	string	The agent ID
name	string	The name of the agent
extension	number	The three digit extension of the agent
Password	string	The password of the agent
notify	string	The missed call notification of the agent
phone	string	The phone number of the agent
start_time	string	The shift start time of the agent
end_time	string	The shift end time of the agent

HTTP status codes

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

Status code	Status Type	Description
2000	Success	We received the request
404	Error	Invalid app id or secret, authentication failed, Missing parameter, Invalid Agent ID