Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateUserConfig

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


POST /users/InstanceId/UserId/config HTTP/1.1
Content-type: application/json

{
   "AfterContactWorkConfigs": [ 
      { 
         "AfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "AgentFirstCallbackAfterContactWorkConfig": { 
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "string"
      }
   ],
   "AutoAcceptConfigs": [ 
      { 
         "AgentFirstCallbackAutoAccept": boolean,
         "AutoAccept": boolean,
         "Channel": "string"
      }
   ],
   "PersistentConnectionConfigs": [ 
      { 
         "Channel": "string",
         "PersistentConnection": boolean
      }
   ],
   "PhoneNumberConfigs": [ 
      { 
         "Channel": "string",
         "PhoneNumber": "string",
         "PhoneType": "string"
      }
   ],
   "VoiceEnhancementConfigs": [ 
      { 
         "Channel": "string",
         "VoiceEnhancementMode": "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

UserId

The identifier of the user account.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AfterContactWorkConfigs

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.

Type: Array of AfterContactWorkConfigPerChannel objects

Required: No

AutoAcceptConfigs

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.

Type: Array of AutoAcceptConfig objects

Required: No

PersistentConnectionConfigs

The list of persistent connection configuration settings for each channel.

Type: Array of PersistentConnectionConfig objects

Required: No

PhoneNumberConfigs

The list of phone number configuration settings for each channel.

Type: Array of PhoneNumberConfig objects

Required: No

VoiceEnhancementConfigs

The list of voice enhancement configuration settings for each channel.

Type: Array of VoiceEnhancementConfig objects

Required: No

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.

ConditionalOperationFailedException

Request processing failed because dependent condition failed.

HTTP Status Code: 409

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

Examples

Request syntax

This example illustrates one usage of UpdateUserConfig.


POST /users/{InstanceId}/{UserId}/config HTTP/1.1
Content-type: application/json

{
   "AfterContactWorkConfigs": [
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "CHAT"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "EMAIL"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "TASK"
      },
      {
         "AfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "AgentFirstCallbackAfterContactWorkConfig": {
            "AfterContactWorkTimeLimit": number
         },
         "Channel": "VOICE"
      }
   ],
   "AutoAcceptConfigs": [
      {
         "AutoAccept": boolean,
         "Channel": "CHAT"
      },
      {
         "AutoAccept": boolean,
         "Channel": "EMAIL"
      },
      {
         "AutoAccept": boolean,
         "Channel": "TASK"
      },
      {
         "AgentFirstCallbackAutoAccept": boolean,
         "AutoAccept": boolean,
         "Channel": "VOICE"
      }
   ],
   "PhoneNumberConfigs": [
      {
         "Channel": "VOICE",
         "PhoneNumber": "string",
         "PhoneType": "string"
      }
   ],
   "PersistentConnectionConfigs": [
      {
         "Channel": "VOICE",
         "PersistentConnection": boolean
      }
   ],
   "VoiceEnhancementConfigs": [
      {
         "Channel": "VOICE",
         "VoiceEnhancementMode": "string"
      }
   ]
}