Giao thức HTTP của Giải pháp gửi thông báo qua đám mây của Firebase

Tham số này chỉ định người nhận tin nhắn.

Giá trị này có thể là mã thông báo đăng ký của thiết bị, khoá thông báo hoặc một chủ đề duy nhất (có tiền tố là /topics/). Để gửi đến nhiều chủ đề, hãy sử dụng Tham số condition.

Tham số này chỉ định người nhận của một thông báo phát đa hướng, một thông báo được gửi đến nhiều mã thông báo đăng ký.

Giá trị này phải là một mảng gồm các mã thông báo đăng ký để gửi thông báo truyền tin nhiều điểm. Mảng phải chứa tối thiểu 1 và tối đa 1.000 mã mã thông báo đăng ký. Để gửi thông báo đến một thiết bị, hãy sử dụng tham số to.

Chỉ cho phép tin nhắn phát đa hướng bằng cách sử dụng định dạng HTTP JSON.

Tham số này chỉ định một biểu thức logic của các điều kiện xác định mục tiêu của thông báo.

Điều kiện được hỗ trợ: Chủ đề, được định dạng là "'yourTopic' trong chủ đề". Giá trị này không phân biệt chữ hoa chữ thường.

Toán tử được hỗ trợ: &&, ||. Tối đa 2 toán tử cho mỗi thông báo chủ đề được hỗ trợ.

Thông số này không còn được dùng nữa. Thay vào đó, hãy sử dụng to để chỉ định người nhận thư. Để biết thêm thông tin về cách gửi tin nhắn tới nhiều thiết bị, hãy xem tài liệu dành cho nền tảng của bạn.

Thông số này xác định một nhóm thông báo (ví dụ: có collapse_key: "Updates Available") có thể thu gọn được để chỉ thông báo cuối cùng sẽ được gửi khi có thể tiếp tục gửi. Điều này nhằm tránh gửi quá nhiều thông báo giống nhau khi thiết bị kết nối lại mạng hoặc hoạt động trở lại.

Xin lưu ý rằng chúng tôi không đảm bảo thứ tự gửi tin nhắn.

Lưu ý: Tại một thời điểm bất kỳ, bạn chỉ được phép sử dụng tối đa 4 khoá thu gọn khác nhau. Điều này có nghĩa là FCM có thể lưu trữ đồng thời 4 tin nhắn cho mỗi ứng dụng khách. Nếu bạn vượt quá con số này, nhưng không thể đảm bảo FCM sẽ giữ lại 4 khoá thu gọn nào.

Đặt mức độ ưu tiên của thông báo. Giá trị hợp lệ là "bình thường" và "cao". Trên các nền tảng của Apple, các thông số này tương ứng với mức độ ưu tiên của APN 5 và 10.

Theo mặc định, tin nhắn thông báo được gửi với mức độ ưu tiên cao và tin nhắn dữ liệu được gửi với mức độ ưu tiên bình thường. Mức độ ưu tiên bình thường sẽ tối ưu hoá mức tiêu thụ pin và nên được sử dụng trừ phi cần giao hàng ngay. Đối với các thư có mức độ ưu tiên bình thường, ứng dụng có thể nhận thư bằng độ trễ không xác định.

Khi thư được gửi với mức độ ưu tiên cao, thư đó sẽ được gửi ngay lập tức và ứng dụng có thể hiển thị thông báo.

Trên các nền tảng của Apple, hãy sử dụng trường này để biểu thị content-available trong tải trọng APN. Khi một thông báo hoặc tin nhắn được gửi và được đặt thành true, một ứng dụng khách không hoạt động sẽ được đánh thức và tin nhắn sẽ được gửi qua APN dưới dạng thông báo im lặng chứ không phải thông qua FCM. Lưu ý rằng thông báo im lặng trong APN không được đảm bảo được phân phối và có thể phụ thuộc vào các yếu tố như việc người dùng bật Chế độ tiết kiệm pin Chế độ buộc thoát ứng dụng, v.v. Trên Android, thông báo dữ liệu sẽ đánh thức ứng dụng theo mặc định. Trên Chrome, hiện không được hỗ trợ.

Trên các nền tảng của Apple, hãy sử dụng trường này để biểu thị mutable-content trong tải trọng APNs. Khi một thông báo được gửi và cài đặt này được đặt vào true, nội dung thông báo có thể được sửa đổi trước khi hiển thị, sử dụng Phần mở rộng về ứng dụng Dịch vụ thông báo. Tham số này sẽ bị bỏ qua đối với Android và web.

Tham số này chỉ định khoảng thời gian (tính bằng giây) tin nhắn sẽ được lưu giữ trong bộ nhớ FCM nếu thiết bị đang ngoại tuyến. Thời gian tồn tại tối đa được hỗ trợ là 4 tuần và giá trị mặc định là 4 tuần. Để biết thêm thông tin, hãy xem Thiết lập thời gian tồn tại của thông báo.

Khi được đặt thành true, tham số này cho phép nhà phát triển kiểm thử một yêu cầu mà không cần thực sự gửi thông báo.

Giá trị mặc định là false.

Thông số này chỉ định các cặp khoá-giá trị tuỳ chỉnh của gói dữ liệu của thông báo.

Ví dụ: với data:{"score":"3x1"}:

Trên các nền tảng của Apple, nếu thông báo được gửi qua APN, thì thông báo đó đại diện cho các trường dữ liệu tuỳ chỉnh. Nếu gửi qua FCM, giá trị đó sẽ được biểu thị dưới dạng từ điển khoá-giá trị trong AppDelegate application:didReceiveRemoteNotification:.

Trên Android, điều này sẽ dẫn đến một ý định bổ sung có tên score với giá trị chuỗi là 3x1.

Khoá không được là từ dành riêng ("from", "message_type" hoặc bất kỳ từ nào bắt đầu bằng "google" hoặc "gcm"). Không sử dụng bất kỳ từ nào được xác định trong bảng này (chẳng hạn như collapse_key).

Bạn nên sử dụng giá trị thuộc loại chuỗi. Bạn phải chuyển đổi giá trị trong các đối tượng hoặc các kiểu dữ liệu khác không phải chuỗi (ví dụ: số nguyên hoặc boolean) thành chuỗi.

Tiêu đề của thông báo.

Trường này không hiển thị trên điện thoại và máy tính bảng.

Văn bản nội dung của thông báo.

Âm thanh sẽ phát khi thiết bị nhận được thông báo.

Chuỗi chỉ định các tệp âm thanh trong gói chính của ứng dụng khách hoặc trong thư mục Library/Sounds của vùng chứa dữ liệu của ứng dụng. Hãy xem Thư viện dành cho nhà phát triển iOS để biết thêm thông tin.

Giá trị của huy hiệu trên biểu tượng ứng dụng trên màn hình chính.

Nếu không được chỉ định, huy hiệu sẽ không thay đổi.

Nếu bạn đặt thành 0 thì huy hiệu sẽ bị xoá.

Hành động liên quan đến lượt nhấp của người dùng vào thông báo.

Tương ứng với category trong tải trọng APN.

Phụ đề của thông báo.

Khoá cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng để dùng để bản địa hoá văn bản nội dung theo nội dung bản địa hoá hiện tại của người dùng.

Tương ứng với loc-key trong tải trọng APN.

Hãy xem nội dung Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung của thông báo từ xa để biết thêm thông tin.

Các giá trị chuỗi biến sẽ được sử dụng thay cho thông số định dạng trong body_loc_key dùng để bản địa hoá văn bản nội dung thành nội dung bản địa hoá hiện tại của người dùng.

Tương ứng với loc-args trong tải trọng APN.

Hãy xem phần Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung của thông báo từ xa để biết thêm thông tin.

Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng để dùng để bản địa hoá văn bản tiêu đề theo nội dung bản địa hoá hiện tại của người dùng.

Tương ứng với title-loc-key trong tải trọng APN.

Hãy xem nội dung Tài liệu tham khảo về khoá tải trọng và Bản địa hoá nội dung của thông báo từ xa để biết thêm thông tin.

Giá trị chuỗi biến sẽ được sử dụng thay cho chỉ định định dạng trong title_loc_key để sử dụng nhằm bản địa hoá văn bản tiêu đề theo ngôn ngữ bản địa hoá hiện tại của người dùng.

Tương ứng với title-loc-args trong tải trọng APN.

Xem Tài liệu tham khảo khoá tải trọng và Bản địa hoá nội dung của thông báo từ xa để biết thêm của bạn.

Tiêu đề của thông báo.

Văn bản nội dung của thông báo.

Mã nhận dạng kênh của thông báo (mới trong Android O).

Ứng dụng phải tạo một kênh có mã nhận dạng kênh này trước khi nhận được bất kỳ thông báo nào có mã nhận dạng kênh này.

Nếu bạn không gửi mã nhận dạng kênh này trong yêu cầu hoặc nếu mã nhận dạng kênh bạn cung cấp chưa được do ứng dụng tạo, FCM sẽ dùng mã nhận dạng kênh được chỉ định trong tệp kê khai ứng dụng.

Biểu tượng của thông báo.

Đặt biểu tượng thông báo thành myicon cho tài nguyên có thể vẽ myicon. Nếu bạn không gửi khoá này trong yêu cầu, FCM sẽ hiển thị biểu tượng trình chạy được chỉ định trong tệp kê khai ứng dụng.

Âm thanh sẽ phát khi thiết bị nhận được thông báo.

Hỗ trợ "default" hoặc tên tệp của tài nguyên âm thanh được đóng gói trong ứng dụng. Tệp âm thanh phải nằm trong /res/raw/.

Giá trị nhận dạng được dùng để thay thế thông báo hiện có trong thông báo ngăn.

Nếu không được chỉ định, mỗi yêu cầu sẽ tạo một thông báo mới.

Nếu được chỉ định và một thông báo có cùng thẻ đang hiển thị, thì thông báo mới sẽ thay thế thông báo hiện có trong ngăn thông báo.

Màu biểu tượng của thông báo, được thể hiện ở định dạng #rrggbb.

Hành động liên kết với một lượt nhấp của người dùng vào thông báo.

Nếu được chỉ định, một hoạt động có bộ lọc ý định phù hợp sẽ khởi chạy khi người dùng nhấp vào thông báo.

Khoá cho chuỗi nội dung trong tài nguyên chuỗi của ứng dụng để sử dụng nhằm bản địa hoá văn bản nội dung theo ngôn ngữ hiện tại của người dùng.

Xem Tài nguyên chuỗi để biết thêm thông tin.

Các giá trị chuỗi biến sẽ được sử dụng thay cho thông số định dạng trong body_loc_key dùng để bản địa hoá văn bản nội dung thành nội dung bản địa hoá hiện tại của người dùng.

Xem Định dạng và định kiểu để biết thêm thông tin.

Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng để dùng để bản địa hoá văn bản tiêu đề theo nội dung bản địa hoá hiện tại của người dùng.

Hãy xem phần Tài nguyên chuỗi để biết thêm thông tin.

Các giá trị chuỗi biến sẽ được sử dụng thay cho thông số định dạng trong title_loc_key dùng để bản địa hoá văn bản tiêu đề thành nội dung bản địa hoá hiện tại của người dùng.

Xem Định dạng và định kiểu để biết thêm thông tin.

Tiêu đề của thông báo.

Văn bản nội dung của thông báo.

URL sử dụng cho biểu tượng của thông báo.

Hành động liên quan đến lượt nhấp của người dùng vào thông báo.

Đối với tất cả giá trị URL, bạn phải sử dụng HTTPS.

Thông số này chỉ định các ứng dụng khách (mã thông báo đăng ký) nhận được thông báo.

Chỉ được phép gửi thông báo đa hướng (gửi đến nhiều mã thông báo đăng ký) bằng định dạng JSON HTTP.

Tham số này chỉ định các cặp khoá-giá trị trong tải trọng của thông báo. Không có giới hạn về số lượng tham số khoá-giá trị, nhưng tổng kích thước thư có giới hạn là 4096 byte.

Ví dụ: trong Android, "data.score"."3x1" sẽ dẫn đến một ý định bổ sung có tên score bằng giá trị chuỗi 3x1.

Khoá không được là một từ dành riêng ("from", "message_type" hoặc bất kỳ từ nào bắt đầu bằng "google" hoặc "gcm"). Không sử dụng bất kỳ từ nào được xác định trong bảng này (chẳng hạn như collapse_key).

• message_id: Chuỗi chỉ định một mã nhận dạng duy nhất cho mỗi mã được xử lý thành công .
• error: Chuỗi chỉ định lỗi xảy ra khi xử lý thông báo cho người nhận. Bạn có thể xem các giá trị có thể có trong bảng 9.

• Nếu ứng dụng khách huỷ đăng ký bằng FCM.
• Nếu ứng dụng khách tự động bị huỷ đăng ký, điều này có thể xảy ra nếu người dùng gỡ cài đặt ứng dụng. Ví dụ: trên iOS, nếu APN Dịch vụ phản hồi đã báo cáo mã thông báo APN là không hợp lệ.
• Nếu mã thông báo đăng ký hết hạn (ví dụ: Google có thể quyết định làm mới mã thông báo đăng ký hoặc mã thông báo APNs đã hết hạn đối với thiết bị iOS).
• Nếu ứng dụng khách được cập nhật nhưng phiên bản mới chưa được định cấu hình để nhận thông báo.

• Thiếu tiêu đề uỷ quyền hoặc có cú pháp không hợp lệ trong yêu cầu HTTP.
• Dự án Firebase mà khoá máy chủ được chỉ định thuộc về không chính xác.
• Chỉ khoá máy chủ cũ – yêu cầu bắt nguồn từ một máy chủ không có trong danh sách IP của khoá máy chủ.

Máy chủ không thể xử lý yêu cầu kịp thời. Thử gửi lại yêu cầu đó, nhưng bạn phải:

• Tuân thủ tiêu đề Retry-After nếu tiêu đề này được đưa vào phản hồi từ Máy chủ kết nối FCM.
• Triển khai thuật toán thời gian đợi luỹ thừa trong cơ chế thử lại của bạn. (ví dụ: nếu bạn đợi một giây trước khi thử lại lần đầu tiên, hãy đợi ít nhất hai giây trước lần thử lại tiếp theo, sau đó là 4 giây, v.v.). Nếu bạn đang gửi nhiều thư, hãy trì hoãn từng thư một cách độc lập với một số tiền ngẫu nhiên bổ sung để tránh phải gửi một yêu cầu mới cho tất cả thư cùng một lúc.

Những người gửi gây ra vấn đề sẽ có nguy cơ bị đưa vào danh sách đen.

Tỷ lệ tin nhắn gửi đến một thiết bị cụ thể quá cao. Nếu một ứng dụng Apple gửi thông báo ở tốc độ vượt quá giới hạn của APN thì có thể thiết bị sẽ nhận được thông báo lỗi này

Giảm số lượng thông báo được gửi đến thiết bị này và sử dụng thời gian đợi luỹ thừa để thử gửi lại.