API Auto Call cho phép hệ thống bên ngoài thêm khách hàng vào chiến dịch gọi tự động trên nền tảng Alohub. Ứng dụng phổ biến: gọi OTP, auto call marketing, đồng bộ danh sách khách hàng từ hệ thống thứ ba.
| Thông tin | Chi tiết |
|---|---|
| Base URL | {{baseUrl}}/api — Alohub cung cấp riêng cho từng tenant |
| Xác thực | Header Authorization: {{apikey}} |
| Content-Type | application/json |
| Giao thức | HTTPS |
/crm/addCampaignCustomer?userName={{userName}}
Thêm số điện thoại khách hàng vào chiến dịch Auto Call. Hệ thống sẽ tự động xếp hàng và thực hiện cuộc gọi theo cấu hình chiến dịch.
| Param | Bắt buộc | Mô tả |
|---|---|---|
userName |
Có | Tên tài khoản thực hiện yêu cầu (dùng để ghi nhận audit log) |
{
"phone": "84901234567",
"campaignId": 12345,
"externalId": "CUST-2024-001",
"otp": "123456"
}| Param | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
phone |
string | Có | Số điện thoại khách hàng (khuyến nghị định dạng 84xxx) |
campaignId |
integer | Có | Mã chiến dịch Auto Call (lấy từ giao diện CRM Alohub) |
externalId |
string | Không | Mã tham chiếu từ hệ thống bên ngoài, dùng để đối soát |
otp |
string | Không | Nội dung text-to-speech cho chiến dịch đọc OTP. Hệ thống sẽ tự đọc giá trị này cho khách hàng |
curl -X POST "{{baseUrl}}/api/crm/addCampaignCustomer?userName=admin01" \
-H "Authorization: {{apikey}}" \
-H "Content-Type: application/json" \
-d '{
"phone": "84901234567",
"campaignId": 12345,
"externalId": "CUST-2024-001",
"otp": "123456"
}'const axios = require('axios')
const BASE_URL = '{{baseUrl}}/api'
const API_KEY = '{{apikey}}'
async function addCampaignCustomer() {
try {
const response = await axios.post(
`${BASE_URL}/crm/addCampaignCustomer`,
{
phone: '84901234567',
campaignId: 12345,
externalId: 'CUST-2024-001',
otp: '123456'
},
{
params: { userName: 'admin01' },
headers: {
'Authorization': API_KEY,
'Content-Type': 'application/json'
}
}
)
console.log('Thành công:', response.data)
} catch (error) {
console.error('Lỗi:', error.response?.data || error.message)
}
}
addCampaignCustomer()import requests
BASE_URL = "{{baseUrl}}/api"
API_KEY = "{{apikey}}"
response = requests.post(
f"{BASE_URL}/crm/addCampaignCustomer",
params={"userName": "admin01"},
headers={
"Authorization": API_KEY,
"Content-Type": "application/json"
},
json={
"phone": "84901234567",
"campaignId": 12345,
"externalId": "CUST-2024-001",
"otp": "123456"
}
)
if response.ok:
print("Thành công:", response.json())
else:
print("Lỗi:", response.status_code, response.text)
Truyền mã OTP qua field otp, hệ thống sẽ sử dụng text-to-speech đọc mã cho khách hàng.
Phù hợp cho xác thực tài khoản, xác nhận giao dịch.
{
"phone": "84912345678",
"campaignId": 100,
"otp": "482916"
}
Thêm danh sách khách hàng vào chiến dịch callbot marketing. Không cần truyền otp —
kịch bản hội thoại được cấu hình sẵn trên giao diện Alohub.
{
"phone": "84987654321",
"campaignId": 200,
"externalId": "LEAD-2024-500"
}
Sử dụng externalId để liên kết khách hàng giữa hệ thống CRM bên ngoài và Alohub,
thuận tiện cho việc đối soát và báo cáo.
campaignId phải là mã của chiến dịch đang ở trạng thái hoạt động (Active).
Nếu chiến dịch đã tạm dừng hoặc kết thúc, API sẽ trả về lỗi.
84xxx — bỏ số 0 đầu, thêm mã quốc gia 84.
Ví dụ: 0901234567 → 84901234567.
externalId để liên kết khách hàng giữa hệ thống của bạn và Alohub,
giúp đối soát kết quả cuộc gọi dễ dàng qua webhook.