You need to enable JavaScript to run this app.
导航
发送商品下单购买消息
最近更新时间:2025.01.03 10:57:39首次发布时间:2025.01.03 10:57:39

每当有观众下单购买商品,您需调用 SendProductOrderMessage 接口,发送下单购买消息。观众可在聊天区域查看下单购买消息,点击消息中的立即购买,即可跳转至指定商品的详情页,从而提高商品成单率。

注意事项

  • 请求频率:单用户请求频率限制为 100 次/秒
  • 前提条件
    • 调用 ModifyActivityMenus 接口,启用商品卡片和聊天互动菜单。
    • 调用 UpdateActivityProduct 接口,完成以下配置:
      • EnableStatus 的参数值设置为 1,上架商品卡片
      • IsOrderMsgEnable 的参数值设置为 1,开启商品卡片的下单消息
    • 调用 UpdateActivityCommentConfig 接口,将 IsViewOrderEnable 的参数值设置为 1,开启下单购买消息。
  • 使用限制:目前仅支持在移动端发送商品下单购买消息。

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=SendProductOrderMessage&Version=2023-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringSendProductOrderMessage接口名称。当前 API 的名称为 SendProductOrderMessage
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述
ActivityIdLong177****9762直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。
ProductIdLong8****6下单购买的商品对应的商品卡片 ID。您可通过调用 GetActivityProducts 接口获取 ID。
UserNameString小王展示在下单购买消息中的观众昵称。长度为 1 到 15 个字符。不传该参数或传空值,则默认为小*

返回参数

参数类型示例值描述
StatusBooleantrue是否成功发送商品下单购买消息。成功返回 true

请求示例

POST https://livesaas.volcengineapi.com/?Action=SendProductOrderMessage&Version=2023-08-01
{
    "ActivityId": 177****9762,
    "ProductId": 8****6,
    "UserName": "小王"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "SendProductOrderMessage",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true
    }
}

错误码

下表提供了该接口特有的错误码,公共错误码请参见公共错误码错误码文档。

状态码错误码错误信息说明
403OperationDenied.ProductIsOrderMsgEnableInvalidOperation is denied because product isOrderMsgEnable should be 1.下单购买消息发送失败,未开启商品卡片的下单消息。您可调用 UpdateActivityProduct 接口,将 IsOrderMsgEnable 的参数值设置为 1,开启商品卡片的下单消息。
403OperationDenied.EnableStatusInvalidOperation is denied because product EnableStatus should be 1.下单购买消息发送失败,未上架商品卡片。您可调用 UpdateActivityProduct 接口,将 EnableStatus 的参数值设置为 1,上架商品卡片。
403OperationDenied.MenuInvalidOperation is denied because product menu is not enabled, please enable it first.下单购买消息发送失败,未启用商品卡片菜单。您可调用 ModifyActivityMenus 接口,启用商品卡片菜单。
403OperationDenied.CommentConfigNotFoundOperation is denied because comment config is not found, please create or enable it first.下单购买消息发送失败,未启用聊天互动菜单。您可调用 ModifyActivityMenus 接口,启用聊天互动菜单。
403OperationDenied.IsViewOrderEnableInvalidOperation is denied because comment config IsViewOrderEnable should be 1.下单购买消息发送失败,未开启下单购买消息。您可调用 UpdateActivityCommentConfig 接口,将 IsViewOrderEnable 的参数值设置为 1,开启下单购买消息。