简要描述:

  • 用户直播活动列表

访问权限

账号类型 是否有权限
主账号
子账号

接口URL:

http://api.zmengzhu.com/business/v1/video/listByKeyword

请求方式:

GET

返回结果格式:

JSON

参数:

参数名 是否必须 类型 默认值 说明
name string 0 搜索活动名称

返回示例:

响应成功JSON示例:

// 文字广告示例
{
	code: 200,
	msg: "ok",
	data: {
		list: [{
				id: "5194", //
				video_id: "2615", // 视频id
				group_id: "0", // 分组id
				uid: "12", // 用户id
				channel_id: "2049551", // 频道id
				ticket_id: "10002872",  // 活动id
				live_at: "1611284210",  // 直播开始时间
				duration: "0", // 时长
				weight: "0", // 权重
				is_record_mode: "1", // 是否为录播 0:否 1:是
				status: "0", // 直播状态 0:未直播 1:直播中 2:回放 3:断流中
				name: "233333333333", // 名称
				is_stick: "0", // 是否置顶 0:否 1:是
				introduction: "<p>3333</p>", // 简介
				is_display: "1", // 是否对外显示
				cover_url: "http://s1.dev.mengzhu.com/upload/img/12/37/1237aea68a6055f13f0db8fe995a2c03.jpeg", // 封面
				view_mode: "1", // 观看方式 1:免费 2:vip 3:付费 4:密码  5:白名单观看 6:F码观看
				created_at: "1611110833", // 创建时间
				live_type: "0", //类型 0:直播视频 1:直播语音 2:录播视频
				live_style: "0", //直播样式 0:横屏 1:竖屏
				popular: 10, // 活动人气
				real_uv: 2, // 真实uv
				real_pv: 4, // 真实pv
			},
		],
		total: "173",
	},
}

错误时返回:

{
    "code": 20001,
    "msg": "签名校验失败",
    "data": {}
}

菜单子参数示例:

参数名 示例值 类型 说明
name 聊天 string 菜单名称 如 聊天、互动、简介(或自定义填写的名称)
coee doc string 菜单代码标志,用来区分菜单功能 (功能代码见 菜单子参数代码标识)
data {'content':[]} object 菜单内容,不同功能菜单,内容格式不同 (详细见 菜单自参数内容示例)

菜单子参数代码标识

名称 功能说明
chat 聊天互动
summary 简介
rich_text 富文本
link 链接
rank 排行榜
component 组件
doc 文档
chapter 章节
answer 问答

菜单子参数内容

菜单功能代码标志 内容示例 说明
chat {"content":[]} 聊天功能系统默认, content内容为空
summary {"content":[],"is_enter_channel":1} 简介功能系统默认, content内容为空,使用互动的简介内容,is_enter_channel参数控制H5页面是否展示进入频道的入口,0:关闭入口 1:展示入口
rich_text {"content":["

第一行内容

第二行内容

"]}
富文本菜单,content数组内容首个元素为 文本内容
link {"content":["https://www.xx.com"]} 自定义链接菜单 content数组首个元素 为链接地址
rank {"content":["reward","invite","share"]} 排行榜菜单,控制H5页面展示排行榜单 reward:打赏榜,invite:邀约榜,share:分享榜
component {"content":["webinar","external-link","invite-data"]} 系统组件功能 webinar:展示活动, external-link:展示外链, invite-data:展示我的频道数据
doc {"content":[]} 文档菜单, content内容为空,H5页面展示活动关联文档内容
chapter {"content":[]} 章节菜单, content内容为空, H5页面展示活动设置的章节内容
answer {"content":[]} 问答菜单, content内容为空, H5页面展示活动设置的问答内容