查询频道文档转换状态

接口URL

http://api.polyv.net/live/v3/channel/document/status/get

接口说明

1、提供ppt文档转换状态接口
2、支持https

支持格式

JSON

请求方式

GET

请求数限制

TRUE

请求参数

参数名 必选 类型 说明
appId string 从API设置中获取,在直播系统登记的appId
timestamp string 当前时间的秒级时间戳(13位)
sign string 签名,为32位大写的MD5值
channelId int 频道号
fileId string 文件ID,(如果有多个,可以用英文逗号隔开拼接成字符串)

操作成功响应示例

{
  "code": "",
  "message": "text",
  "status": "",
  "data": [
    {
      "totalPage": 1,
      "smallImages": [
        "http://www.polyv.net/1.png"
      ],
      "imageCount": 1,
      "images": [
        "http://www.polyv.net/2.png"
      ],
      "errorMsg": "",
      "htmlUrl": "http://www.polyv.net/1.html",
      "convertStatus": "normal",
      "fileId": "xxxxxx"
    },
    {
      "totalPage": 1,
      "smallImages": [
        "http://www.polyv.net/1.png"
      ],
      "imageCount": 1,
      "images": [
        "http://www.polyv.net/2.png"
      ],
      "errorMsg": "",
      "htmlUrl": "http://www.polyv.net/1.html",
      "convertStatus": "normal",
      "fileId": "xxxxxx"
    }
  ]
}

操作失败响应示例

签名错误

{
    "code": 403,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}

缺少参数 channelId

{
    "code": 400,
    "status": "error"
    "message": "param should not be empty: channelId",
    "data": ""
}

响应字段说明

名称 类型 说明
code string 响应代码,成功为200,失败为400,签名错误为403,异常错误500
status string 成功为success,失败为error
message string 错误时为错误提示消息
data string 成功响应数组
data[0].convertStatus string 转换状态. (“normal”:正常。”failUpload“: 上传失败。“waitConvert”: 转换PPT中。“failConvert”: 转换失败,失败原因会返回在data[0].errorMsg字段中展示)
data[0].errorMsg string 错误信息(转换失败原因,data[0].convertStatus=“waitConvert” 返回)
data[0].totalPage int 总页数(data[0].convertStatus=“normal” 返回)
data[0].images string[] 大图地址数组,(data[0].convertStatus=“normal” 返回)
data[0].smallImages string[] 小图地址数组,(data[0].convertStatus=“normal” 返回)
data[0].imageCount int 大图图片数量,(data[0].convertStatus=“normal” 返回)
data[0].htmlUrl string 动画PPT地址,(data[0].convertStatus=“normal” 返回)
data[0].fileId string 文件ID
以上内容是否对您有帮助?根本没有帮助文档较差文档一般文档不错文档很好
Loading...