请求方式: 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 | 是 | 直播的标题,最多支持20个utf8字符 |
living_start | 是 | 直播开始时间的unix时间戳 |
living_duration | 是 | 直播持续时长 |
type | 否 | 直播的类型,0:通用直播,1:小班课,2:大班课,3:企业培训,4:活动直播,默认 0。其中大班课和小班课仅k12学校和IT行业类型能够发起 |
description | 否 | 直播的简介,最多支持100个utf8字符,仅对“通用直播”、“小班课”、“大班课”和“企业培训”生效,“活动直播”简介通过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"
}
参数说明: