Tin Zalo Tư vấn đính kèm ảnh

HTTP request

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

• Content Type: text/plain

• Response Type: application/json

curl --location 'https://rest.esms.vn/MainService.svc/json/SendZaloFollowerMessage_V5_post_json/' \
--header 'Content-Type: text/plain' \
--data '{
    "ApiKey": "{{ApiKey}}",
    "SecretKey": "{{SecretKey}}",
    "OAID": "{{OAID}}", 
    "Payload": {
        "recipient": {
            "user_id": "{{user_id}}"
        },
        "message": {
            "text": "Tin Zalo Tư vấn đính kèm ảnh",
            "attachment": {
                "type": "template",
                "payload": {
                    "template_type": "media",
                    "elements": [
                        {
                            "media_type": "image",
                            "url": "https://minio.esms.vn/blogimg/agent-1/BlogImg/full_3f8df17c-2d15-4ecb-b9fd-3bcc9cb0d97b.png"
                        }
                    ]
                }
            }
        }
    }
}'

// Truyền \r\n để gửi nội dung xuống dòng

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

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
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.
CallbackUrl	string		eSMS sẽ trả về kết quả của tin nhắn này. 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

---

Cấu trúc thuộc tính recipient

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.

Cấu trúc thuộc tính message

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
text	string		Tiêu đề của ảnh Giới hạn tối đa là 2.000 ký tự
attachment	Object		Attachment cần gửi.

Cấu trúc thuộc tính message.attachment

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
type	string		Loại attachment. Giá trị nhận vào bắt buộc: type = template
payload	Object		Chứa payload của attachment muốn gửi.

Cấu trúc thuộc tính message.attachment.payload

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
template_type	string		Loại template Với template gửi thông báo theo mẫu đính kèm ảnh, giá trị nhận vào là: template_type = media
elements	array		Các đối tượng của template. Lưu ý: Cấu trúc element thay đổi tùy theo loại template. Với template media, danh sách element bao gồm tối đa 1 phần tử.

Cấu trúc thuộc tính message.attachment.payload.element

Tham số	Kiểu dữ liệu	Tính bắt buộc	Mô tả
media_type	string		Loại media. Các giá trị nhận vào: image: ảnh tĩnh gif: ảnh động
url	string		Đường dẫn đến ảnh Các định dạng ảnh hỗ trợ: jpg và png Dung lượng tối đa: 1MB Lưu ý: kích thước ảnh tối ưu 16:9 và vùng safe zone 14:9

• Response:

100

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

Request hợp lệ.

101

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

Sai thông tin ApiKey/SecretKey.

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