Skip to main content

Add Supervisor

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

Base URL​

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

https://rest.telecmi.com/v2/supervisor/add

Required Parameters​

These are the required POST method parameters with description

Parameter NameTypeDescription
appidnumberYour app ID
secretstringYour app secret
extensionnumberThe three digit extension for supervisor
namestringThe name of the Supervisor
phone_numbernumberThe phone number of the supervisor
passwordstringThe password of the supervisor
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",
"extension":101,
"name":"Manish",
"phone_number":919999999999,
"password":"123456"
}

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",
"super": {
"super_id": "101_1111112",
"name": "Manish",
"extension": 101
}
}

Properties​

These are the list of properties and its description

PropertyTypeDescription
super_idstringThe created supervisor ID
namestringThe name of the supervisor
extensionnumberThe three digit extension of the supervisor

HTTP status codes​

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

Status codeStatus TypeDescription
200SuccessWe received the request
401ErrorInvalid app id or secret, authentication failed
400ErrorParameter missing, Supervisor ID already exists