Connect / Client / update_user_phone_config

update_user_phone_config¶

Connect.Client.update_user_phone_config(**kwargs)¶

Updates the phone configuration settings for the specified user.

Note

We recommend using the UpdateUserConfig API, which supports additional functionality that is not available in the UpdateUserPhoneConfig API, such as voice enhancement settings and per-channel configuration for auto-accept and After Contact Work (ACW) timeouts. In comparison, the UpdateUserPhoneConfig API will always set the same ACW timeouts to all channels the user handles.

Request Syntax

response = client.update_user_phone_config(
    PhoneConfig={
        'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
        'AutoAccept': True|False,
        'AfterContactWorkTimeLimit': 123,
        'DeskPhoneNumber': 'string',
        'PersistentConnection': True|False
    },
    UserId='string',
    InstanceId='string'
)

Parameters:

PhoneConfig (dict) –
[REQUIRED]

Information about phone configuration settings for the user.
- PhoneType (string) –
  
  The phone type.
- AutoAccept (boolean) –
  
  The Auto accept setting.
- AfterContactWorkTimeLimit (integer) –
  
  The After Call Work (ACW) timeout setting, in seconds. This parameter has a minimum value of 0 and a maximum value of 2,000,000 seconds (24 days). Enter 0 if you don’t want to allocate a specific amount of ACW time. It essentially means an indefinite amount of time. When the conversation ends, ACW starts; the agent must choose Close contact to end ACW.
  
  Note
  When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
- DeskPhoneNumber (string) –
  
  The phone number for the user’s desk phone.
- PersistentConnection (boolean) –
  
  The persistent connection setting for the user.
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