Add 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 add 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/add
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 |
*extension | number | The three digit extension for user |
*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",
"extension":101,
"name":"Manish",
"phone_number":"919200000000",
"password":"123456",
"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": {
"agent_id": "101_1111112",
"name": "Manish",
"extension": 101
}
}
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 added user details |
agent_id | string | The created user ID |
name | string | The name of the user |
extension | number | The three digit extension 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 | Authentication failed |
400 | Error | Parameter missing, User ID Already Exists, User limit reached |