Connect / Client / update_user_config

update_user_config¶

Connect.Client.update_user_config(**kwargs)¶

Updates the configuration settings for the specified user, including per-channel auto-accept and after contact work (ACW) timeout settings.

Note

This operation replaces the UpdateUserPhoneConfig API. While UpdateUserPhoneConfig applies the same ACW timeout to all channels, UpdateUserConfig allows you to set different auto-accept and ACW timeout values for each channel type.

Request Syntax

response = client.update_user_config(
    AutoAcceptConfigs=[
        {
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
            'AutoAccept': True|False,
            'AgentFirstCallbackAutoAccept': True|False
        },
    ],
    AfterContactWorkConfigs=[
        {
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
            'AfterContactWorkConfig': {
                'AfterContactWorkTimeLimit': 123
            },
            'AgentFirstCallbackAfterContactWorkConfig': {
                'AfterContactWorkTimeLimit': 123
            }
        },
    ],
    PhoneNumberConfigs=[
        {
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
            'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
            'PhoneNumber': 'string'
        },
    ],
    PersistentConnectionConfigs=[
        {
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
            'PersistentConnection': True|False
        },
    ],
    VoiceEnhancementConfigs=[
        {
            'Channel': 'VOICE'|'CHAT'|'TASK'|'EMAIL',
            'VoiceEnhancementMode': 'VOICE_ISOLATION'|'NOISE_SUPPRESSION'|'NONE'
        },
    ],
    UserId='string',
    InstanceId='string'
)

Parameters:

AutoAcceptConfigs (list) –
The list of auto-accept configuration settings for each channel. When auto-accept is enabled for a channel, available agents are automatically connected to contacts from that channel without needing to manually accept. Auto-accept connects agents to contacts in less than one second.
- (dict) –
  
  Configuration settings for auto-accept for a specific channel.
  - Channel (string) – [REQUIRED]
    
    The channel for this auto-accept configuration. Valid values: VOICE, CHAT, TASK, EMAIL.
  - AutoAccept (boolean) – [REQUIRED]
    
    Indicates whether auto-accept is enabled for this channel. When enabled, available agents are automatically connected to contacts from this channel.
  - AgentFirstCallbackAutoAccept (boolean) –
    
    Indicates whether auto-accept is enabled for agent-first callbacks. This setting only applies to the VOICE channel.
AfterContactWorkConfigs (list) –
The list of after contact work (ACW) timeout configuration settings for each channel. ACW timeout specifies how many seconds agents have for after contact work, such as entering notes about the contact. The minimum setting is 1 second, and the maximum is 2,000,000 seconds (24 days). Enter 0 for an indefinite amount of time, meaning agents must manually choose to end ACW.
- (dict) –
  
  Configuration settings for after contact work (ACW) timeout for a specific channel.
  - Channel (string) – [REQUIRED]
    
    The channel for this ACW timeout configuration. Valid values: VOICE, CHAT, TASK, EMAIL.
  - AfterContactWorkConfig (dict) – [REQUIRED]
    
    The ACW timeout settings for this channel.
    - AfterContactWorkTimeLimit (integer) –
      
      The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter 0 for indefinite ACW time.
  - AgentFirstCallbackAfterContactWorkConfig (dict) –
    
    The ACW timeout settings for agent-first callbacks. This setting only applies to the VOICE channel.
    - AfterContactWorkTimeLimit (integer) –
      
      The ACW timeout duration in seconds. Minimum: 1 second. Maximum: 2,000,000 seconds (24 days). Enter 0 for indefinite ACW time.
PhoneNumberConfigs (list) –
The list of phone number configuration settings for each channel.
- (dict) –
  
  Configuration settings for phone type and phone number.
  - Channel (string) – [REQUIRED]
    
    The channel for this phone number configuration. Only VOICE is supported for this data type.
  - PhoneType (string) – [REQUIRED]
    
    The phone type. Valid values: SOFT_PHONE, DESK_PHONE.
  - PhoneNumber (string) –
    
    The phone number for the user’s desk phone.
PersistentConnectionConfigs (list) –
The list of persistent connection configuration settings for each channel.
- (dict) –
  
  Configuration settings for persistent connection for a specific channel.
  - Channel (string) – [REQUIRED]
    
    Configuration settings for persistent connection. Only VOICE is supported for this data type.
  - PersistentConnection (boolean) – [REQUIRED]
    
    Indicates whether persistent connection is enabled. When enabled, the agent’s connection is maintained after a call ends, enabling subsequent calls to connect faster.
VoiceEnhancementConfigs (list) –
The list of voice enhancement configuration settings for each channel.
- (dict) –
  
  Configuration settings for voice enhancement.
  - Channel (string) – [REQUIRED]
    
    The channel for this voice enhancement configuration. Only VOICE is supported for this data type.
  - VoiceEnhancementMode (string) – [REQUIRED]
    
    The voice enhancement mode.
UserId (string) –
[REQUIRED]

The identifier of the user account.
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.

Returns:

None

Exceptions

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