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

Scenario

This interface is invoked to query script details by ID. The query criterion is sg_id, which indicates the unique ID of a script and is mandatory.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/conversation-rules/getSentenceGroup (For example, the domain name is service.besclouds.com.)

Request Description

**Table 1** Request header parameters
No.	Parameter	Type	Mandatory or Not	Description
1	Content-Type	String	No	The value is fixed to application/json; charset=UTF-8.
2	x-app-key	String	No	App key
3	Authorization	String	Yes	Authentication field. The format is Bearer {Value of AccessToken* returned by the tokenByAkSk interface}. (A space is required after Bearer*.)
4	x-UserId	String	Yes	Operator ID You can sign in to the system and go to the employee management page to view the value of userId returned by an interface.

**Table 2** Request body parameters
No.	Parameter	Type	Mandatory or Not	Description
1	sg_id	Object	Yes	Script ID

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	sg_id	String	No	Script ID
1.2	role	String	No	Role corresponding to a script
1.3	dialogueFlowId	String	No	Dialog logic ID
1.4	sentences	Array [Object]	No	Sentence array
1.4.1	category_id	String	No	Sentence category ID
1.4.2	sentence_id	String	No	Sentence ID
1.4.3	sentence_name	String	No	Sentence name
1.5	position_distance	String	No	Script phase distance
1.6	position	String	No	Script phase
1.7	SGType	String	No	Expression type
1.8	resultCode	String	No	Return code 0405000: success Others: failure
1.9	resultDesc	String	No	Return description

Status code: 400
Incorrect request. Check the request path and parameters.
Status code: 401
Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.
Status code: 404
The requested content is not found. Check the request path.
Status code: 500
Business failure. Check the values of parameters in the request.

Error Codes

None

Example

Scenario: Query script details.

Request header:

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

Request parameters:

{
	"sg_id": "923004925930115072"
}

Response parameters:

{
	"sg_id": "923083618002145280",
	"role": "any",
	"dialogueFlowId": "923083617557549056",
	"sentences": [{
		"category_id": "925090936373907456",
		"sentence_id": "14402",
		"sentence_name": "Do you need help?"
	}],
	"position_distance": "0",
	"resultCode": "0405000",
	"sg_name": null,
	"position": "any",
	"SGType": "must",
	"resultDesc": "Operation successful."
}

Parent topic: conversationspecific

Previous topic: POST /CCSQM/rest/ccisqm/v1/conversation-rules/updateSentenceGroup

Next topic: POST /CCSQM/rest/ccisqm/v1/conversation-rules/addSentenceGroup