บทสนทนา

รายการบทสนทนา

แสดงบทสนทนาแบบเรียลไทม์ limit 1..100 ค่าเริ่มต้น 20 type ต้องเป็นค่า user / group / channel แบบตรงกันและไม่ trim สำหรับ WhatsApp หากไม่ส่ง label_id จะคืนเฉพาะ starred / “特别关注” ส่วน cursor ผิดอาจถูกจัดการต่างกันตาม provider

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

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

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

ที่มาของพารามิเตอร์

account_id: รับ data.id จากการสร้างหรือค้นหาบัญชี รหัสเป็นของ workspace ที่ระบุด้วย X-Api-Key ดูบัญชี

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

ส่วนหัว

X-Api-Key

stringจำเป็น

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

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

account_id

stringจำเป็น

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

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

type

string

ค่าที่ตรงกันทั้งหมด user, group, channel คั่นด้วยจุลภาค โดยไม่มีการ trim

cursor

string

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

limit

integer

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

minimum: 1 · maximum: 100

label_id

string

ตัวระบุ label แบบตรงกันทั้งหมด สำหรับ WhatsApp หากละไว้จะคืนบทสนทนา starred / “特别关注”

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

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

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

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

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

{
  "request_id": "<REQUEST_ID>",
  "data": {
    "items": [
      {
        "conversation_id": "peer_example",
        "type": "user",
        "title": "Display name",
        "avatar_url": "",
        "unread_count": 3,
        "last_message_at": "2026-05-13T10:00:00Z"
      }
    ],
    "next_cursor": "",
    "has_more": false
  }
}

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

conversation_id

string

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

type

string

ประเภทบทสนทนา: user, group หรือ channel

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 ที่ไม่ได้อยู่ใน schema มาตรฐาน

next_cursor

string

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

has_more

boolean

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

การตอบกลับ

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