Appearance
扩展能力
此部分为接入方按需调用接口,不使用不影响主流程。请求方为接入方。
公共响应体
说明:此为所有接口响应的结构体。
参数:
字段 | 位置 | 必须 | 类型 | 说明 |
---|---|---|---|---|
Content-Type | header | 必须 | String | 请求体为 json 格式,application/json |
code | body | 必须 | String | 0-成功,其他为错误 |
msg | body | 必须 | String | 错误code码,可以附带描述信息 |
data | body | 必须 | String | 具体业务数据 |
返回值示例:
json
{
"code": "0",
"msg": "",
"data": {
// 具体业务数据
}
}
获取指定文档协作人
接口:GET /wenqu/api/v1/ability/{fileId}/cops/user?appId={appId}
说明:该接口用于获取指定文件的协作用户列表,没有协作用户表示指定文档未协作。
参数:
字段 | 位置 | 必须 | 类型 | 说明 |
---|---|---|---|---|
fileId | Path | 必须 | String | 当前文档在接入方系统中的唯一 id |
appId | Query | 必须 | String | 分配给接入方应用 id |
请求体:无
返回值:
字段 | 必须 | 类型 | 说明 |
---|---|---|---|
userId | 必须 | String | /file/info回调接入方返回的用户id |
userName | 必须 | String | /file/info回调接入方返回的用户name |
返回值示例:
json
{
"code": 0,
"msg": null,
"data": {
"users": [
{
"userId": "admin#173109927232",
"userName": "访客001"
}
]
}
}
code 错误码说明:
错误码 | 说明 |
---|---|
200004 | 文档Id,不存在开档记录 |
200005 | APPID渠道信息有误 |
400001 | 未知异常 |