Connectparticipant

This page documents function available when using the Connectparticipant module, created with @service Connectparticipant.

Index

Documentation

Main.Connectparticipant.complete_attachment_uploadMethod
complete_attachment_upload(attachment_ids, client_token, x-_amz-_bearer)
complete_attachment_upload(attachment_ids, client_token, x-_amz-_bearer, params::Dict{String,<:Any})

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • attachment_ids: A list of unique identifiers for the attachments.
  • client_token: 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.
  • x-_amz-_bearer: The authentication token associated with the participant's connection.
source
Main.Connectparticipant.create_participant_connectionMethod
create_participant_connection(x-_amz-_bearer)
create_participant_connection(x-_amz-_bearer, params::Dict{String,<:Any})

Creates the participant's connection. ParticipantToken is used for invoking this API instead of ConnectionToken. The participant token is valid for the lifetime of the participant – until they are part of a contact. The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic. For chat, you need to publish the following on the established websocket connection: {"topic":"aws/subscribe","content":{"topics":["aws/chat"]}} Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before. Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide. Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • x-_amz-_bearer: This is a header parameter. The ParticipantToken as obtained from StartChatContact API response.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConnectParticipant": Amazon Connect Participant is used to mark the participant as connected for message streaming.
  • "Type": Type of connection information required. This can be omitted if ConnectParticipant is true.
source
Main.Connectparticipant.disconnect_participantMethod
disconnect_participant(x-_amz-_bearer)
disconnect_participant(x-_amz-_bearer, params::Dict{String,<:Any})

Disconnects a participant. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • x-_amz-_bearer: The authentication token associated with the participant's connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
source
Main.Connectparticipant.get_attachmentMethod
get_attachment(attachment_id, x-_amz-_bearer)
get_attachment(attachment_id, x-_amz-_bearer, params::Dict{String,<:Any})

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • attachment_id: A unique identifier for the attachment.
  • x-_amz-_bearer: The authentication token associated with the participant's connection.
source
Main.Connectparticipant.get_transcriptMethod
get_transcript(x-_amz-_bearer)
get_transcript(x-_amz-_bearer, params::Dict{String,<:Any})

Retrieves a transcript of the session, including details about any attachments. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • x-_amz-_bearer: The authentication token associated with the participant's connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ContactId": The contactId from the current contact chain for which transcript is needed.
  • "MaxResults": The maximum number of results to return in the page. Default: 10.
  • "NextToken": The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
  • "ScanDirection": The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
  • "SortOrder": The sort order for the records. Default: DESCENDING.
  • "StartPosition": A filtering option for where to start.
source
Main.Connectparticipant.send_eventMethod
send_event(content_type, x-_amz-_bearer)
send_event(content_type, x-_amz-_bearer, params::Dict{String,<:Any})

Sends an event. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • content_type: The content type of the request. Supported types are: application/vnd.amazonaws.connect.event.typing application/vnd.amazonaws.connect.event.connection.acknowledged application/vnd.amazonaws.connect.event.message.delivered application/vnd.amazonaws.connect.event.message.read
  • x-_amz-_bearer: The authentication token associated with the participant's connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
  • "Content": 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"}"
source
Main.Connectparticipant.send_messageMethod
send_message(content, content_type, x-_amz-_bearer)
send_message(content, content_type, x-_amz-_bearer, params::Dict{String,<:Any})

Sends a message. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • content: 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.
  • content_type: The type of the content. Supported types are text/plain, text/markdown, and application/json.
  • x-_amz-_bearer: The authentication token associated with the connection.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ClientToken": 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.
source
Main.Connectparticipant.start_attachment_uploadMethod
start_attachment_upload(attachment_name, attachment_size_in_bytes, client_token, content_type, x-_amz-_bearer)
start_attachment_upload(attachment_name, attachment_size_in_bytes, client_token, content_type, x-_amz-_bearer, params::Dict{String,<:Any})

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. ConnectionToken is used for invoking this API instead of ParticipantToken. The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Arguments

  • attachment_name: A case-sensitive name of the attachment being uploaded.
  • attachment_size_in_bytes: The size of the attachment in bytes.
  • client_token: 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.
  • content_type: Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
  • x-_amz-_bearer: The authentication token associated with the participant's connection.
source