Click to Call
Click to call API lets you dial a customer number by just clicking on the number, without the need of manually dialing it.
The API assists the agents or the users to make calls by entering the number they want to dial and thereafter, choosing the DID number from which they want to make the call. Click to Call is an advanced telephony solution feature which offers various advantages such as:
- Hassle-free way to communicate quickly as the caller need not worry about dialing the number in the event of an emergency
- Connects customers to your business and get a company representative on the line with a single click
- Adds to agents’ productivity by saving their time to dial out customer numbers. This cuts manual tasks for Agents and leads to a dramatic improvement in agent productivity
Getting Help
- Be sure to set the proper authorization header for your deployment.
- You can work on the API in live mode by simply navigating to the Click to Call API Reference Page.
Sample Request
Implement Click to Call via the method outlined below:
curl --request POST \
--url https://api.servetel.in/v1/click_to_call\
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{"agent_number":"90XXXXXXXX9","destination_number":"80XXXXXXXX9"}'
Request Variables (Body params)
The body params used for making calls are:
| Variable | Description | Data Type |
|---|---|---|
| agent_number* | The agent's EID, intercom number, extension username, or DID. For example, 809XXXXXXXX. | String |
| destination_number* | The number of the customer who will receive the call. Note: Customer numbers must be between 10 and 15 digits long, with the prefixes +91 and 0 allowed. For example, 9973XXXXXX, +919873XXXXXX and 09873XXXXXX. | String |
| caller_id | The caller ID that is shown to the called party. For example, 876XXXXXXX. | Integer |
| async | The number of calls the agent can make at a point of time. For example, 22. Note: Allows to not wait for an agent to pick up the call before sending back the response, which enables making multiple calls simultaneously. | String |
| call_timeout | The limit time of the call wherein it will auto-disconnect after provided seconds have reached the summit duration. For example, 32. | Integer |
| custom_identifier | The custom parameter that can be sent while making a click to call request.
| String |
Response variables
The response is as following:
| Variable | Description | Data Type |
|---|---|---|
| success | The possible values are:
| Boolean |
| message | The message corresponding to success status. For example, in 200 Response, the message displayed is "Originate successfully queued". | String |
Response Schema
A successful request returns the HTTP 200 OK status code and a JSON response body as detailed below:
{
"success": true,
"message": "Originate successfully queued"
}
Note:
Servetel supports custom variables that be send while make a click to call request and receive those variables back through webhooks.
For instance you can put a special identifier in a string, numeric format which can be passed while making a request to Smartflo and in the webhook that identifier will be returned to help you track your click to calls.