เอกสารอ้างอิง API

ข้อความ

แสดงปฏิกิริยาต่อข้อความ

เพิ่มอิโมจิ reaction ให้ข้อความ หรือลบ reaction เดิมเมื่อ emoji เป็นสตริงว่าง sender_id ระบุเจ้าของข้อความที่ถูก react ค่าเริ่มต้นคือบัญชีเอง

POSThttps://api.unifyport.ai/v1/messages/reaction

ก่อนเรียกใช้

ใช้ X-Api-Key ของ workspace เจ้าของทรัพยากรบนเซิร์ฟเวอร์ แทนค่าตัวอย่างทั้งหมดก่อนเรียกใช้

พารามิเตอร์คำขอ

ส่วนหัว

X-Api-Key
stringจำเป็น

API key ของพื้นที่ทำงาน ระบบจะระบุพื้นที่ทำงานจากส่วนหัวนี้

Content-Type
stringจำเป็น

ใช้ application/json เมื่อต้องส่งเนื้อหาของคำขอเป็น JSON

เนื้อหาของคำขอ

account_id
stringจำเป็น

บัญชีที่ดำเนินการ

conversation_id
stringจำเป็น

ตัวระบุบทสนทนาเป้าหมาย

message_id
stringจำเป็น

ตัวระบุข้อความเป้าหมาย

sender_id
string

ตัวระบุผู้ส่งเดิม ละได้เฉพาะเมื่อดำเนินการกับข้อความของบัญชีเอง

emoji
string

emoji สำหรับ reaction เมื่อตัว provider รองรับ การละไว้หรือส่งสตริงว่างจะลบ reaction

ทำความเข้าใจผลลัพธ์

อ่านฟิลด์ตอบกลับและสถานะ HTTP ตามเอกสาร 204 สำเร็จไม่มีเนื้อหา ใช้ X-Request-Id เพื่อตรวจสอบ ขั้นตอนต่อไปอยู่ในการทำงานที่เกี่ยวข้อง

การตอบกลับ 200 OK

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "ok": true
  }
}

เนื้อหาการตอบกลับ

ok
boolean

เป็น true เสมอเมื่อการดำเนินการสำเร็จ ส่วนกรณีล้มเหลวจะคืนสถานะที่ไม่ใช่ 2xx แทน

การตอบกลับ

200

200 OK

คำขอสำเร็จ ดูตัวอย่างเนื้อหาตอบกลับด้านบน

400

Bad Request

เนื้อหาของคำขอ path หรือพารามิเตอร์ไม่ถูกต้อง

401

Unauthorized

ส่วนหัว X-Api-Key หายไปหรือไม่ถูกต้อง

409

Conflict

การดำเนินการขัดแย้งกับบัญชีของผู้ให้บริการหรือทรัพยากรที่มีอยู่

500

Internal Server Error

บริการพบข้อผิดพลาดที่ไม่คาดคิด

501

Not Implemented

provider ที่เลือกยังไม่รองรับการดำเนินการนี้

502

Bad Gateway

อะแดปเตอร์หรือ upstream provider ไม่สามารถทำรายการให้เสร็จได้

เมื่อคำขอล้มเหลว

ตรวจ HTTP และ error.code/numeric_code เก็บ request_id แล้วแก้พารามิเตอร์ ยืนยันตัวตนต่อ หรือตรวจ runtime ตามสาเหตุ ตรวจผลครั้งก่อนก่อนส่งหรือเขียนซ้ำ อ้างอิงรหัสข้อผิดพลาด

invalid_request · 10000 · 400
ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
invalid_api_key · 11001 · 401
ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่