Tin Zalo Tư vấn dạng yêu cầu thông tin người dùng

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}}",
"RequestId": "96accf59-0c41-4bc7-a5c4-4a466c2e41c2", 
"Payload": {
        "recipient": {
            "user_id": "{{UserID}}"
        },
        "message": {
            "attachment": {
                "type": "template",
                "payload": {
                    "template_type": "request_user_info",
                    "elements": [
                        {
                            "title": "OA Chatbot",
                            "subtitle": "Đang yêu cầu thông tin từ bạn",
                            "image_url": "https://minio.esms.vn/blogimg/agent-1/BlogImg/full_cccc34d4-3a46-4644-8613-1b226203c5d5.png"
                        }
                    ]
                }
            }
        }
    }
}'

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

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.

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.

CallbackUrl

string

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

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

Payload

Object

Chứa nội dung cần gửi

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

user_id

string

ID của người nhận.

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

attachment

Object

Chứa payload của attachment muốn gửi

type

string

Loại attachment.

Giá trị nhận vào bắt buộc:

type = template

Tham số

Kiểu dữ liệu

Tính bắt buộc

Mô tả

title

string

Tiêu đề hiển thị của template Lưu ý: Hỗ trợ tối đa 100 ký tự

subtitle

string

Tiêu đề phụ của template Lưu ý: Hỗ trợ tối đa 500 ký tự

image_url

string

Đường dẫn đến ảnh.

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

Request hợp lệ.

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 tin nhắn do esms trả về.

ErrorMessage

string

Thông tin lỗi trả về (nếu có lỗi).

hashtagHTTP request

HTTP request