Initiate Click to Call

This API allows you to use 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.

Sample Request

curl --request POST \
     --url \
     --header 'accept: application/json' \
     --header 'content-type: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Body Params)

The following parameter is required to retrieve the call detail records.

Variable NameDescriptionData Type
agent_number*ID of the Servetel agent who will receive the call.String
destination_number*Number of the client that needs to be called.String
caller_idCaller ID that is shown to the called party.String
asyncMake multiple calls simultaneously, i.e don't wait for agent to pick up the call before sending back the response. 1: asynchronous request, 0: synchronous requestString
call_timeoutWith the help of this request variable you can limit the time of the call. Call will auto disconnect after provided seconds have been reached in call duration.Integer
custom_identifierCustom parameter that can be send while making a Click To Call request. This parameter will be returned in webhook. Note: This is a sample custom identifier, you can send your own custom parameters while making a request to Servetel.String
get_call_idSetting this parameter to 1 will return call_id in response. Note: call_id will only be returned if the call has been answered by the agent.Integer

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.String
Click Try It! to start a request and see the response here!