Lấy thông tin người dùng
API hỗ trợ lấy thông tin của người dùng theo user_id.
HTTP request
GET https://{app_id}.api.piscale.com/user/v1.0/user/{user_id}
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 lấy thông tin 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 (ID bên hệ thống của bạn) | ✓ |
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,
"verified": true
},
"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 của user |
| 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, mapping 1:1 với user_id |
| 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: NORMAL_USER, 2: BOT |
| data.verified | bool | User được xác thực hay không |