Khởi tạo lại user
API hỗ trợ khởi tạo lại user, tương đương với việc tạo 1 user mới và giữ lại các thông tin display_name
, avatar_url
, alias
, verified
. Còn các thông tin khác như danh sách các cuộc hội thoại, các tin nhắn cũ, ... sẽ bị xoá.
Lưu ý
API này tương đương với việc tạo 1 user mới nên giá trị trường thông tin ext_user_id
bị thay đổi. Nếu bên hệ thống của bạn có lưu lại thông tin ext_user_id
này, vui lòng cập nhật lại thành giá trị mới
HTTP request
POST https://{app_id}.api.piscale.com/user/v1.0/user/{user_id}/reinit
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 khởi tạo lại user của tenant nào (ID bên hệ thống của bạn) | ✗ |
Parameters
Bảng mô tả tham số:
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
user_id | string | Chỉ định ID duy nhất của user (ID bên hệ thống của bạn) | ✓ |
Request body
Content-Type: application/json
Ví dụ
{
"user_type_id": 192812
}
Bảng mô tả thuộc tính:
Tên | Kiểu dữ liệu | Mô tả | Bắt buộc |
---|---|---|---|
user_type_id | number | User Type ID của user, nếu không cung cấp sẽ không thay đổi User Type , nếu giá trị là 0 được coi là type Default | ✗ |
Responses
Nếu thành công, API này trả về dữ liệu như sau:
Status: 200 OK
{
"data": {
"user_id": "49918031",
"ext_user_id": "6872016393206737",
"tenant_id": "89915020",
"ext_tenant_id": "6872016393176737",
"display_name": "Emily Johnson",
"alias": "emily_johnson92",
"avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/20b8582d-6beb-4161-b157-f7d2bf290962.png",
"status": 1,
"type": 1
},
"message_code": "M200",
"message": "Success"
}
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 | object | Thông tin user mới được khởi tạo lại |
data.user_id | string | ID duy nhất của user (ID bên hệ thống của bạn) |
data.ext_user_id | string | ID duy nhất của user do Piscale tự sinh, id này sẽ khác với ext_user_id cũ. Nếu bên hệ thống của bạn có lưu lại thông tin ext_user_id này, vui lòng cập nhật lại thành giá trị mới |
data.tenant_id | string | Tenant ID của user (ID bên hệ thống của bạn) |
data.ext_tenant_id | string | Tenant ID do Piscale tự sinh, mapping 1:1 với tenant_id |
data.display_name | string | Tên hiển thị |
data.alias | string | Tên khác |
data.avatar_url | string | Đường dẫn dùng để hiển thị avatar |
data.status | number | Trạng thái của user. 1: ACTIVE , 2: INACTIVE |
data.type | number | Loại user. 1: USER , 2: BOT |