ConnectParticipant / Client / send_message

send_message

ConnectParticipant.Client.send_message(**kwargs)

Sends a message.

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_message(
    ContentType='string',
    Content='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters:
  • ContentType (string) –

    [REQUIRED]

    The type of the content. Possible types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

    Supported types on the contact are configured through SupportedMessagingContentTypes on StartChatContact and StartOutboundChatContact.

    For Apple Messages for Business, SMS, and WhatsApp Business Messaging contacts, only text/plain is supported.

  • Content (string) –

    [REQUIRED]

    The content of the message.

    • For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.

    • For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.

    • For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Id (string) –

      The ID of the message.

    • AbsoluteTime (string) –

      The time when the message 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