อัปเดตคุณสมบัติบทสนทนา

อัปเดต (upsert) ค่าคุณสมบัติบทสนทนาระดับเซสชันตาม conversation_id ที่ส่งเข้ามา ระบบจะบันทึกเฉพาะคุณสมบัติบทสนทนาที่ Agent กำหนดไว้เท่านั้น (ชื่อคุณสมบัติที่ไม่ได้กำหนดไว้จะถูกละเว้น) และแปลงค่าให้เป็นมาตรฐานตามประเภทที่กำหนดของคุณสมบัติบทสนทนา จะอัปเดตเฉพาะคุณสมบัติที่ส่งเข้ามาในครั้งนี้เท่านั้น คุณสมบัติอื่น ๆ จะไม่ได้รับผลกระทบ

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

POST

Endpoint

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

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

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

การร้องขอ

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

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "conversation_id": "6a55ff78f847452309cae7d4", "properties": [ { "name": "vip_level", "value": "3" }, { "name": "user_city", "value": "Bangkok" }, { "name": "is_member", "value": "true" } ] }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/conversation/property/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
  "conversation_id": "6a55ff78f847452309cae7d4",
  "properties": [
    { "name": "vip_level", "value": "3" },
    { "name": "user_city", "value": "Bangkok" },
    { "name": "is_member", "value": "true" }
  ]
}'

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

Request Headers

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

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

ฟิลด์	ประเภท	จำเป็นต้องกรอก	คำอธิบาย
conversation_id	string	ใช่	รหัสระบุบทสนทนา
properties	JSON Array	ใช่	รายการคุณสมบัติบทสนทนาที่ต้องการอัปเดต
name	string	ใช่	ชื่อคุณสมบัติบทสนทนา ต้องเป็นคุณสมบัติบทสนทนาที่ Agent กำหนดไว้แล้ว หากไม่ได้กำหนดไว้จะถูกละเว้น
value	string	ไม่	ค่าคุณสมบัติบทสนทนา ส่งเป็นสตริงทั้งหมด: DATETIME ส่งสตริง epoch มิลลิวินาที, BOOLEAN ส่ง "true"/"false", NUMBER/INTEGER ส่งสตริงตัวเลข, STRING ส่งตามเดิม ฝั่งเซิร์ฟเวอร์จะแปลงค่าให้เป็นมาตรฐานตามประเภทที่กำหนดของคุณสมบัติบทสนทนาโดยอัตโนมัติ

การตอบกลับ

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

{ "code": 0, "message": "OK" }

                      
                      {
  "code": 0,
  "message": "OK"
}

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

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

ฟิลด์	ประเภท	คำอธิบาย
code	int	รหัสส่งคืน 0 หมายถึงสำเร็จ
message	string	ข้อความอธิบาย

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

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

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

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