更新时间:2024-09-24 GMT+08:00
分享

查询所有业务场景

场景描述

查询所有业务场景的接口。

接口方法

POST

接口URI

https://域名/apiaccess/CCSQM/rest/ccisqm/v1/scenariomanage/queryAllScenario,例如域名是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

limit

number

True

每页查询总数

1.2

page

number

True

查询页数

1.3

scenarioName

string

False

业务场景名称

1.4

scenarioStatus

string

False

是否正在被启用(0 代表不启用,1 代表启用)

1.5

startTime

string

False

创建开始时间

1.6

endTime

string

False

创建结束时间

响应说明

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

序号

名称

参数类型

是否必选

说明

1.1

total

number

False

查询结果数据总数

1.2

data

array[object]

False

业务场景查询结果对象

1.2.1

group_id

string

True

业务场景标识

1.2.2

group_name

string

False

业务场景名称

1.2.3

is_enable

number

True

是否正在被启用(0 代表不启用,1 代表启用)

1.2.4

create_time

number

True

业务场景创建时间

1.2.5

description

string

False

业务场景描述

1.2.6

other

object

False

场景的整体通话过滤条件

1.2.6.1

call_from

number

False

通话起始时间,时间戳毫秒

1.2.6.2

call_end

number

False

通话结束时间,时间戳毫秒

1.2.7

rule_count

number

False

已配置的质检规则总数

1.2.8

ignore_sensitive

number

False

是否计入敏感词分数(0 代表计入,1 代表不计入)

1.2.9

interaction_type

number

False

交互类型

  • 0和不填表示语音
  • 2表示多媒体
  • 响应状态码: 400

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

  • 响应状态码: 401

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

  • 响应状态码: 404

    请求的内容未找到:请检查请求的路径。

  • 响应状态码: 500

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

错误码

无。

报文样例

  • 场景描述:查询所有业务场景

    请求头:

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

    请求参数:

    {
        "limit": 10,
        "page": 1,
        "scenarioName": null,
        "startTime": null,
        "endTime": null,
        "scenarioStatus": null
    }

    响应参数:

    {
    	"total": 1,
    	"data": [{
    		"tenant_id": "202106114153",
    		"silence_rules": ["920806740809748480"],
    		"other": {},
    		"speed_rules": [],
    		"interposal_rules": [],
    		"create_time": 1623391966,
    		"group_name": "test3",
    		"ignore_sensitive": 0,
    		"is_enable": 1,
    		"description": "3",
    		"rules": [],
    		"group_id": "groupid_1760cfbb-e24c-4c9f-92f7-2701f154577c",
    		"rule_count": 1
    	}]
    }

相关文档