Connect / Client / create_participant

create_participant#

Connect.Client.create_participant(**kwargs)#

Adds a new participant into an on-going chat contact. For more information, see Customize chat flow experiences by integrating custom participants.

See also: AWS API Documentation

Request Syntax

response = client.create_participant(
    InstanceId='string',
    ContactId='string',
    ClientToken='string',
    ParticipantDetails={
        'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'|'CUSTOM_BOT',
        'DisplayName': 'string'
    }
)
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. Only contacts in the CHAT channel are supported.

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

    DisplayName is Required.

    • ParticipantRole (string) –

      The role of the participant being added.

    • DisplayName (string) –

      The display name of the participant.

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

  • Connect.Client.exceptions.InvalidRequestException

  • Connect.Client.exceptions.InvalidParameterException

  • Connect.Client.exceptions.ResourceNotFoundException

  • Connect.Client.exceptions.InternalServiceException

  • Connect.Client.exceptions.ServiceQuotaExceededException

  • Connect.Client.exceptions.ThrottlingException