Bắt đầu

Hướng dẫn này mô tả cách thiết lập ứng dụng API Tại chỗ, đăng ký số điện thoại doanh nghiệp, cập nhật các chế độ cài đặt và gửi tin nhắn thử nghiệm.

Quá trình bắt đầu sử dụng API này có thể được chia thành 3 phần:

  1. Chuẩn bị tài sản - Trước khi bắt đầu, bạn phải thiết lập các tài sản cần thiết để hoàn tất quá trình tích hợp API, trong đó có Tài khoản WhatsApp Business.
  2. Cài đặt ứng dụng API Tại chỗ - Cài đặt ứng dụng API. Sau khi ứng dụng hoạt động, bạn có thể cập nhật các chế độ cài đặt ứng dụng.
  3. Bắt đầu sử dụng ứng dụng - Đăng ký số điện thoại của bạn bằng lệnh gọi API đến /account và gửi tin nhắn thử nghiệm bằng lệnh gọi đến /messages.

Trước khi bạn bắt đầu

Bạn cần có:

Sau khi bạn xác minh doanh nghiệp mình, doanh nghiệp đó sẽ được xem xét để đảm bảo việc tuân thủ Điều khoản dịch vụ của WhatsAppChính sách thương mại của WhatsApp. Bước này được bắt đầu tự động. Bạn có thể kiểm tra trạng thái của quy trình xác minh và xét duyệt doanh nghiệp trong tab Cài đặt của tài khoản WhatsApp Business trong Trình quản lý kinh doanh. Mục Xác minh doanh nghiệp sẽ có trạng thái là Đã xác minh và mục Trạng thái tài khoản sẽ hiển thị là Đã phê duyệt sau khi chúng tôi phê duyệt xong.

Thiết lập tài khoản WhatsApp

Thêm số điện thoạitên hiển thị của số này vào tài khoản WhatsApp Business của bạn. Thao tác này sẽ gửi tên hiển thị đi xét duyệt.

Trước khi hoàn tất đăng ký, nếu muốn, bạn có thể thay đổi tên hiển thị bao nhiêu lần tùy thích. Sau đó, bạn phải đợi 30 ngày thì mới có thể tiếp tục gửi yêu cầu thay đổi tên hiển thị.

Sau khi mọi quá trình xét duyệt hoàn tất, bạn có thể xem và truy cập vào chứng chỉ được mã hóa base64. Đây là chứng chỉ cần thiết để đăng ký ứng dụng API Tại chỗ. Bạn nên đăng ký bằng một tên hiển thị đã được phê duyệt để bắt đầu tích hợp, trước khi thực hiện bất kỳ thay đổi nào khác đối với tên hiển thị. Sau khi tích hợp, bạn có thể thay đổi tên hiển thị vào bất cứ thời điểm nào.

Xem lại thông tin lập hóa đơn và giá

Khi bắt đầu gửi tin nhắn thông qua API Tại chỗ, doanh nghiệp của bạn cần phải hiểu quy trình lập hóa đơn, chẳng hạn như cách thức và thời điểm bạn bị tính phí cũng như cách xem và thanh toán hóa đơn hàng tháng. Để biết thêm thông tin, hãy xem phần Giới thiệu về cách lập hóa đơn cho tài khoản WhatsApp Business. Để biết các quy tắc định giá và chi phí trên mỗi tin nhắn, hãy xem trang Giá cả của chúng tôi.

Phần mềm Phiên bản Chi tiết

API Tại chỗ

Xem nhật ký thay đổi

Xem nhật ký thay đổi

API Tại chỗ dành cho AWS

Xem nhật ký thay đổi


Phiên bản mẫu: v3.0.1

Xem nhật ký thay đổi

MySQL

5.7.xx8.0.xx

Vui lòng lưu ý rằng bạn không thể hạ cấp cơ sở dữ liệu được chuyển sang MySQL 8 xuống MySQL 5. Do vậy, hãy sao lưu cơ sở dữ liệu trước khi chuyển.

PostgreSQL

13.8

Hỗ trợ 13.x, 12.x11.x

Docker

18.04 trở lên, không bao gồm phiên bản 19.03.7

Kể từ v2.33, phiên bản 18.04 là bắt buộc


Đảm bảo lệnh gọi hệ thống statx nằm trong danh sách lệnh gọi hệ thống được phép dành cho Docker.

Postman

Bất kỳ phiên bản nào gần đây

libseccomp

2.3.3

Chỉ hỗ trợ 2.3.3

glibc

2.28

Chỉ hỗ trợ phiên bản 2.28 trở lên

Hệ điều hành

Phiên bản gần đây nhất

Sử dụng phiên bản kernel tối thiểu là 4.11

Bước 1: Cài đặt ứng dụng API Tại chỗ

Môi trường

Về cơ bản, ứng dụng API Tại chỗ hoạt động dựa trên vùng chứa Docker. Hãy xem bài viết Cấu trúc ứng dụng để biết thông tin về từng thành phần.

Hiện tại, ứng dụng API Tại chỗ không hỗ trợ Docker cho Windows hay Hệ thống phụ Windows cho Linux. Đối với nhu cầu phát triển, bạn nên dùng Máy ảo Linux và chạy Docker trong máy đó. Đối với phần việc chính thức, bạn nên dùng Máy chủ Linux để tránh các vấn đề về hiệu suất và khả năng tương thích.

Thiết bị

Ứng dụng API Tại chỗ sẽ chạy trên bất kỳ máy nào có kết nối Internet có thể chạy Docker cho Linux, dù là trên máy ảo hay trên máy chủ Linux. Để biết thêm thông tin, hãy xem bài viết Câu hỏi thường gặp. Ví dụ: bạn có thể tiến hành thử nghiệm đơn giản trên laptop Đối với máy chủ môi trường chính thức, bạn nên sử dụng tối thiểu ổ SSD 250 GB, RAM 16 GB và CPU 4 lõi. Không nên dùng ổ HDD vì tốc độ Đầu vào/Đầu ra sẽ bị giảm xuống mức tối thiểu trong quá trình tải.

Trong hầu hết các trường hợp, bạn nên chạy cơ sở dữ liệu trên một máy chủ thực tách biệt với vùng chứa Coreapp và Webapp. Máy chủ cơ sở dữ liệu chỉ được chênh lệch với (các) máy tính vài mili giây.

Cài đặt

Có 2 cách để bắt đầu sử dụng API Tại chỗ:

  • Cài đặt tại chỗ - Bạn có thể tự thiết lập vùng chứa Docker theo Hướng dẫn cài đặt. Bạn nên bắt đầu bằng một trong những Cách thiết lập dành cho nhà phát triển để làm quen với quy trình thiết lập và gửi tin nhắn. Bạn có thể sử dụng giải pháp Tại chỗ này trên máy tính của mình trước khi chuyển sang môi trường chính thức.
  • Amazon Web Services (AWS): Nếu bạn sử dụng AWS hoặc muốn một giải pháp độc lập hơn, hãy xem hướng dẫn về AWS. Giải pháp AWS thiết lập toàn bộ giải pháp API Tại chỗ bằng cách sao lưu, khôi phục, v.v. trong đám mây AWS mà bạn quản lý và sở hữu.

Khi ứng dụng API Tại chỗ đang chạy, bạn phải đăng nhập với vai trò admin để thực hiện các bước thiết lập còn lại.

Cập nhật chế độ cài đặt

Bạn có thể thay đổi Cài đặt ứng dụng sau khi ứng dụng API Tại chỗ hoạt động. Tuy nhiên, bạn không có quyền truy cập vào các chế độ cài đặt trang cá nhân khác nhau của ứng dụng API Tại chỗ cho đến khi quá trình đăng ký hoàn tất.

  • Cài đặt ứng dụng có liên quan đến cách hoạt động của ứng dụng - chế độ cài đặt gọi lại, Webhooks, máy nhắn tin trực sẵn, trạng thái đã gửi, hành vi tải file phương tiện xuống, v.v. Lưu ý: Bạn nên thiết lập URL Webhook để nhận thông báo về tin nhắn đến hoặc lỗi.
  • Cài đặt trang kinh doanhCài đặt trang cá nhân bao gồm các thông tin về doanh nghiệp, chẳng hạn như địa chỉ, email, trang web, ngành, thông tin giới thiệu và ảnh đại diện.

Bước 2: Bắt đầu sử dụng ứng dụng

Đăng ký

Sau khi thiết lập và chạy ứng dụng API Tại chỗ, bạn có thể đăng ký số điện thoại của mình bằng cách gửi lệnh gọi API đến điểm cuối account.

Gửi tin nhắn thử nghiệm

Bạn có thể gửi tin nhắn thử nghiệm bằng điểm cuối messages. Trước tiên, hãy kiểm tra trạng thái của số điện thoại mà bạn đang dùng để thử nghiệm. Bạn cần gửi cho tài khoản WhatsApp một tin nhắn từ số điện thoại thử nghiệm này để bật cửa sổ Dịch vụ khách hàng. Thông qua cửa sổ này, bạn có thể gửi mọi loại tin nhắn trong khoảng thời gian 24 giờ (Xem phần Kiểm soát theo giới hạn để biết chi tiết). Sau đó, gửi tin nhắn văn bản đến số điện thoại thử nghiệm. Nếu số đó nhận được tin nhắn thì tức là bạn đã cài đặt thành công. Nếu số đó không nhận được tin nhắn, hãy kiểm tra Webhook để xem các thông báo có chỉ ra sự cố nào không.

Bảo mật

Hãy xem tài liệu hướng dẫn về Bảo mật của chúng tôi để biết thông tin về mật khẩu, xác thực, cấu hình SSL, phân tách mạng, thông tin giao tiếp được mã hóa, tiêu đề HTTP và giao thức TLS cho máy chủ web có liên quan đến ứng dụng API Tại chỗ.

Quy trình khởi động

API Tại chỗ của WhatsApp sẽ trải qua quy trình khởi động sau khi thiết lập kết nối với máy chủ. Đây là quy trình thiết yếu để đảm bảo đem lại một phương tiện gửi và nhận tin nhắn liền mạch cũng như đáng tin cậy. Trong giai đoạn khởi động này, ứng dụng cốt lõi (coreapp) sẽ chờ quá trình thực hiện một vài điều kiện tiên quyết, bao gồm:

  • Tải tin nhắn mẫu: API này sẽ tải tin nhắn mẫu từ máy chủ trong quá trình khởi tạo.

  • Nhận và xử lý tin nhắn offline: API này cũng xử lý việc nhận và xử lý tin nhắn offline.

Nếu cố gửi tin nhắn trong khi chưa đáp ứng các điều kiện tiên quyết nêu trên, ứng dụng cốt lõi sẽ phản hồi bằng thông báo lỗi "Coreapp chưa sẵn sàng", đồng thời nhật ký sẽ hiển thị lỗi "Dịch vụ chưa sẵn sàng". Lưu ý rằng quy trình khởi động này sẽ diễn ra mỗi khi thiết lập kết nối mới với máy chủ WhatsApp. Do đó, nếu ứng dụng cốt lõi được khởi động lại hoặc bị ngắt kết nối, quy trình khởi động sẽ bắt đầu lại để đặt trạng thái của ứng dụng cốt lõi thành "sẵn sàng". Nhờ vậy mà API Tại chỗ của WhatsApp trở nên đáng tin cậy và sẵn sàng cho hoạt động trao đổi qua tin nhắn.

Xử lý tin nhắn offline

Khi không tìm thấy tin nhắn offline nào, bước xử lý tin nhắn offline sẽ bị bỏ qua. Nói cách khác, nếu không có tin nhắn nào đang chờ ở trạng thái offline, giai đoạn xử lý tin nhắn cụ thể này sẽ bị bỏ qua.

Trong những điều kiện thông thường, API Tại chỗ của WhatsApp sẽ xử lý tin nhắn offline theo một giao thức tiêu chuẩn. API này sẽ chờ nhận và xử lý tất cả tin nhắn offline trong thời gian chờ tối đa định sẵn là 6 phút. Sau khi hết khoảng thời gian 6 phút nêu trên, giai đoạn xử lý tin nhắn offline sẽ được xem là đã hoàn tất thành công.

Gợi ý khác

NÊN

Trước tiên, hãy bắt đầu nhắn tin qua lại với nhân viên trong tổ chức để đảm bảo rằng hệ thống hoạt động bình thường.

Trả lời tất cả khách hàng trong vòng 24 giờ.

Tuân thủ các chính sách của chúng tôi có trong Chính sách của WhatsApp BusinessChính sách thương mại của WhatsApp.

Sử dụng nhiều số điện thoại cho nhu cầu phát triển, thử nghiệm và phát hành chính thức.

Hãy xem bài viết Câu hỏi thường gặp trước khi mở phiếu Hỗ trợ trực tiếp.

Cung cấp phản hồi về sản phẩm. Hỗ trợ trực tiếp là kênh lý tưởng nhất để làm điều đó.

Cung cấp thông tin chi tiết để tái hiện sự cố, chẳng hạn như nhật ký, thông tin hỗ trợ từ nút healthsupport, dữ liệu WADebug, lệnh gọi API để tái hiện sự cố, v.v.

KHÔNG NÊN

Gửi các thông báo giống nhau cho nhiều kênh.

Gửi spam.

Sử dụng các số 1-800 để thử nghiệm.

Tạo Trình quản lý kinh doanh chỉ để tích hợp WhatsApp. Sử dụng Trình quản lý kinh doanh hiện tại, nếu có.

Nếu phát hiện thấy bạn vi phạm bất kỳ chính sách hoặc nguyên tắc nào của chúng tôi, chúng tôi có quyền giới hạn hoặc gỡ quyền truy cập của bạn vào WhatsApp.