获取用户信息
在线编辑页面批量获取当前正在编辑和编辑过文档的用户信息,需以数组的形式返回响应。
请求说明
| 请求地址 | 回调地址 + uri(默认为:/v1/3rd/user/info) |
|---|---|
| 请求方法 | POST |
| 签名方式 | 无 |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| X-Weboffice-File-Id | 是 | 文件id |
| X-Wps-Weboffice-Token | 否 | 开发者通过JSSDK设置用于用户鉴权TOKEN |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| _w_third_* | object | 否 | 合作方自定义参数, _w_third_作为前缀,_w_third_appid,_w_third_file_id 字段已被使用,对接方请合理避开 |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| ids | array | 是 | 字符串数组,用户 id 数组 |
请求体示例
json
{
"ids": ["id1000", "id2000"]
}1
2
3
2
3
响应体(Response)
正常返回
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| users | array | 是 | 用户信息数组 |
| ∟ id | string | 是 | 用户 ID,字符串长度不超过 32 位 |
| ∟ name | string | 是 | 用户名 |
| ∟ avatar_url | string | 否 | 用户头像地址,支持url 和 base64 |
正常返回示例
json
{
"users": [
{
"id": "id1000",
"name": "wps-1000",
"avatar_url": "http://xxx.cn/?id=1000"
},
{
"id": "id2000",
"name": "wps-2000",
"avatar_url": "http://xxx.cn/?id=2000"
}
]
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
2
3
4
5
6
7
8
9
10
11
12
13
14
异常返回
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | integer | 是 | 错误码 |
| message | string | 是 | 错误提示 |
| details | string | 是 | 错误提示详细信息 |
| hint | string | 否 | 自定义错误信息,当code为40007错误码时必填 |
异常返回示例
json
{
"code": 40005,
"message": "InvalidArgument",
"details": "参数错误",
"hint": "自定义错误提示"
}1
2
3
4
5
6
2
3
4
5
6