Tin nhắn đa kênh: Zalo => SMS OTP/CSKH
Giải pháp Multi-Channel Messaging API cho phép bạn gửi tin nhắn đến khách hàng bằng tin ZNS và tự động gửi tin SMS nếu tin ZNS gửi thất bại.
HTTP request
POST https://rest.esms.vn/MainService.svc/json/MultiChannelMessage/
Content Type: application/json
Response Type: application/json
curl --location 'https://rest.esms.vn/MainService.svc/json/MultiChannelMessage/' \
--header 'Content-Type: application/json' \
--data '{
"ApiKey": "{{ApiKey}}",
"SecretKey": "{{SecretKey}}",
"Phone": "0901888484",
"Channels": [
"zalo",
"sms"
],
"Data": [
{
"TempID": "205644",
"Params": [
"686868"
],
"OAID": "4097311281936189049",
"campaignid": "Gửi OTP",
"CallbackUrl": "https://esms.vn/webhook/",
"RequestId": "c82cd356-bf49-4113-9466-65a7f6359c97",
"Sandbox":"0",
"SendingMode": "1"
},
{
"Content": "686868 la ma xac minh dang ky Baotrixemay cua ban",
"IsUnicode": "0",
"SmsType": "2",
"Brandname": "Baotrixemay",
"CallbackUrl": "https://esms.vn/webhook/",
"RequestId": "c82cd356-bf49-4113-9466-65a7f6359c98",
"Sandbox":"0"
}
]
}'Cấu trúc body của request:
ApiKey
string
ApiKey của tài khoản.
SecretKey
string
Secretkey của tài khoản.
Phone
string
Số điện thoại nhận tin.
Channels
string
Các kênh đa kênh Giá trị này không thay đổi. Không thay đổi thứ tự, không bỏ bớt kênh.
Data
array
Cấu hình gửi tin của kênh ZNS và SMS.
Cấu trúc thuộc tính Data[0]
TempID
string
Template của Zalo OA mà khách hàng đăng kí với eSMS.
Params
array
Giá trị cần truyền cho các biến trong Template *Lưu ý:
Các tham số truyền vào phải đúng thứ tự như template bạn đăng ký.
Nếu tham số trùng nhau chỉ cần truyền vào một tham số.
OAID
string
Zalo OA ID, là ID của trang Zalo Offical Account của doanh nghiệp. Doanh nghiệp cần đăng nhập vào trang quản trị của Zalo OA để lấy phần Zalo OA ID này. Chú ý: sẽ phải đăng ký trước khi sử dụng.
campaignid
string
Tên chiến dịch gửi tin, tối đa 254 ký tự
CallbackUrl
string
RequestId
string
ID đối tác truyền sang để chặn trùng và đối soát khi cần. Độ dài tối đa 50 ký tự. Mỗi RequestId truyền sang có hiệu lực chặn trong ngày.
Sandbox
string
1: Tin gửi ở môi trường test, dùng để kiểm tra kết nối và các thông số tích hợp, không về tin nhắn, không trừ tiền. 0: Tin gửi ở môi trường bình thường, có về tin nhắn.
SendingMode
string
Chế độ gửi: 1 (Default): Gửi thường, tin ZNS được gửi theo cơ chế thông thường. 3: Gửi vượt hạn mức, cho phép OA gửi tin ZNS tag 3 vượt hạn mức. Lưu ý: Chế độ Gửi vượt hạn mức (SendingMode = 3) chỉ áp dụng cho các OA được whitelist. Vui lòng liên hệ đội ngũ CSKH nếu có nhu cầu gửi ở chế độ Gửi vượt hạn mức.
Cấu trúc thuộc tính Data[1]
Content
string
Nội dung tin nhắn.
IsUnicode
string
Gửi tin nhắn có dấu 0: Gửi tin không dấu. 1: Gửi tin nhắn có dấu.
SmsType
string
2: Tin CSKH
Brandname
string
Tên Brandname (tên công ty hay tổ chức khi gửi tin sẽ hiển thị trên tin nhắn đó). Chú ý: sẽ phải đăng ký trước khi sử dụng.
CallbackUrl
string
RequestId
string
ID đối tác truyền sang để chặn trùng và đối soát khi cần.
Sandbox
string
1: Tin gửi ở môi trường test, dùng để kiểm tra kết nối và các thông số tích hợp, không về tin nhắn, không trừ tiền. 0: Tin gửi ở môi trường bình thường, có về tin nhắn.
Response:
{
"CodeResult": "100",
"CountRegenerate": 0,
"SMSID": "d8e0f1f0702544b2acb456ca9ccfd111250"
}Request hợp lệ.
Cấu trúc trả về của response:
CodeResult
string
Request được gửi đến ESMS thành công. Lưu ý: Mã phản hồi 100 chỉ xác nhận rằng yêu cầu đã được gửi thành công đến hệ thống ESMS, không phản ánh việc tin nhắn đã được gửi đến số điện thoại người nhận hay chưa. Để theo dõi trạng thái cuối cùng của tin nhắn, quý khách vui lòng truyền thêm tham số CallbackUrl; hệ thống ESMS sẽ tự động gửi phản hồi (callback) đến địa chỉ này khi có trạng thái cuối của tin.
SMSID
string
ID của tin nhắn mới được tạo ra trên hệ thống eSMS. Dùng ID này để query lấy trạng thái tin nhắn.
ErrorMessage
string
Thông tin lỗi trả về (nếu có lỗi).
Thông tin chi tiết mã lỗi xem ở bảng: Mã lỗi .
Lấy code mẫu của các ngôn ngữ ở link: Link Code mẫu .
Last updated