システム変数

システム変数は、エージェントの実行プロセス中に変数値データへアクセスするために使用され、変数を通じてエージェントの動的なロジックや応答を実現します。ユーザーはテキスト入力欄、FlowAgentコンポーネント、workflow内で{{を入力することで変数を簡単に挿入できます。実行時にはシステム変数が自動的に正しい値に置換され、値がない場合は空値となります。
システム変数にはグローバル変数とユーザーソース変数が含まれ、システム変数の値は開発者が設定できず、GPTBotsプラットフォームが現在の実行環境に基づき自動で値を割り当てます。

グローバル変数

フィールド名	型	説明
sys_dev_id	string	エージェント開発者のID
sys_agent_id	string	エージェントのID
sys_conversation_id	string	現在の会話ID
sys_anonymous_id	string	エージェントと会話中のユーザーの匿名ID。匿名IDは通常、サードパーティチャネルプラットフォームのユーザー固有IDとなります。詳細は匿名ID取得ロジックを参照してください。
sys_user_id	string	エージェントと会話中のユーザーID。ユーザーIDは開発者が定義するユーザー固有IDです。
sys_lang	string	ユーザーポータルの使用言語
sys_conversation_source	string	会話の統合チャネル（例：whatsapp、telegram等）。ログ内のソースと同じフィールドです。
sys_user_message_count	number	ユーザーが現在の会話で送信したメッセージの合計回数

グローバル変数はすべてGPTBotsプラットフォームによって自動的に割り当てられ、ユーザーが手動で設定する必要はありません。

ユーザーソース変数

ユーザーがブラウザ、WhatsApp、LINEなどのチャネルを通じてメッセージを送信する場合、ユーザーソースプラットフォームはそのチャネルとなります。ユーザーが異なるチャネルからメッセージを送信する場合、ユーザーソースプラットフォーム変数の値も異なります。そのため、エージェントでユーザーソースプラットフォーム変数を使用する際は、ユーザーがどのプラットフォームからアクセスしているかに注意してください。

GPTBotsプラットフォームは今後もTelegram、Facebookなど、より多くのユーザーソースプラットフォーム変数をサポート予定です。

ブラウザ変数

ブラウザ変数は、ユーザーがブラウザで共有ページやワークスペースなどにアクセスした際にGPTBotsプラットフォームが自動で取得・割り当てます。ユーザーがAPI、WhatsApp、LINEなどのチャネルからメッセージを送信した場合、ブラウザ変数は空値となります。

フィールド名	型	説明
browser_info	string	ブラウザ名
browser_lang	string	現在使用中のブラウザ言語
browser_os	string	オペレーティングシステム
browser_timezone	string	タイムゾーン
browser_region	string	国または地域
browser_current_url	string	現在アクセス中のページURL
browser_source_url	string	参照元ページURL
browser_duration_of_stay	number	現在のページ滞在時間

WhatsApp属性

WhatsApp属性は、ユーザーがWhatsAppチャネルからメッセージを送信した場合のみGPTBotsプラットフォームが自動で取得・割り当てます。ユーザーが手動で設定する必要はありません。

フィールド名	型	説明
wa_user_name	string	WhatsAppユーザーのニックネームまたは表示名
wa_user_id	string	WhatsAppユーザーの一意識別子（通常は国際形式の電話番号の後に@c.usが付与されます）

Telegram属性

Telegram属性は、ユーザーがTelegramチャネルからメッセージを送信した場合のみGPTBotsプラットフォームが自動で取得・割り当てます。ユーザーが手動で設定する必要はありません。

フィールド名	型	説明
tg_user_id	string	Telegramユーザーの一意識別子（システム内部でユーザーを一意に識別）
tg_user_name	string	Telegramユーザーのニックネームまたは表示名（例：@username）
tg_lang_code	string	Telegramユーザーの言語コード（例：en、zh-CNなど）

LiveChat属性

LiveChat属性は、ユーザーがLiveChatチャネルからメッセージを送信した場合のみGPTBotsプラットフォームが自動で取得・割り当てます。ユーザーが手動で設定する必要はありません。

フィールド名	型	説明
lc_org_id	string	LiveChat組織の一意識別子
lc_chat_id	string	LiveChatチャットセッションの一意識別子（会話全体の追跡用）
lc_thread_id	string	LiveChatチャットセッション内の特定スレッドの一意識別子（会話内のサブトピックやメッセージシーケンスの整理用）
lc_user_id	string	LiveChatエンドユーザーの一意識別子（システム内部でユーザーを一意に識別）