Skip to main content
GET
/
end-users
/
{end_user_id}
Error
A valid request URL is required to generate request examples
{
  "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
  "tenant_id": "11223344-5566-7788-99aa-bbccddeeff00",
  "app_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "type": "service_api",
  "external_user_id": "abc-123",
  "name": null,
  "is_anonymous": false,
  "session_id": "abc-123",
  "created_at": "2024-01-16T12:00:29Z",
  "updated_at": "2024-01-16T12:00:29Z"
}

Authorizations

​
Authorization
string
header
required

API Key 认证。对于所有 API 请求，请在 Authorization HTTP 头中包含您的 API Key，并加上 Bearer 前缀。示例：Authorization: Bearer {API_KEY}。强烈建议将 API Key 存储在服务端，不要在客户端共享或存储，以避免 API Key 泄漏导致严重后果。

Path Parameters

​
end_user_id
string<uuid>
required

终端用户 ID。

Response

成功获取终端用户。

​
id
string<uuid>

终端用户 ID。

​
tenant_id
string<uuid>

租户 ID。

​
app_id
string<uuid> | null

应用 ID。

​
type
string

终端用户类型。Service API 用户固定为 service_api。

​
external_user_id
string | null

API 请求中提供的 user 标识符（例如 发送对话消息 中的 user 字段）。

​
name
string | null

终端用户名称。

​
is_anonymous
boolean

用户是否为匿名用户。当原始 API 请求中未提供 user 标识符时，值为 true。

​
session_id
string

会话标识符。默认为 external_user_id 的值。

​
created_at
string<date-time>

创建时间戳。

​
updated_at
string<date-time>

最后更新时间戳。