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

บทสนทนา

รายการสมาชิกบทสนทนา

แสดงสมาชิกของบทสนทนาประเภท group ส่ง conversation_id ทาง query และแบ่งหน้าด้วย cursor / limit แต่ละรายการมี peer_id / display_name / avatar_url และ role เป็น member / admin / superadmin โดย superadmin คือเจ้าของหรือผู้สร้างกลุ่ม หากประเภทบทสนทนาไม่รองรับ เช่น 1:1 จะคืน 400

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

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

ใช้ 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

cursor
string

next_cursor แบบ opaque ละไว้เพื่อเริ่มหน้าแรก ส่วน cursor ที่ผิดหรือหมดอายุอาจถูกจัดการต่างกันตาม provider

limit
integer

ขนาดหน้าตั้งแต่ 1 ถึง 100 ค่าเริ่มต้นดูในคำอธิบาย endpoint

minimum: 1 · maximum: 100

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

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

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "peer_id": "user_example",
        "display_name": "",
        "avatar_url": "",
        "role": "superadmin"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

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

peer_id
string

ตัวระบุแบบ opaque ของสมาชิกภายในบทสนทนา โดย WhatsApp มักคืน LID และหมายเลขโทรศัพท์จะอยู่แยกใน extra.phone เมื่อมีข้อมูล

username
string

username ของสมาชิกฝั่ง provider เมื่อมีค่า

display_name
string

ชื่อแสดงผลของสมาชิก หรือสตริงว่างเมื่อไม่มีค่า

avatar_url
string

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

role
string

บทบาทมาตรฐาน: เจ้าของ/ผู้สร้างเป็น superadmin ผู้ดูแลเป็น admin และสมาชิกทั่วไปหรือไม่ทราบเป็น member

enum: member, admin, superadmin

joined_at
string

เวลาที่สมาชิกเข้าร่วมตามที่ provider รายงาน

format: date-time

extra
object

ฟิลด์สมาชิกเฉพาะของ provider เช่น หมายเลขโทรศัพท์

next_cursor
string

cursor แบบ opaque สำหรับหน้าถัดไป ส่งกลับมาเป็น cursor; สตริงว่างหมายถึงไม่มีหน้าต่อไปแล้ว

has_more
boolean

เป็น true เมื่อมีผลลัพธ์เพิ่มเติมนอกเหนือจากหน้านี้

การตอบกลับ

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