Tham chiếu API

Groups

Danh sách yêu cầu vào nhóm

Liệt kê các yêu cầu đang chờ của nhóm bật duyệt thành viên. group_id truyền qua query parameter. Push từ thượng nguồn không được bảo đảm — hãy poll endpoint này làm nguồn tin cậy.

GEThttps://api.unifyport.ai/v1/accounts/{account_id}/groups/join-requests

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
group_id
Nhóm cần thao tác — id được trả về bởi Liệt kê nhóm. Được giữ trong chuỗi truy vấn vì id của nhà cung cấp có thể chứa @ hoặc :.

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 groups.

Tham số truy vấn

group_id
stringbắt buộc

Nhóm cần thao tác — id được trả về bởi Liệt kê nhóm. Được giữ trong chuỗi truy vấn vì id của nhà cung cấp có thể chứa @ hoặc :.

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": {
    "group_id": "group_example",
    "items": [
      {
        "id": "member_example",
        "phone": "8613912345678",
        "requested_at": "2026-06-08T12:34:56Z"
      }
    ]
  }
}

Nội dung phản hồi

id
string

Định danh yêu cầu tham gia; truyền làm member_ids khi phê duyệt hoặc từ chối.

phone
string

Số điện thoại của người yêu cầu, khi nhà cung cấp công khai nó.

lid
string

LID của người yêu cầu phía provider, khi có.

requested_at
string

Dấu thời gian RFC3339 của thời điểm yêu cầu tham gia.

format: date-time

group_id
string

Nhóm mà các yêu cầu tham gia thuộc về.

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.