Click-To-Call India
The Click-To-Call India API is used to connect the call, between TeleCMI softphone and Indian phone number. Using user login token you can able to make a Click-To-Call API request. It connects the TeleCMI user softphone first. Once the person at the From end picks up the call, then it will connect the To number provided by you. After getting the user login token, make a POST request to the below base URL to initiate the Click-To-Call.
Base URL
Send your POST method request with valid parameters, to the following base URL.
https://rest.telecmi.com/v2/ind/click2call
Sample JSON Request
Below is the following sample JSON POST method request
{
"token": "xxxx-xxxx-xxxx-xxxx",
"to": 919200000000,
"extra_params": {"crm": "true"},
"callerid": 919800000000
}
Required Parameters
These are the required POST method parameters with description
Parameter Name | Type | Description |
---|---|---|
*token | string | Your user token |
*to | number | The destination number you need to call |
extra_params | JSON | Your custom parameters |
callerid | number | It defines the caller id of this call. By default, the user selected callerid will be displayed. |
Note
Sample Response
If the provided information is valid, your web server will get a sample response from TeleCMI Platform as given below
{
"code": 200,
"msg": "Call initiated",
"request_id": "s96C6XK1BUHX0oVZfOo5NhoJfZZJd0y1nmrNN6dhdkW"
}
Properties
These are the list of properties and its description
Property | Type | Description |
---|---|---|
msg | string | The Call initiated |
request_id | string | The unique ID for this call |
HTTP status codes
TeleCMI API platform represents the following status code to identity the errors.
Status code | Status Type | Description |
---|---|---|
200 | OK | We received the request |
404 | Error | Invalid Number, failed to authenticate token |
400 | Error | To parameter missing |