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/v2/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 |
| *id | string | The User ID |
| *name | string | The name 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 |
| sms_alert | boolean | The missed call notification for the user |
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",
"id":"101_1111112",
"name":"Abishek",
"phone_number":"919100000000",
"password":"12345678",
"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": 200,
"status": "success",
"msg": "Saved successfully",
"agent": {
"name": "Abishek",
"password": "12345678",
"notify": true,
"phone": "919100000000",
"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 |
| msg | string | The message information of the request |
| agent | JSON array | The updated user details |
| name | string | The updated name of the user |
| Password | string | The update password of the user |
| notify | boolean | The updated missed call notification of the user |
| phone | string | The updated phone number of the user |
| start_time | number | The updated shift start time of the user |
| end_time | number | The updated 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 | We received the request |
| 401 | Error | Invalid app id or secret, authentication failed, Invalid user ID |
| 400 | Error | Parameter missing |