第三方应用开发 服务端API 效率工具 直播 创建预约直播
创建预约直播

请求方式: POST(HTTPS
请求地址: https://qyapi.weixin.qq.com/cgi-bin/living/create?access_token=ACCESS_TOKEN

请求包体:

{
   "anchor_userid": "zhangsan",
   "theme": "theme",
   "living_start": 1600000000,
   "living_duration": 3600,
   "description": "test description",
   "type": 4,
   "agentid" : 1000014,
   "remind_time": 60,
   "activity_cover_mediaid": "MEDIA_ID",
   "activity_share_mediaid": "MEDIA_ID",
   "activity_detail":
   {
       "description": "活动描述,非活动类型的直播不用传",
       "image_list": [
            "MEDIA_ID_1",
			"MEDIA_ID_2"
       ]
   }
}

参数说明:

参数必须说明
access_token调用接口凭证。获取方法查看“获取access_token
anchor_userid直播发起者的userid
theme直播的标题,最多支持60个字节
living_start直播开始时间的unix时间戳
living_duration直播持续时长
type直播的类型,0:通用直播,1:小班课,2:大班课,3:企业培训,4:活动直播,默认 0。其中大班课和小班课仅k12学校和IT行业类型能够发起
description直播的简介,最多支持300个字节,仅对“通用直播”、“小班课”、“大班课”和“企业培训”生效,“活动直播”简介通过activity_detail.description控制
agentid授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数
remind_time指定直播开始前多久提醒用户,相对于living_start前的秒数,默认为0
activity_cover_mediaid活动直播特定参数,直播间封面图的mediaId
activity_share_mediaid活动直播特定参数,直播分享卡片图的mediaId
activity_detail活动直播特定参数,活动直播详情信息
activity_detail.description活动直播特定参数,活动直播简介
activity_detail.image_list活动直播特定参数,活动直播附图的mediaId列表,最多支持传5张,超过五张取前五张

权限说明:

  • 发起人必须在应用可见范围内,「上课直播/直播」应用默认全员可见
  • 系统应用「上课直播/直播」默认可使用直播接口
  • 自建应用需要配置在“可调用接口的应用”里
  • 第三方服务商创建应用的时候,需要开启“直播接口权限”

返回结果:

{
   "errcode": 0,
   "errmsg": "ok",
   "livingid": "XXXXXXXXX"
}

参数说明:

参数说明
errcode返回码
errmsg对返回码的文本描述内容
livingid直播id,通过此id可调用“进入直播”接口(包括小程序接口JS-SDK接口),以实现主播到点后的开播操作,以及观众进入直播详情预约和观看直播
上一篇
概述
下一篇
修改预约直播