POST /CCSQM/rest/ccisqm/v1/scenariomanage/queryScenario

Scenario

This interface is invoked to query details about a business scenario based on its unique ID.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/scenariomanage/queryScenario (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	group_id	String	Yes	Business scenario ID

Response Description

Status code: 200

**Table 3** Response body parameters
No.	Parameter	Type	Mandatory or Not	Description
1.1	group_id	String	Yes	Business scenario ID
1.2	group_name	String	No	Business scenario name
1.3	is_enable	Number	Yes	Whether to enable a business scenario. The options are 0 (no) and 1 (yes).
1.4	other	Object	No	Conditions for triggering a business scenario
1.4.1	call_end	Number	No	Call start time. The value is a timestamp, in seconds.
1.4.2	call_from	Number	No	Call end time. The value is a timestamp, in seconds.
1.5	create_time	Number	No	Creation time
1.6	description	String	No	Business scenario description
1.7	ignore_sensitive	Number	No	Whether to calculate the points deducted for sensitive words. The options are 0 (yes) and 1 (no).
1.8	rules	Array [String]	No	Dialog rules. Use commas (,) to separate multiple rules.
1.9	silence_rules	Array [String]	No	Silence rules. Use commas (,) to separate multiple rules.
1.10	speed_rules	Array [String]	No	Speed rules. Use commas (,) to separate multiple rules.
1.11	interposal_rules	Array [String]	No	Interruption rules. Use commas (,) to separate multiple rules.

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 details about a business scenario.

Request header:

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

Request parameters:

{
	"group_id": "groupid_33bba990-c39e-4397-a649-1fdb46d54b17"
}

Response parameters:

{
	"tenant_id": "202106114153",
	"silence_rules": [{
		"rule_id": "920806740809748480",
		"rule_name": "Silence rule 1"
	}],
	"other": {},
	"speed_rules": [],
	"interposal_rules": [],
	"create_time": 1624413549,
	"group_name": "Business scenario 1",
	"group_id": "groupid_48450728-6b9d-4942-9884-2c5405e974d0",
	"ignore_sensitive": 0,
	"is_enable": 0,
	"description": "",
	"rules": []
}

Parent topic: scenariomanage

Previous topic: POST /CCSQM/rest/ccisqm/v1/scenariomanage/createScenario

Next topic: POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenario