Appearance
直播间商品讲解/取消讲解
请求路径
- 请求方式:
POST - 请求头:
Content-Type:application/json - 接口地址:
https://gateway.nuoyunapi.com/Api/RoomManager/Shop/explainGoods/2.0.0 - 频率限制:
10秒100次
请求参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| room_id | 是 | integer | 直播间ID |
| goods_id | 是 | integer | 商品ID |
| menu_id | 是 | integer | 自定义菜单ID |
| explain | 是 | integer | 操作类型:1-讲解,2-取消讲解 |
请求示例
开始讲解商品
json
{
"room_id": 509762586,
"goods_id": 174882,
"menu_id": 155247,
"explain": 1
}取消讲解商品
json
{
"room_id": 509762586,
"goods_id": 174882,
"menu_id": 155247,
"explain": 2
}响应参数
| 参数 | 必选 | 类型 | 描述 |
|---|---|---|---|
| code | 是 | integer | 状态码:200-成功,400-失败 |
| msg | 是 | string | 提示信息 |
| data | 是 | object | 响应数据 |
响应示例
成功响应
json
{
"code": 200,
"data": {},
"msg": "操作成功!"
}失败响应
json
{
"code": 400,
"msg": "商品不存在或不在该菜单中",
"data": {}
}返回值状态码说明
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 失败 |
功能说明
1. 讲解状态
- 讲解中 (
explain: 1):商品被标记为正在讲解,通常在直播间中会有特殊标识 - 未讲解 (
explain: 2):取消商品的讲解状态
2. 业务逻辑
- 同时只能讲解一个商品:设置新商品讲解时,会自动取消其他商品的讲解状态
- 讲解优先级:讲解中的商品通常在直播间中显示更突出
- 状态同步:讲解状态会实时同步到直播间界面
3. 使用场景
- 直播带货:主播讲解商品时标记当前讲解的商品
- 商品推广:突出展示重点推广的商品
- 互动营销:配合直播内容进行商品讲解
注意事项
- 权限验证:需要确保有操作该直播间的权限
- 商品存在性:商品必须已添加到指定菜单中
- 状态互斥:同一时间只能有一个商品处于讲解状态
- 实时同步:讲解状态变更会实时反映到直播间
- 菜单关联:操作只影响指定菜单中的商品
错误情况
| 错误信息 | 可能原因 | 解决方案 |
|---|---|---|
| 直播间不存在 | 直播间ID无效 | 检查直播间ID是否正确 |
| 商品不存在或不在该菜单中 | 商品ID无效或不在指定菜单 | 确认商品是否已添加到该菜单 |
| 权限不足 | 无操作权限 | 确认账号有直播间管理权限 |
| 菜单不存在 | 菜单ID无效 | 检查菜单ID是否正确 |
状态管理
讲解状态流转
未讲解 (explain: 2)
↓ 设置讲解
讲解中 (explain: 1)
↓ 取消讲解 或 设置其他商品讲解
未讲解 (explain: 2)与其他状态的关系
- 推荐状态:独立于讲解状态,可以同时设置
- 显示状态:商品必须是显示状态才能设置讲解
- 售卖状态:独立于讲解状态,但讲解通常用于售卖中的商品
相关接口
业务场景
- 直播带货:主播介绍商品时设置讲解状态
- 商品切换:从一个商品切换到另一个商品的讲解
- 重点推荐:突出显示当前重点推荐的商品
- 互动营销:配合抽奖、优惠等活动讲解商品
- 销售引导:引导观众关注特定商品
操作流程
开始讲解商品
1. 确认商品已添加到直播间菜单
↓
2. 调用接口设置讲解状态 (explain: 1)
↓
3. 系统自动取消其他商品的讲解状态
↓
4. 直播间界面更新,突出显示当前讲解商品取消讲解
1. 调用接口取消讲解 (explain: 2)
↓
2. 商品恢复普通显示状态
↓
3. 直播间界面更新最佳实践
- 及时更新:根据直播进度及时更新讲解状态
- 状态同步:确保讲解状态与直播内容同步
- 用户体验:避免频繁切换讲解状态影响观众体验
- 商品准备:讲解前确保商品信息完整准确
- 数据统计:记录讲解数据用于后续分析优化