Lấy danh sách thành viên trong cuộc hội thoại
HTTP Request
GET https://{app_id}.api.piscale.com/open-api/v1.0/chat/threads/{thread_id}/members
Parameters
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
thread_id | string | Mã cuộc hội thoại | ✓ |
Request header
Bảng mô tả tham số của request header:
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
X-Api-Key | string | API Key của ứng dụng | ✓ |
X-Tenant-Id | string | Chỉ định tenant của thread | ✗ |
Query
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
last_member_id | string | Mã thành viên. | ✓ |
member_id_type | number | 1 : ext_user_id của PiScale 2 : user_id của khách hàng đã đồng bộ | ✓ |
limit | number | Giới hạn số lượng thành viên. Tối đa 100 thành viên. | ✗ |
status | string | all : Lấy tất cả thành viênactive : Chỉ lấy những thành viên đang hoạt độngremoved : Chỉ lấy những thành viên bị xóamuted : Chỉ lấy những thành viên không có quyền gửi tin nhắnbanned : Chỉ lấy những thành viên bị xóa và chặn | ✓ |
note
Dữ liệu trả về sẽ được sắp xếp theo ext_user_id
tăng dần.
Để lấy dữ liệu của trang tiếp theo vui lòng truyền last_member_id
tương ứng với id
của phần tử cuối cùng trong mảng dữ liệu trả về.
Response
Nếu thành công, bạn sẽ nhận được phản hồi.
Ví dụ
{
"message_code": "M200",
"message": "Thành công",
"data": [
{
"user_id": "49918031",
"ext_user_id": "6872016393206737",
"display_name" : "Andrew. Ng",
"avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/1b00a38d-cf83-41d4-9d59-e651836d21ff.png",
"status": "active",
"role": "owner",
},
{
"user_id": "49918032",
"ext_user_id": "6872016393206738",
"display_name" : "And. Ng",
"avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/1b00a38d-cf83-41d4-9d59-e651836d21ff.png",
"status": "banned",
"role": "member",
}
],
}
Tên | Kiểu dữ liệu | Mô tả |
---|---|---|
message_code | string | Mã thông điệp. Xem chi tiết |
message | string | Nội dung mã thông điệp |
data[i].user_id | string | User id phía khách hàng đã đồng bộ |
data[i].ext_user_id | string | User id thuộc hệ thống của Piscale |
data[i].display_name | string | Tên hiển thị |
data[i].avatar_url | string | Ảnh đại diện của user |
data[i].status | string | active , banned , removed , muted |
data[i].role | string | owner , admin , member |