UpdateQueueOutboundCallerConfigCommand

Suggest an Edit

This API is in preview release for Amazon Connect and is subject to change.

Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue.

  • If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for OutboundCallerIdNumberId. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is 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.

  • Only use the phone number ARN format that doesn't contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid. This is the same ARN format that is returned when you call the ListPhoneNumbersV2  API.

  • If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see Allow or Deny queue API actions for phone numbers in a replica Region .

Example Syntax

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

import { ConnectClient, UpdateQueueOutboundCallerConfigCommand } from "@aws-sdk/client-connect"; // ES Modules import
// const { ConnectClient, UpdateQueueOutboundCallerConfigCommand } = require("@aws-sdk/client-connect"); // CommonJS import
const client = new ConnectClient(config);
const input = { // UpdateQueueOutboundCallerConfigRequest
  InstanceId: "STRING_VALUE", // required
  QueueId: "STRING_VALUE", // required
  OutboundCallerConfig: { // OutboundCallerConfig
    OutboundCallerIdName: "STRING_VALUE",
    OutboundCallerIdNumberId: "STRING_VALUE",
    OutboundFlowId: "STRING_VALUE",
  },
};
const command = new UpdateQueueOutboundCallerConfigCommand(input);
const response = await client.send(command);
// {};

UpdateQueueOutboundCallerConfigCommand Input

See UpdateQueueOutboundCallerConfigCommandInput for more details

Parameter
Type
Description
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.

OutboundCallerConfig
Required
OutboundCallerConfig | undefined

The outbound caller ID name, number, and outbound whisper flow.

QueueId
Required
string | undefined

The identifier for the queue.

UpdateQueueOutboundCallerConfigCommand Output

See UpdateQueueOutboundCallerConfigCommandOutput for details

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

Throws

Name
Fault
Details
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.

InvalidRequestException
client

The request is 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.