Skip to content

扩展能力

此部分为接入方按需调用接口,不使用不影响主流程。请求方为接入方。

公共响应体

说明:此为所有接口响应的结构体。

参数:

字段位置必须类型说明
Content-Typeheader必须String请求体为 json 格式,application/json
codebody必须String0-成功,其他为错误
msgbody必须String错误code码,可以附带描述信息
databody必须String具体业务数据

返回值示例:

json
{
	"code": "0",
	"msg": "",
	"data": {
		// 具体业务数据
	}
}

获取指定文档协作人

接口:GET /wenqu/api/v1/ability/{fileId}/cops/user?appId={appId}

说明:该接口用于获取指定文件的协作用户列表,没有协作用户表示指定文档未协作。

参数:

字段位置必须类型说明
fileIdPath必须String当前文档在接入方系统中的唯一 id
appIdQuery必须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,不存在开档记录
200005APPID渠道信息有误
400001未知异常