调用 DeleteVipOrBlackListUserInfo，在直播间内删除红包中指定的优先中奖名单或中奖黑名单用户信息。
请求频率：单用户请求频率限制为 10 次/秒。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | DeleteVipOrBlackListUserInfo | 接口名称。当前 API 的名称为 DeleteVipOrBlackListUserInfo。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ActivityId | Long | 是 | 182519****981916 | 直播间 ID。您可通过调用 ListActivityAPI 接口获取 ID。 |
| Id | Long | 是 | 162****123 | 优先中奖名单 ID 或中奖黑名单 ID。您可调用 CreateVipOrBlackListUserInfo 接口，通过返回参数的 VipUserInfoId 或 BlackUserInfoId 获取 ID。 |
DeleteAll | Integer | 否 |
| 是否删除名单中的全部用户信息。默认值为
说明 如果不传 |
DeleteUserList | Array of DeleteUserList | 否 |
| 名单中待删除的用户信息。单次接口调用最多支持删除 2100 条用户信息。 说明 当 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| UserId | String | 否 | 172739****031831 | 用户 ID。 |
| UserName | String | 否 | 观众 A | 昵称。 |
| UserTel | String | 否 | 156****1234 | 手机号。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Integer | 1 | 是否成功删除用户信息。成功返回 1。 |
POST https://livesaas.volcengineapi.com/?Action=DeleteVipOrBlackListUserInfo&Version=2023-08-01 { "DeleteAll": 0, "ActivityId": 182519****981916, "Id": 162****123, "DeleteUserList": [ { "UserId": "172739****031831", "UserName": "观众 A", "UserTel": "156****1234" } ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DeleteVipOrBlackListUserInfo", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "Status": 1 } }