API Access Control

To send contacts with guard time values down to the exact minute, using the REST API. When the RestAPIEnabled option is enabled in the dialer configuration, contacts are transmitted via the REST API instead of the legacy method. To use this functionality, valid REST API Username (consumer key) and REST API Password (secret key) must be configured.

Note:

The REST API has certain limitations: it supports a maximum of 1,000 contacts per request and allows up to 40 requests per minute.

Perform the following steps:

1. Go to User > Access Control > Permission in the Five9 Admin portal.

2. Select a user and click Edit.

3. In the Permission tab, under Security, activate the following permissions:
   

   1. Create Application

   2. Edit Application

4. Go to API Access Control from the Five9 VCC portal.
   

5. Click Create to open the Create API Access Control panel.

6. In the API Access Control panel, configure the following fields:

   1. Name: Enter a descriptive name for the API access.

   2. Contact Email: Provide a valid contact email.

   3. Duration: Select one of the following:

      1. Never Expires – Grants continuous access without expiration.

      2. Custom – Grants access for a specified duration.

7. In the Family field, select All APIs Access from the dropdown list.
   

8. Under Scopes, make sure to select the following permissions:

   1. Campaigns:read

   2. lists:read

   3. lists:write

To Generate Consumer Key and Secret:

1. Select the created or existing API entry.

2. Go to the Credential tab.

3. Click Add Credential. The system displays the generated Consumer Key and Secret Key.

   Note:

   The Secret Key is shown only once. You must copy and store it securely at this point, as it is required for dialer configuration and cannot be retrieved later.

4. Click the Copy icon to copy the credentials.

5. Click Close to finish.