Tin nhắn Zalo ZNS

Gửi tin nhắn ZNS tới Zalo của khách hàng thông qua số điện thoại

1. Gửi ZNS

Chuẩn bị: ID kịch bản trên hệ thống caresoft với template được ZALO duyệt (kèm ZNS_ID)

Thông tin trường dữ liệu gửi ZNS

STT	Trường	Kiểu	Chú thích
1	zns	Object	Object chứa thông tin gửi ZNS
	..
2	phone	TelephoneNo	Số điện thoại cần gửi ZNS
3	template_id	Int	Mẫu nội dung template được cấu hình đã được Zalo phê duyệt Template này được cấu hình liên kết đến 1 zalo OA đã tích hợp vào caresoft từ trước đó (Xem hướng dẫn ở mục 2)
4	ticket_id	Int	Id của phiếu ghi nếu muốn thực hiện nghiệp vụ trả lời cho 1 phiếu ghi đã có, trong trường hợp không truyền tham số này hệ thống sẽ tự tạo 1 phiếu ghi mới
5	params	Object	Object Param dạng { param:value, param1:value1 } Đây là tên biến và giá trị thay thế được cấu hình trên nội dung kịch bản ZNS (xem hướng dẫn Mục 3 phía dưới) Trong trường hợp không truyền tham số này, Hệ thống tự động lấy các tham số đã cấu hình mapping trong kịch bản

Body Payload tiêu biểu.

Trong payload này hệ thống sẽ gửi 1 kịch bản ZNS có ID là 366 tới khách hàng có số điện thoại 09839**148 và ghi chú phản hồi vào phiếu ghi có ID 297005

Body Payload JSON/Object

{
    "zns": {
        "phone": "09839**148",
        "template_id": 366,
        "ticket_id": 297005,
        "params": {
            "requester": "Nguyễn Hải Hà",
            "masoDatve": "098733" 
        }
    }
}

Gửi tin nhắn Zalo ZNS

POST {{domain}}/api/v1/zalo/zns

Gửi tin nhắn ZNS tới 1 số điện thoại bất kỳ đã đăng ký tài khoản Zalo

Headers

Name	Type	Description
***	String	Thông tin xác thực chung

Request Body

Name	Type	Description
zns	Object	Object thông tin gửi ZNS
zns.phone	PhoneNo	Số điện thoại cần gửi ZNS
zns.template_id	Int	Mẫu nội dung template được cấu hình đã được Zalo phê duyệt Template này được cấu hình liên kết đến 1 zalo OA đã tích hợp vào caresoft từ trước đó (Xem hướng dẫn ở mục 2)
zns.params	Object	Object Param dạng { param:value, param1:value1 } Đây là tên biến và giá trị thay thế được cấu hình trên nội dung kịch bản ZNS (xem hướng dẫn Mục 3 phía dưới) Trong trường hợp không truyền tham số này, Hệ thống tự động lấy các tham số đã cấu hình mapping trong kịch bản
zns.ticket_id	Int	Id của phiếu ghi nếu muốn thực hiện nghiệp vụ trả lời cho 1 phiếu ghi đã có, trong trường hợp không truyền tham số này hệ thống sẽ tự tạo 1 phiếu ghi mới

200: OK Kết quả thành công

{
    "status": "OK",
    "ticket": {
        "ticketId": "297002"
    }
}

400: Bad Request Lỗi thông tin

Lỗi không tìm thấy template

{
    "code": "errors",
    "errors": {
        "template_id": [
            "The selected template id is invalid."
        ]
    }
}

2. Cách lấy template_id trên CareSoft

Sử dụng tài khoản Admin vào menu Admin → Kịch bản , Trong loại kịch bản chọn “Gửi tin nhắn Zalo ZNS” → bấm tìm kiếm

Copy ID kịch bản trong phần kết quả (khoanh tròn màu đỏ) tương ứng.

3. Cấu hình kịch bản ZNS

Lưu ý: ID kịch bản Zalo ZNS phải là ID được Zalo phê duyệt. Zalo OA là Page Zalo đã được tích hợp vào CareSoft