logo
Development
OverviewUser GuideAPI ReferenceBest PracticeCHANGELOG
Search
English
API Reference / User API / User Overview
User Overview
Last updated：6 months ago

User Overview

A user refers to an end user who engages in conversations with an Agent. GPTBots allows developers to set unique identity IDs for different users. Through this user ID (UserId), user identities can be associated across different channels, enabling cross-channel identity consolidation, business queries via Tools, and maintenance of user attributes and chat histories.

Definitions

User:
A user refers to an end user who engages in conversations with an Agent.

Anonymous ID:
When users interact with an Agent through third-party platforms (such as Telegram, WhatsApp, LINE, etc.), GPTBots uses the platform-generated user ID as the Anonymous ID.

Third-party Platforms:
GPTBots currently supports Agent integration with numerous third-party platforms, including: Intercom, WebChat, LiveChat, Telegram, WhatsApp, etc.

UserId:
A unique identifier assigned to end users by enterprise developers. Through API interfaces, developers can set a UserId for a specific anonymousID. For UserId usage scenarios and advanced features, please refer to Setting User ID.

  • userId takes precedence over anonymousID
  • Multiple anonymousID can belong to a single userId.

Conversation ID:
The Conversation ID (conversationID) identifies a conversation session between a user and an Agent. It serves as the smallest unit of isolation between different business scenarios (typically containing multiple message IDs).

  • conversationID automatically expires after 60 minutes, except for those generated through API channels, which have no expiration time.
  • When a conversationID expires on third-party platforms and widget bubbles, a new conversationID is generated to start a new conversation round.

Message ID:
Message ID (messageID) identifies a single conversation message between an Agent and a user, representing the smallest unit of dialogue.

  • messageID is generated by the GPTBots platform and cannot be customized by developers.
  • messageID belongs to a conversationID, and one conversationID typically contains multiple messageIDs.

Conversation ID Generation Principle

When a user initiates a conversation with an Agent through a third-party platform, the system generates an anonymousID based on the user's third-party platform, and automatically generates a conversationID based on this anonymousID to carry the conversation round between the user and Agent.

  • When using the API method, developers must first generate a conversationID and then pass it as a parameter to initiate conversations with the Agent.
  • For non-API channels, GPTBots automatically generates the conversationID. The specific business process for generation is as follows:
    user-management