Update User

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

Base URL

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

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

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

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",
    "agent_id": "1001_1111112",
    "first_name": "Abishek",
    "last_name": "Kumar",
    "phone_number": "919100000000",
    "password": "password1234"
} 

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

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

HTTP status codes

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

Status code	Status Type	Description
200	Success	Saved successfully
401	Error	Authentication Failed
400	Error	Validation failed, Email Already Exists!, Invalid Phone number
404	Error	Agent not found or no changes made
500	Error	Error checking email, Error updating agent, or Sorry, something goes wrong !