List Users

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

Base URL

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

https://rest.telecmi.com/v3/user/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. By default the page is 1.
limit	number	The Number of record for request.
name	string	Filter by name (optional)

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": 200,
    "status": "success",
    "count": 4,
    "agents": [
        {
            "agent_id": "1001_1111112",
            "first_name": "Manish",
            "last_name": "Kumar",
            "extension": 1001,
            "password": "password123",
            "notify": true,
            "phone": "967755XXXX",
            "start_time": 1,
            "end_time": 24
        }
    ]
}

Properties

These are the list of properties and its description

Property	Type	Description
status	string	The status of the request, success or error
count	number	The total count of user list
agents	JSON array	The list of user details
agent_id	string	The user ID
first_name	string	The first name of the user
last_name	string	The last name of the user
extension	number	The four digit extension of the user
password	string	The password of the user
phone	string	The phone number of the user
user_id	string	The unique system ID of the user
notify	boolean	The missed call notification status
start_time	number	The shift start time of the user
end_time	number	The shift end time of the user

HTTP status codes

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

Status code	Status Type	Description
200	Success	Request processed successfully
401	Error	Authentication Failed
400	Error	Validation failed
500	Error	Sorry, something goes wrong !