AssociatePhoneNumberContactFlow
Associates a flow with a phone number claimed to your Amazon Connect instance.
Important
If the number is claimed to a traffic distribution group, and you are calling this API 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 alternate
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.
Request Syntax
PUT /phone-number/PhoneNumberId/contact-flow HTTP/1.1
Content-type: application/json
{
"ContactFlowId": "string",
"InstanceId": "string"
}URI Request Parameters
The request uses the following URI parameters.
- PhoneNumberId
-
A unique identifier for the phone number.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ContactFlowId
-
The identifier of the flow.
Type: String
Length Constraints: Maximum length of 500.
Required: Yes
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
