View a markdown version of this page

Upgrade your Contact Control Panel (CCP) when using the Connect Customer Streams API - Amazon Connect Customer
Verify your network settingsUpdate your SAML URL to ccp-v2

Upgrade your Contact Control Panel (CCP) when using the Connect Customer Streams API

Note

The Connect Customer Streams API remains the same between the earlier and latest versions of the CCP. We recommend validating custom implementations built using the Connect Customer Streams API when upgrading versions to ensure consistency in behavior.

Use the following steps to upgrade to the latest CCP.

  1. We recommend using the latest Connect Customer Streams API.

  2. Update the URL associated with initCCP() from /ccp# to /ccp-v2. For information about initCCP(), see connect.core.initCCP() in the Connect Customer Streams API documentation on GitHub.

  3. Add your domain URL to the Approved origin list:

    1. Log in to the AWS Management Console (https://console.aws.amazon.com/console) using your AWS account.

    2. Navigate to the Connect Customer console.

    3. Check that you're in the correct Region for your Connect Customer instance. Choose your instance.

      The Connect Customer virtual contact center instances page, the alias of your instance.

    4. Choose Application integration, and then choose Add origin.

      The left navigation pane, application integration option, Add origin.

    5. Enter your domain URL. All domains that embed the CCP for a particular instance to be explicitly added. For more information, see this article on GitHub.

      If you use Salesforce, you need to add the Salesforce domains to your allowlist to prevent any issues with the CTI Adapter CCP functionality. For detailed instructions, see the Connect Customer CTI Adapter for Salesforce Lightning installation guide or the Connect Customer CTI Adapter for Salesforce Classic installation guide.

Verify your network settings

We highly recommend setting up your network to use Option 1 (recommended): Replace Amazon EC2 and CloudFront IP range requirements with a domain allowlist.

Using this option helps Connect Customer Support to quickly troubleshoot any issues you have. Specifically, using *.telemetry.connect.{region}.amazonaws.com passes more metrics to our Support team to help with troubleshooting.

Update your SAML URL to ccp-v2

If you use SAML 2.0 as your identity management system, be sure to update the destination in your relay state URL to ccp-v2.

Change destination=/connect/ccp to destination=/connect/ccp-v2.

For more information, see Use a destination in your relay state URL