Appearance

创建直播 ​

拥有此API的权限集
直播管理-增删改

请求方式及url ​

  • 请求方式： POST
  • 请求头：Content-Type:application/json
  • 接口地址： https://api.xiaoe-tech.com/xe.alive.live.create/1.0.0
  • 频率限制：1秒1次

接口调试

请求参数
响应结果
暂无响应数据

请求参数 ​

参数名必选类型说明备注（示例）
access_token是string专属token...
resource_info是object资源信息...
module_info否object配置信息...
goods_info是object商品信息...
relation_info否object关联课程信息...
role_info否object讲师信息...

资源信息resource_info

参数名必选类型说明备注（示例）
title是string直播标题（字符长度必须小于45）...
summary否string直播简介（字符长度必须小于256，默认为空）...
descrb否string直播详情（仅允许纯文本，不得超过5000个字符，默认为空）...
alive_type否int直播类型：0-语音，1-录播直播，2-推流直播（默认为0-语音直播）0
zb_start_at是string预设直播开始时间（距离当前时间不能超过五年）2023-05-31 18:00:00
zb_stop_at是int预设直播时长，单位：秒（距离预设直播开始时间不能超过十年）3600
img_material_id否string详情封面图素材ID（不传则为B端默认详情封面图，图片大小不能超过5MB）...
alive_img_material_id否string宣传封面图素材ID（不传则为B端默认宣传图，图片大小不能超过5MB）...
aliveroom_img_material_id否string暖场图素材ID（当module_info.warm_up=1时有效，不传则为B端默认暖场图，图片大小不能超过5MB）...
warm_up_video_material_id否string暖场视频素材ID（当module_info.warm_up=2时必填，否则该字段无效，视频大小不能超过5GB）...
alive_video_material_id否string录播视频素材ID（当resource_info.alive_type=1时必填，否则该字段无效，视频大小不能超过5GB）...
ios_applet_desc否object苹果端小程序信息调整（在ios微信小程序展示该直播时，会被替换为下面的信息）...
ios_applet_desc.title否string直播标题（字符长度必须小于45，默认为空）...
ios_applet_desc.summary否string直播简介（字符长度必须小于45，默认为空）...
ios_applet_desc.descrb否string直播详情（仅允许纯文本，不得超过5000个字符，默认为空）...
ios_applet_desc.state否int显示设置：0-在苹果小程序内显示该直播，1-在苹果小程序内不显示（默认为0-在苹果小程序内显示该直播）...
ios_applet_desc.img_material_id否string直播封面图素材ID（不传则为B端默认详情封面图，图片大小不能超过5MB）...
ios_applet_desc.alive_img_material_id否string宣传封面图素材ID（不传则为B端默认宣传图，图片大小不能超过5MB）...

配置信息module_info

参数名必选类型说明备注（示例）
is_lookback否int是否开启回放：0-开启，1-关闭（默认为0-开启）0
play_fast_state_switch否int回放是否允许倍速播放或快进：0-允许，1-禁止（默认为0-允许）0
alive_mode否int直播模式：0-横屏直播，1-竖屏直播（默认为0-横屏直播）0
expire_type否int回放有效期设置：1-永久，2-限时（默认为1-永久）1
expire否string回放过期时间（当expire_type=2时必填）2023-06-30
warm_up否int暖场设置：1-暖场图，2-暖场视频（默认为1-暖场图）1
is_open_complete_time否int是否开启完成条件：0-关闭，1-开启（默认为0-关闭）0
complete_time否int设置最短学习时间（单位：分钟，当module_info.is_open_complete_time=1时必填，否则该字段无效，且最大不能超过300）...
is_contact_on否int是否开启联系学员：0-关闭，1-开启（默认为0-关闭）...

商品信息goods_info

参数名必选类型说明备注（示例）
sale_type是int售卖类型：1-单独售卖、2-关联售卖``
payment_type是int支付类型：1-免费，2-收费，3-加密，4-指定学员可用，5-仅关联上级资源，仅当goods_info.sale_type=2时才可用...
piece_price否int价格（单位：分，当payment_type=2时必填，否则该字段无效）0
line_price否int划线价格（单位：分，当payment_type=2时才可用，否则该字段无效，默认为0）0
resource_password否string密码（goods_info.payemnt_type为3时必填，否则该字段无效）...
recycle_bin_state否int上下架：1-下架，0-上架（默认为0-上架）0
start_at否string定时上架时间（当recycle_bin_state=0且该字段有值时，为定时上架，默认为空2023-05-31 17:19:26
is_stop_sell否int是否停售：0-否，1-是（默认为0-否）0
goods_sn否string商品编码（字符长度不能超过64，默认为空）...
state否int商品状态：0-可见，1-隐藏（默认为0-可见）0

关联课程relation_info

参数名必选类型说明备注（示例）
package否array关联课程id列表（当goods_info.sale_type=2时必填，否则该字段无效）...

讲师信息列表role_info

参数名必选类型说明备注（示例）
role_name否string自定义身份标签（1-10个字符，当需要添加讲师时为必填）讲师
user_id否string用户id（当需要添加讲师时为必填）u_6688888888889999999
is_can_exceptional否int是否接受打赏：1-接受打赏，0-不接受打赏（默认为0-不接受打赏）...

请求示例 ​

{
   "access_token":"xxxxxxx",
   "resource_info": {
       "title": "直播名称",
       "summary": "直播简介",
       "descrb": "直播详情",
       "alive_type": 2,
       "zb_start_at": "2023-05-31 18:00:00",
       "zb_stop_at": 3600,
       "img_material_id": "",
       "alive_img_material_id": "",
       "aliveroom_img_material_id": "",
       "warm_up_video_material_id": "",
       "alive_video_material_id": "",
       "ios_applet_desc": {
           "title": "",
           "summary": "",
           "descrb": "",
           "state": 0,
           "img_material_id": "",
           "alive_img_material_id": ""
       }
   },
   "module_info": {
       "is_lookback": 1, 
       "play_fast_state_switch": 0, 
       "alive_mode": 0, 
       "expire_type": 2, 
       "expire": "2023-06-30",
       "warm_up": 1, 
       "is_open_complete_time": 1, 
       "complete_time": 33, 
       "is_contact_on": 0 
   },
   "goods_info": {
       "sale_type": 1,
       "payment_type": 1, 
       "piece_price": 0,
       "line_price": 0,
       "resource_password": "",
       "recycle_bin_state": 0, 
       "start_at": "2023-05-31 17:19:26",
       "is_stop_sell": 1, 
       "goods_sn": "",
       "state": 1 
   },
   "role_info": [{
       "role_name": "讲师", 
       "user_id": "u_6688888888889999999", 
       "is_can_exceptional": 1 
   }]
}

返回参数说明 ​

参数名必选类型说明备注（示例）
code是int业务返回码0
msg是string提示信息ok
data.id是string直播id...

返回示例 ​

{
   "code": 0,
   "msg": "ok",
   "data": {
       "id": "l_649ce91de4b064a81xxxxxx"
   }
}