WebOffice 开放平台

主题

回到顶部
本页内容

用户信息

该组接口用于获取协同场景下的用户信息，如查看历史改动，在线协同用户头像等。

批量获取用户信息

说明：该接口用于获取指定用户的名称和头像，在协同场景下，如查看历史改动，在线协同用户头像等都需要获取用户信息。

接口: GET /v3/3rd/users

参数：

字段位置必须类型说明
user_ids
Query
是
string，repeat
多个用户的 ID，例如：/v3/3rd/users?user_ids=1&user_ids=2&user_ids=3

返回值:

提示

🔔 该接口的实现需确保可以接收到多个 user_ids 参数，返回值根据传入的 user_ids 返回对应 id 的用户信息数组，不要写死，写死可能会导致某些功能异常。

常见功能异常场景：用户打开文档，显示当前用户不存在，无法打开文档；用户插入图片，显示当前用户不存在，无法成功插入图片；评论用户信息无法显示；回复评论无法正常显示回复人；协作记录对应的用户信息不存在，无法回滚；对应的用户版本信息异常等，遇到上述问题可通过相关 x-request-id 查询日志优先排查一下该回调接口的实现。

相关讨论：社区-用户信息

字段必须类型说明
id
是
string
当前用户 ID
name
是
string
用户昵称
avatar_url
否
string
用户头像 URL

返回值示例：

例如：/v3/3rd/users?user_ids=1&user_ids=2&user_ids=3

json
{
  "code": 0,
  "data": [
    {
      "id": "1",
      "name": "user name1"
    },
    {
      "id": "2",
      "name": "user name2"
    },
    {
      "id": "3",
      "name": "user name3"
    }
  ]
}