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

POST /CCSQM/rest/ccisqm/v1/silencerule/querySilenceRule

Scenario

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

Method

POST

URI

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

silence_id

String

Yes

Silence rule ID

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

exception

Object

No

Exception settings

1.1.1

before

Object

No

Exception settings before silence

1.1.1.1

staff

Array [Object]

No

IDs of sentences said by the agent

1.1.1.1.1

category_id

String

No

Sentence category ID

1.1.1.1.2

sentence_id

String

No

Sentence ID

1.1.1.1.3

sentence_name

String

No

Sentence name

1.1.1.2

customer

Array [Object]

No

IDs of sentences said by the customer

1.1.1.2.1

category_id

String

No

Sentence category ID

1.1.1.2.2

sentence_id

String

No

Sentence ID

1.1.1.2.3

sentence_name

String

No

Sentence name

1.1.2

after

Object

No

Exception settings after silence

1.1.2.1

staff

Array [Object]

No

IDs of sentences said by the agent

1.1.2.1.1

category_id

String

No

Sentence category ID

1.1.2.1.2

sentence_id

String

No

Sentence ID

1.1.2.1.3

sentence_name

String

No

Sentence name

1.2

resultCode

String

No

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

1.3

resultDesc

String

No

Return description

1.4

setting

Object

No

Basic silence rule information

1.4.1

score

String

No

Rule score

1.4.2

seconds

String

No

Silence duration, in seconds

1.4.3

times

String

No

Number of silence times

1.4.4

silence_id

String

No

Silence rule ID

1.4.5

other

Object

No

Trigger conditions

1.4.5.1

call_end

Number

No

Start timestamp of a call, in seconds

1.4.5.2

call_from

Number

No

End timestamp of a call, in seconds

1.4.6

name

String

No

Rule name

  • 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 silence rule details by ID.

    Request header:

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

    Request parameters:

    {
    	"silence_id": "922988537635147776"
    }

    Response parameters:

    {
    	"exception": {
    		"before": {
    			"staff": [{
    				"category_id": "894378237264662529",
    				"sentence_id": "14161",
    				"sentence_name": "Intent name demo1"
    			}],
    			"customer": []
    		},
    		"after": {
    			"staff": []
    		}
    	},
    	"resultCode": "0405000",
    	"resultDesc": "Operation successful."
    	"setting": {
    		"score": "-4",
    		"seconds": "5",
    		"times": "4",
    		"silence_id": "922988537635147776",
    		"other": {
    			"call_end": 1624430285,
    			"call_from": 1623911884
    		},
    		"name": "test35444"
    	}
    }