接口:新建文档

  • 新建文档

请求URL:

POST/v2/activity-doc/create-doc

参数:

参数名 是否必须 说明
name 文档名称
oss_file 文档地址(域名加路径)

返回参数说明:

公共相应参数,详细内容请参考[返回结果]

返回数据如下:

参数名 类型 说明
msg string 状态信息
data object 数据对象
data[business_user_id] string 用户ID
data[doc_id] string 文档ID
data[name] string 文档名称
data[page_num] string 文档页数
data[transfer] string 转换状态 0:等待上传 1:等待转换 2:转换中 3:转换成功 4:转换失败
data[yun_id] string 微吼云文档id
data[type] string 文档类型
data[live_time] string 文档最近演示时间
data[oss_file] string 文档下载地址
data[created_at] string 创建时间
data[updated_at] string 最后更新时间
code int 状态码

请求结果示例:

正确时返回:


{
    "code": 200,
    "msg": null,
    "data": {
        "name": "1619581519072.jpg",
        "created_at": "2021-05-27 02:27:47",
        "page_num": 0,
        "transfer": 1,
        "status": 1,
        "operator": 23300083,
        "business_user_id": 23300083,
        "yun_id": "973ae622",
        "doc_url": "",
        "url_expire": "",
        "oss_file": "https://test-zhike.oss-cn-beijing.aliyuncs.com/mp-test/62/4b/624bb0783449ef9a6a1dfed406109208a.jpg",
        "type": "jpg",
        "updated_at": "2021-05-27 02:27:47",
        "doc_id": 330
    }
}

失败时返回:

{
    "code": 201,
    "msg": "name 不能为空。",
    "data": null
}

备注:

  • 更多返回错误代码请看首页的错误代码描述