v1

latestOpenAPI 3.1.02026-07-241360148.9 KB

Initiate Click to Call Support

This API allows you to initiate click to call support.

post/v1/click_to_call_support

Request body

customer_numberstring required

The number of the customer who will receive call. The customer number must be between 10 and 15 digits. For example, 9999888877.

customer_ring_timeoutinteger

Time in seconds to ring the customer's number before stopping. Minimum: 10 seconds, Maximum: 30 seconds. Defaults to 30 seconds if not specified.

caller_idstring

This request uses the DID number (Format Ex- 9180694XXXXX) to initiate the call, if it is pre-configured and valid under your account.

async1 required

Make multiple calls simultaneously, i.e don't wait for agent to pick up the call before sending back the response (Set default value to 1)

api_keystring required

The API Key for authentication and also to determine the destination for the call. Note that the Click to call API key is generated for a specific agent, department etc.

custom_identifierstring

Note: The parameter name is flexible and can be modified based on the specific use case.

call_timeoutinteger

With 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.

Response

200

object required