Tham chiếu API

Groups

Get group

Returns one group in real time. Pass group_id as a query parameter (it can contain @ / : so it is not placed in the path). Returns 404 when the group cannot be found.

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

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": {
    "id": "group_example",
    "conversation_id": "group_example",
    "name": "Project team",
    "avatar_url": "",
    "member_count": 5,
    "description": "..."
  }
}

Nội dung phản hồi

id
string

Định danh nhóm. Với một nhóm thì conversation_id bằng id này.

conversation_id
string

Định danh cuộc trò chuyện cho nhóm; bằng với id.

name
string

Tên nhóm.

avatar_url
string

URL ảnh đại diện của nhóm, hoặc chuỗi rỗng khi không được đặt.

member_count
integer

Số thành viên trong nhóm.

format: int64

joined_at
string

Thời gian tài khoản kết nối tham gia nhóm, khi có.

format: date-time

created_at
string

Thời gian tạo nhóm do provider báo cáo, khi có.

format: date-time

description
string

Mô tả nhóm, khi có sẵn.

permissions
object

Group-wide speaking permissions, returned only when explicitly supplied by the source. Missing means unknown; admins_only=false permits ordinary members to speak, but does not guarantee this account can send.

admins_only
boolean

true means only administrators may speak; false is an explicit state, not an omitted or default value.

extra
object

Các trường nhóm mở rộng riêng của nhà cung cấp. Dữ liệu nhóm WhatsApp có thể có phân loại nhóm thông báo, tùy dữ liệu sẵn có cho lần truy vấn này.

is_announcement_group
boolean

Chỉ có cho nhóm WhatsApp. true xác nhận đây là nhóm thông báo cộng đồng; false nghĩa là dữ liệu lần này xác nhận nhóm không đáp ứng điều kiện của nhóm thông báo. Thiếu trường nghĩa là chưa rõ; không trả về null. Phân loại này không cho biết tài khoản hiện tại có quyền gửi tin nhắn. Độc lập với permissions.admins_only.

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.