Skip to content

StartChatContactResponse

Source code in docs_src/capo_connect/types/start_chat_contact_response.py
class StartChatContactResponse(TypedDict, closed=True):
    contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The identifier of this contact within the Connect Customer instance. </p>"""
    participant_id: NotRequired["capo_connect.types.participant_id.ParticipantId"]
    """<p>The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.</p>"""
    participant_token: NotRequired[
        "capo_connect.types.participant_token.ParticipantToken"
    ]
    """<p>The token used by the chat participant to call <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a>. The participant token is valid for the lifetime of a chat participant.</p>"""
    continued_from_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The contactId from which a persistent chat session is started. This field is populated only for persistent chats.</p>"""
    connection_credentials: NotRequired[
        "capo_connect.types.connection_credentials.ConnectionCredentials"
    ]
    """<p>The connection credentials for the chat participant. Returned only when the request includes <code>CONNECTION_CREDENTIALS</code> in <code>ConnectionTypes</code>.</p>"""
    websocket: NotRequired["capo_connect.types.websocket.Websocket"]
    """<p>The websocket for the chat participant. Returned only when the request includes <code>WEBSOCKET</code> in <code>ConnectionTypes</code>.</p>"""
    streaming_id: NotRequired["capo_connect.types.streaming_id.StreamingId"]
    """<p>The identifier of the streaming configuration enabled with the chat. Returned only when the request sets <code>ChatStreamingConfiguration</code>. Use this value to call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StopContactStreaming.html">StopContactStreaming</a>.</p>"""

connection_credentials instance-attribute

connection_credentials: NotRequired[ConnectionCredentials]

The connection credentials for the chat participant. Returned only when the request includes CONNECTION_CREDENTIALS in ConnectionTypes.

contact_id instance-attribute

contact_id: NotRequired[ContactId]

The identifier of this contact within the Connect Customer instance.

continued_from_contact_id instance-attribute

continued_from_contact_id: NotRequired[ContactId]

The contactId from which a persistent chat session is started. This field is populated only for persistent chats.

participant_id instance-attribute

participant_id: NotRequired[ParticipantId]

The identifier for a chat participant. The participantId for a chat participant is the same throughout the chat lifecycle.

participant_token instance-attribute

participant_token: NotRequired[ParticipantToken]

The token used by the chat participant to call CreateParticipantConnection. The participant token is valid for the lifetime of a chat participant.

streaming_id instance-attribute

streaming_id: NotRequired[StreamingId]

The identifier of the streaming configuration enabled with the chat. Returned only when the request sets ChatStreamingConfiguration. Use this value to call StopContactStreaming.

websocket instance-attribute

websocket: NotRequired[Websocket]

The websocket for the chat participant. Returned only when the request includes WEBSOCKET in ConnectionTypes.