# 创建直播
|拥有此API的权限集|
|:----- |
|直播管理-直播操作|
**请求方式及url**
- 请求方式： `POST`
- 请求头：`Content-Type:application/json`
- 接口地址： `https://api.xiaoe-tech.com/xe.alive.live.create/1.0.0`
- 频率限制：`1秒1次`
{%
api
method="POST",
data={
"access_token" : "xxxxxxxx",
"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
}]
},
url="https://api-doc.xiaoe-tech.com/_agent/forward?url=https://api.xiaoe-tech.com/xe.alive.live.create/1.0.0" %}
{% endapi %}
**请求参数**
|参数名|必选|类型|说明|备注（示例）
|:---- |:---|:----- |:----- |----|
|access_token |是 |string | [专属token](./../get_access_token.md) |`...`|
|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"
}
}
```
- 开发前必读
- 小鹅云介绍
- 更新日志
- 开始开发
- 开发指南
- 创建并授权应用
- 获取access_token（含代码示例）
- 开通接口权限
- 全局返回码
- 常用工具
- 日志排查工具
- 场景方案
- 同步用户场景
- 同步商品场景
- 同步订购关系场景
- 同步积分场景
- 同步页面统计场景
- 同步学习数据场景
- 同步推广员场景
- 内嵌SDK服务场景
- 产品介绍
- 产品简介
- 客户案例
- 接入流程
- 业务文档
- 账号打通
- 支付
- 直播带货
- 商品同步
- 订单同步
- 学习数据同步
- 企业内训
- PCweb
- H5web
- 流量变现
- App分享
- 微页面装修
- 直播连麦
- 技术文档
- 小鹅通SDK开发者声明
- 小鹅通SDK个人信息保护政策(2022年9月28日生效)
- 小鹅通SDK个人信息保护政策(2022年9月28日失效)
- 开发指南
- 原生SDK登录态
- Android-SDK 接入
- iOS-SDK 接入
- WebSDK接入
- 小程序接入
- 小程序支付接入
- 代币支付签名算法
- SDK&H5账号详解
- 发布日志（iOS）
- 发布日志（Android）
- 常见问题
- 消息推送
- 使用说明
- 消息加/解密
- 消息接收URL校验说明
- 订单状态推送
- 用户手机号变更推送
- 用户状态变更推送
- 积分变更消息推送
- 商品变更推送
- 考试消息推送
- 活动签到推送
- 订单支付推送
- 账号合并推送
- 用户注册推送
- 优惠券消息推送
- 信息采集推送
- 权益变更推送
- 用户标签变更消息推送
- API列表
- 获取access_token（含代码示例）
- 用户管理
- 使用说明
- 注册新用户
- 更新用户信息
- 获取用户列表2.0
- 获取用户列表1.0
- 查询单个用户信息
- 批量查询用户信息
- 获取用户消费信息
- 获取课程学员列表
- 获取训练营pro学员列表
- 获取会员卡用户信息
- 查询单个用户标签列表
- 查询用户合并记录
- 获取标签列表
- 添加/修改标签
- 添加/修改用户标签
- 获取用户反馈列表
- 获取用户反馈回复列表
- 回复用户反馈
- 学习数据管理
- 获取学习记录列表
- 获取每日学习记录
- 获取指定资源学习记录信息
- 获取营期下用户的学习情况
- 获取训练营pro学员任务详情
- 直播管理
- 获取直播列表
- 批量查询指定直播间列表信息
- 获取班课列表
- 获取签到列表
- 获取签到学员列表
- 获取直播红包列表
- 获取红包领取记录
- 获取直播数据概览
- 获取直播详情
- 获取直播详情2.0
- 获取红包数据概况
- 获取直播间讨论区消息列表
- 获取直播间多段推流记录
- 创建直播
- 编辑直播
- 上架/下架直播
- 删除直播
- 获取直播间用户列表
- 商品管理
- 查询商品列表2.0
- 查询商品列表1.0
- 查询组合课资源列表4.0
- 查询组合课资源列表3.0
- 获取训练营营期任务
- 商品详情2.0
- 商品详情1.0
- 获取课程关联的助学工具
- 获取直播带货商品列表
- 获取实物商品评论列表
- 商品增加库存
- 商品减少库存
- 新建实物商品
- 编辑实物商品
- 删除实物商品
- 获取实物商品类目列表
- 获取C端搜索商品列表
- 商品分组管理
- 获取店铺商品分组列表
- 获取商品分组内商品列表
- 批量新建/更新商品分组
- 删除商品分组
- 素材管理
- 获取素材列表
- 获取素材分组列表
- 素材分组编辑
- 素材分组移动
- 素材分组删除
- 订单管理
- 获取订单列表2.0
- 获取订单详情2.0
- 获取订单列表1.1
- 获取订单列表1.0
- 查询用户订单列表
- 获取订单详情
- 获取买赠订单信息
- 待付款订单改价
- 获取售后订单列表
- 获取售后订单详情
- 订单退款
- 订购管理
- 用户开通产品包权益2.0
- 用户开通产品包权益
- 查询用户订购资源列表
- 用户购买关系查询
- 查询用户资源权益2.0
- 查询用户资源权益1.0
- 取消订购
- 批量开通用户产品包权益-创建任务
- 批量开通用户产品包权益-查询任务列表
- 批量开通用户产品包权益-查询任务详情
- 物流管理
- 普通实物单发货(即将下线)
- 获取物流公司信息列表
- 订单全部商品发货
- 订单部分商品发货
- 修改已发货订单的物流信息
- 获取运费模板列表
- 推广员管理
- 查询推广员列表
- 查询推广员客户列表
- 查询推广员的下级推广员列表
- 查询指定推广员的信息
- 查询客户所属推广员
- 查询推广员名下新增/过期客户
- 新增推广员
- 推广员绑定客户
- 修改/解除绑定关系
- 设置推广员上级
- 推广订单详情
- 按日期查询推广员的收益和新增加的下级
- 推广订单详情(支持购物车订单返回多条记录)
- 信息采集管理
- 获取信息采集列表
- 获取单个信息采集结果
- 获取用户信息采集结果
- 根据表单ID以及用户ID获取信息采集结果
- 营销码券管理
- 优惠券列表
- 获取优惠券详情2.0
- 获取优惠券详情
- 获取优惠券领券用户
- 发放优惠券2.0
- 发放优惠券
- 优惠券核销
- 获取优惠码列表
- 获取优惠码码库列表
- 获取优惠码效果数据
- 创建优惠码
- 优惠码添加库存
- 优惠码失效
- 编辑优惠码
- 优惠码删除
- 获取兑换码码库列表
- 追加兑换码库存
- 创建兑换码
- 编辑兑换码
- 兑换码失效
- 用户使用兑换码
- 获取兑换码批次列表
- 作废单个兑换码
- 积分管理
- 查询用户积分日志
- 获取单个用户积分信息
- 批量获取用户积分列表
- 获取店铺积分信息
- 批量发放积分
- 批量扣减积分
- 解冻冻结积分
- 设置店铺积分过期时间
- 业务类型说明
- 页面统计管理
- 新建页面统计
- 编辑页面统计
- 获取页面统计列表
- 获取页面统计详情
- 获取页面统计订单列表
- 新建投放渠道
- 获取投放渠道列表
- 打卡管理
- 获取打卡列表
- 获取打卡参与用户
- 获取指定学员活动日记列表
- 获取活动点赞列表
- 获取指定学员被点赞总数和列表
- 获取用户日记被点评/评论列表
- 获取指定打卡的作业列表
- 获取学员的打卡日记列表
- 获取打卡关联的课程信息
- 练习管理
- 获取练习基本信息列表
- 获取练习结果列表
- 获取练习详情
- 获取学员练习答题详情
- 作业管理
- 获取作业本列表
- 获取作业基本信息列表
- 获取作业结果列表
- 获取作业详情
- 获取学员作业答题详情
- 圈子管理
- 获取用户参与的圈子
- 考试管理
- 获取考试列表
- 获取考试详情
- 获取考试结果列表信息
- 获取考试结果详细信息
- 活动管理
- 获取活动列表
- 获取签到列表
- 获取活动报名列表
- 获取活动签到信息
- 组织管理
- 获取员工列表
- 获取员工详细信息
- 添加或者保存员工信息
- 启用员工
- 停用员工
- 删除员工
- 根据员工账号获取用户ID
- 获取组织结构树
- 添加或修改组织架构
- 移除组织架构
- 微页面管理
- 获取微页面列表
- 企学院专用(不对外开放)
- 学员管理（限企学院）
- 企学院获取学员列表
- 企学院添加学员
- 企学院修改学员
- 企学院删除学员
- 企学院添加组织架构
- 企学院删除组织架构
- 企学院编辑组织架构
- 企学院获取组织架构
- 企学院获取部门信息
- 活动管理（限企学院）
- 企学院用户签到活动列表
- 培训计划管理（限企学院）
- 获取培训计划列表
- 获取培训计划详情
- 获取用户培训学习数据
- 获取员工的培训计划列表
- 常见问题
- 问题汇总
- 问题反馈