NAME

Paws::ConnectParticipant - Perl Interface to AWS Amazon Connect Participant Service

SYNOPSIS

  use Paws;
  my $obj = Paws->service('ConnectParticipant');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/participant.connect-2018-09-07>

METHODS

Each argument is described in detail in: Paws::ConnectParticipant::CompleteAttachmentUpload

Returns: a Paws::ConnectParticipant::CompleteAttachmentUploadResponse instance

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

CreateParticipantConnection

ParticipantToken => Str
Type => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::ConnectParticipant::CreateParticipantConnection

Returns: a Paws::ConnectParticipant::CreateParticipantConnectionResponse instance

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.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

DisconnectParticipant

ConnectionToken => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::ConnectParticipant::DisconnectParticipant

Returns: a Paws::ConnectParticipant::DisconnectParticipantResponse instance

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 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

GetAttachment

AttachmentId => Str
ConnectionToken => Str

Each argument is described in detail in: Paws::ConnectParticipant::GetAttachment

Returns: a Paws::ConnectParticipant::GetAttachmentResponse instance

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

GetTranscript

ConnectionToken => Str
[ContactId => Str]
[MaxResults => Int]
[NextToken => Str]
[ScanDirection => Str]
[SortOrder => Str]
[StartPosition => Paws::ConnectParticipant::StartPosition]

Each argument is described in detail in: Paws::ConnectParticipant::GetTranscript

Returns: a Paws::ConnectParticipant::GetTranscriptResponse instance

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 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

SendEvent

ConnectionToken => Str
ContentType => Str
[ClientToken => Str]
[Content => Str]

Each argument is described in detail in: Paws::ConnectParticipant::SendEvent

Returns: a Paws::ConnectParticipant::SendEventResponse instance

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 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

SendMessage

ConnectionToken => Str
Content => Str
ContentType => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::ConnectParticipant::SendMessage

Returns: a Paws::ConnectParticipant::SendMessageResponse instance

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 (https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).

StartAttachmentUpload

AttachmentName => Str
AttachmentSizeInBytes => Int
ClientToken => Str
ConnectionToken => Str
ContentType => Str

Each argument is described in detail in: Paws::ConnectParticipant::StartAttachmentUpload

Returns: a Paws::ConnectParticipant::StartAttachmentUploadResponse instance

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

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>