更新商品卡片配置

更新直播间商品卡片菜单的配置信息。

通过本接口的 Product 参数，您可以新增、更新和删除卡片。

• 新增卡片：在请求参数中不传 Id 参数或传入 Id 参数且取值为 0 ，即可新增卡片。
• 更新卡片：在请求参数中传入待更新卡片的 ID 作为 Id 参数值并按需更新卡片的配置信息，即可更新该卡片。为保证卡片配置信息的参数值不被清空或替换为默认值，即便参数在该接口中为非必选，只要您有自定义的需求，就必须传入对应的参数值。

  说明

  仅可以更新当前菜单中已有的卡片。

• 删除卡片：在请求参数中不传已有卡片的 ID，即可删除该卡片。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。

请求说明

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

请求参数

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

Query

Body

ProductConfig

UAInfo

Product

UAInfos

Products

返回参数

ProductConfigResponse

UAInfoResponse

ProductResponse

UAInfosResponse

ProductsResponse

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateActivityProduct&Version=2023-08-01
{
  "ActivityId": 1776085489138,
  "VerticalIconUrl": "https//p.byted.org/6ed59yyum2-z75.png",
  "ProductConfig": {
    "MenuName": "商品卡片",
    "Product": {
      "Products": [
        {
          "Title": "卡片标题",
          "Index": 0,
          "RedirectUrl": "https://example.com",
          "Remark": "备注信息",
          "Strikethrough": "划线文字",
          "Id": 105472,
          "EnableStatus": 1,
          "MiniAppDirectUrl": "https://example.com",
          "Highlight": "卡片高亮文案",
          "IntroduceImage": "https://example.com",
          "RedirectImage": "https://example.com",
          "DirectUrls": [
            "https://example.com",
            "https://example2.com"
          ]
        }
      ]
    },
    "Id": 780,
    "EnableFloating": true,
    "ProductsPosition": 0,
    "EnableUA": true,
    "EnableMiniApp": true,
    "DisplayEnable": 1,
    "MiniAppId": "dsdwsd",
    "DefaultRedirectImage": "https://example/MenuBar",
    "UAInfo": {
      "UAInfos": [
        {
          "UAName": "微信",
          "UAAddress": "MicroMessenger"
        }
      ]
    }
  }
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "UpdateActivityProduct",
    "Version": "2023-08-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656067132
  },
  "Result": {
    "ProductConfig": {
      "MenuName": "商品卡片",
      "Product": {
        "Products": [
          {
            "DirectUrls": [
              "https://example.com",
              "https://example2.com"
            ],
            "ExplainTime": 0,
            "RedirectImage": "https://example.com",
            "Highlight": "卡片高亮文案",
            "Id": 105472,
            "ExplainStatus": 0,
            "FloatingStatus": 1,
            "PageAdvertisementType": 4,
            "RedirectUrl": "https://example.com",
            "Strikethrough": "划线文字",
            "Remark": "备注信息",
            "Index": 0,
            "IntroduceImage": "https://example.com",
            "Title": "卡片标题",
            "EnableStatus": 1,
            "MiniAppDirectUrl": "https://example.com"
          }
        ]
      },
      "DefaultRedirectImage": "https://example/MenuBar",
      "EnableMiniApp": true,
      "UAInfo": {
        "UAInfos": [
          {
            "UAName": "微信",
            "UAAddress": "MicroMessenger"
          }
        ]
      },
      "EnableFloating": true,
      "EnableUA": true,
      "DisplayEnable": 1,
      "Id": 780,
      "MiniAppId": "dsdwsd",
      "ProductsPosition": 0
    },
    "VerticalIconUrl": "https://p.byted.org/6ed59yyum2-z75.png"
  }
}

错误码

访问公共错误码和错误码获取详细信息。