每当有观众下单购买商品,您需调用 SendProductOrderMessage 接口,发送下单购买消息。观众可在聊天区域查看下单购买消息,点击消息中的立即购买,即可跳转至指定商品的详情页,从而提高商品成单率。
EnableStatus 的参数值设置为 1,上架商品卡片IsOrderMsgEnable 的参数值设置为 1,开启商品卡片的下单消息IsViewOrderEnable 的参数值设置为 1,开启下单购买消息。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SendProductOrderMessage | 接口名称。当前 API 的名称为 SendProductOrderMessage。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ActivityId | Long | 是 |
| 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
| ProductId | Long | 是 | 8****6 | 下单购买的商品对应的商品卡片 ID。您可通过调用 GetActivityProducts 接口获取 ID。 |
| UserName | String | 否 | 小王 | 展示在下单购买消息中的观众昵称。长度为 1 到 15 个字符。不传该参数或传空值,则默认为小*。 |
Amount | Integer | 否 |
| 本次下单的人数,默认值为
说明 企业直播服务端会每 5 秒统计并向观播端的聊天区推送一次当前下单的总人数。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true | 是否成功发送商品下单购买消息。成功返回 true。 |
POST https://livesaas.volcengineapi.com/?Action=SendProductOrderMessage&Version=2023-08-01 { "ActivityId": 177****9762, "ProductId": 8****6, "UserName": "小王", "Amount": 1 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "SendProductOrderMessage", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": true } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
| 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
| 403 | OperationDenied.ProductIsOrderMsgEnableInvalid | Operation is denied because product isOrderMsgEnable should be 1. | 下单购买消息发送失败,未开启商品卡片的下单消息。您可调用 UpdateActivityProduct 接口,将 IsOrderMsgEnable 的参数值设置为 1,开启商品卡片的下单消息。 |
| 403 | OperationDenied.EnableStatusInvalid | Operation is denied because product EnableStatus should be 1. | 下单购买消息发送失败,未上架商品卡片。您可调用 UpdateActivityProduct 接口,将 EnableStatus 的参数值设置为 1,上架商品卡片。 |
| 403 | OperationDenied.MenuInvalid | Operation is denied because product menu is not enabled, please enable it first. | 下单购买消息发送失败,未启用商品卡片菜单。您可调用 ModifyActivityMenus 接口,启用商品卡片菜单。 |
| 403 | OperationDenied.CommentConfigNotFound | Operation is denied because comment config is not found, please create or enable it first. | 下单购买消息发送失败,未启用聊天互动菜单。您可调用 ModifyActivityMenus 接口,启用聊天互动菜单。 |
| 403 | OperationDenied.IsViewOrderEnableInvalid | Operation is denied because comment config IsViewOrderEnable should be 1. | 下单购买消息发送失败,未开启下单购买消息。您可调用 UpdateActivityCommentConfig 接口,将 IsViewOrderEnable 的参数值设置为 1,开启下单购买消息。 |