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

场景描述

根据ID查询话术详情，查询条件：sg_id，唯一标识，必填。

接口方法

POST

接口URI

https://域名/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/getSentenceGroup，例如域名是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	True	操作员标识可在登陆后，进入员工管理页面，查看接口返回的userId

表2 请求体参数
序号	名称	参数类型	是否必选	说明
1	sg_id	object	True	话术标识

响应说明

响应状态码: 200

表3 响应体参数
序号	名称	参数类型	是否必选	说明
1.1	sg_id	string	False	话术标识
1.2	role	string	False	话术对应的角色
1.3	dialogueFlowId	string	False	对话逻辑标识
1.4	sentences	array[object]	False	句子数组
1.4.1	category_id	string	False	句子分类标识
1.4.2	sentence_id	string	False	句子标识
1.4.3	sentence_name	string	False	句子名称
1.5	position_distance	string	False	话术位置距离
1.6	position	string	False	话术位置
1.7	SGType	string	False	表达式类型
1.8	resultCode	string	False	返回码 0405000 表示成功其他表示失败
1.9	resultDesc	string	False	返回描述

响应状态码: 400
错误的请求：请检查请求路径及参数。
响应状态码: 401
未授权：1. 请确认是否购买了相关服务。 2. 请联系客服人员检查您账号的当前状态。
响应状态码: 404
请求的内容未找到：请检查请求的路径。
响应状态码: 500
业务失败：请依次确认您请求中各参数的取值。

错误码

无。

报文样例

场景描述：查询话术详情

请求头:

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

请求参数:

{
	"sg_id": "923004925930115072"
}

响应参数:

{
	"sg_id": "923083618002145280",
	"role": "any",
	"dialogueFlowId": "923083617557549056",
	"sentences": [{
		"category_id": "925090936373907456",
		"sentence_id": "14402",
		"sentence_name": "询问客户是否需要帮助"
	}],
	"position_distance": "0",
	"resultCode": "0405000",
	"sg_name": null,
	"position": "any",
	"SGType": "must",
	"resultDesc": "操作成功"
}

父主题： 话术接口 (conversationspecific)

上一篇：POST /CCSQM/rest/ccisqm/v1/conversation-rules/updateSentenceGroup

下一篇：POST /CCSQM/rest/ccisqm/v1/conversation-rules/addSentenceGroup