Chúng tôi sẽ ngừng cung cấp API Tại chỗ. Hãy tham khảo tài liệu về việc Ngừng cung cấp API Tại chỗ để biết chi tiết, đồng thời tìm hiểu cách chuyển sang API Đám mây thế hệ tiếp theo của chúng tôi.
Cài đặt ứng dụng
Cài đặt ứng dụng cho ứng dụng WhatsApp Business Tại chỗ.
Yêu cầu
- Bạn phải thực hiện yêu cầu qua tài khoản
admincủa mình - Tất cả phản hồi đều phải chứa mã
200 OK HTTPS
Đọc
Lấy cài đặt ứng dụng hiện tại cho ứng dụng WhatsApp Business Tại chỗ
Ví dụ
Gửi yêu cầu GET đến điểm cuối /v1/settings/application để lấy cài đặt ứng dụng hiện tại.
GET /v1/settings/application
Khi thành công, phản hồi sẽ chứa mã 200 OK và một phần tải dữ liệu JSON chứa đối tượng application liệt kê tất cả cài đặt ứng dụng hiện tại cùng giá trị của những cài đặt đó.
Phản hồi mẫu
{
"settings": {
"application": {
"callback_backoff_delay_ms": 3000,
"callback_persist": true,
"garbagecollector_enable": {
"media": false,
"messages": true
},
"heartbeat_interval": 5,
"max_callback_backoff_delay_ms": 900000,
"media": {
"auto_download": [
"image",
"video",
"voice",
"sticker",
"audio",
"document"
]
},
"notify_user_change_number": true,
"show_security_notifications": true,
"unhealthy_interval": 30,
"wa_id": "16315551019",
"webhooks": {
"url": "<Webhook URL, https>",
"max_concurrent_requests": max-concurrent-requests,
"message": { // Available for v2.41.2 and above
"sent": true,
"delivered": true,
"read": false
},
},
"verbose_logging": false,
"log_level" : "info"
},
},
"meta": {
"api_status": "stable",
"version": "3.0.1"
}
}
Cạnh
| Cạnh | Mô tả |
|---|---|
Dùng để quản lý danh sách nhà cung cấp file phương tiện trong trường hợp gửi liên kết của file phương tiện. |
Cập nhật
Để cập nhật cài đặt ứng dụng, hãy gửi yêu cầu PATCH đến điểm cuối /v1/settings/application kèm theo đối tượng JSON chứa tên và giá trị của trường cần đặt.
Đối với các chiến dịch nhắn tin có lượng tin nhắn lớn, bạn nên vô hiệu hóa tính năng tự động thu thập dữ liệu rác bằng cách đặt garbagecollector_enable.messages thành false, sau đó bật lại tính năng này sau khi chiến dịch kết thúc bằng cách đặt lại về true.
Bạn có thể xác minh xem tính năng tự động thu thập dữ liệu rác đã bị vô hiệu hóa hay chưa bằng cách gửi yêu cầu GET đến điểm cuối /v1/settings/application và đọc thuộc tính garbagecollector_enable.
Yêu cầu mẫu
PATCH /v1/settings/application
{
"callback_persist": true | false,
"max_callback_backoff_delay_ms": max-delay-in-ms,
"media": {
"auto_download": ["audio", "document", "voice", "video", "image", "sticker"]
}
"callback_backoff_delay_ms": "delay-in-ms",
"heartbeat_interval": heartbeat-interval-in-secs,
"unhealthy_interval": unhealthy-interval-in-secs,
"webhooks": {
# See the Webhooks Parameters table below for more information
"max_concurrent_requests": max-concurrent-requests,
"url": "<Webhook URL, https>",
"message": { // Available on v2.41.2 and above
"sent": false,
"delivered": true,
"read": false
},
},
"axolotl_context_striping_disabled": false | true,
"notify_user_change_number": false | true,
"show_security_notifications": false | true,
# Available on v2.49.1 and above
"garbagecollector_enable": {
"messages": true | false,
"media": true | false
}
"skip_referral_media_download": true | false,
"webhook_payload_conversation_pricingmodel_disabled": false | true
# Available on v2.51.1 and above
"verbose_logging": false | true,
"log_level" : log-level-str,
}
Khi thành công, phản hồi sẽ chứa mã 200 OK kèm theo null hoặc một đối tượng JSON.
Nếu bạn gặp bất kỳ lỗi nào, hãy xem bài viết Thông báo trạng thái và thông báo lỗi.
Thông số
Đối với một số cài đặt, bạn cần phải khởi động lại Coreapp thì các thay đổi mới có hiệu lực. Các cài đặt đó là callback_persist, garbagecollector_enable, verbose_logging, log_level và webhooks.max_concurrent_requests.
| Tên | Mô tả |
|---|---|
loại: Boolean | Ảnh hưởng đến các giới hạn kết nối cơ sở dữ liệu. Cải thiện hiệu quả kết nối ra bên ngoài và vào nội bộ khi dùng Giá trị: Cần phải khởi động lại Coreapp. |
loại: Chuỗi | Độ trễ xử lý lệnh gọi lại không thành công tính bằng mili giây. Cài đặt này được dùng để đặt cấu hình khoảng thời gian chậm trễ xử lý trước khi thử thực hiện lệnh gọi lại không thành công một lần nữa. Độ trễ xử lý sẽ cộng thêm giá trị này mỗi khi lệnh gọi lại không nhận được phản hồi Mặc định: 3000 |
loại: Boolean | Lưu trữ các lệnh gọi lại trên ổ đĩa cho đến khi Webhook xác nhận lệnh gọi lại có thành công hay không. Thông báo và lệnh gọi lại đều được lưu trữ trong một cơ sở dữ liệu cục bộ nhằm đảm bảo chúng được gửi đi thành công trước khi bị gỡ khỏi cơ sở dữ liệu cục bộ đó. Đây là cách để bảo vệ lệnh gọi lại trong trường hợp ứng dụng API WhatsApp Business hoặc máy chủ gặp sự cố. Giá trị: |
loại: Boolean | Trường này đã ngừng hoạt động trong v2.49. Cho phép tự động dọn dẹp cơ sở dữ liệu tin nhắn nhằm hỗ trợ hoạt động quản lý cơ sở dữ liệu. Thông số này có giá trị là Giá trị: Cần phải khởi động lại Coreapp. |
loại: Đối tượng trình thu gom rác | Cho phép tự động dọn dẹp tin nhắn và file phương tiện. Bạn nên bật cài đặt dọn dẹp tin nhắn và file phương tiện để đảm bảo gỡ các hàng và file cũ/không sử dụng. Nếu trình thu gom rác bị vô hiệu hóa, bạn có thể khởi chạy bằng cách sử dụng điểm cuối Cần phải khởi động lại Coreapp. |
loại: Số nguyên | Khoảng thời gian nút Master giám sát các nút Coreapp tính bằng giây. Mặc định: 5 |
loại: Chuỗi | Độ trễ tối đa đối với một lệnh gọi lại không thành công tính bằng mili giây. Để biết thêm thông tin, hãy đọc phần mô tả về Mặc định: 900000 |
loại: Mảng | Danh sách file phương tiện sẽ tự động tải xuống. Hãy xem phần Cài đặt tự động tải xuống file phương tiện để biết thêm thông tin. |
loại: Boolean | Ảnh hưởng đến thông báo Giá trị: |
loại: Boolean | Kể từ v2.35, bạn sẽ không thể bật lại cài đặt Cho phép xóa hoặc lưu trữ từng tin nhắn vào cơ sở dữ liệu cục bộ sau khi gửi hoặc đọc tin nhắn đó. Sau khi được gửi đi, tin nhắn sẽ được lưu trữ trong cơ sở dữ liệu cục bộ. Cơ sở dữ liệu này được dùng làm lịch sử của ứng dụng. Vì doanh nghiệp tự lưu giữ lịch sử của họ nên bạn có thể chỉ định xem bạn có muốn bật cài đặt
Bạn nên tắt Giá trị: Cần phải khởi động lại Coreapp. |
loại: Boolean | Nếu bật thông số này, bạn sẽ nhận được thông báo Webhook Giá trị: |
loại: Boolean | Nếu bạn đặt thông số này thành Mặc định: |
loại: Số nguyên | Số giây tối đa nút Master sẽ chờ nút Coreapp phản hồi xung động trước khi xem xung động đó là bất thường và bắt đầu quy trình chuyển đổi dự phòng. Mặc định: 30 |
loại: Boolean | Trường này đã ngừng hoạt động trong v2.39. Kiểm soát hoạt động thêm phần tải dữ liệu có thông tin về cuộc trò chuyện và giá vào thông báo trạng thái tin nhắn. Giá trị: Không cần phải khởi động lại Coreapp. |
loại: Đối tượng Webhooks | Bắt buộc khi bạn sử dụng Webhooks. Cung cấp URL cho Webhook của bạn. Nếu bạn chưa đặt URL Webhook thì lệnh gọi lại sẽ bị hủy. Nếu bạn muốn biết cách đơn giản để xem và thử nghiệm Webhooks, hãy tham khảo phần Ứng dụng thử nghiệm mẫu. Bạn có thể xác thực các sự kiện Webhooks bằng cách chỉ định một khóa bí mật được chia sẻ làm thông số truy vấn khi đặt URL Webhook. Ví dụ: URL Webhook. Ví dụ: Nếu bạn chưa đặt URL Webhook thì lệnh gọi lại sẽ bị bỏ dở. Lệnh gọi lại là một kênh quan trọng để gửi cả thông báo kịp thời lẫn thông báo lỗi ngoài dải băng tần. Do đó, bạn nên đặt cấu hình điểm cuối URL Webhook. Để biết chi tiết về các trường Webhook, hãy xem bảng Thông số Webhooks ở bên dưới. | `log_level`
loại: Boolean | Cho phép ghi chi tiết trong coreapp. Bạn chỉ nên sử dụng cấp độ ghi này để thử nghiệm nhằm tránh tình trạng khối lượng đầu ra lớn. Nếu đặt thành Giá trị: |
loại: Đối tượng Webhooks | Đặt cấu hình cấp độ ghi trong coreapp. Mỗi cấp độ sẽ giảm dần khối lượng nhật ký đầu ra: Giá trị: |
Thông số Webhooks
| Tên | Mô tả |
|---|---|
loại: Số nguyên | Đặt cấu hình số lượng yêu cầu gọi lại nội tuyến tối đa được gửi đi. Giá trị: |
loại: Chuỗi | Thông báo gửi vào nội bộ và ra bên ngoài được định tuyến đến URL này. Hãy xem tài liệu về Webhooks để biết thêm thông tin. Cần có điểm cuối dựa trên HTTPS; HTTP sẽ không hoạt động. |
loại: Đối tượng tin nhắn Có trên v2.41.2 trở lên | Được lồng trong đối tượng Doanh nghiệp có thể chọn nhận hoặc không nhận thông báo webhook này bằng cách đặt các giá trị này thành |
Thông số file phương tiện
| Tên | Mô tả |
|---|---|
loại: Mảng | Chỉ định các loại file phương tiện sẽ tự động tải xuống. Giá trị: |
Thông số trình thu gom rác
| Tên | Mô tả |
|---|---|
loại: Bool | Đặt cấu hình tính năng dọn dẹp tin nhắn. Giá trị: |
loại: Bool | Đặt cấu hình tính năng dọn dẹp file phương tiện. Giá trị: |
Đặt lại về cài đặt mặc định
Để đặt lại tất cả cài đặt ứng dụng về giá trị mặc định, hãy gửi yêu cầu DELETE đến điểm cuối /v1/settings/application.
Yêu cầu mẫu
DELETE /v1/settings/application
Khi thành công, phản hồi sẽ chứa mã 200 OK kèm theo null hoặc {}.
Nếu bạn gặp bất kỳ lỗi nào, hãy xem bài viết Thông báo trạng thái và thông báo lỗi.