文档首页/ 云客服/ API参考/ 质检/监控/统计类/ 智能质检/ 对话逻辑接口 (conversationflow)/ POST /CCSQM/rest/ccisqm/v1/conversation-rules/getConversationFlow
更新时间:2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/conversation-rules/getConversationFlow

场景描述

根据ID查询对话逻辑,查询条件:flow_id,唯一标识,必填。

接口方法

POST

接口URI

/CCSQM/rest/ccisqm/v1/conversation-rules/getConversationFlow

请求说明

表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

True

操作员标识

可在登陆后,进入员工管理页面,查看接口返回的userId

表2 请求体参数

序号

名称

参数类型

是否必选

说明

1

flow_id

string

True

对话逻辑标识

响应说明

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

序号

名称

参数类型

是否必选

说明

1.1

sentence_groups

array[object]

False

对话逻辑中使用到的句子分组

1.1.1

sg_id

string

False

句子分组标识

1.2

min

string

False

对话逻辑匹配个数

1.3

expression

string

False

句子分组之间的逻辑关系,例如if 7cb411de0c5c4c8fab51e28a1ce7d3c7 then 9bb193e53de64e3a9e8545e5ce28bb2e

1.4

flow_id

string

False

对话逻辑标识

1.5

resultCode

string

False

返回码,0405000表示成功,其他表示失败

1.6

flow_name

string

False

对话逻辑名称

1.7

resultDesc

string

False

返回的描述信息

  • 响应状态码: 400
表4 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

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

  • 响应状态码: 401
表5 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

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

  • 响应状态码: 404
表6 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

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

  • 响应状态码: 500
表7 响应体参数

序号

名称

参数类型

是否必选

说明

1

schema

string

True

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

错误码

无。

报文样例

  • 场景描述:根据ID查询对话逻辑

    请求头:

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

    请求参数:

    {
    	"flow_id": "871578307970207744"
    }

    响应参数:

    {
    	"sentence_groups": [{
    		"sg_id": "923083618002145280"
    	}],
    	"min": null,
    	"expression": "must 923083618002145280",
    	"flow_id": "923083617557549056",
    	"resultCode": "0405000",
    	"flow_name": "wqqw",
    	"resultDesc": "操作成功"
    }