Skip to content

PersistentChat

Used by
Source code in docs_src/capo_connect/types/persistent_chat.py 
12
13
14
15
16
class PersistentChat(TypedDict, closed=True):
    rehydration_type: NotRequired["capo_connect.types.rehydration_type.RehydrationType"]
    """<p>The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. </p> <ul> <li> <p> <code>ENTIRE_PAST_SESSION</code>: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the <code>initialContactId</code> of the past ended chat session in the <code>sourceContactId</code> field. In this type, Connect Customer determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. </p> </li> <li> <p> <code>FROM_SEGMENT</code>: Rehydrates a chat from the past chat contact that is specified in the <code>sourceContactId</code> field. </p> </li> </ul> <p>The actual contactId used for rehydration is provided in the response of this API. </p>"""
    source_contact_id: NotRequired["capo_connect.types.contact_id.ContactId"]
    """<p>The contactId from which a persistent chat session must be started.</p>"""

rehydration_type instance-attribute 

rehydration_type: NotRequired[RehydrationType]

The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat.

  • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Connect Customer determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat.

  • FROM_SEGMENT: Rehydrates a chat from the past chat contact that is specified in the sourceContactId field.

The actual contactId used for rehydration is provided in the response of this API.

source_contact_id instance-attribute 

source_contact_id: NotRequired[ContactId]

The contactId from which a persistent chat session must be started.