首页
产品
帮助文档
博客
控制台

白板服务接口

接口目录

创建白板

POST /board/api/create-board

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
board 白板信息 object
board.id 白板 ID string
board.create_time 创建时间 string
board.rw_token 有读写权限的 token string
board.r_token 只读权限的 token string

返回示例:

{
	"board": {
		"id": "17lok52y",
		"create_time": "1",
		"rw_token": "1",
		"r_token": "1"
	},
	"errcode": 1000
}

获取一页白板

GET /board/api/get-boards

URL 参数

参数 描述 取值
page 页数,默认 1 int
limit 每页个数,默认 15 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
boards 白板列表 object array
boards.id 白板 ID string
boards.create_time 创建时间 string
boards.rw_token 有读写权限的 token string
boards.r_token 只读权限的 token string
count 总个数 int

返回示例:

{
	"errcode": 1000,
	"boards": [
		{
			"id": "17lok52y",
			"create_time": "1",
			"rw_token": "1",
			"r_token": "1"
		}
	],
	"count": 33
}

获取白板

GET /board/api/get-board

URL 参数

参数 描述 取值
id 白板 ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
create_time 创建时间 string
options 用户白板操作 object array
options.board_id 白板 ID int
options.timestamp 创建时间 string
options.page 页码 int
options.data JSON 数据,描述该操作 string

返回示例:

{
	"errcode": 1000,
	"create_time": "2010-11-22 15:16:17 +0800 CST",
	"options": [
		{
			"board_id": 1,
			"timestamp": "1",
			"page": 1,
			"data": "1"
		}
	]
}

获取用户白板操作

GET /board/api/get-options

URL 参数

参数 描述 取值
id 白板 ID string
page 需要获取哪一页page,如果不填,返回所有的操作 int

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int
options 用户白板操作 object array
options.board_id 白板 ID int
options.timestamp 创建时间 string
options.page 页码 int
options.data JSON 数据,描述该操作 string

返回示例:

{
	"errcode": 1000,
	"options": [
		{
			"board_id": 1,
			"timestamp": "1",
			"page": 1,
			"data": "1"
		}
	]
}

删除白板

POST /board/api/delete-board

URL 参数

参数 描述 取值
id 白板 ID string

返回字段

参数 描述 取值
errcode 错误码,1000 为正常 int

返回示例:

{
	"errcode": 1000
}