删除敏感词--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

删除敏感词

最近更新时间：2023.11.08 09:30:20首次发布时间：2022.07.15 16:07:49

在指定直播间中删除敏感词。

注意事项

请求频率：单用户请求频率限制为 120 次/分钟。

请求说明

请求方式：POST
请求地址：https://livesaas.volcengineapi.com/?Action=DelActivityAntidirtAPI&Version=2020-06-01

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DelActivityAntidirtAPI`	接口名称。当前 API 的名称为 `DelActivityAntidirtAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。

Body

参数类型是否必选示例值描述

ActivityId Long 是 1772441830705 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

WordList Array of String 是 ["ab","abc"] 需要删除的敏感词。敏感词中不能包含逗号等特殊符号。

参数	类型	是否必选	示例值	描述
ActivityId	Long	是	`1772441830705`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
WordList	Array of String	是	`["ab","abc"]`	需要删除的敏感词。敏感词中不能包含逗号等特殊符号。
DeleteAll	Boolean	否	`true`	是否删除所有敏感词。 `true`：是 `false`：否

DeleteAll

Boolean

否

true

是否删除所有敏感词。

true：是
false：否

返回参数

参数类型示例值描述

参数	类型	示例值	描述
Status	Boolean	`true`	敏感词是否删除成功。 `true`：成功 `false`：失败

Status

Boolean

true

敏感词是否删除成功。

true：成功
false：失败

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=DelActivityAntidirtAPI&Version=2020-06-01
{
  "ActivityId": 1772441830705,
  "WordList": [
    "ab",
    "abc"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202206282037260102***",
    "Action": "DelActivityAntidirtAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1656419846
  },
  "Result": {
    "Status": true
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParameter.ActivityIDInvalid	The specified parameter ActivityID is invalid.	直播间 ID 不符合规范，请修改后重试
500	InternalError	The request has failed due to an unknown error.	请求处理过程中出现了未知错误，请联系技术支持获取帮助