AssociatePhoneNumberContactFlowCommand

Suggest an Edit

Associates a flow with a phone number claimed to your Amazon Connect instance.

If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services 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 Amazon Web Services 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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { ConnectClient, AssociatePhoneNumberContactFlowCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, AssociatePhoneNumberContactFlowCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // AssociatePhoneNumberContactFlowRequest
  PhoneNumberId: "STRING_VALUE", // required
  InstanceId: "STRING_VALUE", // required
  ContactFlowId: "STRING_VALUE", // required
};
const command = new AssociatePhoneNumberContactFlowCommand(input);
const response = await client.send(command);
// {};

AssociatePhoneNumberContactFlowCommand Input

See AssociatePhoneNumberContactFlowCommandInput for more details

Parameter
Type
Description
ContactFlowId
Required
string | undefined

The identifier of the flow.

InstanceId
Required
string | undefined

The identifier of the Amazon Connect instance. You can find the instance ID  in the Amazon Resource Name (ARN) of the instance.

PhoneNumberId
Required
string | undefined

A unique identifier for the phone number.

AssociatePhoneNumberContactFlowCommand Output

See AssociatePhoneNumberContactFlowCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient permissions to perform this action.

InternalServiceException
server

Request processing failed because of an error or failure with the service.

InvalidParameterException
client

One or more of the specified parameters are not valid.

ResourceNotFoundException
client

The specified resource was not found.

ThrottlingException
client

The throttling limit has been exceeded.

ConnectServiceException
Base exception class for all service exceptions from Connect service.