Updated on 2023-09-27 GMT+08:00

POST /CCSQM/rest/ccisqm/v1/scenariomanage/createScenario

Scenario

This interface is invoked to create a business scenario.

After a business scenario is created, it is unavailable. You need to invoke the interface for updating a business scenario to update it before using it normally.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/scenariomanage/createScenario (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.1

group_name

String

Yes

Business scenario name

1.2

description

String

No

Business scenario description

1.3

ignore_sensitive

Number

No

Whether to calculate the points deducted for sensitive words. The options are 0 (yes) and 1 (no). If this parameter is not transferred, the default value 0 is used.

1.4

other

Object

Yes

Call filter conditions of a scenario

1.4.1

call_end

Number

No

Call end time. The value is a timestamp, in seconds.

1.4.2

call_from

Number

No

Call start time. The value is a timestamp, in seconds.

1.5

interaction_type

Integer

No

Inspection type

  • 0 or empty: voice
  • 2: multimedia

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

resultCode

String

No

Return code

  • 0406000: success
  • Others: failure

1.3

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: Create a business scenario.

    Request header:

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

    Request parameters:

    {
    	"group_name": "Business scenario 1",
    	"description": "Business scenario",
    	"ignore_sensitive": 0,
    	"other": {
    		"type": 0,
    		"connected_call_type": 0,
    		"call_from": 1622536490,
    		"call_end": 1625042093
    	}
    }

    Response parameters:

    {
    	"group_id": "groupid_48450728-6b9d-4942-9884-2c5405e974d0",
    	"resultCode": "0406000",
    	"resultDesc": "The business scenario is created successfully."
    }