ConnectParticipant / Client / send_event

send_event

ConnectParticipant.Client.send_event(**kwargs)

Note

The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType will no longer be supported starting December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field.

Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.

For security recommendations, see Amazon Connect Chat security best practices.

Note

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

See also: AWS API Documentation

Request Syntax

response = client.send_event(
    ContentType='string',
    Content='string',
    ClientToken='string',
    ConnectionToken='string'
)

Parameters:

• ContentType (string) –

  [REQUIRED]

  The content type of the request. Supported types are:

  • application/vnd.amazonaws.connect.event.typing

  • application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on December 31, 2024)

  • application/vnd.amazonaws.connect.event.message.delivered

  • application/vnd.amazonaws.connect.event.message.read

• Content (string) –

  The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

  Sample Content: “{"messageId":"11111111-aaaa-bbbb-cccc-EXAMPLE01234"}”

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

• ConnectionToken (string) –

  [REQUIRED]

  The authentication token associated with the participant’s connection.

Return type:

dict

Returns:

Response Syntax

{
    'Id': 'string',
    'AbsoluteTime': 'string'
}

Response Structure

• (dict) –

  • Id (string) –

    The ID of the response.

  • AbsoluteTime (string) –

    The time when the event was sent.

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

Exceptions

• ConnectParticipant.Client.exceptions.AccessDeniedException

• ConnectParticipant.Client.exceptions.InternalServerException

• ConnectParticipant.Client.exceptions.ThrottlingException

• ConnectParticipant.Client.exceptions.ValidationException

• ConnectParticipant.Client.exceptions.ConflictException