推播語音播報 API

注：透過此 API 創建的語音播報，只能透過 API 進行獲取、修改或刪除操作。註：語音檔案語言類型目前僅支援"en", "zh-Hans", "zh-Hant"。

調用驗證

更多詳情請參考 REST API 概述中的鑑權方式。

創建/更新語音播報

如果語音播報不存在，則創建；如果已存在，則更新。

調用地址

POST v4/voices

          POST v4/voices

此代碼塊在浮窗中顯示

請求示例

請求報頭

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

此代碼塊在浮窗中顯示

請求數據

--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：上傳文件在華為雲 OBS 的下載地址。

失敗響應

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 格式，以便與系統正確集成。

獲取語音播報列表

調用地址

GET v4/voices

請求示例

請求報頭

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

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

此代碼塊在浮窗中顯示

排序規則：更新時間從最新開始。

返回示例

成功返回

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 為創建/更新時客戶上傳文件對應的華為雲obs下載地址。

獲取語音播報詳情

調用地址

GET v4/voices/{language}

請求示例

請求報頭

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

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

此代碼塊在浮窗中顯示

返回示例

成功返回

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 為上傳文件對應的華為雲obs下載地址。

刪除語音文件

調用地址

DELETE v4/voices/{language}

請求示例

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

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

此代碼塊在浮窗中顯示

返回示例

成功返回

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

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

此代碼塊在浮窗中顯示

失敗返回

language 無效，不存在的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 message" } }

          {
    "error": {
        "code": 28400,
        "message": "error message"
    }
}

此代碼塊在浮窗中顯示

錯誤碼

Code	HTTP	描述	Error Message	詳細解釋
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 通信錯誤。