สอบถามข้อมูล User CDP

นักพัฒนาสามารถสอบถามข้อมูล CDP (Customer Data Platform) ของผู้ใช้ใน Agent/Workflow ได้ เช่น user ID, anonymous ID และประเภทการสนทนา โดยสามารถใช้ user ID หรือ anonymous ID ในการสอบถามก็ได้

ข้อมูล User CDP จะถูกจัดเก็บแยกกันในแต่ละ Agent/Workflow หมายความว่าข้อมูลของผู้ใช้คนเดียวกันจะถูกแยกออกจากกันในแต่ละ Agent/Workflow

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

GET

Endpoint

https://api.${endpoint}/v1/user/get-user-cdp

การยืนยันตัวตน

โปรดดูรายละเอียดวิธีการยืนยันตัวตนได้ที่ API Overview

การร้องขอ

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

สอบถามด้วย user_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123' \
-H 'Authorization: Bearer ${token}'

บล็อกโค้ดนี้ในหน้าต่างลอย

สอบถามด้วย anonymous_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

บล็อกโค้ดนี้ในหน้าต่างลอย

สอบถามด้วยทั้ง user_id และ anonymous_id:

curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \ -H 'Authorization: Bearer ${token}'

                      
                      curl -X GET 'https://api.${endpoint}/v1/user/get-user-cdp?user_id=BC123&anonymous_id=22ses32dsafdabd1w2sad' \
-H 'Authorization: Bearer ${token}'

บล็อกโค้ดนี้ในหน้าต่างลอย

สามารถดูค่า anonymous_id ของผู้ใช้ปัจจุบันได้จาก "Agent/Workflow Configuration - Global Variables"

Request Headers

ฟิลด์	ประเภท	คำอธิบาย
Authorization	Bearer ${token}	ใช้ `Authorization: Bearer ${token}` สำหรับยืนยันตัวตน รับคีย์ `${token}` ได้จากหน้า API Key

Query Parameters

พารามิเตอร์	ประเภท	คำอธิบาย	จำเป็นหรือไม่
user_id	string	user ID ที่นักพัฒนากำหนดเอง	ไม่จำเป็น
anonymous_id	string	anonymous ID ที่สร้างโดย GPTBots มักอ้างอิงจาก unique identifier ของแพลตฟอร์มภายนอก สามารถดูได้จาก "Agent/Workflow Configuration - Global Variables"	ไม่จำเป็น

ต้องระบุอย่างน้อย 1 ค่าใน user_id หรือ anonymous_id มิฉะนั้นจะเกิดข้อผิดพลาดของพารามิเตอร์

หากระบุเฉพาะ user_id จะสอบถามข้อมูลที่ผูกกับ user ทั้งหมด

หากระบุเฉพาะ anonymous_id จะสอบถามข้อมูลผู้ใช้ที่เกี่ยวข้องกับ anonymous ID นั้น

หากระบุทั้ง user_id และ anonymous_id จะเป็นการสอบถามแบบแม่นยำ

การตอบกลับ

ตัวอย่าง Response

{ "code": 0, "message": "OK", "data": { "user1": { "user_id": "user1", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "WEB", "source_id": null } ] }, "67b58121035e5b152b0419ee": { "user_id": "67b58121035e5b152b0419ee", "anonymous_ids": [ { "anonymous_id": "aId3", "conversation_type": "C", "source_id": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "user1": {
            "user_id": "user1",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "WEB",
                    "source_id": null
                }
            ]
        },
        "67b58121035e5b152b0419ee": {
            "user_id": "67b58121035e5b152b0419ee",
            "anonymous_ids": [
                {
                    "anonymous_id": "aId3",
                    "conversation_type": "C",
                    "source_id": null
                }
            ]
        }
    }
}

บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับสำเร็จ

ผลลัพธ์จะเป็นอ็อบเจกต์ที่ key คือ user_id และ value คือข้อมูล CDP ของผู้ใช้นั้น

ฟิลด์	ประเภท	คำอธิบาย
{user_id}	object	อ็อบเจกต์ที่ key เป็น user ID และ value เป็นข้อมูล CDP ของผู้ใช้
{user_id}.user_id	string	user ID
{user_id}.anonymous_ids	array	รายการ anonymous ID ที่ผูกกับ user ID นี้ พร้อมประเภทการสนทนา
{user_id}.anonymous_ids[].anonymous_id	string	anonymous ID
{user_id}.anonymous_ids[].conversation_type	string	ประเภทการสนทนา ดูตาราง mapping ได้ในหัวข้อประเภทการสนทนาใน User Overview
{user_id}.anonymous_ids[].source_id	string	source ID จากแพลตฟอร์มสนทนา เช่น หากเชื่อมต่อกับ `TELEGRAM` และเพิ่ม TG Bot 2 ตัว แต่ละ Bot จะมี source ID ของตัวเอง

การตอบกลับผิดพลาด

ฟิลด์	ประเภท	คำอธิบาย
code	int	รหัสข้อผิดพลาด
message	string	ข้อความข้อผิดพลาด

รหัสสถานะ

รหัสสถานะ	คำอธิบาย
200	สำเร็จ
400	ข้อผิดพลาดของพารามิเตอร์ (ไม่มี query parameter)
401	ไม่ได้รับอนุญาต
403	ไม่มีสิทธิ์เข้าถึง
500	ข้อผิดพลาดของเซิร์ฟเวอร์