Tài liệu này cung cấp tài liệu tham khảo về cú pháp HTTP dùng để chuyển thông báo từ máy chủ ứng dụng của bạn đến các ứng dụng khách thông qua Giải pháp gửi thông báo qua đám mây của Firebase.
Khi sử dụng giao thức HTTP cũ, máy chủ ứng dụng của bạn phải chuyển hướng tất cả yêu cầu HTTP đến điểm cuối sau:
https://fcm.googleapis.com/fcm/send
Các tham số và tuỳ chọn có sẵn thuộc các danh mục chính sau đây:
Cú pháp thông báo truyền xuống
Phần này cung cấp cú pháp để gửi thông báo xuống dưới và diễn giải phản hồi HTTP từ Giải pháp gửi thông báo qua đám mây của Firebase.
Thông báo HTTP truyền xuống (JSON)
Bảng sau đây liệt kê các mục tiêu, tuỳ chọn và tải trọng cho thông báo JSON HTTP.
Thông số | Hoạt động sử dụng | Mô tả | |
---|---|---|---|
Mục tiêu | |||
to |
Chuỗi không bắt buộc |
Tham số này chỉ định người nhận tin nhắn.
Giá trị có thể là mã thông báo đăng ký của một thiết bị, khoá thông báo của nhóm thiết bị hoặc một chủ đề (có tiền tố là |
|
registration_ids | Mảng chuỗi không bắt buộc |
Tham số này chỉ định người nhận của một thông báo phát đa hướng. Đây là một tin nhắn được gửi đến nhiều mã thông báo đăng ký.
Giá trị phải là một mảng mã thông báo đăng ký để gửi thông báo phát đa hướng. Mảng phải chứa tối thiểu 1 và tối đa 1.000 mã thông báo đăng ký. Để gửi tin nhắn đến một thiết bị, hãy sử dụng tham số Chỉ cho phép tin nhắn phát đa hướng bằng cách sử dụng định dạng HTTP JSON. |
|
condition |
Chuỗi không bắt buộc | 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à ""yourChủ đề" trong các chủ đề". Giá trị này không phân biệt chữ hoa chữ thường. Các toán tử được hỗ trợ: |
|
notification_key Không dùng nữa |
Chuỗi không bắt buộc | Tham số này không được dùng nữa. Thay vào đó, hãy sử dụng |
|
Lựa chọn | |||
collapse_key |
Chuỗi không bắt buộc | Thông số này xác định một nhóm thông báo (ví dụ: với Xin lưu ý rằng chúng tôi không thể đảm bảo thứ tự gửi thư. Lưu ý: Mỗi thời điểm chỉ được phép có tối đa 4 phím 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 khác nhau cho mỗi ứng dụng. Nếu bạn vượt quá con số này, thì chúng tôi không thể đảm bảo FCM sẽ giữ lại 4 khoá thu gọn nào. |
|
priority |
Chuỗi không bắt buộc | Đặt mức độ ưu tiên của thông báo. Các giá trị hợp lệ là "bình thường" và "cao". Trên các nền tảng của Apple, những giá trị 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 còn thông báo 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 của ứng dụng khách và nên được dùng trừ phi cần phân phối ngay. Đối với các thông báo có mức độ ưu tiên bình thường, ứng dụng có thể nhận được thông báo với độ trễ không xác định. Khi một tin nhắn được gửi với mức độ ưu tiên cao, tin nhắn đó sẽ được gửi ngay lập tức và ứng dụng có thể hiển thị thông báo. |
|
content_available |
Giá trị boolean | Trên các nền tảng của Apple, hãy sử dụng trường này để đại diện cho |
|
mutable_content |
Giá trị boolean JSON không bắt buộc | Trên các nền tảng của Apple, hãy sử dụng trường này để biểu thị |
|
time_to_live |
Số (không bắt buộc) | Tham số này chỉ định khoảng thời gian (tính bằng giây) thông báo sẽ được lưu giữ trong bộ nhớ FCM nếu thiết bị không có kết nối mạng. Thời gian tối đa để phát trực tiếp đượ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. |
|
restricted_package_
(chỉ dành cho Android) |
Chuỗi không bắt buộc | Tham số này chỉ định tên gói của ứng dụng mà mã thông báo đăng ký phải khớp để nhận được thông báo. | |
dry_run |
Giá trị boolean | Khi được đặt thành Giá trị mặc định là |
|
Tải trọng | |||
data |
Đối tượng (không bắt buộc) | Thông số này chỉ định các cặp khoá-giá trị tuỳ chỉnh trong tải trọng của thông báo. Ví dụ: với 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 được gửi qua FCM, giá trị này sẽ được biểu thị dưới dạng từ điển khoá-giá trị trong Trên Android, điều này sẽ dẫn đến một ý định bổ sung có tên 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"). Đừng sử dụng bất kỳ từ nào được xác định trong bảng này (chẳng hạn như Bạn nên sử dụng các giá trị trong loại chuỗi. Bạn phải chuyển đổi các giá trị trong đố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. |
|
notification |
Đối tượng (không bắt buộc) | Tham số này chỉ định các cặp khoá-giá trị mà người dùng nhìn thấy được xác định trước trong tải trọng thông báo. Hãy xem phần Hỗ trợ tải trọng thông báo để biết thông tin chi tiết.
Để biết thêm thông tin về các tuỳ chọn tin nhắn thông báo và dữ liệu,
hãy xem
Loại thông báo. Nếu tải trọng thông báo được cung cấp hoặc tuỳ chọn content_available được đặt thành true cho một thông báo gửi đến thiết bị Apple, thì thông báo sẽ được gửi qua APN, nếu không thì thông báo sẽ được gửi qua FCM.
|
Hỗ trợ tải trọng thông báo
Các bảng sau đây liệt kê các khoá được xác định trước hiện có để tạo thông báo cho iOS và Android.
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
title |
Chuỗi không bắt buộc |
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. |
body |
Chuỗi không bắt buộc |
Văn bản nội dung của thông báo. |
sound |
Chuỗi không bắt buộc |
Âm thanh sẽ phát khi thiết bị nhận được thông báo.
Chuỗi chỉ định tệp âm thanh trong gói chính của ứng dụng hoặc trong thư mục |
badge |
Chuỗi không bắt buộc |
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 |
click_action |
Chuỗi không bắt buộc |
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 |
subtitle |
Chuỗi không bắt buộc |
Tiêu đề phụ của thông báo. |
body_loc_key |
Chuỗi không bắt buộc |
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 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. |
body_loc_args |
Mảng JSON không bắt buộc dưới dạng chuỗi |
Các giá trị chuỗi biến được dùng thay cho thông số định dạng trong
Tương ứng với 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. |
title_loc_key |
Chuỗi không bắt buộc |
Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng được 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 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. |
title_loc_args |
Mảng JSON không bắt buộc dưới dạng chuỗi |
Các giá trị chuỗi biến được dùng thay cho thông số định dạng trong
Tương ứng với 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. |
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
title |
Chuỗi không bắt buộc |
Tiêu đề của thông báo. |
body |
Chuỗi không bắt buộc |
Văn bản nội dung của thông báo. |
android_channel_id |
Chuỗi không bắt buộc |
Mã kênh của thông báo (mới có trong Android O). Ứng dụng phải tạo một kênh bằng mã nhận dạng kênh này thì mới 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 ứng dụng chưa tạo mã nhận dạng kênh được cung cấp, thì FCM sẽ sử dụng mã nhận dạng kênh được chỉ định trong tệp kê khai ứng dụng. |
icon |
Chuỗi không bắt buộc |
Biểu tượng của thông báo.
Đặt biểu tượng thông báo thành |
sound |
Chuỗi không bắt buộc |
Âm thanh sẽ phát khi thiết bị nhận được thông báo.
Hỗ trợ |
tag |
Chuỗi không bắt buộc |
Giá trị nhận dạng dùng để thay thế thông báo hiện có trong ngăn thông báo. 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. |
color |
Chuỗi không bắt buộc |
Màu biểu tượng của thông báo, được thể hiện ở định dạng |
click_action |
Chuỗi không bắt buộc |
Hành động liên quan đến 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ẽ chạy khi người dùng nhấp vào thông báo. |
body_loc_key |
Chuỗi không bắt buộc |
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. Hãy xem phần Tài nguyên chuỗi để biết thêm thông tin. |
body_loc_args |
Mảng JSON không bắt buộc dưới dạng chuỗi |
Các giá trị chuỗi biến được dùng thay cho thông số định dạng trong Hãy xem phần Định dạng và định kiểu để biết thêm thông tin. |
title_loc_key |
Chuỗi không bắt buộc |
Khoá cho chuỗi tiêu đề trong tài nguyên chuỗi của ứng dụng được 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. |
title_loc_args |
Mảng JSON không bắt buộc dưới dạng chuỗi |
Các giá trị chuỗi biến được dùng thay cho thông số định dạng trong Hãy xem phần Định dạng và định kiểu để biết thêm thông tin. |
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
title |
Chuỗi không bắt buộc |
Tiêu đề của thông báo. |
body |
Chuỗi không bắt buộc |
Văn bản nội dung của thông báo. |
icon |
Chuỗi không bắt buộc |
URL sử dụng cho biểu tượng của thông báo. |
click_action |
Chuỗi không bắt buộc |
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 báo HTTP xuôi dòng (Văn bản thuần tuý)
Bảng sau đây liệt kê cú pháp cho mục tiêu, tuỳ chọn và tải trọng trong thông báo HTTP xuôi dòng ở dạng văn bản thuần tuý.
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
Mục tiêu | ||
registration_id |
Bắt buộc, chuỗi | Tham số này chỉ định những ứng dụng khách (mã thông báo đăng ký) nhận được thông báo. Chỉ cho phép gửi tin nhắn đa hướng (gửi đến nhiều mã thông báo đăng ký) bằng định dạng JSON HTTP. |
Lựa chọn | ||
collapse_key |
Chuỗi không bắt buộc | Xem bảng 1 để biết chi tiết. |
time_to_live |
Số (không bắt buộc) | Xem bảng 1 để biết chi tiết. |
restricted_package_name |
Chuỗi không bắt buộc | Xem bảng 1 để biết chi tiết. |
dry_run |
Giá trị boolean | Xem bảng 1 để biết chi tiết. |
Tải trọng | ||
data.<key> |
Chuỗi không bắt buộc | 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 có giới hạn tổng kích thước thông báo là 4.096 byte. Ví dụ: trong Android, 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"). Đừng sử dụng bất kỳ từ nào được xác định trong bảng này (chẳng hạn như |
Diễn giải nội dung phản hồi cho tin nhắn tiếp theo
Máy chủ ứng dụng phải đánh giá cả tiêu đề phản hồi tin nhắn và nội dung để diễn giải phản hồi tin nhắn được gửi từ FCM. Bảng sau đây mô tả các phản hồi có thể có.
Phản hồi | Mô tả |
---|---|
200 | Thư đã được xử lý thành công. Nội dung phản hồi sẽ chứa thêm thông tin chi tiết về trạng thái thông báo, nhưng định dạng của thông báo sẽ phụ thuộc vào việc yêu cầu là JSON hay văn bản thuần tuý. Xem bảng 5 để biết thêm thông tin chi tiết. |
400 | Chỉ áp dụng cho các yêu cầu JSON. Cho biết không thể phân tích cú pháp yêu cầu dưới dạng JSON hoặc chứa các trường không hợp lệ (ví dụ: truyền một chuỗi dự kiến chứa số). Lý do chính xác không thành công được mô tả trong phản hồi và bạn cần giải quyết vấn đề trước khi thử gửi lại yêu cầu. |
401 | Đã xảy ra lỗi khi xác thực tài khoản người gửi. |
5xx | Lỗi trong phạm vi 500-599 (chẳng hạn như 500 hoặc 503) cho biết đã có lỗi nội bộ trong phần phụ trợ FCM khi cố gắng xử lý yêu cầu hoặc máy chủ tạm thời không hoạt động (ví dụ: do hết thời gian chờ). Người gửi phải thử lại sau, tuân theo mọi tiêu đề Retry-After có trong phản hồi. Máy chủ ứng dụng phải triển khai thuật toán thời gian đợi luỹ thừa. |
Bảng sau đây liệt kê các trường trong nội dung phản hồi thông báo tiếp theo (JSON).
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
multicast_id |
Bắt buộc, số | Mã nhận dạng duy nhất (số) xác định thông báo phát đa hướng. |
success |
Bắt buộc, số | Số lượng thư đã được xử lý mà không có lỗi. |
failure |
Bắt buộc, số | Số lượng thư không xử lý được. |
results |
Mảng đối tượng bắt buộc | Mảng gồm các đối tượng thể hiện trạng thái của thông báo được xử lý. Các đối tượng được liệt kê theo cùng thứ tự với yêu cầu (tức là đối với mỗi mã đăng ký trong yêu cầu, kết quả sẽ được liệt kê trong cùng một chỉ mục trong phản hồi).
|
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
message_id |
Số (không bắt buộc) | Mã nhận dạng của tin nhắn chủ đề khi FCM nhận được yêu cầu và sẽ cố gắng gửi đến tất cả thiết bị đã đăng ký. |
error |
Chuỗi không bắt buộc | Đã xảy ra lỗi khi xử lý thư. Bạn có thể xem các giá trị có thể có trong bảng 9. |
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
id |
Bắt buộc, chuỗi | Tham số này chỉ định mã nhận dạng thư duy nhất FCM được xử lý thành công. |
registration_id |
Chuỗi không bắt buộc | Tham số này chỉ định mã thông báo đăng ký cho ứng dụng khách mà thông báo đã được xử lý và gửi đến. |
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
Error |
Bắt buộc, chuỗi | Tham số này chỉ định giá trị lỗi trong khi xử lý tin nhắn cho người nhận. Xem bảng 9 để biết chi tiết. |
Mã phản hồi lỗi của tin nhắn xuôi dòng
Bảng sau đây liệt kê các mã phản hồi lỗi cho các thông báo thứ cấp.
Lỗi | Mã HTTP | Việc nên làm |
---|---|---|
Thiếu mã thông báo đăng ký | 200 + lỗi:Thiếu đăng ký | Kiểm tra để đảm bảo yêu cầu có chứa mã thông báo đăng ký (trong registration_id trong tin nhắn văn bản thuần tuý hoặc trong trường to hoặc registration_ids trong JSON). |
Mã thông báo đăng ký không hợp lệ | 200 + lỗi:InvalidRegistration | Kiểm tra định dạng của mã thông báo đăng ký mà bạn chuyển đến máy chủ. Hãy đảm bảo mã này khớp với mã thông báo đăng ký mà ứng dụng khách nhận được khi đăng ký bằng Thông báo Firebase. Đừng cắt bớt hoặc thêm ký tự khác. |
Thiết bị chưa được đăng ký | 200 + lỗi:Chưa đăng ký | Mã thông báo đăng ký hiện có có thể hết hiệu lực trong một số trường hợp, trong đó có:
|
Tên gói không hợp lệ | 200 + lỗi:InvalidPackageName | Hãy đảm bảo rằng thông báo được gửi đến mã thông báo đăng ký có tên gói khớp với giá trị được chuyển trong yêu cầu. |
Lỗi xác thực | 401 | Không thể xác thực tài khoản người gửi được dùng để gửi thư. Nguyên nhân có thể là:
|
Người gửi không khớp | 200 + error:MismatchSenderId | Mã thông báo đăng ký được liên kết với một nhóm người gửi nhất định. Khi đăng ký FCM, một ứng dụng khách phải chỉ định những người gửi được phép gửi thông báo. Bạn nên sử dụng một trong các mã nhận dạng người gửi đó khi gửi tin nhắn đến ứng dụng khách. Nếu bạn chuyển sang một người gửi khác, mã thông báo đăng ký hiện có sẽ không hoạt động. |
JSON không hợp lệ | 400 | Kiểm tra để đảm bảo thông báo JSON được định dạng đúng và chứa các trường hợp lệ (ví dụ: đảm bảo truyền đúng loại dữ liệu). |
Tham số không hợp lệ | 400 + lỗi:InvalidParameters | Kiểm tra để đảm bảo các thông số đã cung cấp có tên và loại phù hợp. |
Tin nhắn quá lớn | 200 + lỗi:MessageTooBig | Kiểm tra để đảm bảo rằng tổng kích thước của dữ liệu tải trọng có trong một thông báo không vượt quá giới hạn của FCM: 4096 byte đối với hầu hết các thông báo hoặc 2048 byte đối với trường hợp thông báo đến chủ đề. Dữ liệu này bao gồm cả khoá và giá trị. |
Khoá dữ liệu không hợp lệ | 200 + lỗi:
InvalidDataKey |
Kiểm tra để đảm bảo rằng dữ liệu tải trọng không chứa khoá (chẳng hạn như from hoặc gcm hay bất kỳ giá trị nào có tiền tố google ) được FCM sử dụng nội bộ. Lưu ý rằng một số từ (chẳng hạn như collapse_key ) cũng được FCM sử dụng nhưng được cho phép trong tải trọng. Trong trường hợp đó, giá trị tải trọng sẽ bị giá trị FCM ghi đè. |
Thời gian tồn tại không hợp lệ | 200 + lỗi:InvalidTtl | Kiểm tra để đảm bảo giá trị dùng trong time_to_live là một số nguyên biểu thị thời lượng tính bằng giây từ 0 đến 2.419.200 (4 tuần). |
Hết giờ | 5xx hoặc 200 + error:Không có | Máy chủ không thể xử lý yêu cầu kịp thời. Hãy thử yêu cầu lại, nhưng bạn phải:
Những người gửi gây ra vấn đề sẽ có nguy cơ bị đưa vào danh sách đen. |
Lỗi máy chủ nội bộ | 500 hoặc 200 + lỗi:internalServerError | Máy chủ đã gặp lỗi trong khi cố gắng xử lý yêu cầu. Bạn có thể thử lại yêu cầu tương tự theo các yêu cầu được liệt kê trong phần "Thời gian chờ" (xem hàng ở trên). Nếu lỗi vẫn tiếp diễn, vui lòng liên hệ với nhóm hỗ trợ của Firebase. |
Đã vượt quá tốc độ tin nhắn trên thiết bị | 200 + lỗi:
DeviceMessageRate Đã vượt quá |
Tốc độ tin nhắn gửi đến một thiết bị cụ thể quá cao. Nếu một ứng dụng của Apple gửi thông báo ở tốc độ vượt quá giới hạn của APN, thì ứng dụng đó có thể nhận được thông báo lỗi này Hã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. |
Đã vượt quá tỷ lệ tin nhắn theo chủ đề | 200 + lỗi:
TopicsMessageRate Đã vượt quá |
Tỷ lệ tin nhắn gửi đến người đăng ký một chủ đề cụ thể quá cao. Hãy giảm số lượng tin nhắn được gửi cho chủ đề này và sử dụng thời gian đợi luỹ thừa để thử gửi lại. |
Thông tin đăng nhập APN không hợp lệ | 200 + lỗi:
InvalidApnsCredential |
Không thể gửi tin nhắn nhắm đến thiết bị Apple vì khoá xác thực APN bắt buộc chưa được tải lên hoặc đã hết hạn. Kiểm tra tính hợp lệ của thông tin xác thực phát triển và phát hành chính thức. |
Quản lý nhóm thiết bị
Bảng sau đây liệt kê các khoá để tạo nhóm thiết bị cũng như thêm và xoá thành viên. Để biết thêm thông tin, hãy xem hướng dẫn dành cho nền tảng của bạn, iOS+ hoặc Android.
Thông số | Hoạt động sử dụng | Mô tả |
---|---|---|
operation |
Bắt buộc, chuỗi | Thao tác cần thực hiện.Các giá trị hợp lệ là create , add và remove . |
notification_key_name |
Bắt buộc, chuỗi | Tên do người dùng xác định của nhóm thiết bị để tạo hoặc sửa đổi. |
notification_key |
Bắt buộc (ngoại trừ thao tác create , chuỗi |
Giá trị nhận dạng duy nhất của nhóm thiết bị. Giá trị này được trả về trong phản hồi cho một thao tác create thành công và là bắt buộc đối với tất cả các thao tác tiếp theo trên nhóm thiết bị. |
registration_ids |
Mảng chuỗi bắt buộc | Mã thông báo thiết bị để thêm hoặc xoá. Nếu bạn xoá tất cả các mã thông báo đăng ký hiện có khỏi một nhóm thiết bị, thì FCM sẽ xoá nhóm thiết bị đó. |