บทสนทนา

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

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

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

ช่องทางที่รองรับ

TelegramWhatsAppLINEXTikTok

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

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

ค่าที่ตรงกับ enum ทุกตัวอักษร ได้แก่ user, group หรือ channel คั่นด้วยจุลภาค โดยไม่ตัดช่องว่าง ไม่แปลงตัวพิมพ์ และไม่ละเว้นรายการว่าง ค่าที่ไม่ถูกต้องคืน 400 invalid_conversation_type สำหรับ WhatsApp ค่า group รวมกลุ่มประกาศของชุมชนด้วย และบทสนทนากลุ่ม WhatsApp ทั้งหมดคืน type=group

cursor

string

cursor แบบ opaque ของ provider ให้ส่ง next_cursor จากคำตอบก่อนหน้ากลับไปโดยไม่แก้ไข ละไว้หรือเว้นว่างสำหรับหน้าแรก cursor ที่ปลอม หมดอายุ หรือนำมาใช้ข้ามการค้นหา อาจถูกละเลย รีเซ็ตเป็นหน้าแรก หรือทำให้เกิดข้อผิดพลาดจาก provider จึงไม่ควรคาดหวังว่าจะได้ 400 เสมอ

limit

integer

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

minimum: 1 · maximum: 100

label_id

string

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

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

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

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

พิจารณาผลจากฟิลด์คำตอบและสถานะ HTTP ของ API นี้ แล้วเลือกขั้นตอนถัดไปจากคำสั่งที่เกี่ยวข้อง

การตอบกลับ 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 กลุ่มประกาศของชุมชน 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 การจัดประเภทนี้ไม่ได้ระบุว่าบัญชีปัจจุบันมีสิทธิ์ส่งข้อความ

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: ตรวจฟิลด์บังคับ รูปแบบ และเงื่อนไขช่องทาง แล้วแก้คำขอ
missing_api_key · 11000 · 401: ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่
invalid_api_key · 11001 · 401: ตรวจ X-Api-Key และว่า workspace ยังใช้งานอยู่