获取当前文档信息更新时间：2020-11-30 20:21:46

获取当前文档信息

API 地址

api.vhallyun.com/api/v2/document/get-watch-info

描述

根据频道ID获取频道当前演示的文档信息

场景描述：

用于文档演示的时候，来获取文档的页码、文档的容器基本情况、文档状态等基础信息

入参

关于公共请求参数详细内容，请参考 公共请求参数。

参数 类型 是否必选 含义
channel_id string 是 频道ID

出参

参数 类型 是否必选 含义
list array 是 当前直播间演示文档列表
switch_status string 是 文档演示状态，1开启，0关闭

list参数含义

参数 类型 是否必选 含义
converted_page float 是 动态转换成功页数
status float 是 动态转换状态
converted_page_jpeg float 是 静态转换成功页数
status_jpeg float 是 静态转换状态
show_page string 是 当前演示页
show_step string 是 当前演示步数
docId string 是 当前文档id
is_board int 是 是否是白板,1文档2白板，默认文档
active float 是 激活状态,0未激活1激活，默认未激活
hash string 是 当前演示文档hash
ext int 是 文件后缀
page int 是 文档页数
width int 是 文档宽
height string 是 文档高
doc_type string 是 文档类型
switch_status string 是 文档演示状态，1开启，0关闭
cw string 是 文档演示容器宽
ch string 是 文档演示容器高
cid string 是 文档演示容器ID
backgroundColor string 是 文档演示容器背景色
pageData list 是 文档演示当前页历史文档消息

错误码

响应格式

{
	"code": 200,
	"msg": null,
	"data": ["list": {
		{
			"converted_page": 1,
			"status": 200,
			"converted_page_jpeg": 1,
			"status_jpeg": 200,
			"show_page": 4,
			"show_step": 0,
			"docId": "018184b4",
			"is_board": 2,
			"active": 0,
			"hash": "1",
			"ext": "1",
			"page": 1,
			"width": 1,
			"height": 1,
			"cw": 1,
			"ch": 1,
			"cid": "board-1234567",
			"backgroundColor": "#FFFFFF",
			"pageData": [],
			"switch_status": 1,
			"doc_type": 0
		},
		{
			"converted_page": 0,
			"status": 0,
			"converted_page_jpeg": 0,
			"status_jpeg": 0,
			"show_page": 4,
			"show_step": 0,
			"docId": "018184b2",
			"is_board": 1,
			"active": 0,
			"hash": "512931b75eedd5cb35e4c4d32130ab1f",
			"ext": "doc",
			"page": 0,
			"width": 0,
			"height": 0,
			"switch_status": 1,
			"doc_type": 0,
			"cw": 1,
			"ch": 1,
			"cid": "board-1234567",
			"backgroundColor": "#FFFFFF",
			"pageData": []
		},
	},
	"switch_status": 1, ]
}