Gọi ra Text-to-speech

API thực hiện cuộc gọi ra và đọc nội dung văn bản cho khách hàng nghe bằng giọng nói tự động (TTS — Text-to-Speech). Phù hợp cho các tình huống cần nội dung động như đọc mã OTP, số dư tài khoản, thông báo nội dung tuỳ biến theo từng khách.

Xác thực: Request cần gửi header X-Api-Key. Liên hệ Alohub để được cấp API Key.

Endpoint

POST `{{base_url}}/v1/voice/text-to-speech`

Headers

Header	Bắt buộc	Mô tả
`X-Api-Key`	Có	API Key xác thực
`Content-Type`	Có	`application/json`

Request Body

Tham số	Kiểu	Bắt buộc	Mô tả
`phone`	string	Có	Số điện thoại khách hàng
`transactionId`	string	Không	ID giao dịch do client tạo ra để đối chiếu kết quả qua webhook
`otp`	string	Có	Văn bản cần đọc cho khách hàng nghe. Có thể chứa số, chữ, dấu câu (VD: mã OTP, nội dung thông báo động)

Code mẫu

curl --location -g '{{base_url}}/v1/voice/text-to-speech' \
  --header 'X-Api-Key: {{api_key}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "phone": "0123456789",
    "transactionId": "TXN_003",
    "otp": "Mã xác nhận của bạn là 482615"
  }'

const axios = require('axios')

const response = await axios.post('{{base_url}}/v1/voice/text-to-speech', {
  phone: '0123456789',
  transactionId: 'TXN_003',
  otp: 'Mã xác nhận của bạn là 482615'
}, {
  headers: {
    'X-Api-Key': '{{api_key}}',
    'Content-Type': 'application/json'
  }
})

console.log(response.data)

import requests

response = requests.post('{{base_url}}/v1/voice/text-to-speech',
  json={
    'phone': '0123456789',
    'transactionId': 'TXN_003',
    'otp': 'Mã xác nhận của bạn là 482615'
  },
  headers={
    'X-Api-Key': '{{api_key}}',
    'Content-Type': 'application/json'
  }
)

print(response.json())

Ví dụ nội dung TTS

Use case	Nội dung `otp`	Ghi chú
Đọc mã OTP	`"Mã xác nhận của bạn là 4 8 2 6 1 5"`	Tách số bằng space để đọc rõ từng chữ số
Nhắc lịch hẹn	`"Bạn có lịch hẹn vào 9 giờ ngày mai"`	Dùng chữ viết thường cho giọng tự nhiên
Xác nhận đơn	`"Đơn hàng 12345 của bạn đã được xác nhận"`	Mã đơn đọc liền hoặc tách tuỳ ngữ cảnh

Lưu ý: Nội dung otp nên ngắn gọn (dưới 200 ký tự) để đảm bảo khách hàng nghe được toàn bộ. Với nội dung cố định lặp lại nhiều lần, dùng Gọi ra phát Audio với file thu sẵn để chất lượng tốt hơn.