创建预约直播

POST

http://127.0.0.1/cgi-bin/living/create

第三方应用开发/效率工具/直播

最后修改时间：2022-08-30 03:03:37

责任人：未设置

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

文档ID: 25240
原文档地址：
https://open.work.weixin.qq.com/api/doc/90001/90143/93717
https://open.work.weixin.qq.com/api/doc/90000/90135/93637

请求参数

Query 参数

access_token

string

调用接口凭证

必需

示例值:

Body 参数application/json

agentid

integer <int32>

可选

授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数

remind_time

integer <int32>

可选

指定直播开始前多久提醒用户，相对于living_start前的秒数，默认为0

activity_cover_mediaid

string

可选

活动直播特定参数，直播间封面图的mediaId

living_start

integer <int32>

必需

直播开始时间的unix时间戳

description

string

可选

直播的简介，最多支持300个字节，仅对“通用直播”、“小班课”、“大班课”和“企业培训”生效，“活动直播”简介通过activity_detail.description控制

activity_detail

object

可选

活动直播特定参数，活动直播详情信息

description

string

可选

活动直播特定参数，活动直播简介

image_list

array[string]

可选

活动直播特定参数，活动直播附图的mediaId列表，最多支持传5张，超过五张取前五张

theme

string

必需

直播的标题，最多支持60个字节

activity_share_mediaid

string

可选

活动直播特定参数，直播分享卡片图的mediaId

type

integer <int32>

可选

直播的类型，0：通用直播，1：小班课，2：大班课，3：企业培训，4：活动直播，默认 0。其中大班课和小班课仅k12学校和IT行业类型能够发起

anchor_userid

string

必需

直播发起者的userid

living_duration

integer <int32>

直播持续时长

必需

示例

{
  "anchor_userid": "zhangsan",
  "theme": "theme",
  "living_start": 1600000000,
  "living_duration": 3600,
  "description": "testdescription",
  "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"
    ]
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'http://127.0.0.1/cgi-bin/living/create?access_token={{accesstoken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "anchor_userid": "zhangsan",
    "theme": "theme",
    "living_start": 1600000000,
    "living_duration": 3600,
    "description": "testdescription",
    "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"
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

errcode

integer <int32>

返回码

可选

livingid

string

可选

直播id，通过此id可调用“进入直播”接口(包括小程序接口和JS-SDK接口)，以实现主播到点后的开播操作，以及观众进入直播详情预约和观看直播

errmsg

string

可选

对返回码的文本描述内容

示例

{
  "errcode": 0,
  "livingid": "string",
  "errmsg": "string"
}

修改于 2022-08-30 03:03:37

获取会议详情

修改预约直播