Rest API | Push-to-Speech API | ドキュメント - EngageLab | AppPush 開発者ガイド REST API 日本語

注: この API を通じて作成された音声ブロードキャストは、API 経由でのみ取得、変更、削除できます。
注: 現在、音声ファイルでサポートされている言語は、en、zh-Hans、zh-Hant のみです。

認証

詳細については、REST API Overview の Authentication Method セクションを参照してください。

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

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

Endpoint

POST v4/voices

              
              POST v4/voices

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

リクエスト例

Request Headers

POST /v4/voices Authorization: Basic (base64 auth string) Content-Type: multipart/form-data Accept: multipart/form-data

              
              POST /v4/voices
Authorization: Basic (base64 auth string)
Content-Type: multipart/form-data
Accept: multipart/form-data

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

Request Data

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

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

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

Request Data Description

language: 音声ブロードキャストファイルの言語を指定します。ユーザーが必要とする音声ブロードキャストの言語を選択するために使用されます。
file: 音声ブロードキャストに使用する ZIP ファイルです。必要な MP3 ファイルをすべて含めてください。

レスポンス例

Successful Response

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。

Failed Response

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 message" } }

              
              {
  "error": {
    "code": 28400,
    "message": "error 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 形式であることを確認してください。

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

Endpoint

GET v4/voices

              
              GET v4/voices

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

リクエスト例

Request Headers

GET /v4/voices Authorization: Basic (base64 auth string)

              
              GET /v4/voices
Authorization: Basic (base64 auth string)

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

並び順は更新時刻の降順で、最新のものが先頭になります。

レスポンス例

Successful Response

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 です。

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

Endpoint

GET v4/voices/{language}

              
              GET v4/voices/{language}

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

リクエスト例

Request Headers

GET /v4/voices/en Authorization: Basic (base64 auth string)

              
              GET /v4/voices/en
Authorization: Basic (base64 auth string)

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

レスポンス例

Successful Response

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

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

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

Response Data

{ "file_url": "" }

              
              {
  "file_url": ""
}

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

指定した言語が存在しない場合は 404 が返されます。存在する場合、返される file_url は、アップロードされたファイルに対応する Huawei Cloud OBS のダウンロード URL です。

音声ファイルの削除

Endpoint

DELETE v4/voices/{language}

              
              DELETE v4/voices/{language}

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

リクエスト例

DELETE /v4/voices/en Authorization: Basic (base64 auth string)

              
              DELETE /v4/voices/en
Authorization: Basic (base64 auth string)

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

レスポンス例

Successful Response

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

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

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

Failed Response

無効な言語、または指定した言語が存在しない場合

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": 23903, "message": "voice does not exist" } }

              
              {
  "error": {
    "code": 23903,
    "message": "voice does not exist"
  }
}

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

エラーコード

Code	HTTP	Description	Error Message	Detailed Explanation
28000	200	正常なレスポンスが返されました	nil	成功ステータスコード
28101	401	認証に失敗しました	Basic authentication failed.	`appkey` と `mastersecret` が一致しません。
28200	500	システム内部エラー	Server Internal error.	予期しないエラーが発生しました。
28203	503	システム内部エラー。しばらくしてから再試行することを推奨します	Execute action timeout, please try later again	schedule-server との通信エラー。
23903	404	リクエストパラメータエラー	voice does not exist	音声ブロードキャストが存在しません。
23904	400	リクエストパラメータエラー	voice does not support this	この言語は音声ブロードキャストでサポートされていません。