Click to call

The Click to call API is used to connect the call, between two numbers. Using agent login token 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 agent 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://piopiy.telecmi.com/v1/agentConnect

Required Parameters

These are the required POST method parameters with description

Parameter Name	Type	Description
*token	string	Your agent token
*to	string	The TO number you need to call

Note

The * marked parameter is mandatory.

Sample JSON Request

Below is the following sample JSON POST method request

{
  "token": "xxxx-xxxx-xxxx-xxxx",
  "to": "9100000000"
} 

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	Invalid Number, failed to authenticate token