Tin nhắn Zalo

Api kiểm tra trạng thái của khách hàng và gửi tin nhắn tư vấn, tin nhắn giao dịch, tin nhắn truyền thông...

Kiểm tra trạng thái khách hàng

Hàm kiểm tra các trạng thái Payload body TEXT/JSON

{
    "phone_no": "098****980",
    "oa_id": "160019****752846"
}

Bảng mô tả kết quả trả về thành công

Stt	Trường dữ liệu	Chú thích
1	code	ok/errors: Trạng thái thành công/ Thất bại
2	data	Object dữ liệu trạng thái khách hàng
3	data.user_id	ID khách hàng
3	data.username	Tên khách hàng trên hệ thống CareSoft
4.	data.zalo_psid	Zalo ID của khách hàng tương ứng với OA truyền vào.
5	data.following_status	Trạng thái follow: 1: Đang follow 0/null: Không follow
6	data.last_user_activity_time	Lần tương tác gần nhất (Định dạng YYYY-mm-dd HH:MM:SS). null: Không có tương tác
7	data.can_send_consultation_message	Có thể gửi tin nhắn tư vấn: 1: Có thể 0/null: Không thể
8	data.consultation_message_expired_time	Thời hạn có thể gửi tin nhắn tư vấn (Định dạng YYYY-mm-dd HH:MM:SS). null: Không thể gửi
9	data.can_send_transaction_message	Có thể gửi tin nhắn giao dịch true: Có thể false: Không thể
10	data.can_send_promotion_message	Có thể gửi tin nhắn truyền thông true: Có thể false: Không thể
11	data.can_call_zcc_by_phone	Có thể gọi Zalo Call theo số điện thoại true: Có thể false: Không thể
12	data.can_call_zcc_by_zalo_id	Có thể gọi Zalo Call theo zalo_id true: Có thể false: Không thể
13	data.can_send_zns	Có thể gửi tin nhắn ZNS true: Có thể false: Không thể

Kiểm tra trạng thái Zalo của số điện thoại bất kỳ

POST {{domain}}/api/v1/zalo/user-status

Trạng thái Tương tác với Zalo của một số điện thoại tới 1 trang Zalo theo OA ID

Request Body

Name	Type	Description
phone_no*	Telephone	Số điện thoại của khách hàng
oa_id	String	Zalo OA Id

200: OK Thành công

Kết quả thành công

{
    "code": "ok",
    "data": {
        "user_id": "63**92",
        "username": "Nguyễn **Nghĩa",
        "zalo_psid": "894*****136201",
        "following_status": true,
        "last_user_activity_time": "2023-08-03 16:32:40",
        "can_send_consultation_message": true,
        "consultation_message_expired_time": "2023-08-10 16:32:40",
        "consultation_message_free_remain": 10,
        "can_send_transaction_message": true,
        "can_send_promotion_message": true,
        "can_call_zcc_by_phone": false,
        "can_call_zcc_by_zalo_id": true,
        "can_send_zns": true
    }
}

Giải thích kết quả theo payload phía trên: Dữ liệu kiểm tra tương tác khách hàng có số 098****980 với OA 160019****752846 Có kết quả - user_id 63**92 (ContactId trên hệ thống CareSoft) - Họ tên: "Nguyễn **Nghĩa" - Zalo ID: "894*****136201" - Trạng thái follow: Đang follow - Lần tương tác gần đây nhất: "2023-08-03 16:32:40" - Có thể gửi tin nhắn tin vấn. - Còn có thể gửi: 10 tin nhắn tư vấn - Có thể gửi tin nhắn giao dịch - Có thể gửi tin nhắn quảng bá - Không thể gọi Zalo Call theo số điện thoại - Có thể gọi Zalo Call theo Zalo ID - Có thể gửi tin nhắn ZNS

400: Bad Request Có lỗi

Lỗi không tìm thấy người dùng/khách hàng

{
    "code": "errors",
    "message": "Not found users ",
    "status": -1
}

Lỗi không tìm thấy OA hoặc OA mất kích hoạt

{
    "code": "errors",
    "message": "Not found or in-active zalo oa id",
    "status": -1
}

Gửi tin nhắn truyền thông, tin nhắn giao dịch và tin nhắn tư vấn

Tùy theo mục đích sử dụng và nhu cầu của nghiệp vụ, nhà phát triển có thể sử dụng API dưới đây để gửi tin ZALO tới khách hàng của mình. Body Payload điển hình 1. Gửi tin nhắn tới số điện thoại theo kịch bản có parameter

{
    "zalo": {
        "phone_no": "098*****980",
        "oa_id": "16001****13752846",
        "script_id": 608,
        "template_params": {
            "username": "Anh Tan"
        }
    }
}

2. Gửi tin nhắn tới số điện thoại theo nội dung tùy ý

{
    "zalo": {
        "phone_no": "098*****980",
        "oa_id": "16001****13752846",
        "message": "CareSoft cảm ơn quý khách đã sử dụng dịch vụ"
    }
}

3. Gửi tin nhắn tới id của Khách hàng trên Caresoft theo nội dung tùy ý

{
    "zalo": {
        "user_id": "122052447",
        "oa_id": "16001****13752846",
        "message": "CareSoft Xin chào!"
    }
}

Bảng mô tả thông tin gửi đi. trong object "zalo"

STT	Trường dữ liệu	Kiểu	Ghi chú
1	phone_no (*)	Telephone	Số điện thoại của người nhận (*) Nếu không có cần có user_id của người dùng để thay thế
2	user_id (*)	Int	ContactID của khách hàng định danh trên CareSoft (*) Trong trường hợp gửi theo số điện thoại thì không điền tham số này
3	oa_id *	Int	Zalo OA Id của Trang Zalo đã tích hợp lên CareSoft (Bắt buộc)
4	script_id (**)	Int	ID Biểu mẫu được cấu hình trên CareSoft (Xem trên giao diện Admin/Kịch Bản/Kịch bản Zalo) Kịch bản có thể là kịch bản tin nhắn truyền thông, tin tư vấn hoặc tin giao dịch. (**)Trong trường hợp không điền tham số này thì bắt buộc phải có trường message
5	message(**)	Text(1000)	Nội dung tin nhắn. Nội dung bắt buộc nếu không truyền script_id, Nếu điền script_id vui lòng bỏ qua params này
6	template_params	ObjectArray	Trường này chỉ có tác dụng Khi gửi tin nhắn theo kịch bản Đối tượng chứa các param thay thế được cấu hình trong kịch bản

Gửi tin nhắn Zalo

POST {{domain}}/api/v1/zalo/send-message

Gửi tin nhắn Truyền thông, Tin nhắn Giao dịch, Tin nhắn tư vấn

Request Body

Name	Type	Description
(*)	String	Theo Payload JSON Object phía trên

200: OK Thành công

{
    "code": "ok",
    "message": "Tạo thành công!"
}

400: Bad Request Lỗi

Lỗi không tìm thấy người dùng

{
    "code": "errors",
    "message": "Not found zalo profile of user"
}

Lỗi không tìm thấy Zalo OA id hoặc OA đang mất kích hoạt

{
    "code": "errors",
    "message": "Not found zalo oa 160011954754137252846"
}

422: Unprocessable Entity Lỗi thông tin không hợp lệ

Payload body còn thiếu hoặc sai nội dung