文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 智能质检/ 敏感词管理接口 (sensitiveWordManage)/ 取得敏感词列表
更新时间：2024-09-24 GMT+08:00
查看PDF
分享

取得敏感词列表

场景描述

取得敏感词列表的接口。

接口方法

POST

接口URI

https://域名/apiaccess/CCSQM/rest/ccisqm/v1/sensitiveWordManage/querySensitiveWordList，例如域名是service.besclouds.com

请求说明

表1 请求头参数

序号

名称

参数类型

是否必选

说明

1

Content-Type

string

False

固定填 application/json; charset=UTF-8。

2

x-app-key

string

False

appKey标识

3

Authorization

string

True

鉴权字段，内容格式为: Bearer +tokenByAKSK接口的返回值中AccessToken（Bearer后有空格）

4

x-UserId

string

False

操作员标识

可在登录后，进入员工管理页面，查看接口返回的userId
表2 请求体参数

序号

名称

参数类型

是否必选

说明

1.1

page

number

True

页码

1.2

limit

number

True

每页数量

  • 取值范围：5, 10, 20, 50， 100

1.3

keyword

string

False

敏感词名称的关键字

响应说明

  • 响应状态码: 200
表3 响应体参数

序号

名称

参数类型

是否必选

说明

1.1

paging

object

False

分页信息对象

1.1.1

total

number

False

查询结果总数

1.2

data

array[object]

False

查询结果记录

1.2.1

sw_id

string

False

敏感词唯一标识

1.2.2

sw_name

string

False

敏感词名称

1.2.3

category_id

string

False

敏感词分类的唯一标识

1.3

resultCode

string

False

返回码

  • 0401000 表示成功
  • 其他表示失败

1.4

resultDesc

string

False

返回描述
  • 响应状态码: 400

    错误的请求：请检查请求路径及参数。

  • 响应状态码: 401

    未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。

  • 响应状态码: 404

    请求的路径未找到：请检查请求的路径。

  • 响应状态码: 500

    业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

  • 场景描述：取得敏感词列表的接口。

    请求头:

    x-app-key:************************************  
X-UserID:1611917095665261978  
Authorization:Bearer ********************************

    请求参数:

    {
	"page": 1,
	"limit": 10,
        "keyword":"更改"
}

    响应参数:

    {
    "data": [
        {
            "category_id": "1065038086678777856",
            "sw_id": "1067229455178534912",
            "sw_name": "更改敏感词名称766"
        },
        {
            "category_id": "1071491122737451008",
            "sw_id": "1071495709510864896",
            "sw_name": "更改敏感词名称131"
        }
    ],
    "resultCode": "0401000",
    "paging": {
        "total": 2
    },
    "resultDesc": "操作成功"
}

相关文档