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

POST /CCSQM/rest/ccisqm/v1/appraisecall/details

Scenario

This interface is invoked to obtain the call status and ASR result.

Method

POST

URI

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

call_from

Number

No

Call start time

The value is a timestamp, in seconds.

1.2

call_to

Number

No

Call end time

The value is a timestamp, in seconds.

1.3

call_types

Array [Integer]

Yes

Call file type

  • 0: voice
  • 2: text

1.4

limit

Integer

Yes

Number of records on each page

1.5

page

Integer

Yes

Page number

1.6

status

Array [Integer]

Yes

Inspection status

  • 0: The call is waiting for inspection.
  • 1: The inspection is in progress.
  • 2: The inspection is successful.
  • 3: The ASR is in progress.
  • 9: The inspection fails. An error occurs, or the data volume of inspection audio files or the number of daily inspection files reaches the upper limit.
  • 31: The voice content of the ASR result is empty.
  • 32: The ASR fails.
  • 33: The voice file fails to be uploaded to the ASR.
  • 34: The iFLYTEK ASR result transfer task fails to be submitted.
  • 35: The multimedia inspection task fails to be executed.
  • 36: The TUC inspection fails.
  • 37: The ASR fails to convert the voice file to a text file.
  • 38: The inspection result fails to be updated.
  • 39: The inspection task fails to be executed.
  • 40: The voice file is invalid.

1.7

keyword

String

No

Dialog keyword

1.8

staff_id

String

No

User ID of an agent

You can sign in to the system and go to the agent management page to view the value of accountId returned by an interface.

1.9

staff_name

String

No

Agent name

1.10

upload_from

Number

Yes

Call upload start time

1.11

upload_to

Number

Yes

Call upload end time

1.12

duration_min

Integer

No

Minimum call duration

1.13

duration_max

Integer

No

Maximum call duration

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

paging

Object

No

Page information

1.1.1

total

Number

No

Total number of calls

1.2

data

Array [Object]

No

Call information list

1.2.1

calls

Array [Object]

No

Multi-call information

1.2.1.1

call_id

String

No

Session ID

1.2.1.2

call_time

Number

No

Call time

1.2.1.3

call_type

Number

No

File type

1.2.1.4

call_uuid

String

No

Session UUID

1.2.1.5

deal

Number

No

Whether the business is completed

1.2.1.6

duration

Number

No

Call duration

1.2.1.7

file_name

String

No

File name

1.2.1.8

left_channel

String

No

Channel information, which is used to identify a customer or agent

1.2.1.9

left_silence_time

Number

No

Silence time

1.2.1.10

left_speech_ratio

Number

No

Left channel speaking proportion. The speaker is determined by the left_channel parameter.

1.2.1.11

left_speed

Number

No

Left channel speaking speed

1.2.1.12

right_channel

String

No

Channel information, which is used to identify a customer or agent

1.2.1.13

right_silence_time

Number

No

Silence time

1.2.1.14

right_speech_ratio

Number

No

Right channel speaking proportion

1.2.1.15

right_speed

Number

No

Right channel speaking speed

1.2.1.16

staff_id

String

No

User ID of an agent

You can sign in to the system and go to the agent management page to view the value of accountId returned by an interface.

1.2.1.17

status

Number

No

Status

  • 0: The call is waiting for inspection.
  • 1: The inspection is in progress.
  • 2: The inspection is successful.
  • 3: The ASR is in progress.
  • 9: The inspection fails. An error occurs, or the data volume of inspection audio files or the number of daily inspection files reaches the upper limit.
  • 31: The voice content of the ASR result is empty.
  • 32: The ASR fails.
  • 33: The voice file fails to be uploaded to the ASR.
  • 34: The iFLYTEK ASR result transfer task fails to be submitted.
  • 35: The multimedia inspection task fails to be executed.
  • 36: The TUC inspection fails.
  • 37: The ASR fails to convert the voice file to a text file.
  • 38: The inspection result fails to be updated.
  • 39: The inspection task fails to be executed.
  • 40: The voice file is invalid.

1.2.1.18

upload_time

Number

No

Call upload time

1.2.1.19

staff_name

String

No

Agent name

1.2.2

call_group_id

String

No

Call group ID

  • 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: Obtain the call status and ASR result.

    Request header:

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

    Request parameters:

    {
    	"limit": 10,
    	"page": 1,
    	"call_types": [0, 2],
    	"call_from": 1621333149,
    	"call_to": 1623925149,
    	"staff_id": null,
    	"upload_from": null,
    	"upload_to": null,
    	"status": [2]
    }

    Response parameters:

    {
    	"data": [{
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622633782,
    			"left_speed": 241.552,
    			"left_speech_ratio": 0.4613,
    			"file_name": "Consultant",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.3252,
    			"call_time": 1622633782,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497",
    			"left_silence_time": 88.46,
    			"duration": 164.22,
    			"upload_time": 1622633782,
    			"right_silence_time": 110.82,
    			"right_speed": 165.169,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "3b9cd7a9-d38c-4aa0-a35d-77f6abb9f497"
    	}, {
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622554272,
    			"left_speed": 307.127,
    			"left_speech_ratio": 0.251,
    			"file_name": "myvoice",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.206,
    			"call_time": 1622554272,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a",
    			"left_silence_time": 260.03,
    			"duration": 347.16,
    			"upload_time": 1622554272,
    			"right_silence_time": 275.65,
    			"right_speed": 318.837,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "2ef38e9b-36dd-4c1f-97cb-a665a2d9de3a"
    	}, {
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622552201,
    			"left_speed": 305.061,
    			"left_speech_ratio": 0.251,
    			"file_name": "myvoice",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.206,
    			"call_time": 1622552201,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4",
    			"left_silence_time": 260.03,
    			"duration": 347.16,
    			"upload_time": 1622552201,
    			"right_silence_time": 275.65,
    			"right_speed": 319.676,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "4aca6bb8-13e6-4fd8-ac5b-0402fbb5bef4"
    	}, {
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622552093,
    			"left_speed": 324.068,
    			"left_speech_ratio": 0.6081,
    			"file_name": "6335",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.185,
    			"call_time": 1622552093,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "4a8507ec-8519-46ab-9ca7-241556a6eb6c",
    			"left_silence_time": 40.8,
    			"duration": 104.12,
    			"upload_time": 1622552093,
    			"right_silence_time": 84.86,
    			"right_speed": 230.53,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "4a8507ec-8519-46ab-9ca7-241556a6eb6c",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "4a8507ec-8519-46ab-9ca7-241556a6eb6c"
    	}, {
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622528466,
    			"left_speed": 307.127,
    			"left_speech_ratio": 0.251,
    			"file_name": "myvoice",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.206,
    			"call_time": 1622528466,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "ead642de-fa23-4bc0-adf5-f2bac9614b01",
    			"left_silence_time": 260.03,
    			"duration": 347.16,
    			"upload_time": 1622528466,
    			"right_silence_time": 275.65,
    			"right_speed": 321.354,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "ead642de-fa23-4bc0-adf5-f2bac9614b01",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "ead642de-fa23-4bc0-adf5-f2bac9614b01"
    	}, {
    		"calls": [{
    			"staff_name": "*****",
    			"create_time": 1622513361,
    			"left_speed": 306.439,
    			"left_speech_ratio": 0.251,
    			"file_name": "20208650",
    			"left_channel": "customer",
    			"right_speech_ratio": 0.206,
    			"call_time": 1622513361,
    			"inspect_status": 0,
    			"right_channel": "staff",
    			"complain_status": -1,
    			"call_id": "1e158a1a-2f6d-44f6-ba44-b15d52e21651",
    			"left_silence_time": 260.03,
    			"duration": 347.16,
    			"upload_time": 1622513361,
    			"right_silence_time": 275.65,
    			"right_speed": 320.515,
    			"staff_id": "1600226440112042215",
    			"call_uuid": "1e158a1a-2f6d-44f6-ba44-b15d52e21651",
    			"review_status": -1,
    			"call_type": 0,
    			"status": 2
    		}],
    		"call_group_id": "1e158a1a-2f6d-44f6-ba44-b15d52e21651"
    	}],
    	"paging": {
    		"total": 6
    	}
    }