Guides
Home

Manage API Keys

Once API Keys have been created, you can view and manage them from the Click to Call Support API Tokens page. This page provides a centralized view of all Click to Call Support API Keys created for your account. You can use this page to identify the API Key associated with a specific Caller ID or destination, check its current status, and perform available management actions.

Navigate to: API Connect → Click to Call Support API

API Key List

The Click to Call Support API Tokens page displays all API Keys created for your account. Each API Key is listed along with the Caller ID and destination associated with it.

The page also provides a summary of the API Keys configured for the account, including the total number of API Keys, enabled API Keys, and disabled API Keys.

Search and Locate an API Key

When multiple API Keys are configured, use the Search option to quickly locate the required API Key. You can use the available information associated with the API Key, such as the Caller ID or destination, to identify the required configuration.

This is particularly useful when different API Keys have been created for different numbers, agents, or destinations.

API Key Status

The Status column indicates whether an API Key is currently active.

Enabled - An Enabled API Key is active and can be used in Click to Call Support API requests.

Disabled - A Disabled API Key is inactive and cannot be used to initiate calls through the Click to Call Support API.

Before troubleshooting an API request, verify that the API Key being used by your application is in the Enabled state.

Copy an API Key

The API Key can be copied from the API Key list and used in your application. The API Key is displayed in a masked format. Use the Copy option available next to the API Key to copy the key.

The copied value should be passed 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
}

For the complete API request structure, refer to the Click to Call Support API Reference.

Security: Treat the API Key as sensitive information. Do not share it with unauthorized users or expose it in publicly accessible source code, client-side applications, or public repositories.

Manage API Key Status

You can manage the status of an existing API Key using the available Action options. An API Key can be disabled when it should no longer be used, without necessarily removing the configuration from the account.

Similarly, a previously disabled API Key can be enabled when it needs to be used again.

When to Disable an API Key

Consider disabling an API Key when:

  • The associated integration is no longer in use.
  • The API Key should temporarily stop accepting API requests.
  • You want to prevent an existing integration from initiating calls.

When to Enable an API Key

Enable an API Key when:

  • The associated integration needs to be activated again.
  • A previously disabled configuration needs to be reused.

Important: Disabling an API Key can affect applications that are currently using it. Make sure the API Key is not required by an active integration before disabling it.

Manage API Key Configuration

The Action menu associated with each API Key provides the available management options for that configuration. Depending on the current UI and permissions, you may be able to:

  • Edit the API Key configuration.
  • Enable or Disable the API Key.
  • Delete the API Key.

If you edit an existing configuration, review the associated Caller ID and Destination carefully, as changes may affect subsequent calls made using that API Key.

Delete an API Key

Delete an API Key when the configuration is permanently no longer required. Deleting an API Key removes that configuration from the Click to Call Support API setup.

Warning: Before deleting an API Key, make sure it is not being used by any active application or integration. Applications using a deleted API Key may no longer be able to initiate Click to Call Support API requests.

Important Considerations

  • Keep API Keys secure and share them only with authorized users.
  • Verify that the API Key is Enabled before using it in an API request.
  • Do not delete an API Key that is being used by an active integration.
  • If an API Key is disabled or deleted, API requests using that key may fail.
  • If an API Key is associated with multiple Caller IDs, review the configuration before making changes.
  • Use the API Reference for information about API request parameters and execution.

Updated 12 days ago