API Push-to-Speech

Nota: Las emisiones de voz creadas mediante esta API solo pueden recuperarse, modificarse o eliminarse a través de la propia API.
Nota: Los tipos de idioma admitidos actualmente para los archivos de voz son únicamente "en", "zh-Hans" y "zh-Hant".

Autenticación

Para obtener más información, consulta la sección Método de autenticación en la descripción general de la API REST.

Crear/actualizar una emisión de voz

Si la emisión de voz no existe, se creará. Si ya existe, se actualizará.

Endpoint

POST v4/voices
              
              POST v4/voices

            
Este bloque de código se muestra en una ventana flotante

Ejemplo de solicitud

Encabezados de la solicitud

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

            
Este bloque de código se muestra en una ventana flotante

Datos de la solicitud

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

            
Este bloque de código se muestra en una ventana flotante

Descripción de los datos de la solicitud

  • language: especifica el idioma del archivo de emisión de voz y se utiliza para seleccionar el idioma de emisión de voz requerido por el usuario.
  • file: archivo ZIP utilizado para la emisión de voz, que contiene todos los archivos MP3 necesarios.

Ejemplo de respuesta

Respuesta correcta

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

            
Este bloque de código se muestra en una ventana flotante
{ "file_url": "" }
              
              {
  "file_url": ""
}

            
Este bloque de código se muestra en una ventana flotante
  • file_url: URL de descarga del archivo cargado en Huawei Cloud OBS.

Respuesta fallida

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

            
Este bloque de código se muestra en una ventana flotante
{ "error": { "code": 28400, "message": "error message" } }
              
              {
  "error": {
    "code": 28400,
    "message": "error message"
  }
}

            
Este bloque de código se muestra en una ventana flotante

Descripción del formato del archivo de voz

Los archivos de emisión de voz admitidos por esta API deben nombrarse según los números y palabras especificados, y cada archivo debe utilizar el formato .mp3. Se admiten las siguientes convenciones de nomenclatura:

  • Inglés (en):

    • Números: "0" a "20", "30", "40", "50", "60", "70", "80", "90", "100", "1000", "1000000", "1000000000"
    • Palabras: "point", "and"
  • Chino (zh):

    • Números: "0" a "10", "100", "1000", "10000", "100000000"
    • Palabras: "point"

Asegúrate de que todos los archivos estén en formato MP3 para garantizar una integración correcta en el sistema.

Obtener la lista de emisiones de voz

Endpoint

GET v4/voices

Ejemplo de solicitud

Encabezados de la solicitud

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

            
Este bloque de código se muestra en una ventana flotante
  • Regla de ordenación: se ordena por hora de actualización, con el más reciente en primer lugar.

Ejemplo de respuesta

Respuesta correcta

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

            
Este bloque de código se muestra en una ventana flotante
[ { "language": "en", "file_url": "" } ]
              
              [
  {
    "language": "en",
    "file_url": ""
  }
]

            
Este bloque de código se muestra en una ventana flotante
  • Devuelve una lista de emisiones de voz válidas de esta aplicación.
  • El language devuelto es el idioma solicitado por el cliente durante la creación o la actualización.
  • El file_url devuelto es la URL de descarga de Huawei Cloud OBS correspondiente al archivo cargado por el cliente durante la creación o la actualización.

Obtener los detalles de una emisión de voz

Endpoint

GET v4/voices/{language}

Ejemplo de solicitud

Encabezados de la solicitud

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

            
Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Respuesta correcta

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

            
Este bloque de código se muestra en una ventana flotante

Datos de la respuesta

{ "file_url": "" }
              
              {
  "file_url": ""
}

            
Este bloque de código se muestra en una ventana flotante
  • Si el idioma no existe, se devuelve 404. En caso contrario, el file_url devuelto es la URL de descarga de Huawei Cloud OBS correspondiente al archivo cargado.

Eliminar un archivo de voz

Endpoint

DELETE v4/voices/{language}

Ejemplo de solicitud

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

            
Este bloque de código se muestra en una ventana flotante

Ejemplo de respuesta

Respuesta correcta

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

            
Este bloque de código se muestra en una ventana flotante

Respuesta fallida

  • Idioma no válido o el idioma no existe.
HTTP/1.0 404 Not Found Content-Type: application/json
              
              HTTP/1.0 404 Not Found
Content-Type: application/json

            
Este bloque de código se muestra en una ventana flotante
  • Operación de actualización no válida.
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

            
Este bloque de código se muestra en una ventana flotante
{ "error": { "code": 23903, "message": "voice does not exist" } }
              
              {
  "error": {
    "code": 23903,
    "message": "voice does not exist"
  }
}

            
Este bloque de código se muestra en una ventana flotante

Códigos de error

Code HTTP Description Error Message Detailed Explanation
28000 200 Respuesta correcta devuelta nil Código de estado correcto
28101 401 Error de autenticación Basic authentication failed. appkey y mastersecret no coinciden.
28200 500 Error interno del sistema Server Internal error. Se ha producido un error inesperado.
28203 503 Error interno del sistema; se recomienda reintentar más tarde Execute action timeout, please try later again Error de comunicación con schedule-server.
23903 404 Error en el parámetro de la solicitud voice does not exist La emisión de voz no existe.
23904 400 Error en el parámetro de la solicitud voice does not support this La emisión de voz no admite este idioma.
Icon Solid Transparent White Qiyu
Contacto