View a markdown version of this page

Voice ID and Connect Customer Integration Association APIs - Amazon Connect Customer

Voice ID and Connect Customer Integration Association APIs

Note

End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID. After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Connect Customer admin website or Contact Control Panel, or access Voice ID resources. For more information, visit Amazon Connect Voice ID end of support.

You can use the following APIs to manage associations with Connect Customer instances. You can perform these operations on the AWS Console as well.

  1. CreateIntegrationAssociation: To enable Voice ID on an Connect Customer instance, you will need to associate a Voice ID domain with a Connect Customer instance using a CreateIntegrationAssociation request. You can only associate one Voice ID domain to an Connect Customer instance. If the instance is already associated with a domain, the API returns the following error:

    DuplicateResourceException (409) - Request is trying to created a duplicate resource.

    Note

    When you enable Voice ID for an Connect Customer instance (by using either the Connect Customer console or the CreateIntegrationAssociation API), Connect Customer creates a managed Amazon EventBridge rule in your account. This rule is used to ingest Voice ID events for creating contact records related to Voice ID. Additionally, Connect Customer adds Voice ID permissions to the service-linked role for Connect Customer.

  2. DeleteIntegrationAssociation: To delete an existing association between an Connect Customer instance and a Voice ID domain, you will need to call the DeleteIntegrationAssociation APIs along with the Connect Customer InstanceID and the IntegrationAssociationID returned by CreateIntegrationAssociation. This is a required step if you want to associate a different Voice ID domain to this Connect Customer instance. We do not recommend deleting associations in a production setup as it can cause unpredictable behavior for Voice ID in your Connect Customer instance.

  3. ListIntegrationAssociations: To list all the associations between Connect Customer instance and Voice ID domains for your account in this Region, you can invoke ListIntegrationAssociations API.