API Push-to-Speech

Catatan: Siaran suara yang dibuat melalui API ini hanya dapat diambil, diubah, atau dihapus melalui API.
Catatan: Jenis bahasa yang saat ini didukung untuk file suara hanya "en", "zh-Hans", dan "zh-Hant".

Autentikasi

Untuk detail selengkapnya, lihat bagian Metode Autentikasi pada Ikhtisar REST API.

Membuat/Memperbarui Siaran Suara

Jika siaran suara belum ada, siaran suara akan dibuat. Jika sudah ada, siaran suara akan diperbarui.

Endpoint

              
              POST v4/voices

            

Contoh Permintaan

Header Permintaan

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

            

Data Permintaan

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

            

Deskripsi Data Permintaan

• language: Menentukan bahasa file siaran suara dan digunakan untuk memilih bahasa siaran suara yang dibutuhkan pengguna.
• file: File ZIP yang digunakan untuk siaran suara, berisi semua file MP3 yang diperlukan.

Contoh Respons

Respons Berhasil

              
              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: URL unduhan file yang diunggah ke Huawei Cloud OBS.

Respons Gagal

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

            

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

            

Deskripsi Format File Suara

File siaran suara yang didukung oleh API ini harus diberi nama sesuai angka dan kata yang ditentukan, dan setiap file harus menggunakan format .mp3. Konvensi penamaan berikut didukung:

• Inggris (en):

  • Angka: "0" hingga "20", "30", "40", "50", "60", "70", "80", "90", "100", "1000", "1000000", "1000000000"
  • Kata: "point", "and"

• Tionghoa (zh):

  • Angka: "0" hingga "10", "100", "1000", "10000", "100000000"
  • Kata: "point"

Pastikan semua file menggunakan format MP3 agar integrasi sistem berjalan dengan benar.

Mendapatkan Daftar Siaran Suara

Endpoint

GET v4/voices

Contoh Permintaan

Header Permintaan

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

            

• Aturan pengurutan: diurutkan berdasarkan waktu pembaruan, dengan data terbaru ditampilkan terlebih dahulu.

Contoh Respons

Respons Berhasil

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

            

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

            

• Mengembalikan daftar siaran suara yang valid di bawah aplikasi ini.
• language yang dikembalikan adalah bahasa yang diminta klien saat pembuatan atau pembaruan.
• file_url yang dikembalikan adalah URL unduhan Huawei Cloud OBS yang sesuai dengan file yang diunggah klien saat pembuatan atau pembaruan.

Mendapatkan Detail Siaran Suara

Endpoint

GET v4/voices/{language}

Contoh Permintaan

Header Permintaan

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

            

Contoh Respons

Respons Berhasil

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

            

Data Respons

              
              {
  "file_url": ""
}

            

• Jika bahasa tidak ada, 404 akan dikembalikan. Jika ada, file_url yang dikembalikan adalah URL unduhan Huawei Cloud OBS yang sesuai dengan file yang diunggah.

Menghapus File Suara

Endpoint

DELETE v4/voices/{language}

Contoh Permintaan

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

            

Contoh Respons

Respons Berhasil

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

            

Respons Gagal

• Bahasa tidak valid, atau bahasa tersebut tidak ada.

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

            

• Operasi pembaruan tidak valid.

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

            

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

            

Kode Error