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

POST /CCISQM/rest/ccisqm/v1/openapi/getTextByTaskId

Scenario

This interface is invoked to obtain the text converted from a recording file.

Method

POST

URI

https://Domain name/apiaccess/CCISQM/rest/ccisqm/v1/openapi/getTextByTaskId (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

taskId

String

Yes

ID of a created task

NOTE:

The value of taskId must be the ID of an inspection task created within three days.

1.2

language

String

Yes

Language of the recording file. The options are zh_CN (Chinese) and en_US (English).

Response Description

  • Status code: 200
Table 3 Response body parameters

No.

Parameter

Type

Mandatory or Not

Description

1.1

resultCode

String

No

Response status code

1.2

bytesZip

String

No

ZIP package

1.3

resultDesc

String

No

Response status message

  • 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: Obtain the text converted from a recording file.

    Request header:

    x-app-key:************************************   
    Authorization:Bearer ************************************

    Request parameters:

    {
    	"language": "zh_CN",
    	"taskId": "605d5aff00000927"
    }

    Response parameters:

    {
    	"errorMessage": "Failed to obtain the task id is {}605d5aff00000927",
    	"errorCode": 1010404
    }