ตั้งค่า User ID

GPTBots ช่วยให้นักพัฒนาตั้งค่ารหัสประจำตัวผู้ใช้ (UserId) ที่ไม่ซ้ำกันสำหรับผู้ใช้ Agent ในแต่ละช่องทาง (เช่น เว็บไซต์, แอป, LiveChat) โดย UserId นี้จะเชื่อมโยงตัวตนผู้ใช้ข้ามช่องทางต่าง ๆ เพื่อรวมข้อมูลตัวตน, ค้นหาข้อมูลธุรกิจผ่าน Tools และดูแลข้อมูลคุณสมบัติผู้ใช้และประวัติการสนทนา ตัวอย่างการใช้งาน UserId เช่น

• Tools: เมื่อ AI Agent เรียกใช้ Tools เพื่อส่งคำขอไปยัง API ของธุรกิจ นักพัฒนาจะได้รับ UserId ใน header เพื่อระบุตัวผู้ใช้
• คุณสมบัติผู้ใช้: หลังตั้งค่า UserId ข้อมูลคุณสมบัติของผู้ใช้จะถูกผูกกับ UserId นี้
• ประวัติการสนทนา: หลังตั้งค่า UserId ประวัติการสนทนาระหว่างผู้ใช้กับ Agent จะถูกผูกกับ UserId นี้
• Event Callback: หลังตั้งค่า UserId ข้อมูล Event Callback ที่เกิดใน iframe/widget และรายงานไปยัง GA4/webhook จะมี UserId แนบไปด้วย

⚠️ User ID (UserId) ควรเป็นรหัสประจำตัวที่ไม่ซ้ำกันของผู้ใช้ในระบบธุรกิจของนักพัฒนา โดย UserId นี้สามารถนำไปใช้ค้นหาข้อมูลธุรกิจ เช่น ระดับ VIP, แท็กผู้ใช้, ข้อมูลคำสั่งซื้อ ฯลฯ

วิธีตั้งค่า User ID

API นี้ช่วยให้นักพัฒนาตั้งค่า User ID โดยใช้การรวมกันของ anonymous ID + ประเภทการสนทนา + source ID เพื่อจัดการข้อมูลตัวตนผู้ใช้

• ตั้งค่า User ID ใน Bubble Widget
• ตั้งค่า User ID ใน Iframe
• ตั้งค่า User ID ใน LiveChat

วิธีการร้องขอ

POST

Endpoint

https://api.${endpoint}/v1/user/set-userid

ตัวอย่างการร้องขอ

                      
                      curl -X POST 'https://api.${endpoint}/v1/user/set-userid' \
-H 'Authorization: Bearer ${token}' \
-H 'Content-Type: application/json' \
-d '{
    "user_id": "67b58121035e5b152b0419ee",
    "anonymous_ids": [
        {
            "anonymous_id": "6a0dnyvi3jc32flk7enw",
            "conversation_type": "SHARE"
        },
        {
            "anonymous_id": "6a0dnyvi3jc32flk7enw",
            "conversation_type": "TELEGRAM",
            "source_id": "bot_029392"
        }
    ]
}'

                    

user_id หนึ่งรายการ สามารถผูกกับ anonymous_id ได้สูงสุด 100 รายการ หากเกินระบบจะลบ binding ที่มี updateTime เก่าที่สุดโดยอัตโนมัติ
นักพัฒนาสามารถดึง anonymous ID ของผู้ใช้ปัจจุบันได้จากตัวแปร global anonymous_id และประเภทการสนทนาจาก conversation_type

Request Headers

Request Body

ตรรกะการผูกข้อมูล:

1. ความสัมพันธ์การผูกจะถูกกำหนดโดย anonymous_id + conversation_type + source_id ที่ไม่ซ้ำกัน
2. หาก combination นี้ถูกผูกกับ user_id ปัจจุบันอยู่แล้ว จะอัปเดตเฉพาะเวลาการผูก (updateTime)
3. หาก combination นี้ยังไม่ผูกกับ user_id ใด จะสร้างความสัมพันธ์ใหม่
4. หาก combination นี้ผูกกับ user_id อื่นอยู่ก่อน จะยกเลิก binding เก่าแล้วผูกกับ user_id ปัจจุบัน
5. หาก binding ของ user_id เดียวเกิน 100 รายการ ระบบจะลบ binding ที่มี updateTime เก่าที่สุดโดยอัตโนมัติ

Response

ตัวอย่าง Response

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "user_id": "67b58121035e5b152b0419ee",
        "anonymous_ids": [
            {
                "anonymous_id": "6a0dnyvi3jc32flk7enw",
                "conversation_type": "SHARE",
                "source_id": null
            },
            {
                "anonymous_id": "6a0dnyvi3jc32flk7enw",
                "conversation_type": "TELEGRAM",
                "source_id": "bot_029392"
            }
        ]
    }
}

                    

คำอธิบาย Response ที่สำเร็จ

Response ที่ผิดพลาด

รหัสสถานะ (Status Codes)