Tài liệu này cung cấp tài liệu tham khảo về cú pháp XMPP dùng để truyền thông báo giữa máy chủ ứng dụng, ứng dụng khách và Firebase Cloud Messaging (FCM). Máy chủ ứng dụng của bạn phải kết nối với các điểm cuối sau:
// Production fcm-xmpp.googleapis.com:5235 // Testing fcm-xmpp.googleapis.com:5236
Các tham số và tuỳ chọn có sẵn thuộc các danh mục sau:
- Cú pháp thông báo truyền xuống
- Mã phản hồi lỗi thông báo hạ nguồn
- Cú pháp của thông báo luồng lên
- Thông báo điều khiển FCM
Cú pháp thông báo hạ nguồn
Phần này cung cấp cú pháp để gửi thông báo xuống dưới.
Thông báo XMPP hạ nguồn (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 điệp XMPP JSON.
Thông số | Cách sử dụng | Mô tả | |
---|---|---|---|
Mục tiêu | |||
to |
Chuỗi tùy chọn |
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ủ đề duy nhất (có tiền tố là |
|
condition |
Chuỗi tùy chọn | 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ợ: |
|
Lựa chọn | |||
message_id |
Bắt buộc, chuỗi | Tham số này xác định duy nhất một thông báo trong kết nối XMPP. |
|
collapse_key |
Không bắt buộc, chuỗi | Tham số này xác định một nhóm thông báo (ví dụ: có Chúng tôi không đảm bảo thứ tự gửi tin nhắn. Lưu ý: Tại mỗi thời điểm, bạn chỉ được phép sử dụng tối đa 4 khoá thu gọn khác nhau. Điều này nghĩa là FCM có thể lưu trữ đồng thời 4 thông báo khác nhau cho mỗi ứng dụng khách. Nếu bạn vượt quá con số này, thì chúng tôi không thể đảm bảo sẽ giữ lại được 4 khoá thu gọn nào FCM. |
|
priority |
Chuỗi tùy chọn | Đặ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, các mức này tương ứng với mức độ ưu tiên 5 và 10 của APN. Theo mặc định, thông báo sẽ được gửi với mức độ ưu tiên cao và thông báo dữ liệu sẽ đượ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 tin nhắn có mức độ ưu tiên thông thường, ứng dụng có thể nhận được tin nhắn 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 |
Không bắt buộc, boolean | 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 |
Không bắt buộc, boolean JSON | 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) | Thông số này chỉ định khoảng thời gian (tính bằng giây) mà thông báo sẽ được lưu trữ trong bộ nhớ FCM nếu thiết bị không có kết nối mạng. 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 phần Đặt thời lượng tồn tại của thông báo. |
|
dry_run |
Không bắt buộc, boolean | Khi được đặt thành Giá trị mặc định là |
|
Trọng tải | |||
data |
Đối tượng (không bắt buộc) | Thông số này chỉ định các cặp khoá-giá trị của 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 do APN gửi, thì thông báo đó sẽ đại diện cho các trường dữ liệu tuỳ chỉnh. Nếu FCM phân phối, thì thông tin này sẽ được biểu thị dưới dạng từ điển giá trị khoá trong Trên Android, điều này dẫn đến một ý định bổ sung có tên 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ư Bạn nên sử dụng giá trị thuộc 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 |
Không bắt buộc, đối tượng | Thông số này chỉ định các cặp khoá-giá trị được xác định trước, hiển thị với người dùng của tải trọng thông báo. Hãy xem phần Hỗ trợ gói dữ liệu 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 thông báo và thông báo dữ liệu, hãy xem phần Các loại thông báo. Nếu bạn cung cấp tải trọng thông báo hoặc đặt tuỳ chọn content_available thành true cho một thông báo gửi đến thiết bị của Apple, thì thông báo đó sẽ được gửi qua APN, nếu không thì 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 có sẵn để tạo thông báo cho các nền tảng Apple và Android.
Thông số | Cách sử dụng | Mô tả |
---|---|---|
title |
Chuỗi tùy chọn |
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 |
Không bắt buộc, chuỗi |
Văn bản nội dung của thông báo. |
sound |
Chuỗi tùy chọn |
Â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 |
Không bắt buộc, chuỗi |
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 |
Không bắt buộc, chuỗi |
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.
Tương ứng với |
subtitle |
Không bắt buộc, chuỗi |
Tiêu đề phụ của thông báo. |
body_loc_key |
Không bắt buộc, chuỗi |
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.
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 |
Không bắt buộc, mảng JSON 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 |
Không bắt buộc, chuỗi |
Khoá cho chuỗi tiêu đề 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 tiêu đề theo ngôn ngữ 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 |
Giá trị chuỗi biến sẽ được sử dụng thay cho chỉ định đị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ố | Cách sử dụng | Mô tả |
---|---|---|
title |
Chuỗi tùy chọn |
Tiêu đề của thông báo. |
body |
Không bắt buộc, chuỗi |
Văn bản nội dung của thông báo. |
android_channel_id |
Chuỗi tùy chọn |
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 ứ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 tùy chọn |
Biểu tượng của thông báo.
Đặt biểu tượng thông báo thành |
sound |
Không bắt buộc, chuỗi |
Âm thanh sẽ phát khi thiết bị nhận được thông báo.
Hỗ trợ |
tag |
Chuỗi tùy chọn |
Giá trị nhận dạng dùng để thay thế các 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 |
Không bắt buộc, chuỗi |
Màu biểu tượng của thông báo, được thể hiện ở định dạng |
click_action |
Không bắt buộc, chuỗi |
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ẽ được khởi chạy khi người dùng nhấp vào thông báo. |
body_loc_key |
Không bắt buộc, chuỗi |
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. 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 |
Giá trị chuỗi biến sẽ được sử dụng thay cho chỉ định đị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 |
Không bắt buộc, chuỗi |
Khoá cho chuỗi tiêu đề 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 tiêu đề theo ngôn ngữ 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 |
Không bắt buộc, mảng JSON dưới dạng chuỗi |
Giá trị chuỗi biến sẽ được sử dụng thay cho chỉ định đị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ố | Cách sử dụng | Mô tả |
---|---|---|
title |
Chuỗi tùy chọn |
Tiêu đề của thông báo. |
body |
Không bắt buộc, chuỗi |
Văn bản nội dung của thông báo. |
icon |
Không bắt buộc, chuỗi |
URL sử dụng cho biểu tượng của thông báo. |
click_action |
Chuỗi tùy chọn |
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. Tất cả giá trị URL đều phải sử dụng giao thức HTTPS. |
Giải thích phản hồi tin nhắn XMPP hạ nguồn
Bảng sau đây liệt kê các trường xuất hiện trong phản hồi tin nhắn XMPP xuôi dòng.
Thông số | Cách sử dụng | Mô tả |
---|---|---|
from |
Bắt buộc, chuỗi | Thông số này chỉ định người đã gửi phản hồi này. Giá trị này là mã thông báo đăng ký của ứng dụng khách. |
message_id |
Bắt buộc, chuỗi | Tham số này xác định duy nhất một thông báo trong kết nối XMPP. Giá trị này là một chuỗi xác định riêng thông báo được liên kết. |
message_type |
Bắt buộc, chuỗi | Tham số này chỉ định một thông báo Nếu bạn đặt giá trị thành |
error |
Không bắt buộc, chuỗi | Tham số này chỉ định một lỗi liên quan đến thông báo hạ nguồn. Thuộc tính này được đặt khi message_type là nack . Hãy xem bảng 4 để biết thông tin chi tiết. |
error_description |
Không bắt buộc, chuỗi | Tham số này cung cấp thông tin mô tả về lỗi. Giá trị này được đặt khi message_type là nack . |
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 thông báo truyền xuống.
Lỗi | Mã XMPP | Hành động được đề xuất |
---|---|---|
Thiếu mã thông báo đăng ký | INVALID_JSON |
Kiểm tra để đảm bảo yêu cầu 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 ở định dạng JSON). |
Thông tin đăng ký APN không hợp lệ | INVALID_JSON |
Đối với các lượt đăng ký iOS, hãy kiểm tra để đảm bảo rằng yêu cầu đăng ký từ ứng dụng khách chứa mã thông báo APN và mã ứng dụng hợp lệ. |
Mã thông báo đăng ký không hợp lệ | BAD_REGISTRATION |
Kiểm tra định dạng của mã thông báo đăng ký mà bạn truyền đến máy chủ. Đả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 FCM. Không cắt bớt hoặc thêm ký tự. |
Thiết bị chưa đăng ký | DEVICE_UNREGISTERED |
Mã thông báo đăng ký hiện có có thể không còn hợp lệ trong một số trường hợp, bao gồm:
|
Người gửi không khớp | SENDER_ID_MISMATCH |
Mã đăng ký được liên kết với một nhóm người gửi nhất định. Khi đăng ký FCM, ứ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ệ | INVALID_JSON |
Kiểm tra để đảm bảo rằng thông báo JSON được định dạng đúng cách và chứa các trường hợp hợp lệ (ví dụ: đảm bảo truyền đúng loại dữ liệu). |
Tin nhắn quá lớn | INVALID_JSON |
Kiểm tra để đảm bảo 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 FCM: 4096 byte đối với hầu hết thông báo hoặc 2048 byte đối với 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ệ | INVALID_JSON |
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 , gcm hoặc bất kỳ giá trị nào có tiền tố google ) được FCM sử dụng nội bộ. Xin 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 phép trong tải trọng. Trong trường hợp này, giá trị tải trọng sẽ bị giá trị FCM ghi đè. |
Thời gian tồn tại không hợp lệ | INVALID_JSON |
Kiểm tra để đảm bảo giá trị được sử 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 trong khoảng từ 0 đến 2.419.200 (4 tuần). |
Thông báo ACK không hợp lệ | BAD_ACK |
Kiểm tra để đảm bảo rằng thông báo ack được định dạng đúng cách trước khi thử lại. Hãy xem bảng 6 để biết thông tin chi tiết. |
Hết giờ | SERVICE_UNAVAILABLE |
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:
Lưu ý: 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ộ | INTERNAL_SERVER_
|
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 cùng một yêu cầu theo các yêu cầu nêu trong phần "Hết thời gian chờ" (xem hàng trên). |
Đã vượt quá giới hạn tần suất gửi tin nhắn trên thiết bị | DEVICE_MESSAGE_RATE |
Tỷ lệ tin nhắn gửi đến một thiết bị cụ thể quá cao. Giảm số lượng tin nhắn gửi đến thiết bị này và không thử gửi lại ngay cho thiết bị này. |
Đã vượt quá tốc độ gửi tin nhắn về chủ đề | TOPICS_MESSAGE_RATE |
Tỷ lệ tin nhắn gửi đến người đăng ký một chủ đề cụ thể quá cao. Giảm số lượng thư được gửi cho chủ đề này và không thử gửi lại ngay lập tức. |
Hết pin do kết nối | CONNECTION_DRAINING |
Không thể xử lý thông báo vì kết nối đang bị hao tổn. Điều này xảy ra vì định kỳ, FCM cần đóng một kết nối để thực hiện cân bằng tải. Thử lại thông báo qua một kết nối XMPP khác. |
Thông tin xác thực APN không hợp lệ | INVALID_APNS_CREDENTIAL |
Không thể gửi thông báo nhắm đến thiết bị iOS 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. |
Không xác thực được | AUTHENTICATION_FAILED |
Không xác thực được bằng các dịch vụ đẩy bên ngoài. Kiểm tra xem bạn có đang sử dụng đúng chứng chỉ đẩy web hay không. |
Cú pháp thông báo ngược
Tin nhắn ngược dòng là tin nhắn mà ứng dụng khách gửi đến máy chủ ứng dụng. Hiện tại, chỉ XMPP hỗ trợ chức năng nhắn tin ngược dòng. Hãy xem tài liệu dành cho nền tảng của bạn để biết thêm thông tin về cách gửi thông báo từ ứng dụng khách.
Diễn giải thông báo XMPP ngược dòng
Bảng sau đây mô tả các trường trong khổ thơ XMPP do FCM tạo ra để phản hồi các yêu cầu tin nhắn ngược từ ứng dụng khách.
Thông số | Cách sử dụng | Mô tả |
---|---|---|
from |
Bắt buộc, chuỗi | Tham số này chỉ định người đã gửi tin nhắn. Giá trị này là mã thông báo đăng ký của ứng dụng khách. |
category |
Bắt buộc, chuỗi | Tham số này chỉ định tên gói ứng dụng của ứng dụng khách đã gửi thông báo. |
message_id |
Bắt buộc, chuỗi | Tham số này chỉ định mã nhận dạng duy nhất của thông báo. |
data |
Chuỗi tùy chọn | Thông số này chỉ định các cặp khoá-giá trị của tải trọng của thông báo. |
Gửi thông báo xác nhận (ACK)
Bảng sau đây mô tả phản hồi ACK mà máy chủ ứng dụng dự kiến sẽ gửi đến FCM để phản hồi thông báo ngược dòng mà máy chủ ứng dụng đã nhận được.
Thông số | Cách sử dụng | Mô tả |
---|---|---|
to |
Bắt buộc, chuỗi | Tham số này chỉ định người nhận thông báo phản hồi. Giá trị này phải là mã thông báo đăng ký của ứng dụng khách đã gửi thông báo ngược dòng. |
message_id |
Bắt buộc, chuỗi | Thông số này chỉ định thông báo mà phản hồi dành cho. Giá trị này phải là giá trị message_id từ thông báo ngược tương ứng. |
message_type |
Bắt buộc, chuỗi | Tham số này chỉ định một thông báo ack từ máy chủ ứng dụng đến CCS.
Đối với thông báo ngược dòng, bạn phải luôn đặt giá trị này thành ack . |
Thông báo máy chủ FCM (XMPP)
Đây là thông báo được gửi từ FCM đến máy chủ ứng dụng. Dưới đây là các loại thông báo chính mà FCM gửi đến máy chủ ứng dụng:
- Kiểm soát: Những thông báo do CCS tạo ra này cho biết máy chủ ứng dụng cần thực hiện hành động.
Bảng sau đây mô tả các trường có trong thông báo mà CCS gửi đến máy chủ ứng dụng.
Thông số | Cách sử dụng | Mô tả |
---|---|---|
Trường phổ biến | ||
message_type |
Bắt buộc, chuỗi | Tham số này chỉ định loại thông báo: điều khiển. Khi bạn đặt chính sách này thành |
control_type |
Chuỗi tùy chọn | Tham số này chỉ định loại thông báo kiểm soát được gửi từ FCM. Hiện tại, chúng tôi chỉ hỗ trợ |