UpdateQueueOutboundCallerConfig
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.
Important
If the number being used in the input 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 OutboundCallerIdNumberId
value
of the OutboundCallerConfig request body 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
POST /queues/InstanceId
/QueueId
/outbound-caller-config HTTP/1.1
Content-type: application/json
{
"OutboundCallerConfig": {
"OutboundCallerIdName": "string
",
"OutboundCallerIdNumberId": "string
",
"OutboundFlowId": "string
"
}
}
URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- QueueId
-
The identifier for the queue.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- OutboundCallerConfig
-
The outbound caller ID name, number, and outbound whisper flow.
Type: OutboundCallerConfig object
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.
- 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
- InvalidRequestException
-
The request is 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: