Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

ConnectParticipant

import { ConnectParticipant } from "https://aws-api.deno.dev/v0.3/services/connectparticipant.ts?docs=full";
class ConnectParticipant {
constructor(apiFactory: client.ApiFactory);
async completeAttachmentUpload(params: CompleteAttachmentUploadRequest, opts?: client.RequestOptions): Promise<void>;
async createParticipantConnection(params: CreateParticipantConnectionRequest, opts?: client.RequestOptions): Promise<CreateParticipantConnectionResponse>;
async disconnectParticipant(params: DisconnectParticipantRequest, opts?: client.RequestOptions): Promise<void>;
async getAttachment(params: GetAttachmentRequest, opts?: client.RequestOptions): Promise<GetAttachmentResponse>;
async getTranscript(params: GetTranscriptRequest, opts?: client.RequestOptions): Promise<GetTranscriptResponse>;
async sendEvent(params: SendEventRequest, opts?: client.RequestOptions): Promise<SendEventResponse>;
async sendMessage(params: SendMessageRequest, opts?: client.RequestOptions): Promise<SendMessageResponse>;
async startAttachmentUpload(params: StartAttachmentUploadRequest, opts?: client.RequestOptions): Promise<StartAttachmentUploadResponse>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new ConnectParticipant(apiFactory: client.ApiFactory)
[src]

§Methods

§
completeAttachmentUpload(params: CompleteAttachmentUploadRequest, opts?: client.RequestOptions): Promise<void>
[src]

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

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

§

Creates the participant's connection. Note that 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.

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

§
disconnectParticipant(params: DisconnectParticipantRequest, opts?: client.RequestOptions): Promise<void>
[src]

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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

§

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

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

§

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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

§

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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

§

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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

§

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

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

§Static Properties