Push-to-Speech-API

Hinweis: Über diese API erstellte Sprachansagen können nur über die API abgerufen, geändert oder gelöscht werden.
Hinweis: Die derzeit unterstützten Sprachtypen für Sprachdateien sind ausschließlich "en", "zh-Hans" und "zh-Hant".

Authentifizierung

Weitere Details finden Sie im Abschnitt Authentication Method in der REST-API-Übersicht.

Sprachansage erstellen/aktualisieren

Wenn die Sprachansage nicht vorhanden ist, wird sie erstellt. Falls sie bereits vorhanden ist, wird sie aktualisiert.

Endpoint

              
              POST v4/voices

            

Anfragebeispiel

Request Headers

              
              POST /v4/voices
Authorization: Basic (base64 auth string)
Content-Type: multipart/form-data
Accept: multipart/form-data

            

Anfragedaten

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

            

Beschreibung der Anfragedaten

• language: Gibt die Sprache der Sprachansagedatei an und wird verwendet, um die vom Benutzer benötigte Sprache der Sprachansage auszuwählen.
• file: Die ZIP-Datei für die Sprachansage, die alle erforderlichen MP3-Dateien enthält.

Antwortbeispiel

Erfolgreiche Antwort

              
              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: Die Download-URL der hochgeladenen Datei in Huawei Cloud OBS.

Fehlgeschlagene Antwort

              
              HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8

            

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

            

Beschreibung des Sprachdateiformats

Von dieser API unterstützte Sprachansagedateien müssen gemäß den angegebenen Zahlen und Wörtern benannt werden, und jede Datei muss das Format .mp3 verwenden. Die folgenden Benennungskonventionen werden unterstützt:

• Englisch (en):

  • Zahlen: "0" bis "20", "30", "40", "50", "60", "70", "80", "90", "100", "1000", "1000000", "1000000000"
  • Wörter: "point", "and"

• Chinesisch (zh):

  • Zahlen: "0" bis "10", "100", "1000", "10000", "100000000"
  • Wörter: "point"

Stellen Sie sicher, dass alle Dateien im MP3-Format vorliegen, um eine ordnungsgemäße Systemintegration zu gewährleisten.

Liste der Sprachansagen abrufen

Endpoint

GET v4/voices

Anfragebeispiel

Request Headers

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

            

• Sortierregel: nach Aktualisierungszeit, die neuesten zuerst.

Antwortbeispiel

Erfolgreiche Antwort

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

            

              
              [
  {
    "language": "en",
    "file_url": ""
  }
]

            

• Gibt eine Liste gültiger Sprachansagen unter dieser Anwendung zurück.
• Das zurückgegebene language ist die Sprache, die der Client beim Erstellen oder Aktualisieren angefordert hat.
• Das zurückgegebene file_url ist die Huawei Cloud OBS-Download-URL, die der vom Client beim Erstellen oder Aktualisieren hochgeladenen Datei entspricht.

Details der Sprachansage abrufen

Endpoint

GET v4/voices/{language}

Anfragebeispiel

Request Headers

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

            

Antwortbeispiel

Erfolgreiche Antwort

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

            

Antwortdaten

              
              {
  "file_url": ""
}

            

• Falls die Sprache nicht existiert, wird 404 zurückgegeben. Andernfalls ist das tatsächlich zurückgegebene file_url die Huawei Cloud OBS-Download-URL, die der hochgeladenen Datei entspricht.

Sprachdatei löschen

Endpoint

DELETE v4/voices/{language}

Anfragebeispiel

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

            

Antwortbeispiel

Erfolgreiche Antwort

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

            

Fehlgeschlagene Antwort

• Ungültige Sprache oder die Sprache existiert nicht.

              
              HTTP/1.0 404 Not Found
Content-Type: application/json

            

• Ungültiger Aktualisierungsvorgang.

              
              HTTP/1.1 400 BAD REQUEST
Content-Type: application/json; charset=utf-8

            

              
              {
  "error": {
    "code": 23903,
    "message": "voice does not exist"
  }
}

            

Fehlercodes