search
Đăng nhập

Tin nhắn Zalo

hashtag
HTTP request

POST https://rest.esms.vn/MainService.svc/json/SendZaloMessage_V6/arrow-up-right

  • Content Type: application/json

  • Response Type: application/json

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": "[email protected]",
        "product_name": "Gói duy trì OA Zalo Premium 1 năm",
        "quantity": "1",
        "payment_amount": "4308000",
        "delivery_date": "01/08/2024"
    },
    "TempID":  "200607",
    "SendingMode":"1",
    "campaignid":  "Xác nhận mua hàng",
    "RequestId": "96accf59-0c41-4bc7-a5c4-4a466c2e41c2",
    "CallbackUrl": "https://esms.vn/webhook/"
}'

  • Cấu trúc body của request:

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

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 24h.

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 ở đâyarrow-up-right. Xem chi tiết ở đây.

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.

  • Response:

Request hợp lệ.

  • Cấu trúc body của response:

Thuộc tính
Kiểu dữ liệu
Mô tả

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

PreviousTin nhắn SMS OTP/CSKH (Khuyên Dùng)NextTin nhắn đa kênh: Zalo => SMS OTP/CSKH

Last updated