logo
การพัฒนา
ค้นหา
Variables

Variables

Variables are a mechanism provided by the GPTBots platform for storing and accessing data during agent execution. Users can quickly reference variables in text input fields, FlowAgent components, and workflows by typing {{. During runtime, these variables will be automatically replaced with their correct values, or empty values if undefined.

Global Variables

Field Name Type Description
sys_dev_id string The ID of the agent's developer
sys_agent_id string The ID of the agent
sys_conversation_id string The ID of the current conversation
sys_anonymous_id string The anonymous ID of the user interacting with the agent. This ID is typically derived from the unique user identifier of third-party channel platforms. See Anonymous ID Logic for details
sys_user_id string The user ID of the person interacting with the agent. This is a custom unique identifier defined by the developer
sys_lang string The language used in the user portal
sys_conversation_source string The integration channel for the conversation (e.g., WhatsApp, Telegram, etc.). This field corresponds to the source field in the logs
sys_user_message_count number The total number of messages sent by the user in the current conversation

Global variables are automatically assigned by the GPTBots platform and do not require manual assignment by users.

Browser Variables

Field Name Type Description
browser_info string Browser name
browser_lang string Current browser language
browser_os string Operating system
browser_timezone string Time zone
browser_region string Country or region
browser_current_url string Current page URL
browser_source_url string Referrer URL
browser_duration_of_stay number Duration of stay on current page

Browser variables are automatically captured and assigned by the GPTBots platform when users access shared pages or workspaces through a web browser. No manual assignment is required. These variables will be empty when messages are sent through API, WhatsApp, LINE, or other channels.

WhatsApp Properties

Field Name Type Description
wa_user_name string WhatsApp user's nickname or display name
wa_user_id string WhatsApp user's unique identifier, typically based on the user's phone number (e.g., international format phone number with @c.us suffix)

WhatsApp properties are automatically captured and assigned by the GPTBots platform only when users send messages through the WhatsApp channel. No manual assignment is required.

Telegram Properties

Field Name Type Description
tg_user_id string Telegram user's unique identifier for internal system differentiation
tg_user_name string Telegram user's nickname or display name, e.g., @username
tg_lang_code string Telegram user's language preference code, e.g., en, zh-CN

Telegram properties are automatically captured and assigned by the GPTBots platform only when users send messages through the Telegram channel. No manual assignment is required.

LiveChat Properties

Field Name Type Description
lc_org_id string Unique identifier for the LiveChat organization
lc_chat_id string Unique identifier for the LiveChat conversation session used to track the entire dialogue
lc_thread_id string Unique identifier for specific threads within a LiveChat conversation session, used to organize subtopics or message sequences
lc_user_id string Unique identifier for LiveChat end users for internal system differentiation

LiveChat properties are automatically captured and assigned by the GPTBots platform only when users send messages through the LiveChat channel. No manual assignment is required.