文書翻訳状態の確認

Classic/VPC環境で利用できます。

文書翻訳の進行状況を現在の処理段階と進捗率(%)で確認します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/status

リクエストヘッダ

Papago Translation APIで共通して使用されるヘッダの詳細は、Papago Translationの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`requestId`	String	Required	翻訳リクエストにより発行された ID(Request ID) 各文書翻訳リクエストの固有の識別値

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://papago.apigw.ntruss.com/doc-trans/v1/status
?requestId={requestId}' \
--header 'X-NCP-APIGW-API-KEY-ID: {アプリの登録時に発行された Client ID}' \
--header 'X-NCP-APIGW-API-KEY: {アプリの登録時に発行された Client Secret}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`data`	Object	-	進行状況の詳細情報
`data.status`	String	-	現在の翻訳の進行段階 `WAITING` \| `PROGRESS` \| `COMPLETE` \| `FAILED` `WAITING`: 翻訳待ち `PROGRESS`: 翻訳中 `COMPLETE`: 翻訳完了してファイルのダウンロードが可能 `FAILED`: 翻訳失敗
`data.progressPercent`	Integer	-	ファイル翻訳の進捗率(%) `status`が`PROGRESS`の場合に確認可能
`data.errCode`	String	-	エラーコード `status`が`FAILED`の場合に確認可能
`data.errMsg`	String	-	エラーメッセージ `status`が`FAILED`の場合に確認可能

レスポンスステータスコード

Papago Translation APIで共通して使用されるレスポンスステータスコードの詳細は、Papago Translationの共通レスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

成功

呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。

{
    "data": {
        "status": "COMPLETE"
    }
}

{
    "data": {
        "status": "PROGRESS",
        "progressPercent": 24
    }
}

失敗

呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

{
    "data": {
        "status": "FAILED",
        "errCode": "17",
        "errMsg": "Detected langcode is the same as target langcode"
    }
}