รับคุณสมบัติบทสนทนา

ดึงรายการคุณสมบัติบทสนทนาระดับเซสชันตาม conversation_id ที่ส่งเข้ามา ประกอบด้วยชื่อคุณสมบัติบทสนทนา ประเภท และค่าของเซสชันปัจจุบัน ระบบจะส่งคืนคุณสมบัติบทสนทนาทั้งหมดที่ Agent กำหนดไว้ หากคุณสมบัติใดยังไม่ได้รับการกำหนดค่าในเซสชันปัจจุบัน value จะใช้ค่าเริ่มต้นตามนิยามของคุณสมบัตินั้นแทน

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

GET

Endpoint

https://api-${endpoint}.gptbots.ai/v1/conversation/property

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

โปรดดูวิธีการยืนยันตัวตนที่ API Overview

การร้องขอ

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

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/conversation/property?conversation_id=6a55ff78f847452309cae7d4' \
-H 'Authorization: Bearer ${API Key}'

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

Request Headers

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

พารามิเตอร์การร้องขอ

ฟิลด์	ประเภท	จำเป็นต้องกรอก	คำอธิบาย
conversation_id	string	ใช่	รหัสระบุบทสนทนา

การตอบกลับ

ตัวอย่างการตอบกลับ

[ { "id": "66aa1b2c3d4e5f60718293a4", "name": "vip_level", "type": "INTEGER", "value": "3" }, { "id": "66aa1b2c3d4e5f60718293a5", "name": "user_city", "type": "STRING", "value": "Bangkok" }, { "id": "66aa1b2c3d4e5f60718293a6", "name": "is_member", "type": "BOOLEAN", "value": "true" } ]

                      
                      [
  {
    "id": "66aa1b2c3d4e5f60718293a4",
    "name": "vip_level",
    "type": "INTEGER",
    "value": "3"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a5",
    "name": "user_city",
    "type": "STRING",
    "value": "Bangkok"
  },
  {
    "id": "66aa1b2c3d4e5f60718293a6",
    "name": "is_member",
    "type": "BOOLEAN",
    "value": "true"
  }
]

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

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

ฟิลด์	ประเภท	คำอธิบาย
id	string	รหัสเฉพาะของนิยามคุณสมบัติบทสนทนา
name	string	ชื่อคุณสมบัติบทสนทนา
type	string	ประเภทคุณสมบัติบทสนทนา มีค่า: STRING, INTEGER, NUMBER, BOOLEAN, DATETIME
value	string	ค่าคุณสมบัติบทสนทนา ส่งคืนเป็นสตริงทั้งหมด (DATETIME เป็นสตริง epoch มิลลิวินาที, BOOLEAN เป็น "true"/"false") หากเซสชันปัจจุบันมีการกำหนดค่าแล้วจะใช้ค่าของเซสชัน มิฉะนั้นจะใช้ค่าเริ่มต้นตามนิยามของคุณสมบัตินั้น

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

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

รหัสข้อผิดพลาด

รหัส	ข้อความ
40000	พารามิเตอร์ไม่ถูกต้อง
40127	การยืนยันตัวตนนักพัฒนาไม่สำเร็จ
40356	ไม่พบบทสนทนา
20059	Agent ถูกลบแล้ว