API Push-to-Speech

Remarque : Les diffusions vocales créées via cette API peuvent uniquement être récupérées, modifiées ou supprimées via l'API.
Remarque : Les langues actuellement prises en charge pour les fichiers vocaux sont uniquement « en », « zh-Hans » et « zh-Hant ».

Authentification

Pour plus de détails, reportez-vous à la section Authentication Method dans la vue d’ensemble de l’API REST.

Créer/Mettre à jour une diffusion vocale

Si la diffusion vocale n’existe pas, elle sera créée. Si elle existe déjà, elle sera mise à jour.

Endpoint

POST v4/voices
              
              POST v4/voices

            
Afficher ce bloc de code dans la fenêtre flottante

Exemple de requête

En-têtes de requête

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

            
Afficher ce bloc de code dans la fenêtre flottante

Données de requête

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

            
Afficher ce bloc de code dans la fenêtre flottante

Description des données de requête

  • language : spécifie la langue du fichier de diffusion vocale et est utilisé pour sélectionner la langue de diffusion vocale requise par l’utilisateur.
  • file : le fichier ZIP utilisé pour la diffusion vocale, contenant tous les fichiers MP3 requis.

Exemple de réponse

Réponse réussie

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

            
Afficher ce bloc de code dans la fenêtre flottante
{ "file_url": "" }
              
              {
  "file_url": ""
}

            
Afficher ce bloc de code dans la fenêtre flottante
  • file_url : l’URL de téléchargement du fichier téléversé dans Huawei Cloud OBS.

Réponse d’échec

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

            
Afficher ce bloc de code dans la fenêtre flottante
{ "error": { "code": 28400, "message": "error message" } }
              
              {
  "error": {
    "code": 28400,
    "message": "error message"
  }
}

            
Afficher ce bloc de code dans la fenêtre flottante

Description du format des fichiers vocaux

Les fichiers de diffusion vocale pris en charge par cette API doivent être nommés selon les nombres et mots spécifiés, et chaque fichier doit utiliser le format .mp3. Les conventions de nommage suivantes sont prises en charge :

  • Anglais (en) :

    • Nombres : "0" à "20", "30", "40", "50", "60", "70", "80", "90", "100", "1000", "1000000", "1000000000"
    • Mots : "point", "and"
  • Chinois (zh) :

    • Nombres : "0" à "10", "100", "1000", "10000", "100000000"
    • Mots : "point"

Assurez-vous que tous les fichiers sont au format MP3 afin de garantir une intégration correcte au système.

Obtenir la liste des diffusions vocales

Endpoint

GET v4/voices

Exemple de requête

En-têtes de requête

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

            
Afficher ce bloc de code dans la fenêtre flottante
  • Règle de tri : tri par heure de mise à jour, de la plus récente à la plus ancienne.

Exemple de réponse

Réponse réussie

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

            
Afficher ce bloc de code dans la fenêtre flottante
[ { "language": "en", "file_url": "" } ]
              
              [
  {
    "language": "en",
    "file_url": ""
  }
]

            
Afficher ce bloc de code dans la fenêtre flottante
  • Retourne une liste des diffusions vocales valides de cette application.
  • Le language retourné est la langue demandée par le client lors de la création ou de la mise à jour.
  • Le file_url retourné est l’URL de téléchargement Huawei Cloud OBS correspondant au fichier téléversé par le client lors de la création ou de la mise à jour.

Obtenir les détails d’une diffusion vocale

Endpoint

GET v4/voices/{language}

Exemple de requête

En-têtes de requête

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

            
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse

Réponse réussie

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

            
Afficher ce bloc de code dans la fenêtre flottante

Données de réponse

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

            
Afficher ce bloc de code dans la fenêtre flottante
  • Si la langue n’existe pas, 404 est renvoyé. Sinon, le file_url effectivement renvoyé est l’URL de téléchargement Huawei Cloud OBS correspondant au fichier téléversé.

Supprimer un fichier vocal

Endpoint

DELETE v4/voices/{language}

Exemple de requête

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

            
Afficher ce bloc de code dans la fenêtre flottante

Exemple de réponse

Réponse réussie

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

            
Afficher ce bloc de code dans la fenêtre flottante

Réponse d’échec

  • Langue invalide ou langue inexistante.
HTTP/1.0 404 Not Found Content-Type: application/json
              
              HTTP/1.0 404 Not Found
Content-Type: application/json

            
Afficher ce bloc de code dans la fenêtre flottante
  • Opération de mise à jour invalide.
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

            
Afficher ce bloc de code dans la fenêtre flottante
{ "error": { "code": 23903, "message": "voice does not exist" } }
              
              {
  "error": {
    "code": 23903,
    "message": "voice does not exist"
  }
}

            
Afficher ce bloc de code dans la fenêtre flottante

Codes d’erreur

Code HTTP Description Error Message Detailed Explanation
28000 200 Réponse correcte renvoyée nil Code de statut de réussite
28101 401 Échec de l’authentification Basic authentication failed. appkey et mastersecret ne correspondent pas.
28200 500 Erreur interne du système Server Internal error. Une erreur inattendue s’est produite.
28203 503 Erreur interne du système ; il est recommandé de réessayer plus tard Execute action timeout, please try later again Erreur de communication avec schedule-server.
23903 404 Erreur de paramètre de requête voice does not exist La diffusion vocale n’existe pas
23904 400 Erreur de paramètre de requête voice does not support this La diffusion vocale ne prend pas en charge cette langue
Icon Solid Transparent White Qiyu
Contactez-nous