Skip to main content

Click-To-Call Admin

The Click to call API is used to connect the call, between two numbers. Using app secret and user id you can able to make a click to call API request. It connects the From number(User Number) 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 app secret and user id, make a POST request to the below base URL to initiate the click to call.

Base URL

Send your GET method request with valid query string, to the following base URL.

https://rest.telecmi.com/v2/webrtc/click2call?user_id=101_1111112&secret=2e0d75-d843-45-945-4171dd7a&to=9100000000&extra_params[name]={"click2call":"true"}&webrtc=true&followme=false

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

https://rest.telecmi.com/v2/webrtc/click2call

Sample JSON Request

Below is the following sample JSON POST method request.

{
"user_id": "101_1111112",
"secret": "2e0d75-d843-45-945-4171dd7a",
"to": 9100000000,
"extra_params": {"crm": true},
"webrtc": true,
"followme": false
}

Required Parameters

These are the required POST method parameters with a description.

Parameter NameTypeDescription
*user_idstringYour user id.
*secretstringYour app secret.
*tonumberThe number you need to call.
extra_paramsJSON objectThe custom parameter of the request.
webrtcbooleanThe default value is true. When the webrtc value is set to false, the softphone won't initiate the call.
followmebooleanThe default value is false. The WebRTC value should be set to false when the followme value set to true. Through this, the call will be initiated to the mobile device.
Note
The * marked parameter is mandatory.

Sample Response

If the provided information is valid, your web server will get a sample response from the TeleCMI Platform as given below.

{
"code": 200,
"msg": "Call initiated",
"request_id": "s96C6XK1BUHX0oVZfOo5NhoJfZZJd0y1nmrNN6dhdkW"
}

Properties

This is the list of properties and their descriptions.

PropertyTypeDescription
msgstringThis is the message information for the request.
request_idstringA unique identification of this call was initiated through click2call.

HTTP status codes

The TeleCMI API platform represents the following status code to identify the errors.

Status codeStatus codeDescription
200OKThere was a successful response to your request.
407Errorinvalid app secret.
404Errorinvalid user_id.
400Erroruser_id parameter missing , secret parameter missing , Enable webrtc or followme.