Assign claimed
phone numbers to traffic distribution groups in Amazon Connect
-
You created a new traffic distribution group and it's status is
ACTIVE. We recommend using the DescribeTrafficDistributionGroup API to verify the status. -
You have already claimed phone numbers to instances or other traffic distribution groups.
Now you can assign those claimed phone numbers to your new traffic distribution
group by using the UpdatePhoneNumber API. Provide the traffic distribution group ARN in
the TargetArn parameter.
Note
To update the Description field, you must use the Amazon Connect console.
Example workflow
Following is an example workflow to assign claimed phone numbers to your traffic distribution group:
-
Call the UpdatePhoneNumber API to assign the phone number to a new
TargetArn.The
TargetArncan be for another Amazon Connect instance or for a traffic distribution group created in the same Region where the phone number was initially claimed. -
Perform the following steps to associate flows to phone numbers.
These steps ensure your telephony traffic will route correctly to your flows to support your traffic distribution configuration.
-
In your existing Amazon Connect instance in the Region where the traffic distribution group was created, do the following steps:
-
Call the ListContactFlows API. Provide the
InstanceIdthat corresponds to the instance that was replicated. -
A list of flow ARNs is returned. Use these flow ARNs to associate a flow to a phone number; call the AssociatePhoneNumberContactFlow API.
-
The phone number to flow association will be mirrored between Amazon Connect instances across AWS Regions.
-
Why an
AssociatePhoneNumberContactFlow call fails
If the number is claimed to a traffic distribution group, and you are calling AssociatePhoneNumberContactFlow using an instance in the AWS Region where the traffic distribution group was created, you can use either a full
phone number ARN or UUID value for the PhoneNumberId URI request
parameter.
However, if the number is claimed to a traffic distribution group and you are calling this API
using an instance in the replica AWS Region associated with the
traffic distribution group, you must provide a full phone number ARN. If a UUID is provided
in
this scenario, you will receive a
ResourceNotFoundException.
Why an UpdatePhoneNumber call
fails
Your UpdatePhoneNumber API call will fail with a
ResourceNotFoundException in the following case:
-
The specified traffic distribution group does not exist, the status of the traffic distribution group is not
ACTIVE, or you do not have ownership of the traffic distribution group.
UpdatePhoneNumber will fail with a
InvalidParameterException error in the following case:
-
The endpoint you are calling is not in the same Region where the traffic distribution group was created.
Phone number statuses
defined
Following is a description of phone number statuses:
-
CLAIMEDmeans the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded. -
IN_PROGRESSmeans a ClaimPhoneNumber, UpdatePhoneNumber operation is still in progress and has not yet completed. You can call DescribePhoneNumber at a later time to verify if the previous operation has completed. -
FAILEDindicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It includes a message indicating the failure reason. A common reason for a failure is that theTargetArnvalue you are claiming or updating a phone number to has reached its limit of total claimed numbers.
