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

บทสนทนา

รายละเอียดบทสนทนา

คืนค่ารายละเอียดของบทสนทนาหนึ่งรายการแบบเรียลไทม์ ส่ง conversation_id เป็น query parameter (ใช้ค่าที่ได้จาก List conversations) การตอบกลับจะมี conversation_id / type / title / avatar_url เสมอ (เป็น string ว่างเมื่อไม่มีค่า) พร้อมฟิลด์เฉพาะตามประเภท เช่น members_count สำหรับกลุ่ม คืนค่า 404 หากหาบทสนทนาไม่พบ

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/conversations/info

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

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

ที่มาของพารามิเตอร์
account_id
รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี
conversation_id
บทสนทนาที่ต้องการค้นหา — ค่าที่คืนเป็น conversation_id จาก List conversations

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

ส่วนหัว

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

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

พารามิเตอร์ใน path

account_id
stringจำเป็น

ตัวระบุที่ใช้ใน route ของ conversations

พารามิเตอร์ Query

conversation_id
stringจำเป็น

บทสนทนาที่ต้องการค้นหา — ค่าที่คืนเป็น conversation_id จาก List conversations

type
string

ประเภทบทสนทนา (user, group หรือ channel) เพื่อช่วยจำแนกการค้นหาให้ชัดเจน

enum: user, group, channel

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

จุดเชื่อมต่อนี้ไม่ต้องใช้เนื้อหา JSON

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "conversation_id": "peer_example",
    "type": "group",
    "title": "Group title",
    "avatar_url": "",
    "description": "...",
    "unread_count": 0,
    "members_count": 42
  }
}

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

conversation_id
string

ตัวระบุบทสนทนา ใช้เป็นเป้าหมายเมื่อส่งข้อความหรือเรียก route ของบทสนทนา

type
string

ประเภทบทสนทนามาตรฐาน: user, group หรือ channel กลุ่มประกาศของชุมชน WhatsApp ยังคงใช้ group

enum: user, group, channel

title
string

ชื่อแสดงผลของบทสนทนา

username
string

username ของบทสนทนาฝั่ง provider เมื่อมีค่า

avatar_url
string

URL ของรูปประจำตัว หรือสตริงว่างเมื่อไม่มีการตั้งค่า

description
string

คำอธิบายของกลุ่มหรือ channel เมื่อมีค่า

last_message_at
string

timestamp แบบ RFC3339 ของข้อความล่าสุด

format: date-time

last_message_text
string

ตัวอย่างข้อความล่าสุด เมื่อมีค่า

unread_count
integer

จำนวนข้อความที่ยังไม่อ่านในบทสนทนา

format: int64

members_count
integer

จำนวนสมาชิก; คืนค่าสำหรับบทสนทนาประเภทกลุ่ม

format: int64

subscribers_count
integer

จำนวนผู้ติดตามของบทสนทนาแบบ channel เมื่อมีค่า

format: int64

is_pinned
boolean

บัญชีที่เชื่อมต่อปักหมุดบทสนทนานี้หรือไม่

is_muted
boolean

บัญชีที่เชื่อมต่อปิดเสียงบทสนทนานี้หรือไม่

created_at
string

เวลาสร้างบทสนทนาที่ provider รายงาน เมื่อมีค่า

format: date-time

extra
object

ฟิลด์เพิ่มเติมเฉพาะ provider บทสนทนากลุ่ม WhatsApp อาจมีการจัดประเภทกลุ่มประกาศ แต่รายการบทสนทนาไม่รับประกันว่าจะมีข้อมูลนี้

is_announcement_group
boolean

มีเฉพาะกลุ่ม WhatsApp ค่า true หมายถึงยืนยันว่าเป็นกลุ่มประกาศของชุมชน ส่วน false หมายถึงข้อมูลครั้งนี้ยืนยันว่าไม่ตรงตามเงื่อนไขของกลุ่มประกาศ หากไม่มีฟิลด์นี้หมายถึงไม่ทราบ และจะไม่คืน null การจัดประเภทนี้ไม่ได้ระบุว่าบัญชีปัจจุบันมีสิทธิ์ส่งข้อความ

การตอบกลับ

200

200 OK

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

400

Bad Request

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

401

Unauthorized

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

404

Not Found

ไม่พบทรัพยากรของ provider ที่ร้องขอ

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 ยังใช้งานอยู่