Skip to main content

Tạo cuộc hội thoại

Chúng tôi chỉ hỗ trợ việc tạo cuộc hội thoại nhóm khi sử dụng phương thức xác thực bằng API-Key. Nếu bạn muốn tạo cuộc hội thoại 1-1 vui lòng sử dụng SDK.

HTTP request​

POST https://{app_id}.api.piscale.com/open-api/v1.0/chat/threads

Request header​

Bảng mô tả tham số của request header:

TênKiểu dữ liệuMô tảBắt buộc
X-Api-KeystringAPI Key của ứng dụng✓
X-Tenant-IdstringChỉ định tenant của thread✗

Request body​

Ví dụ
{
    "name": "Tên thread",
    "avatar_url": "",
    "description": "",
    "member_ids": ["u_1", "u_2"],
    "owner_id": "u_5",
    "id_type": 1,
    "reference_id": "task:123"
}
TênKiểu dữ liệuMô tảBắt buộc
namestringTên cuộc hội thoại✓
avatar_urlstringĐường dẫn của avatar✗
descriptionstringMô tả về nhóm✗
member_idsarrayDanh sách user_id có quyền là member trong thread. Các phần tử có kiểu dữ liệu phải là string✓
owner_idstringDữ liệu user_id có quyền là owner trong thread.✓
id_typenumberid_type xác định kiểu ID bạn truyền vào:
1: Dùng ext_user_id (từ hệ thống PiScale)
2: user_id nội bộ hệ thống của khách hàng (đã được đồng bộ với PiScale)		✓
reference_idstringMã liên kết✗
note

Mọi thành viên trong cuộc hội thoại đều có một vai trò và có các quyền hạn tương ứng. Khi tạo cuộc hội thoại có reference_id:

  • Cuộc hội thoại này sẽ được liên kết với một đối tượng khác (ví dụ: task, ticket, etc.)
  • Cuộc hội thoại sẽ không hiển thị trong danh sách chat của người dùng
  • Người dùng chỉ có thể truy cập cuộc hội thoại này thông qua đối tượng được liên kết

Response​

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ
{
    "message_code": "M200",
    "message": "Success",
    "data": {
        "thread_id": "124123123"
    }
}
TênKiểu dữ liệuMô tả
message_codestringMã thông điệp. Xem chi tiết
messagestringNội dung mã thông điệp
data.thread_idstringMã cuộc hội thoại