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

POST /CCSQM/rest/ccisqm/v1/scenariomanage/updateScenario

Scenario

This interface is invoked to update a business scenario.

Method

POST

URI

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

String

Yes

Business scenario ID

1.2

group_name

String

Yes

Business scenario name

1.3

description

String

No

Business scenario description

1.4

is_enable

Number

Yes

Whether to enable a business scenario. The options are 0 (no) and 1 (yes).

1.5

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.6

other

Object

No

Call filter conditions of a scenario

1.6.1

call_end

Number

No

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

1.6.2

call_from

Number

No

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

1.7

rules

Array [String]

No

Dialog rules. Use commas (,) to separate multiple rules.

1.8

silence_rules

Array [String]

No

Silence rules. Use commas (,) to separate multiple rules.

1.9

speed_rules

Array [String]

No

Speed rules. Use commas (,) to separate multiple rules.

1.10

interposal_rules

Array [String]

No

Interruption rules. Use commas (,) to separate multiple rules.

1.11

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

resultCode

String

No

Return code

  • 0406000: success
  • Others: failure

1.2

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

    Request header:

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

    Request parameters:

    {
    	"group_name": "OIAP",
    	"description": "OIAP",
    	"is_enable": 1,
    	"ignore_sensitive": 0,
    	"other": {
    		"call_from": null,
    		"call_end": null
    	},
    	"Speed_rules": ["919423582684057600"],
    	"group_id": "groupid_826b89d9-bec9-4c14-b677-1d86f16c4993"
    }

    Response parameters:

    {
    	"resultCode": "0406000",
    	"resultDesc": "The business scenario is updated successfully."
    }