update_queue_outbound_caller_config

update_queue_outbound_caller_config(**kwargs)

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.

Warning

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 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 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 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 .

See also: AWS API Documentation

Request Syntax

response = client.update_queue_outbound_caller_config(
    InstanceId='string',
    QueueId='string',
    OutboundCallerConfig={
        'OutboundCallerIdName': 'string',
        'OutboundCallerIdNumberId': 'string',
        'OutboundFlowId': 'string'
    }
)
Parameters
  • InstanceId (string) --

    [REQUIRED]

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

  • QueueId (string) --

    [REQUIRED]

    The identifier for the queue.

  • OutboundCallerConfig (dict) --

    [REQUIRED]

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

    • OutboundCallerIdName (string) --

      The caller ID name.

    • OutboundCallerIdNumberId (string) --

      The caller ID number.

    • OutboundFlowId (string) --

      The outbound whisper flow to be used during an outbound call.

Returns

None

Exceptions

  • Connect.Client.exceptions.InvalidRequestException
  • Connect.Client.exceptions.InvalidParameterException
  • Connect.Client.exceptions.ResourceNotFoundException
  • Connect.Client.exceptions.ThrottlingException
  • Connect.Client.exceptions.InternalServiceException