Tham chiếu API

Hội thoại

Liệt kê thành viên

Liệt kê thành viên hội thoại group. Truyền conversation_id qua query và phân trang bằng cursor / limit. Mỗi mục có peer_id / display_name / avatar_url; role là member / admin / superadmin, trong đó superadmin là chủ sở hữu hoặc người tạo nhóm. Trả về 400 cho loại hội thoại không hỗ trợ như 1:1.

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

Trước khi gọi

Dùng X-Api-Key của workspace sở hữu tài nguyên trên máy chủ. Thay mọi giá trị mẫu trước khi chạy.

Nguồn tham số
account_id
Lấy data.id từ phản hồi tạo hoặc truy vấn tài khoản. ID thuộc workspace của X-Api-Key. Lấy tài khoản
conversation_id
Cuộc trò chuyện cần tra cứu — giá trị được trả về dưới dạng conversation_id bởi Liệt kê hội thoại.

Tham số yêu cầu

Tiêu đề

X-Api-Key
stringbắt buộc

API key của không gian làm việc. Không gian làm việc được xác định từ tiêu đề này.

Tham số đường dẫn

account_id
stringbắt buộc

Định danh dùng cho route conversations.

Tham số truy vấn

conversation_id
stringbắt buộc

Cuộc trò chuyện cần tra cứu — giá trị được trả về dưới dạng conversation_id bởi Liệt kê hội thoại.

type
string

Loại cuộc trò chuyện (user, group hoặc channel) để phân định rõ việc tra cứu.

enum: user, group, channel

cursor
string

next_cursor opaque. Bỏ qua để bắt đầu; cursor sai hoặc hết hạn được các provider xử lý khác nhau.

limit
integer

Kích thước trang từ 1 đến 100; giá trị mặc định nằm trong mô tả endpoint.

minimum: 1 · maximum: 100

Nội dung yêu cầu

Điểm cuối này không cần nội dung JSON.

Hiểu kết quả

Đọc trường phản hồi và trạng thái HTTP được mô tả. Thành công 204 không có nội dung; dùng X-Request-Id để chẩn đoán. Xem thao tác liên quan cho bước tiếp theo.

Phản hồi 200 OK

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

Nội dung phản hồi

peer_id
string

Định danh opaque của thành viên trong cuộc trò chuyện. WhatsApp thường trả về LID; số điện thoại, nếu có, nằm riêng trong extra.phone.

username
string

Username thành viên phía provider, khi có.

display_name
string

Tên hiển thị của thành viên, hoặc chuỗi rỗng khi thiếu.

avatar_url
string

URL ảnh đại diện của thành viên, hoặc chuỗi rỗng khi thiếu.

role
string

Vai trò chuẩn hóa: chủ sở hữu/người tạo là superadmin, quản trị viên là admin, thành viên thường hoặc chưa rõ là member.

enum: member, admin, superadmin

joined_at
string

Thời gian thành viên tham gia do provider báo cáo.

format: date-time

extra
object

Các trường thành viên riêng của provider, như số điện thoại.

next_cursor
string

Con trỏ mờ cho trang tiếp theo. Truyền lại làm cursor; chuỗi rỗng nghĩa là không còn trang nào nữa.

has_more
boolean

true khi còn kết quả ngoài trang này.

Phản hồi

200

200 OK

Yêu cầu thành công. Xem ví dụ nội dung phản hồi.

400

Bad Request

Body, đường dẫn hoặc tham số yêu cầu không hợp lệ.

401

Unauthorized

Header X-Api-Key thiếu hoặc không hợp lệ.

404

Not Found

Không tìm thấy tài nguyên provider được yêu cầu.

409

Conflict

Thao tác đang yêu cầu xung đột với tài khoản hoặc tài nguyên nhà cung cấp đã có.

500

Internal Server Error

Dịch vụ gặp lỗi không mong muốn.

501

Not Implemented

Provider đã chọn chưa triển khai thao tác này.

502

Bad Gateway

Adapter hoặc upstream provider không thể hoàn tất thao tác.

Khi yêu cầu thất bại

Kiểm tra HTTP và error.code/numeric_code, giữ request_id. Sửa tham số, tiếp tục xác thực hoặc kiểm tra runtime tùy nguyên nhân. Xác nhận kết quả cũ trước khi thử lại thao tác gửi hoặc ghi. Tham chiếu mã lỗi

invalid_request · 10000 · 400
Kiểm tra trường bắt buộc, định dạng và điều kiện kênh rồi sửa yêu cầu.
invalid_api_key · 11001 · 401
Kiểm tra X-Api-Key và workspace còn hoạt động.