查询敏感词--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

查询敏感词

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

获取指定直播间配置的敏感词列表。支持输入关键字，查询包含关键字的敏感词或查询所有敏感词。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetActivityAntidirtAPI`	接口名称。当前 API 的名称为 `GetActivityAntidirtAPI`。
Version	String	是	`2020-06-01`	接口版本。当前 API 的版本为 `2020-06-01`。
ActivityId	Long	是	`1772441830705`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。
PageNo	Integer	是	`1`	分页查询页码。
PageItemCount	Integer	是	`10`	分页查询数量。
Content	String	否	`a`	查询的关键字。

返回参数

参数类型示例值描述

参数	类型	示例值	描述
EnablePhoneNumberFilter	Integer	`2`	是否开启屏蔽手机号。 `1`：开启。包含手机号的评论仅发送评论的观众可见。 `其它值`：关闭
TotalItemCount	Integer	`2`	查询到的敏感词总数。
WordList	Array of String	`["ab","abc"]`	查询到的敏感词列表。

EnablePhoneNumberFilter

Integer

2

是否开启屏蔽手机号。

1：开启。包含手机号的评论仅发送评论的观众可见。
其它值：关闭

TotalItemCount Integer 2 查询到的敏感词总数。

WordList Array of String ["ab","abc"] 查询到的敏感词列表。

示例

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetActivityAntidirtAPI&Version=2020-06-01&ActivityId=1772441830705&Content=a&PageItemCount=10&PageNo=1

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20220628203726010212037230061530AF",
    "Action": "GetActivityAntidirtAPI",
    "Version": "2020-06-01",
    "Service": "livesaas",
    "Region": "cn-north-1",
    "SystemTime": 1691380250
  },
  "Result": {
    "WordList": [
      "ab",
      "abc"
    ],
    "TotalItemCount": 2,
    "EnablePhoneNumberFilter": 2
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidParamete.ActivityIDInvalid	The specified parameter ActivityID is invalid.	直播间 ID 不符合规范，请修改后重试。
400	InvalidParameter.PageItemCountInvalid	The specified parameter PageItemCount is invalid.	`PageItemCount` 参数不符合规范，请修改后重试。
400	InvalidParameter.PageNoInvalid	The specified parameter PageNo is invalid.	`PageNo` 参数不符合规范，请修改后重试。