The unique identifier for a Chat Group. Use this field to preserve context from a previous Chat session.
A Chat represents a single session from opening to closing a WebSocket connection. In contrast, a Chat Group is a series of resumed Chats that collectively represent a single conversation spanning multiple sessions. Each Chat includes a Chat Group ID, which is used to preserve the context of previous Chat sessions when starting a new one.
Including the Chat Group ID in the resumed_chat_group_id
query parameter is useful for seamlessly resuming a Chat after unexpected network disconnections and for picking up conversations exactly where you left off at a later time. This ensures preserved context across multiple sessions.
There are three ways to obtain the Chat Group ID:
-
Chat Metadata: Upon establishing a WebSocket connection with EVI, the user receives a Chat Metadata message. This message contains a chat_group_id
, which can be used to resume conversations within this chat group in future sessions.
-
List Chats endpoint: Use the GET /v0/evi/chats
endpoint to obtain the Chat Group ID of individual Chat sessions. This endpoint lists all available Chat sessions and their associated Chat Group ID.
-
List Chat Groups endpoint: Use the GET /v0/evi/chat_groups
endpoint to obtain the Chat Group IDs of all Chat Groups associated with an API key. This endpoint returns a list of all available chat groups.