Click to Call Support API

Overview

The Click to Call Support API allows you to initiate calls programmatically from an external application, CRM, or business system using Smartflo.

Before you can use the API, you must create a Click to Call Support API Key from the Smartflo portal. The API Key acts as a predefined calling configuration that associates one or more Caller ID (DID) numbers with a specific destination.

When you generate an API Key, you configure:

The Caller ID (DID) number(s) that can be used for the call.
The Destination Type that defines how the call should be routed.
The Destination where the call should be connected.

Once the API Key is generated, you pass it in the api_key parameter of the Click to Call Support API request. Smartflo uses the configuration associated with the API Key to determine the Caller ID and destination for the call.

Note: The Click to Call Support API Key is different from the Smartflo API Token. The API Token is used for API authentication, whereas the Click to Call Support API Key identifies the calling configuration and is passed in the API request payload.

Why Do You Need an API Key?

The Click to Call Support API Key allows you to define the calling configuration once in the Smartflo portal and then use that configuration when making API requests.

Instead of specifying the complete routing configuration every time you initiate a call, you can create an API Key with the required Caller ID and destination and pass the corresponding key in your API request.

What Does the API Key Configure?

Each API Key represents a specific Click to Call Support configuration.

The Caller ID determines the number associated with the outbound call. You can select one or multiple DID numbers while generating an API Key. These numbers are associated with the API Key and can be used when executing the Click to Call Support API.

The Destination Type determines the type of destination to which the call should be routed. Depending on your account configuration, available destination types may include:

After selecting the Destination Type, select the specific destination. The selected destination becomes part of the API Key configuration. For example:

Destination Type: IVR
Destination: Testing

How the API Key Is Used

Once the API Key is generated, your application passes the key in the api_key parameter of the Click to Call Support API request. For example:

{
  "api_key": "<YOUR_API_KEY>",
  "customer_number": "9999888877",
  "async": 1
}

The API Key identifies the calling configuration that you created in the Smartflo portal. The API then uses this configuration while processing the call.

Important: You do not need to create a new API Key for every call. Create an API Key based on your required calling configuration and reuse it for subsequent API requests.

For the complete request format, supported parameters, response details, and error handling, see the Click to Call Support API Reference.