UpdateParticipantRoleConfig
Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers:
-
Customer idle timeout
-
Customer auto-disconnect timeout
-
Agent idle timeout
-
Agent auto-disconnect timeout
For more information about how chat timeouts work, see Set up chat timeouts for human participants.
Request Syntax
PUT /contact/participant-role-config/InstanceId/ContactId HTTP/1.1
Content-type: application/json
{
"ChannelConfiguration": { ... }
}URI Request Parameters
The request uses the following URI parameters.
- ContactId
-
The identifier of the contact in this instance of Amazon Connect.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: Yes
- 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
Request Body
The request accepts the following data in JSON format.
- ChannelConfiguration
-
The Amazon Connect channel you want to configure.
Type: UpdateParticipantRoleConfigChannelInfo object
Note: This object is a Union. Only one member of this object can be specified or returned.
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.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- 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:
