Hướng dẫn kết nối Zalo Cloud

Để sử dụng được các dịch vụ Zalo Cloud trên eTelecom buộc các đối tác/khách hàng phải tiến hành liên kết ứng dụng (app) với cs.etelecom.vn

Lưu ý: eTelecom khuyên bạn nên sử dụng 2 ứng dụng riêng biệt cho 2 môi trường sandbox và prod để thuận tiện trong việc tích hợp API.

Bước 1: Truy cập vào trang Zalo developers

Bước 2: Truy cập vào ứng dụng mà trước đó bạn đã tạo

Chọn vào biểu tượng avatar tài khoản Zalo của bạn như hình

Truy cập vào ứng dụng mà bạn muốn kết nối với eTelecom

Lưu ý: Nếu chưa có bạn có thể chọn "Thêm ứng dụng mới"

Nhập các thông tin theo yêu cầu. Chi tiết bạn có thể tham khảo tài liệu này

Bước 3: Tiến hành "Xác thực domain"

Mục đích của việc xác thực domain để bạn có thể cấu hình được link webhook do eTelecom cung cấp

Sau khi truy cập vào ứng dụng -> Xác thực domain -> Tùy thuộc vào môi trường bạn đang dùng mà điền thông tin domain sau:

• Sandbox: api-sandbox.etelecom.vn và etelecom.vn

• Prod: api.etelecom.vn và etelecom.vn

Bạn chọn "Xác thực ngay" để tiến hành xác thực.

Chọn "Thêm thẻ meta vào trang chủ trang web của bạn" -> copy thẻ meta ở "Bước 1" rồi gửi cho eTelecom.

Lưu ý: Quá trình xác thực có thể mất đến 72 giờ để Zalo xét duyệt. Nếu trạng thái domain vẫn là Chưa được xác thực, bạn vui lòng chọn Xác thực lại lần nữa.

Domain được xét duyệt thành công sẽ được hiển thị ở phần "Danh sách domain xác thực"

Bước 4: Cấu hình webhook

Việc cấu hình "Webhook URL" sẽ giúp cho eTelecom có thể nhận được các event Zalo trả về để xây dựng các báo cáo, lịch sử gửi tin, ... một cách chính xác, phục vụ cho nhu cầu của bạn

Sau khi xác thực domain thành công, bạn truy cập vào "Webhook" -> để tiến hành thay đổi thông tin "Webhook URL"

• Sandbox: https://api-sandbox.etelecom.vn/v1/zalo/Callback
• Prod: https://api.etelecom.vn/v1/zalo/Callback

Sau khi cập nhật thành công bạn vui lòng cung cấp cho eTelecom thông tin "OA Secrect Key"

Lưu ý: Trong thường hợp bạn "Cập nhật webhook url" không thành công -> hệ thống xuất hiện thông báo như hình thì vui lòng "Tiến hành xác thực domain" cho đến khi domain được hiển thị ở phần "Danh sách domain xác thực"

Lưu ý: Nếu bạn reset hay thao tác dẫn đến "OA Secret Key" thì hãy cung cấp lại cho eTelecom.

Ở mục "Danh sách sự kiện webhook":

• Nếu bạn sử dụng tính năng ZNS: bạn chỉ cần bật sự kiện "Sự kiện tin nhắn đã được nhận" và "Sự kiện người dùng nhận thông báo ZNS" như hình

• Nếu bạn sử dụng ZNS Journey: bạn cần bật sự kiện "Thông báo Journey hết hạn" và "Thông báo Journey được tính phí".

• Nếu bạn sử dụng tính năng ZCC: bạn cần bật sự kiện "Sự kiện OA gửi yêu cầu thực hiện cuộc gọi đến người dùng / yêu cầu đã hết hạn" và "Sự kiện người dùng trả lời yêu cầu thực hiện cuộc gọi từ OA"

• Để xem được danh sách người quan tâm thì bạn cần bật sự kiện "Sự kiện người dùng quan tâm Official Account" và "Sự kiện người dùng bỏ quan tâm Official Account".

• Để sử dụng được tính năng "OA chat" bạn cần bật các sự kiện liên quan đến "Official Account" và "Người dùng"

Bước 5: Thiết lập đường dẫn yêu cầu cấp quyền

Mục đích của bước này để eTelecom có thông tin thực hiện liên kết ứng dụng của bạn với hệ thống eTelecom

Lưu ý:

• Đối với trường hợp khách hàng muốn "Liên kết Official Account" trên cs.etelecom.vn thì cần thiết lập lại đường dẫn yêu cầu cấp quyền ở mục "Official Account Callback Url" theo thông tin sau:

  • Môi trường Prod: https://api.etelecom.vn/v1/zalo/OAuth
  • Môi trường Sandbox: https://api-sandbox.etelecom.vn/v1/zalo/OAuth
• Đối với trường hợp khách hàng muốn tích hợp API Zalo Cloud vào phần mềm hiện có thì có thể sử dụng Callback URL của chính bạn, Callback URL là nơi thực hiện xử lý để nhận được authorization code và state trả về sau khi thực hiện ủy quyền OA cho App.