ConnectParticipant

Client

class ConnectParticipant.Client

A low-level client representing Amazon Connect Participant Service:

client = session.create_client('connectparticipant')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_participant_connection(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.create_participant_connection(
    Type=[
        'WEBSOCKET'|'CONNECTION_CREDENTIALS',
    ],
    ParticipantToken='string'
)
Parameters
  • Type (list) --

    [REQUIRED]

    Type of connection information required.

    • (string) --
  • ParticipantToken (string) --

    [REQUIRED]

    Participant Token as obtained from StartChatContact API response.

Return type

dict

Returns

Response Syntax

{
    'Websocket': {
        'Url': 'string',
        'ConnectionExpiry': 'string'
    },
    'ConnectionCredentials': {
        'ConnectionToken': 'string',
        'Expiry': 'string'
    }
}

Response Structure

  • (dict) --

    • Websocket (dict) --

      Creates the participant's websocket connection.

      • Url (string) --

        The URL of the websocket.

      • ConnectionExpiry (string) --

        The URL expiration timestamp in ISO date format.

        It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • ConnectionCredentials (dict) --

      Creates the participant's connection credentials. The authentication token associated with the participant's connection.

      • ConnectionToken (string) --

        The connection token.

      • Expiry (string) --

        The expiration of the token.

        It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

disconnect_participant(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.disconnect_participant(
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ClientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_transcript(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_transcript(
    ContactId='string',
    MaxResults=123,
    NextToken='string',
    ScanDirection='FORWARD'|'BACKWARD',
    SortOrder='DESCENDING'|'ASCENDING',
    StartPosition={
        'Id': 'string',
        'AbsoluteTime': 'string',
        'MostRecent': 123
    },
    ConnectionToken='string'
)
Parameters
  • ContactId (string) -- The contactId from the current contact chain for which transcript is needed.
  • MaxResults (integer) -- The maximum number of results to return in the page. Default: 10.
  • NextToken (string) -- The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
  • ScanDirection (string) -- The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
  • SortOrder (string) -- The sort order for the records. Default: DESCENDING.
  • StartPosition (dict) --

    A filtering option for where to start.

    • Id (string) --

      The ID of the message or event where to start.

    • AbsoluteTime (string) --

      The time in ISO format where to start.

      It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • MostRecent (integer) --

      The start position of the most recent message where you want to start.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{
    'InitialContactId': 'string',
    'Transcript': [
        {
            'AbsoluteTime': 'string',
            'Content': 'string',
            'ContentType': 'string',
            'Id': 'string',
            'Type': 'MESSAGE'|'EVENT'|'CONNECTION_ACK',
            'ParticipantId': 'string',
            'DisplayName': 'string',
            'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • InitialContactId (string) --

      The initial contact ID for the contact.

    • Transcript (list) --

      The list of messages in the session.

      • (dict) --

        An item - message or event - that has been sent.

        • AbsoluteTime (string) --

          The time when the message or event was sent.

          It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

        • Content (string) --

          The content of the message or event.

        • ContentType (string) --

          The type of content of the item.

        • Id (string) --

          The ID of the item.

        • Type (string) --

          Type of the item: message or event.

        • ParticipantId (string) --

          The ID of the sender in the session.

        • DisplayName (string) --

          The chat display name of the sender.

        • ParticipantRole (string) --

          The role of the sender. For example, is it a customer, agent, or system.

    • NextToken (string) --

      The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
send_event(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.send_event(
    ContentType='string',
    Content='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ContentType (string) --

    [REQUIRED]

    The content type of the request. Supported types are:

    • application/vnd.amazonaws.connect.event.typing
    • application/vnd.amazonaws.connect.event.connection.acknowledged
  • Content (string) -- The content of the event to be sent (for example, message text). This is not yet supported.
  • ClientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

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

Response Structure

  • (dict) --

    • Id (string) --

      The ID of the response.

    • AbsoluteTime (string) --

      The time when the event was sent.

      It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

send_message(**kwargs)

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

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. Supported types are text/plain.

  • Content (string) --

    [REQUIRED]

    The content of the message.

  • ClientToken (string) --

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    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.

Paginators

The available paginators are: