Tin mutichanel: 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 đi qua các kênh giao tiếp khác nhau như Zalo, SMS theo các thứ tự ưu tiên.

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": "{{Phone}}",
    "Channels": [
        "zalo",
        "sms"
    ],
    "Data": [
        {
            "TempID": "{{TempID}}",
            "Params": ["{{param1}}","{{param2}}","{{param3}}"],
            "OAID": "{{OAID}}",
            "campaignid": "{{campaignid}}",
            "CallbackUrl": "{{CallbackUrl}}",
            "RequestId":"{{RequestId}}",
            "Sandbox":"{{Sandbox}}"
        },
        {
            "Content": "{{Content}}",
            "IsUnicode": "{{IsUnicode}}",
            "SmsType": "{{SmsType}}",
            "Brandname": "{{Brandname}}",
            "CallbackUrl": "{{CallbackUrl}}",
            "Sandbox":"{{Sandbox}}"
        }
    ]
}'
  • Cấu trúc body của request:

Tham sốKiểu dữ liệuTính bắt buộcMô tả

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.

Params

string

Giá trị cần truyền cho các biến trong Template *Lưu ý:

  1. Các tham số truyền vào phải đúng thứ tự như template bạn đăng ký.

  2. Nếu tham số trùng nhau chỉ cần truyền vào một tham số.

TempID

string

Template của Zalo OA mà khách hàng đăng kí với eSMS.

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.

RequestId

string

ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa. Ví dụ: RequestId=123456

campaignid

string

Tên chiến dịch gửi tin, tối đa 254 ký tự

RequestId

string

ID Tin nhắn của đối tác, dùng để kiểm tra ID này đã được hệ thống esms tiếp nhận trước đó hay chưa. Ví dụ: RequestId=123456

CallbackUrl

string

Hàm gửi tin này sẽ truyền link callback riêng cho từng loại tin nhắn. URL nhận kết quả gửi tin. Xem body mẫu ZNS ở đây. Xem body mẫu SMS ở đây. Xem chi tiết ở đây.

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.

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:

Thuộc tínhKiểu dữ liệuMô tả

CodeResult

string

Mã trả về.

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).

Last updated