Tin Zalo giao dịch

HTTP request

POST https://rest.esms.vn/mainservice.svc/json/SendZaloFollowerMessage_V5_post_json/

  • Content Type: application/json

  • Response Type: application/json

curl --location 'https://rest.esms.vn/mainservice.svc/json/SendZaloFollowerMessage_V5_post_json/' \
--header 'Content-Type: application/json' \
--data '{
    "ApiKey": "{{ApiKey}}",
    "SecretKey": "{{SecretKey}}",
    "OAID": "{{OAID}}",
    "CallbackUrl": "{{CallbackUrl}}",
    "Sandbox":0,
    "Payload": {
        "recipient": {
            "user_id": "{{user_id}}"
        },
        "message": {
            "attachment": {
                "type": "template",
                "payload": {
                    "template_type": "{{template_type}}",
                    "language": "{{language}}",
                    "elements": [
                        {
                            "image_url": "{{image_url}}",
                            "type": "banner"
                        },
                        {
                            "type": "header",
                            "content": "{{content}}",
                            "align": "{{align}}"
                        },
                        {
                            "type": "text",
                            "align": "{{align}}",
                            "content": "{{content}}"
                        },
                        {
                            "type": "table",
                            "content": [
                                {
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                },
                                {
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                },
                                {
                                    "style": "{{style}}",
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                },
                                {
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                },
                                {
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                },
                                {
                                    "value": "{{value}}",
                                    "key": "{{key}}"
                                }
                            ]
                        },
                        {
                            "type": "text",
                            "align": "{{align}}",
                            "content": "{{content}}"
                        }
                    ],
                    "buttons": [
                        {
                            "title": "{{title}}",
                            "image_icon": "{{image_icon}}",
                            "type": "oa.open.url",
                            "payload": {
                                "url": "{{url}}"
                            }
                        },
                        {
                            "title": "{{title}}",
                            "image_icon": "{{image_icon}}",
                            "type": "oa.query.show",
                            "payload": "{{payload}}"
                        },
                        {
                            "title": "{{title}}",
                            "type": "oa.open.sms",
                            "payload": {
                                "content": "{{content}}",
                                "phone_code": "{{phone_code}}"
                            }
                        },
                    
                        {
                        "title": "{{title}}",
                        "image_icon": "{{image_icon}}",
                        "type": "oa.open.phone",
                        "payload": {
                            "phone_code": "{{phone_code}}"
                        }
                    }
                ]
            }
        }
    }
}
}'
  • Cấu trúc body của request:

Tham sốKiểu dữ liệuTính bắt buộcĐịnh nghĩa

ApiKey

string

ApiKey của tài khoản.

SecretKey

string

Secretkey của tài khoản.

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.

user_id

string

userid cần gửi đến, đây là userid của zalo.

CallbackUrl

string

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

template_type

string

Loại template: 1. transaction_billing 2. transaction_order 3. transaction_reward 4. transaction_contract 5. transaction_booking 6. transaction_membership 7. transaction_event 8. transaction_transaction 9. transaction_account 10. transaction_internal 11. transaction_partnership 12. transaction_education 13. transaction_rating

language

string

Ngôn ngữ sử dụng của tin Giá trị nhận vào:

  • language = VI

hoặc

  • language = EN

Khi chọn ngôn ngữ các nội dung mặc định của mẫu tin sẽ chuyển sang ngôn ngữ tương ứng.

image_url

string

Đường link hình ảnh đính kèm.

align

string

Chấp nhận 3 giá trị

  • left (hoặc để trống): canh lề bên trái.

  • center: canh lề giữa.

  • right: canh lề bên phải.

table

string

Cấu trúc 1 phần tử trong table là: { "key": "giá trị của key" // maxlength = 25 "value": "giá trị của value" // maxlength = 100 } Trong đó bắt buộc phải có 1 trong 2 phần tử dưới đây: VI: { "key": "Mã..." // bắt đầu là "Mã", dùng định danh người nhận "value": "Giá trị tự do" }

EN: { "key": "...Code..." // bắt buộc có chứa "Code" trong key "value": "Giá trị tự do" } Hoặc: VI:

{ "key": "Tên khách hàng" // key có giá trị cố định "Tên khách hàng" "value": "Giá trị tự do" }

EN:

{ "key": "Customer Name" // key có giá trị cố định "Customer Name" "value": "Giá trị tự do" } Key “Trạng thái” / “Status” là key duy nhất hiện tại được phép sử dụng tham số “Style”: VN: { "key": "Trạng thái" // key có giá trị cố định "Trạng thái" "value": "Giá trị tự do" "style": "yellow" // Giá trị hợp lệ: green, blue, yellow, red, grey }

EN: { "key": "Status" // key có giá trị cố định "Status" "value": "Giá trị tự do" "style": "yellow" // Giá trị hợp lệ: green, blue, yellow, red, grey } ****Lưu ý: có thể khai báo thêm tối đa 5 phần tử tùy ý.

button

string

Có thể thêm tối đa 4 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 body của response:

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

CodeResult

string

Mã trả về.

SMSID

string

ID tin nhắn do esms trả về.

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ác ngôn ngữ trên Postman: Link code mẫu.

Last updated