Remove Agent
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 remove the agent in your app.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://piopiy.telecmi.com/v1/agent/remove
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 Agent ID |
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"
}
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"
}
Properties
These are the list of properties and its description
| Property | Type | Description |
|---|---|---|
| name | string | The updated name of the agent |
| Password | string | The update password of the agent |
| notify | string | The updated missed call notification of the agent |
| phone | string | The updated phone number of the agent |
| start_time | string | The updated shift start time of the agent |
| end_time | string | The updated 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 |
| 400 | Error | Invalid app id or secret, authentication failed, Missing parameter, Invalid Agent ID |