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

POST /CCISQM/rest/ccisqm/v1/appraisecall/credit

Scenario

This interface invoked to query recording inspection results.

Method

POST

URI

https://Domain name/apiaccess/CCISQM/rest/ccisqm/v1/appraisecall/credit (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. Contact operations personnel to obtain it.

3

Authorization

String

Yes

Authentication field. The format is Bearer {Value of AccessToken returned by the tokenByAkSk interface}. (A space is required after Bearer.)

Table 2 Request body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

call_uuid

String

Yes

Call ID

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

create_time

Number

No

Creation time

1.2

credit

Array [Object]

No

Inspection results of related business scenarios

1.2.1

score

Number

No

Inspection score

1.2.2

rules

Array [Object]

No

Dialog rule inspection result

1.2.2.1

valid

Boolean

No

Validity. The options are true (valid) and false (invalid).

1.2.2.2

score

Number

No

Rule score

1.2.2.3

invalid_segment

Array [Object]

No

List of violation segments

1.2.2.3.1

start_time

Number

No

Start time of a segment

1.2.2.3.2

end_time

Number

No

End time of a segment

1.2.2.3.3

call_id

String

No

TTS segment ID

1.2.2.4

revise_id

String

No

Rule instance ID

1.2.2.5

revise

Number

No

Revision status

-1: not revised

0: revised to be invalid

1: revised to be valid

1.2.2.6

setting

Object

No

Dialog rule object

1.2.2.6.1

rule_id

String

No

Rule ID

1.2.2.6.2

rule_name

String

No

Rule name

1.2.3

setting

Object

No

Business scenarios

1.2.3.1

group_id

String

No

Business scenario ID

1.2.3.2

group_name

String

No

Business scenario name

1.2.3.3

ignore_sensitive

Number

No

Whether to ignore sensitive words. The options are 0 (no) and 1 (yes).

1.2.3.4

description

String

No

Business scenario description

1.2.4

silence_rule

Array [Object]

No

Silence rules

1.2.4.1

valid

Boolean

No

Validity. The options are true (valid) and false (invalid).

1.2.4.2

score

Number

No

Rule score

1.2.4.3

invalid_segment

Array [Object]

No

List of violation segments

1.2.4.3.1

start_time

Number

No

Start time of a segment

1.2.4.3.2

end_time

Number

No

End time of a segment

1.2.4.3.3

call_id

String

No

TTS segment ID

1.2.4.4

revise_id

String

No

Rule instance ID

1.2.4.5

revise

Number

No

Revision status

  • -1: not revised
  • 0: revised to be invalid
  • 1: revised to be valid

1.2.4.6

name

String

No

Rule name

1.2.4.7

setting

Object

No

Silence rule object

1.2.4.7.1

silence_id

String

No

Rule ID

1.2.4.7.2

name

String

No

Rule name

1.2.5

speed_rule

Array [Object]

No

Speed rules

1.2.5.1

valid

Boolean

No

Validity. The options are true (valid) and false (invalid).

1.2.5.2

score

Number

No

Rule score

1.2.5.3

invalid_segment

Array [Object]

No

List of violation segments

1.2.5.3.1

start_time

Number

No

Start time of a segment

1.2.5.3.2

end_time

Number

No

End time of a segment

1.2.5.3.3

call_id

String

No

TTS segment ID

1.2.5.4

revise_id

String

No

Rule instance ID

1.2.5.5

revise

Number

No

Revision status

  • -1: not revised
  • 0: revised to be invalid
  • 1: revised to be valid

1.2.5.6

name

String

No

Rule name

1.2.5.7

setting

Object

No

Speed rule object

1.2.5.7.1

name

String

No

Rule name

1.2.5.7.2

speed_id

String

No

Rule ID

1.2.6

interposal_rule

Array [Object]

No

Interruption rules

1.2.6.1

valid

Boolean

No

Validity. The options are true (valid) and false (invalid).

1.2.6.2

score

Number

No

Rule score

1.2.6.3

invalid_segment

Array [Object]

No

List of violation segments

1.2.6.3.1

start_time

Number

No

Start time of a segment

1.2.6.3.2

end_time

Number

No

End time of a segment

1.2.6.3.3

call_id

String

No

TTS segment ID

1.2.6.4

revise_id

String

No

Rule instance ID

1.2.6.5

revise

Number

No

Revision status

  • -1: not revised
  • 0: revised to be invalid
  • 1: revised to be valid

1.2.6.6

name

String

No

Rule name

1.2.6.7

setting

Object

No

Interruption rule object

1.2.6.7.1

interposal_id

String

No

Rule ID

1.2.6.7.2

name

String

No

Rule name

1.3

sensitive_words

Array [Object]

No

Sensitive words

1.3.1

valid

Boolean

No

Validity. The options are true (valid) and false (invalid).

1.3.2

score

Number

No

Sensitive word score

1.3.3

invalid_segment

Array [Number]

No

List of the IDs of TTS segments with sensitive words, for example, [1,34]

1.3.4

revise_id

String

No

Rule instance ID

1.3.5

revise

Number

No

Revision status

  • -1: not revised
  • 0: revised to be invalid
  • 1: revised to be valid

1.3.6

setting

Object

No

Sensitive word rule object

1.3.6.1

sw_id

String

No

Sensitive word ID

1.3.6.2

sw_name

String

No

Sensitive word name

  • Status code: 400

    The requested content is not found. Check the request path and parameter values.

  • 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

    Unauthorized operation. 1. Check whether you have purchased related services. 2. Contact customer service to check the status of your account.

  • Status code: 500

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

Error Codes

None

Example

  • Scenario: Query recording inspection results.

    Request header:

    x-app-key:XXXXXXXXXXX  
    Authorization:Bearer XXXXXXXXXXX

    Request parameters:

    {
    	"call_uuid": "822bbf4d-c4f8-473a-9144-199058375be8"
    }

    Response parameters:

    [{
    	"create_time": 1635410113,
    	"credit": [{
    		"score": 77,
    		"rules": [{
    			"valid": false,
    			"score": -3,
    			"invalid_segment": [],
    			"revise_id": "dialogRule153309ee-7031-4322-a8d4-3682bd6f09ac",
    			"revise": -1,
    			"setting": {
    				"rule_id": "967510375224315904",
    				"rule_name": "Dialog rule test"
    			}
    		}],
    		"setting": {
    			"group_id": "groupid_cbe2442c-471a-4da3-a43b-5ae67960b648",
    			"group_name": "Business scenario 1",
    			"ignore_sensitive": 0,
    			"description": ""
    		}
    	}, {
    		"silence_rule": [{
    			"valid": true,
    			"score": 0,
    			"invalid_segment": [],
    			"revise_id": "silenceRule09c8ea6a-03a7-4302-a246-1accf1f7257e",
    			"revise": -1,
    			"name": "Silence rule 1",
    			"setting": {
    				"silence_id": "966506182489411584",
    				"name": "Silence rule 1"
    			}
    		}],
    		"score": 75,
    		"rules": [{
    			"valid": false,
    			"score": -2,
    			"invalid_segment": [],
    			"revise_id": "dialogRule0a217e0b-fdb1-4819-a6db-b7e4765d6825",
    			"revise": -1,
    			"setting": {
    				"rule_id": "952280134373609472",
    				"rule_name": "Dialog rule"
    			}
    		}],
    		"speed_rule": [{
    			"valid": false,
    			"score": -3,
    			"invalid_segment": [{
    				"start_time": 26.14,
    				"end_time": 32.67,
    				"call_id": "5"
    			}, {
    				"start_time": 38.58,
    				"end_time": 46.52,
    				"call_id": "7"
    			}, {
    				"start_time": 50.9,
    				"end_time": 62.04,
    				"call_id": "8"
    			}, {
    				"start_time": 69.28,
    				"end_time": 71.9,
    				"call_id": "11"
    			}, {
    				"start_time": 100.42,
    				"end_time": 105.24,
    				"call_id": "16"
    			}, {
    				"start_time": 113.76,
    				"end_time": 114.32,
    				"call_id": "19"
    			}, {
    				"start_time": 115.74,
    				"end_time": 122.0,
    				"call_id": "22"
    			}, {
    				"start_time": 128.52,
    				"end_time": 130.2,
    				"call_id": "24"
    			}, {
    				"start_time": 131.76,
    				"end_time": 132.54,
    				"call_id": "25"
    			}, {
    				"start_time": 133.52,
    				"end_time": 157.72,
    				"call_id": "27"
    			}, {
    				"start_time": 159.52,
    				"end_time": 161.0,
    				"call_id": "29"
    			}],
    			"revise_id": "speedRulec4879869-5a0e-48b8-987f-217f7e08eb32",
    			"revise": -1,
    			"name": "Speech speed rule",
    			"setting": {
    				"name": "Speech speed rule",
    				"speed_id": "966506320519761920"
    			}
    		}],
    		"interposal_rule": [{
    			"valid": true,
    			"score": 0,
    			"invalid_segment": [],
    			"revise_id": "interposalRule488e82e6-7d43-429b-9ce7-4c9043d8f8de",
    			"revise": -1,
    			"name": "Interruption rule",
    			"setting": {
    				"interposal_id": "966506430926426112",
    				"name": "Interruption rule"
    			}
    		}],
    		"setting": {
    			"group_id": "groupid_5cbec488-23d1-4551-a41a-6f81e501dcf7",
    			"group_name": "Answer on phone",
    			"ignore_sensitive": 0,
    			"description": "Answer on phone"
    		}
    	}],
    	"sensitive_words": []
    }]