Help Center/ Cognitive Engagement Center/ API Reference/ Inspection, Monitoring, and Statistics Collection Interface Reference/ Intelligent Quality Check/ silencerule/ POST /CCSQM/rest/ccisqm/v1/silencerule/createSilenceRule
Updated on 2023-09-27 GMT+08:00
View PDF

POST /CCSQM/rest/ccisqm/v1/silencerule/createSilenceRule

Scenario

This interface is invoked to add a silence rule.

Method

POST

URI

https://Domain name/apiaccess/CCSQM/rest/ccisqm/v1/silencerule/createSilenceRule (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

No

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

setting

Object

No

Basic silence rule information

1.1.1

name

String

Yes

Rule name

1.1.2

score

Number

Yes

Rule score

Value range: 1–100

1.1.3

seconds

Number

Yes

Silence duration, in seconds

Value range: 1–2147483647

1.1.4

times

Number

Yes

Number of silence times

Value range: 1–2147483647

1.1.5

other

Object

No

Trigger conditions

1.1.5.1

call_from

Number

No

Start timestamp of a call, in seconds

1.1.5.2

call_end

Number

No

End timestamp of a call, in seconds

1.2

exception

Object

No

Exception settings

1.2.1

before

Object

No

Exception settings before silence

1.2.1.1

staff

Array [String]

No

IDs of sentences said by the agent

1.2.1.2

customer

Array [String]

No

IDs of sentences said by the customer

1.2.2

after

Object

No

Exception settings after silence

1.2.2.1

staff

Array [String]

No

IDs of sentences said by the agent

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

silence_id

String

No

Silence rule ID

1.2

resultCode

String

No

Return code. The value 0405000 indicates success, and other values indicate failure.

1.3

resultDesc

String

No

Return description
  • 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: 409

    The rule name exists.

  • Status code: 500

    Business failure. Check the values of parameters in the request.

Error Codes

None

Example

  • Scenario: Add a silent rule.

    Request header:

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

    Request parameters:

    {
	"setting": {
		"name": "test34",
		"score": 4,
		"seconds": 5,
		"times": 4,
		"other": {
			"call_from": 1623911884,
			"call_end": 1624430285
		}
	},
	"exception": {
		"before": {
			"staff": ["14161"],
			"customer": []
		},
		"after": {}
	}
}

    Response parameters:

    {
	"silence_id": "922987647176019968",
	"resultCode": "0405000",
	"resultDesc": "Operation successful."
}
Parent topic: silencerule