API thực hiện cuộc gọi ra và phát file ghi âm có sẵn cho khách hàng nghe. Phù hợp cho các tình huống thông báo tự động: nhắc lịch hẹn, xác nhận đơn hàng, nhắc nợ, khảo sát, v.v.
Xác thực: Request cần gửi header
X-Api-Key. Liên hệ Alohub để được cấp API Key.
Yêu cầu: File ghi âm phải được cấu hình sẵn trong chiến dịch (
campaignId). Nếu chưa có file, liên hệ team kỹ thuật để upload file audio vào campaign trước khi gọi API.
{{base_url}}/v1/voice/play-fileHeader | Bắt buộc | Mô tả |
|---|---|---|
| Có | API Key xác thực |
| Có |
|
Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
| string | Có | Số điện thoại khách hàng |
| number | Có | ID chiến dịch (chứa file ghi âm đã cấu hình sẵn) |
| string | Không | ID giao dịch do client tạo ra để đối chiếu kết quả qua webhook |
curl --location -g '{{base_url}}/v1/voice/play-file' \
--header 'X-Api-Key: {{api_key}}' \
--header 'Content-Type: application/json' \
--data '{
"phone": "0123456789",
"campaignId": 1,
"transactionId": "TXN_002"
}'const axios = require('axios')
const response = await axios.post('{{base_url}}/v1/voice/play-file', {
phone: '0123456789',
campaignId: 1,
transactionId: 'TXN_002'
}, {
headers: {
'X-Api-Key': '{{api_key}}',
'Content-Type': 'application/json'
}
})
console.log(response.data)import requests
response = requests.post('{{base_url}}/v1/voice/play-file',
json={
'phone': '0123456789',
'campaignId': 1,
'transactionId': 'TXN_002'
},
headers={
'X-Api-Key': '{{api_key}}',
'Content-Type': 'application/json'
}
)
print(response.json())So sánh với Text-to-Speech: Dùng Phát Audio khi nội dung cố định và cần chất lượng giọng tốt (thu sẵn). Dùng Text-to-Speech khi nội dung động (mã OTP, số tiền, tên khách hàng, v.v.) không thể thu sẵn.