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

CreateParticipant

Adds a new participant into an on-going chat contact or webRTC call. For more information, see Customize chat flow experiences by integrating custom participants or Enable multi-user web, in-app, and video calling.

Request Syntax


POST /contact/create-participant HTTP/1.1
Content-type: application/json

{
   "ClientToken": "string",
   "ContactId": "string",
   "InstanceId": "string",
   "ParticipantDetails": { 
      "DisplayName": "string",
      "ParticipantCapabilities": { 
         "ScreenShare": "string",
         "Video": "string"
      },
      "ParticipantRole": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ClientToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No

ContactId

The identifier of the contact in this instance of Amazon Connect. Supports contacts in the CHAT channel and VOICE (WebRTC) channels. For WebRTC calls, this should be the initial contact ID that was generated when the contact was first created (from the StartWebRTCContact API) in the VOICE channel

Type: String

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

ParticipantDetails

Information identifying the participant.

Important

The only valid value for ParticipantRole is CUSTOM_BOT for chat contact and CUSTOMER for voice contact.

Type: ParticipantDetailsToAdd object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ParticipantCredentials": { 
      "Expiry": "string",
      "ParticipantToken": "string"
   },
   "ParticipantId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ParticipantCredentials

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

Type: ParticipantTokenCredentials object

ParticipantId

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

Operation cannot be performed at this time as there is a conflict with another operation or contact state.

HTTP Status Code: 409

InternalServiceException

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

Message: The message.

HTTP Status Code: 500

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

ServiceQuotaExceededException

The service quota has been exceeded.

Reason: The reason for the exception.

HTTP Status Code: 402

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429