API Push-to-Speech

Catatan: Siaran suara yang dibuat melalui API ini hanya dapat diakses, diubah, atau dihapus melalui API. Catatan: Bahasa file suara yang didukung saat ini hanya "en", "zh-Hans", "zh-Hant".

Autentikasi

Untuk detail lebih lanjut, silakan lihat bagian ikhtisar REST API pada Metode Autentikasi.

Membuat/Memperbarui Siaran Suara

Membuat siaran suara baru jika belum ada; memperbarui jika sudah ada.

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: Bahasa file siaran suara, digunakan untuk memilih bahasa siaran suara yang diperlukan.
• file: File zip yang berisi semua file mp3 yang dibutuhkan untuk siaran suara.

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"
    }
}

            

Spesifikasi File Audio

File audio untuk API ini harus diberi nama sesuai angka dan kata yang ditentukan, dengan format file .mp3. Berikut detail penamaan yang didukung:

• Bahasa Inggris (en):

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

• Bahasa Mandarin (zh):

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

Pastikan semua file berformat MP3 agar dapat terintegrasi dengan sistem dengan benar.

Mengambil Daftar Siaran Suara

Endpoint

GET v4/voices

Contoh Permintaan

Header Permintaan

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

            

• Urutan: Pembaruan terbaru ditampilkan terlebih dahulu.

Contoh Respons

Pengembalian Berhasil

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

            

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

            

• Mengembalikan daftar siaran suara yang valid dalam aplikasi tersebut.
• language sesuai permintaan saat pembuatan/pembaruan.
• file_url adalah URL unduhan file yang diunggah di Huawei Cloud OBS.

Mengambil Detail Siaran Suara

Endpoint

GET v4/voices/{language}

Contoh Permintaan

Header Permintaan

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

            

Contoh Respons

Pengembalian Berhasil

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

            

Data Respons

              
              {
   "file_url": ""
}

            

• Jika language tidak ditemukan, akan mengembalikan 404. Jika ada, akan mengembalikan file_url yang merupakan URL unduhan file di Huawei Cloud OBS.

Menghapus File Suara

Endpoint

DELETE v4/voices/{language}

Contoh Permintaan

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

            

Contoh Respons

Pengembalian Berhasil

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

            

Pengembalian Gagal

• Jika language tidak valid atau tidak ditemukan.

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

            

• Jika operasi pembaruan tidak sah.

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

            

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

            

Kode Error