ClickToCall 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 POST method request with valid parameters, to the following base URL.

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

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*user_id	string	Your user id
*secret	string	Your app secret
*to	number	The TO number you need to call
extra_params	JSON object	The custom parameter of the request
webrtc	boolean	The default value is true. When the webrtc value is set to false, the softphone won't initiate the call.
followme	boolean	The 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 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
}

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

HTTP status codes

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

Status code	Status code	Description
200	OK	We received the request
404	Error	Failed to authenticate secret(Invalid user id or secret)
400	Error	User id or secret param missing