Webhook

Last updated: May 8, 2020

Mô tả thông tin trả về cho đối tác quảng cáo.

Hiện tại, hệ thống CRM chỉ hỗ trợ tính năng gửi thông tin postback qua phương thức GET.
Mỗi khi teller kết thúc việc thực hiện cuộc gọi (có thể chốt đơn được, có thể khách không mua, có thể hẹn gọi lại ...) thì hệ thống sẽ tự động gọi webhook theo link được cấu hình.
Link webhook có dạng như sau:
https://domain.com/postbacks?offer_type=cpo&api_key={token}&transaction_id={reference_id}&status_message={status_message}&status={status}&product_quantity={product_quantity}&pcus_id={pcus_id}&total_amount={total_amount}
Các thông tin cần thiết sẽ được gửi thông qua request parameters.
Ví dụ, nếu đối tác muốn nhận về mã đối soát trong tham số order_id thì sẽ thay đoạn transaction_id={reference_id} ở trên thành order_id={reference_id} (lưu ý reference_idlà tham số đại diện cho mã tham chiếu trên hệ thống CRM, nên không được đổi tên).
Tên của các parameters có thể tùy biến theo đối tác quảng cáo. Nhưng phần trong dấu {} chỉ bao gồm những fields sau:

Tên trường thông tin	Giá trị có thể nhận	Mô tả
token		Là api token đối tác quảng cáo cấp để gửi kèm trong webhook
reference_id		Là mã tham chiếu của khách hàng trên hệ thống CRM và hệ thống đối tác
status	-1, 0, 1	Giá trị trạng thái của khách hàng sau khi gọi: -1 (CANCEL) - số điện thoại của khách này lên đơn không thành công và sẽ không được gọi lại trên CRM 0 (PENDING) - Gọi lại sau 1 (SUCCESS) - Lên đơn thành công
status_message	CANCEL, PENDING, SUCCESS	Là nội dung ghi chú được tạo với teller sau khi thực hiện cuộc goi. *Tùy theo phương thức hợp tác giữa hệ thống CRM và Đối tác quảng cáo mà trả về thông tin cuộc gọi hoặc chỉ là giá trị mặc định (CANCEL, PENDING, SUCCESS) Riêng trạng thái SUCCESS chỉ trả về tên trạng thái mà không trả về ghi chú cuộc gọi.
product_quantity		Là số lượng chốt đơn theo sản phẩm hợp tác. * Tùy theo hình thức hợp tác mà trả về giá trị này, nếu không yêu cầu trả về thông tin số lượng thì trả về mặc định là 0 * Tùy vào phương thức hợp tác mà có thể trả về cả đơn tư vấn chéo
pcus_id		Thông tin bổ sung, chỉ dùng cho hệ thống CRM.
total_amount		Là tổng doanh số của đơn, sẽ được gửi đi nếu trong cấu hình Affiliate cho phép gửi doanh số cho đổi tác (mặc định là 0)