ConnectParticipant

public struct ConnectParticipant

Client object for interacting with AWS ConnectParticipant service.

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.

Member variables

Initialization

  • Initialize the ConnectParticipant client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    public func createParticipantConnection(_ input: CreateParticipantConnectionRequest) -> EventLoopFuture<CreateParticipantConnectionResponse>

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

    Declaration

    Swift

    public func disconnectParticipant(_ input: DisconnectParticipantRequest) -> EventLoopFuture<DisconnectParticipantResponse>

  • Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

    Declaration

    Swift

    public func getTranscript(_ input: GetTranscriptRequest) -> EventLoopFuture<GetTranscriptResponse>

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

    Declaration

    Swift

    public func sendEvent(_ input: SendEventRequest) -> EventLoopFuture<SendEventResponse>

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

    Declaration

    Swift

    public func sendMessage(_ input: SendMessageRequest) -> EventLoopFuture<SendMessageResponse>

Paginators

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ChatItemType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ConnectionType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ParticipantRole : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ScanDirection : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SortKey : String, CustomStringConvertible, Codable