Skip to main content

Remove 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 remove 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/remove

Required Parameters

These are the required POST method parameters with description

Parameter NameTypeDescription
*appidnumberYour app ID
*secretstringYour app secret
*agent_idstringThe User ID
Note
All the above parameters are mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
"appid": 1111112,
"secret": "xxxx-xxxx-xxxx-xxxx",
"agent_id": "1001_1111112"
}

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

Properties

These are the list of properties and its description

PropertyTypeDescription
statusstringThe status of the request, success or error

HTTP status codes

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

Status codeStatus TypeDescription
200SuccessAgent removed successfully
401ErrorAuthentication Failed
400ErrorValidation failed
404ErrorSorry, something goes wrong !
500ErrorSorry, something goes wrong !