Bulk Update 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 update multiple users in your app in a single request.

Base URL

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

https://rest.telecmi.com/v3/user/update-bulk

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
*users	array	The list of user objects to update

User Object Structure:

Parameter Name	Type	Description
*agent_id	string	The User ID to update
first_name	string	The first name of the user
last_name	string	The last name of the user
email_id	string	The email ID of the user
phone_number	string	The phone number of the user
password	string	The password of the user
start_time	number	The user shift time to start receiving the incoming call
end_time	number	The user shift time to stop receiving the incoming call
followme	boolean	Enable or disable followme feature
callerid	number	The CallerID to assign to the user (USD app only)

Note

The * marked parameter is mandatory. The request is rejected as a whole if any user is invalid.

Sample JSON Request

Below is the following sample JSON POST method request

{
    "appid": 1111112,
    "secret": "xxxx-xxxx-xxxx-xxxx",
    "users": [
        {
            "agent_id": "1001_1111112",
            "first_name": "Abishek",
            "last_name": "Kumar",
            "phone_number": "919100000000",
            "password": "password1234",
            "callerid": 440000000000
        },
        {
            "agent_id": "1002_1111112",
            "followme": true
        }
    ]
}

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",
    "msg": "Saved successfully",
    "updated": ["1001_1111112", "1002_1111112"]
}

If one or more of the given users is not found, the whole request is rejected and your web server will get a sample response as given below

{
    "code": 404,
    "status": "error",
    "msg": "Agent(s) Not Found",
    "users": ["1002_1111112"]
}

If the given callerID is not available for your app, your web server will get a sample response as given below

{
    "code": 404,
    "status": "error",
    "msg": "Caller ID Not Found",
    "callerids": [440000000000]
}

Properties

These are the list of properties and its description

Property	Type	Description
status	string	The status of the request, success or error
msg	string	The message information of the request
updated	array	The list of User IDs updated successfully
users	array	The list of User IDs that failed validation
emails	array	The list of emails that failed validation
callerids	array	The list of CallerIDs that are invalid

HTTP status codes

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

Status code	Status Type	Description
200	Success	Saved successfully
400	Error	Validation failed, Duplicate agent_id, Invalid Phone number, Duplicate email, Email Already Exists!, Caller ID not allowed for this app
401	Error	Authentication Failed
404	Error	Agent(s) Not Found, Caller ID Not Found
500	Error	Sorry, something goes wrong !