Tin nhắn Zalo | eSMS for Developers

curl --location 'https://rest.esms.vn/MainService.svc/json/SendZaloMessage_V6/' \
--header 'Content-Type: application/json' \
--data '{
    "ApiKey": "APIKEYCUABAN",
    "SecretKey": "SECRETKEYCUABAN",
    "OAID": "4097311281936189049",
    "Phone": "0901888484",
    "TempData": {
        "customer_name": "Đinh Thái Hà",
        "order_code": "HD00001",
        "address": "140-142 Đường Số 1, KDC Vạn Phúc, Hiệp Bình Phước, Thủ Đức",
        "phone": "0901888484",
        "email": "dinhthaiha@vihatgroup.com",
        "product_name": "Gói duy trì OA Zalo Premium 1 năm",
        "quantity": "1",
        "payment_amount": "4308000",
        "delivery_date": "01/08/2024"
    },
    "TempID":  "200607",
    "campaignid":  "Xác nhận mua hàng",
    "RequestId": "96accf59-0c41-4bc7-a5c4-4a466c2e41c2",
    "CallbackUrl": "https://esms.vn/webhook/"
}'

Tham số	Kiểu dữ liệu	Mô tả
Phone	string	Số điện thoại người nhận.
ApiKey	string	ApiKey eSMS cung cấp.
SecretKey	string	SecretKey eSMS cung cấp.
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.
TempData	JSON object	Các thuộc tính của template mà khách hàng eSMS đã đăng ký với Zalo. Chú ý: Cấu trúc TempData được quy định riêng ứng với từng template.
SendDate	string	Thời gian hẹn gửi của tin. Không truyền khi tin muốn tin nhắn gửi đi liền. Định dạng: yyyy-mm-dd hh:MM:ss.
TempID	string	Template của Zalo OA mà khách hàng đăng kí với eSMS.
campaignid	string	Tên chiến dịch gửi tin, tối đa 254 ký tự.
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.
CallbackUrl	string	URL nhận kết quả gửi tin. Xem body mẫu ở đây. Xem chi tiết ở đây.

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

Phone

string

Số điện thoại người nhận.

ApiKey

string

ApiKey eSMS cung cấp.

SecretKey

string

SecretKey eSMS cung cấp.

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.

TempData

JSON object

Các thuộc tính của template mà khách hàng eSMS đã đăng ký với Zalo. Chú ý: Cấu trúc TempData được quy định riêng ứng với từng template.

SendDate

string

Thời gian hẹn gửi của tin. Không truyền khi tin muốn tin nhắn gửi đi liền. Định dạng: yyyy-mm-dd hh:MM:ss.

TempID

string

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

campaignid

string

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

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.

CallbackUrl

string

URL nhận kết quả gửi tin. Xem body mẫu ở đây. Xem chi tiết ở đây.

{
    "CodeResult": "100",
    "CountRegenerate": 0,
    "SMSID": "d8e0f1f0702544b2acb456ca9ccfd111250"
}

Request hợp lệ.

{
    "CodeResult": "101",
    "CountRegenerate": 0,
    "ErrorMessage": "Authorize Failed"
}

Sai thông tin ApiKey/SecretKey.

{
    "CodeResult": "789",
    "CountRegenerate": 0,
    "ErrorMessage": "TemplateId is not config"
}

Template chưa được cấu hình cho OA ID bạn đang sử dụng.

Thuộc tính	Kiểu dữ liệu	Mô 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).

Thuộc tính

Kiểu dữ liệu

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

HTTP request