プッシュ-to-音声API

注記： このAPIを通じて作成された音声ブロードキャストは、APIを介してのみアクセス、変更、または削除することができます。 注記： 音声ファイルの言語タイプは現在「en」「zh-Hans」「zh-Hant」のみをサポートしています。

認証

詳細については、REST APIの概要セクションの認証方法を参照してください。

音声ブロードキャストの作成/更新

存在しない場合は新しい音声ブロードキャストを作成し、存在する場合は更新します。

エンドポイント

POST v4/voices

              
              POST v4/voices

このコードブロックはフローティングウィンドウ内に表示されます

リクエスト例

リクエストヘッダー

POST /v4/voices Authorization: Basic (base64認証文字列) Content-Type: multipart/form-data Accept: multipart/form-data

              
              POST /v4/voices
Authorization: Basic (base64認証文字列)
Content-Type: multipart/form-data
Accept: multipart/form-data

このコードブロックはフローティングウィンドウ内に表示されます

リクエストデータ

--form 'language="en"' --form 'file="file"'

              
              --form 'language="en"'
--form 'file="file"'

このコードブロックはフローティングウィンドウ内に表示されます

リクエストデータの説明

language：音声ブロードキャストファイルの言語を指定し、必要な音声ブロードキャスト言語を選択するために使用されます。
file：音声ブロードキャストに必要なzipファイルで、必要なすべてのmp3ファイルが含まれています。

レスポンス例

成功レスポンス

HTTP/1.1 200 OK Server: fasthttp Date: Thu, 01 Dec 2022 07:17:45 GMT Content-Type: application/json Content-Length: 85

              
              HTTP/1.1 200 OK
Server: fasthttp
Date: Thu, 01 Dec 2022 07:17:45 GMT
Content-Type: application/json
Content-Length: 85

このコードブロックはフローティングウィンドウ内に表示されます

{ "file_url": "" }

              
              {
    "file_url": ""
}

このコードブロックはフローティングウィンドウ内に表示されます

file_url：Huawei Cloud OBSにアップロードされたファイルのダウンロードURL。

失敗レスポンス

HTTP/1.1 400 BAD REQUEST Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8

このコードブロックはフローティングウィンドウ内に表示されます

{ "error": { "code": 28400, "message": "エラーメッセージ" } }

              
              {
    "error": {
        "code": 28400,
        "message": "エラーメッセージ"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

オーディオファイルの仕様

このAPIのオーディオファイルは、指定された数字と単語に従って命名する必要があり、各ファイル形式は.mp3です。以下にサポートされている命名の詳細を示します：

英語（en）：
- 数字：「0」～「20」、「30」、「40」、「50」、「60」、「70」、「80」、「90」、「100」、「1000」、「1000000」、「1000000000」
- 単語：「point」、「and」
中国語（zh）：
- 数字：「0」～「10」、「100」、「1000」、「10000」、「100000000」
- 単語：「point」

システムと正しく統合するため、すべてのファイルがMP3形式であることを確認してください。

音声ブロードキャストリストの取得

エンドポイント

GET v4/voices

リクエスト例

リクエストヘッダー

GET /v4/voices Authorization: Basic (base64認証文字列)

              
              GET /v4/voices
Authorization: Basic (base64認証文字列)

このコードブロックはフローティングウィンドウ内に表示されます

ソート順：最新の更新が最初に表示されます。

レスポンス例

成功レスポンス

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8

このコードブロックはフローティングウィンドウ内に表示されます

[ { "language":"en", "file_url":"" } ]

              
              [
    {
        "language":"en", 
        "file_url":""
    }
]

このコードブロックはフローティングウィンドウ内に表示されます

そのアプリケーションの下にある有効な音声ブロードキャストのリストを返します。
languageは作成/更新時にリクエストされたものです。
file_urlはアップロードされたファイルのHuawei Cloud OBSダウンロードURLです。

音声ブロードキャスト詳細の取得

エンドポイント

GET v4/voices/{language}

リクエスト例

リクエストヘッダー

GET /v4/voices/en Authorization: Basic (base64認証文字列)

              
              GET /v4/voices/en
Authorization: Basic (base64認証文字列)

このコードブロックはフローティングウィンドウ内に表示されます

レスポンス例

成功レスポンス

HTTP/1.1 200 OK Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 200 OK 
Content-Type: application/json; charset=utf-8

このコードブロックはフローティングウィンドウ内に表示されます

レスポンスデータ

{ "file_url": "" }

              
              {
   "file_url": ""
}

このコードブロックはフローティングウィンドウ内に表示されます

languageが存在しない場合は404を返し、それ以外の場合は実際のfile_urlを返します。これはアップロードされたファイルのHuawei Cloud OBSダウンロードURLです。

音声ファイルの削除

エンドポイント

DELETE v4/voices/{language}

リクエスト例

DELETE /v4/voices/en Authorization: Basic (base64認証文字列)

              
              DELETE /v4/voices/en
Authorization: Basic (base64認証文字列)

このコードブロックはフローティングウィンドウ内に表示されます

レスポンス例

成功レスポンス

HTTP/1.0 200 Content-Type: application/json Content-Length: 0

              
              HTTP/1.0 200 
Content-Type: application/json
Content-Length: 0

このコードブロックはフローティングウィンドウ内に表示されます

失敗レスポンス

languageが無効または存在しない場合。

HTTP/1.0 404 Not Found Content-Type: application/json

              
              HTTP/1.0 404 Not Found
Content-Type: application/json

このコードブロックはフローティングウィンドウ内に表示されます

更新操作が不正な場合。

HTTP/1.1 400 BAD REQUEST Content-Type: application/json; charset=utf-8

              
              HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8

このコードブロックはフローティングウィンドウ内に表示されます

{ "error": { "code": 28400, "message": "エラーメッセージ" } }

              
              {
    "error": {
        "code": 28400,
        "message": "エラーメッセージ"
    }
}

このコードブロックはフローティングウィンドウ内に表示されます

エラーコード

コード	HTTPステータス	説明	エラーメッセージ	詳細な説明
28000	200	成功レスポンス	nil	成功ステータスコード
28101	401	認証失敗	Basic authentication failed.	Appkeyとmasterscrectが一致しません。
28200	500	サーバー内部エラー	Server Internal error.	予期しないエラーが発生しました。
28203	503	サーバー内部エラー、後で再試行してください	Execute action timeout, please try later again	schedule-serverとの通信エラー。