API Push-to-Speech

Remarque : Les diffusions vocales créées via cette API ne peuvent être consultées, modifiées ou supprimées que via l'API. Remarque : Le type de langue du fichier vocal ne prend actuellement en charge que "en", "zh-Hans", "zh-Hant".

Authentification

Pour plus de détails, veuillez consulter la section vue d'ensemble de l'API REST sur les Méthodes d'authentification.

Créer/Mettre à jour une diffusion vocale

Crée une nouvelle diffusion vocale si elle n'existe pas ; la met à jour si elle existe.

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 la 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 la 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 la requête

  • language : Spécifie la langue du fichier de diffusion vocale, utilisée pour sélectionner la langue de diffusion requise.
  • file : Le fichier zip nécessaire à la diffusion vocale, contenant tous les fichiers mp3 nécessaires.

Exemple de réponse

Réponse en cas de succès

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 envoyé sur Huawei Cloud OBS.

Réponse en cas 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

Spécifications des fichiers audio

Les fichiers audio pour cette API doivent être nommés selon des numéros et mots spécifiés, chaque fichier étant au format .mp3. Voici les détails des noms pris 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 pour une intégration correcte au système.

Récupérer la liste des diffusions vocales

Endpoint

GET v4/voices

Exemple de requête

En-têtes de la 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
  • Ordre de tri : Dernières mises à jour en premier.

Exemple de réponse

Retour réussi

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 la liste des diffusions vocales valides pour cette application.
  • language correspond à la langue demandée lors de la création/mise à jour.
  • file_url est l'URL de téléchargement Huawei Cloud OBS du fichier envoyé.

Récupérer les détails d'une diffusion vocale

Endpoint

GET v4/voices/{language}

Exemple de requête

En-têtes de la 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

Retour réussi

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 la réponse

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

            
Afficher ce bloc de code dans la fenêtre flottante
  • Si language n'existe pas, retourne 404, sinon retourne le file_url réel qui est l'URL de téléchargement sur Huawei Cloud OBS du fichier envoyé.

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

Retour réussi

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

Retour en cas d'échec

  • Si language est invalide ou n'existe pas.
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
  • Si l'opération de mise à jour est illégale.
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

Codes d'erreur

Code Statut HTTP Description Message d'erreur Explication détaillée
28000 200 Réponse réussie nil Code de statut de réussite
28101 401 Échec de l'authentification Basic authentication failed. Appkey et masterscrect ne correspondent pas.
28200 500 Erreur interne du serveur Server Internal error. Une erreur inattendue s'est produite.
28203 503 Erreur interne du serveur, veuillez réessayer plus tard Execute action timeout, please try later again Erreur de communication avec schedule-server.
icon
Contactez-nous