推送语音播报 API

最新更新:2025-05-08

注: 通过此 API 创建的语音播报,只能通过 API 进行获取、修改或删除操作。 注: 语音文件语言类型目前仅支持"en", "zh-Hans", "zh-Hant"。

调用验证

更多详情请参考 REST API 概述中的鉴权方式

创建/更新语音播报

如果语音播报不存在,则创建;如果已存在,则更新。

调用地址

POST https://push.api.engagelab.cc/v4/voices
          POST https://push.api.engagelab.cc/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 https://push.api.engagelab.cc/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 https://push.api.engagelab.cc/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 https://push.api.engagelab.cc/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 通信错误。
在文档中心打开
Contact Sales