Connect / Client / create_participant

create_participant

Connect.Client.create_participant(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_participant(
    InstanceId='string',
    ContactId='string',
    ClientToken='string',
    ParticipantDetails={
        'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT'|'SUPERVISOR',
        'DisplayName': 'string',
        'ParticipantCapabilities': {
            'Video': 'SEND',
            'ScreenShare': 'SEND'
        }
    }
)
Parameters:

  • 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.

  • ContactId (string) –

    [REQUIRED]

    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

  • ClientToken (string) –

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

    This field is autopopulated if not provided.

  • ParticipantDetails (dict) –

    [REQUIRED]

    Information identifying the participant.

    Warning

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

    • ParticipantRole (string) –

      The role of the participant being added.

    • DisplayName (string) –

      The display name of the participant.

    • ParticipantCapabilities (dict) –

      The configuration for the allowed video and screen sharing capabilities for participants present over the call. For more information, see Set up in-app, web, video calling, and screen sharing capabilities in the Amazon Connect Administrator Guide.

      • Video (string) –

        The configuration having the video and screen sharing capabilities for participants over the call.

      • ScreenShare (string) –

        The screen sharing capability that is enabled for the participant. SEND indicates the participant can share their screen.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ParticipantCredentials (dict) –

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

      • ParticipantToken (string) –

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

      • Expiry (string) –

        The expiration of the token. It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • ParticipantId (string) –

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

Exceptions