Chuyển tới nội dung chính

API gửi tin nhắn Voice OTP

Tài liệu này hướng dẫn cách sử dụng API để gửi tin nhắn Voice OTP

📝 Mô tả​

API này cho phép gửi tin nhắn Voice OTP đến một số điện thoại cụ thể bằng brand đã được cấu hình sẵn.


  • Phương thức: POST
  • Endpoint: https://your.domain.com/api/public/sms/send
  • Yêu cầu xác thực: Authorization: Basic {API_KEY}

🔐 Header yêu cầu​

TênGiá trịBắt buộc
AuthorizationBasic {API_KEY}✅

📦 Dữ liệu gửi lên (Request Body)​

{
"phone": "84xxxxxxx",
"msg": "Nội dung gửi đi",
"brand": "ABC",
"tracking_id": "123456789"
}
TrườngLoạiMô tảBắt buộc
phonestringSố điện thoại người nhận định dạng 84x hoặc 0x✅
datastringNội dung tin nhắn được gửi đi✅
brandstringTên brand đã đăng ký và kích hoạt✅
tracking_idstringId tin nhắn của khách hàng❌

✅ Phản hồi thành công​

  • HTTP Code: 200
{
"message": "Thành công",
"msg_id": "e7c57cd5-77f9-4a45-9b51-4dce26de2199",
"status": "200"
}
  • Ý nghĩa: Tin nhắn đã được xử lý và đưa vào hàng đợi gửi.

❌ Phản hồi thất bại​

  • HTTP Code: 400
{
"message": "User not found",
"status": "-400"
}

💻 Ví dụ gửi tin cuộc gọi​

curl -X POST https://your-domain.com/api/v1/sms/send \
-H "Authorization: Basic YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"phone": "84901234567",
"msg": "Chúc quý khách một ngày tốt lành!"
"brand": "ABC_CORP",
"tracking_id": "123456789"
},


📌 Ghi chú​

  • Domain: phụ thuộc vào mỗi khách hàng, sẽ có các tên miền khác nhau. Tên miền sẽ được cung cấp khi tích hợp .
  • Key: sẽ được cung cấp khi tích hợp.