Đặc tả API

Xem thêm hướng dẫn chi tiết tại: https://documenter.getpostman.com/view/12951168/Uz5FHbSd

POST Text to speech

https://vbee.vn/api/v1/tts

Cấu trúc TTS API gửi request lên server như sau:

HTTP Request

URL: https://vbee.vn/api/v1/tts

Method: POST

Content Type: application/json

Response Type: text/json

Tham số Header

CẤU TRÚC BODY CỦA REQUEST

Kiểu Sentence (các tham số khi chuyển theo câu):

Danh sách mã giọng:

• Ngôn ngữ Tiếng Việt

HN - Ngọc Huyền: hn_female_ngochuyen_full_48k-fhg

HN - Anh Khôi: hn_male_phuthang_news65dt_44k-fhg

HN - Thanh Long: hn_male_thanhlong_talk_48k-fhg

HN - Mai Phương: hn_female_maiphuong_vdts_48k-fhg

HN - Mạnh Dũng: hn_male_manhdung_news_48k-fhg

HN - Anh Khôi (Đọc chuyện): hn_male_phuthang_stor80dt_48k-fhg

HN - Ngọc Lan: hn_female_hermer_stor_48k-fhg

HN - Nguyệt Dương: hn_female_lenka_stor_48k-phg

HN - Mạnh Dũng (nhấn nhá): hn_male_manhdung_news_48k-phg

SG - Tường Vy: sg_female_tuongvy_call_44k-fhg

SG - Lan Trinh: sg_female_lantrinh_vdts_48k-fhg

SG - Trung Kiên: sg_male_trungkien_vdts_48k-fhg

SG - Minh Hoàng: sg_male_minhhoang_full_48k-fhg

SG - Thảo Trinh: sg_female_thaotrinh_full_48k-fhg

Huế - Duy Phương: hue_male_duyphuong_full_48k-fhg

SG - Thảo Trinh (nhấn nhá): sg_female_thaotrinh_full_44k-phg

SG - Chí Đạt: sg_male_chidat_ebook_48k-phg

Huế - Hương Giang: hue_female_huonggiang_full_48k-fhg

SG - Thảo Trinh (nhấn nhá): sg_female_thaotrinh_full_44k-phg

SG - Chí Đạt: sg_male_chidat_ebook_48k-phg

• Ngôn ngữ quốc tế

KẾT QUẢ TRẢ VỀ

• status: trạng thái của API (1: thành công, 0: thất bại)

• error_code: mã lỗi

• error_message: chi tiết lỗi

• result: dữ liệu trả về khi gọi API thành công

  • app_id

  • request_id: mã request

  • characters: số ký tự của đoạn văn bản convert

  • voice_code

  • audio_type

  • speed_rate

  • bitrate

  • create_at

  • status: trạng thái của request (IN_PROGRESS)

Callback API

Khi request thành công, hệ thống VBEE TTS sẽ gửi đến Callback URL một HTTP POST như sau

URL: callback url truyền lên khi gọi API

Method: POST

Content Type: application/json

Body:

AUTHORIZATIONBearer TokenToken<token>BODYraw

{
    "app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
    "callbackUrl": "https://mydomain/callback",
    "input_text": "Chào mừng đén với website của chúng tôi! Đây là trang web cung cấp một giải pháp văn bản thành giọng nói, trên cơ sở, nó hỗ trợ các doanh nghiệp xây dựng các hệ thống trung tâm cuộc gọi tự động, hệ thống thông báo công khai, trợ lý ảo, tin tức âm thanh, podcast, sách âm thanh và tường thuật phim.",
    "voice_code": "hn_female_ngochuyen_full_48k-fhg",
    "audio_type":"mp3",
    "bitrate": 128,
    "speed_rate": "1.0"
}

Example RequestText to speechView More

curl --location --request POST 'https://vbee.vn/api/v1/tts' \
--data-raw '{
    "app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
    "callback_url": "https://mydomain/callback",
    "input_text": "Chào mừng đén với website của chúng tôi! Đây là trang web cung cấp một giải pháp văn bản thành giọng nói, trên cơ sở, nó hỗ trợ các doanh nghiệp xây dựng các hệ thống trung tâm cuộc gọi tự động, hệ thống thông báo công khai, trợ lý ảo, tin tức âm thanh, podcast, sách âm thanh và tường thuật phim.",
    "voice_code": "hn_female_ngochuyen_full_48k-fhg",
    "audio_type":"mp3",
    "bitrate": 128,
    "speed_rate": "1.0"
}'

Example Response200 OKBodyHeader(13)View More

{
  "result": {
    "app_id": "55e0053d-f86f-4c2b-b791-b1ba6d59a868",
    "audio_type": "mp3",
    "bitrate": 128,
    "characters": 297,
    "request_id": "5509d1e6-8906-4291-899b-c25643a624af",
    "speed_rate": "1.0",
    "status": "IN_PROGRESS",
    "voice_code": "hn_female_ngochuyen_full_48k-fhg"
  },

GET

Get Request

https://vbee.vn/api/v1/tts/{request_id}

API Get Request

Lấy thông tin của request bằng cách gọi API

URL: https://vbee.vn/api/v1/tts/{request_id}

Method: GET

Content Type: application/json

Response Type: text/json

Tham số Header

KẾT QUẢ TRẢ VỀ

• status: trạng thái của API (1: thành công, 0: thất bại)

• error_code: mã lỗi

• error_message: chi tiết lỗi

• result: dữ liệu trả về khi gọi API thành công

  • app_id

  • request_id: mã request

  • characters: số ký tự của đoạn văn bản convert

  • voice_code

  • audio_type

  • speed_rate

  • bitrate

  • create_at

  • progress: phần trăm xử lý của request

  • status: trạng thái của request

  • audio_link: Đường dẫn tải file audio tổng hợp

  • audio_expired: trạng thái của audio, true nếu audio đã hết hạn lưu trữ