Tin Zalo tư vấn

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}}",
    "CallbackUrl": "{{CallbackUrl}}",
    "Payload": {
        "recipient": {
            "user_id": "{{user_id}}"
        },
        "message": {
            "text": "{{text}}",
            "attachment": {
                "type": "template",
                "payload": {
                    "buttons": [
                        {
                            "title": "{{title}}",
                            "payload": {
                                "url": "{{url}}"
                            },
                            "type": "oa.open.url"
                        },
                        {
                            "title": "{{title}}",
                            "type": "oa.query.show",
                            "payload": "{{payload}}"
                        },
                        {
                            "title": "{{title}}",
                            "type": "oa.query.hide",
                            "payload": "{{payload}}"
                        },
                        {
                            "title": "{{title}}",
                            "type": "oa.open.sms",
                            "payload": {
                                "content": "{{content}}",
                                "phone_code": "{{phone_code}}"
                            }
                        },
                        {
                            "title": "{{title}}",
                            "type": "oa.open.phone",
                            "payload": {
                                "phone_code": "{{phone_code}}"
                            }
                        }
                    ]
                }
            }
        }
    }
}'

• 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.
User_id	string		Userid cần gửi đến, đây là userid của zalo.
Content	string		Nội dung tin nhắn Lưu ý: Khi gửi dạng tin nhắn này khách hàng vui lòng liên hệ cho nhân viên kinh doanh để được hỗ trợ về content.
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 -Với template gửi thông báo theo mẫu yêu cầu thông tin người dùng, giá trị nhận vào là: template_type = request_user_info -Với template gửi thông báo theo mẫu văn bản thì không cần truyền tham số này.
Elements	string		Tittle: mô tả của action. Default_action - Type oa.open.url: Url sẽ được mở trong ứng dụng Zalo khi người quan tâm bấm vào action - Type oa.open.sms: Khi người quan tâm click vào action, cửa sổ sms trên điện thoại của người quan tâm sẽ được mở với 2 thông tin sẵn có là phone code và nội dung tin nhắn trong data. - Type oa.query.hide: Payload là một chuỗi ký tự ví dụ “#eSMS”. Khi người quan tâm bấm vào action, hệ thống sẽ gửi một tin nhắn có nội dung chứa trong data từ người quan tâm đến Official Account. Tin nhắn này sẽ bị ẩn trên cửa sổ chat trên máy của người quan tâm. - Type oa.query.show: Payload là một chuỗi ký tự ví dụ “#eSMS”. Khi người quan tâm bấm vào action, hệ thống sẽ gửi một tin nhắn có nội dung chứa trong data từ người quan tâm đến Official Account. Tin nhắn này sẽ hiện trên cửa sổ chat trên máy của người quan tâm. - Type oa.open.phone: Khi người quan tâm click vào action, cửa sổ call trên điện thoại của người quan tâm sẽ được mở với thông tin số điện thoại là giá trị của phone_code.
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.

---

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