Protocolo XMPP de Firebase Cloud Messaging

Este parámetro especifica el destinatario de un mensaje.

El valor puede ser el token de registro de un dispositivo, la clave de notificación de un grupo de dispositivos o un solo tema (con el prefijo /topics/). Para enviar varios temas, usa el parámetro condition.

Este parámetro especifica una expresión lógica de las condiciones que determina el destino del mensaje.

Condición compatible: Topic, con el formato "'tuTema' in topics". Este valor no distingue entre mayúsculas y minúsculas.

Operadores admitidos: &&, ||. Se admite un máximo de dos operadores por mensaje a tema.

Este parámetro identifica un mensaje en una conexión XMPP de manera inequívoca.

Este parámetro identifica un grupo de mensajes (p. ej., con collapse_key: "Updates Available") que puede contraerse, de modo que solo se envíe el último mensaje cuando se reanude la entrega. Esto es para evitar que se envíen demasiadas instancias del mismo tipo de mensaje cuando el dispositivo vuelve a conectarse o sale del estado de descanso.

No se puede garantizar el orden en que se envían los mensajes.

Nota: Se permite un máximo de 4 claves de contracción diferentes en cualquier momento. Esto significa que FCM puede almacenar 4 mensajes diferentes por app cliente de manera simultánea. Si excede esta cantidad, no habrá ninguna garantía de cuáles serán las 4 claves de contracción que conservará FCM.

Establece la prioridad del mensaje. Los valores válidos son "normal" y "alta". En iOS, estos corresponden a prioridad de APNS de 5 y 10.

De forma predeterminada, los mensajes de notificación se envían con prioridad alta y los mensajes de datos se envían con prioridad normal. La prioridad normal optimiza el consumo de la batería de la app cliente y debe usarse salvo que el mensaje deba entregarse inmediatamente. En el caso de los mensajes con prioridad normal, la app puede recibir los mensajes con una demora no específica.

Los mensajes con prioridad alta se envían inmediatamente y la app puede mostrar una notificación.

En iOS, usa este campo para representar content-available en la carga útil de APNS. Cuando se envía una notificación o un mensaje y el valor del campo es true, se despierta una app cliente inactiva y el mensaje se envía a través de APNS como una notificación silenciosa y no a través del servidor de conexión FCM. Ten en cuenta que el envío de notificaciones silenciosas en APNS no está garantizado y puede depender de factores como la activación del Modo de bajo consumo por parte del usuario, el cierre forzoso de la app y otros. En Android, los mensajes de datos despiertan la app de manera predeterminada. En Chrome, no se admite actualmente.

Actualmente, está disponible solo para dispositivos con iOS 10 y versiones más recientes. En iOS, usa este campo para representar mutable-content en la carga útil de APNS. Cuando se envía una notificación y el valor de este parámetro es true, el contenido de la notificación se puede modificar antes de mostrarse mediante una extensión de aplicación del servicio de notificaciones. Este parámetro se ignorará en Android y en la Web.

Este parámetro especifica el tiempo (en segundos) que el mensaje se debe conservar en el almacenamiento de FCM, si el dispositivo se encuentra sin conexión. El tiempo de vida máximo que se admite es de 4 semanas, y el valor predeterminado es de 4 semanas. Para obtener más información, consulta Configuración de la duración de un mensaje.

Este parámetro le permite al servidor de apps solicitar la confirmación de la entrega del mensaje.

Cuando este parámetro se configura como true, FCM envía una confirmación de entrega cuando el dispositivo confirma que recibió el mensaje.

Nota: Este parámetro no se admite en mensajes enviados a dispositivos iOS. El valor predeterminado es false.

Cuando el valor de este parámetro es true, los desarrolladores pueden probar una solicitud sin enviar realmente un mensaje.

El valor predeterminado es false.

Este parámetro especifica los pares clave-valor de la carga útil del mensaje.

Por ejemplo, con data:{"score":"3x1"}:.

En iOS, si el mensaje se envía a través de APNS, representa los campos de datos personalizados. Si se envía a través de FCM, se representa como un diccionario clave-valor en AppDelegate application:didReceiveRemoteNotification:.

En Android, el resultado sería un intent adicional denominado score con el valor de string 3x1.

La clave no debe ser una palabra reservada (“from”, “message_type”, ni ninguna palabra que empiece con “google“ o “gcm”). No uses ninguna de las palabras que se definen en esta tabla (por ejemplo, collapse_key).

Se recomiendan los valores en tipos de string. Los valores de objetos y otros tipos de datos (p. ej., números enteros o booleanos) deben convertirse a string.

El título de la notificación.

Este campo no es visible en tablets y teléfonos con iOS.

El texto del cuerpo de la notificación.

El sonido que se reproduce cuando el dispositivo recibe la notificación.

Las strings que especifican los archivos de sonido pueden estar dentro del paquete principal de la app cliente o en la carpeta Library/Sounds del contenedor de datos de la app. Consulta la biblioteca para desarrolladores de iOS para obtener más información.

El valor de la insignia en el ícono de la app de la pantalla principal.

Si no se especifica, no se cambia la insignia.

Si se le asigna el valor 0, se quita la insignia.

La acción asociada con el clic de un usuario en la notificación.

Corresponde a category en la carga útil de APNS.

El subtítulo de la notificación.

La clave de la string del cuerpo en los recursos de string de la app que se usa para localizar el texto del cuerpo en la localización actual del usuario.

Corresponde a loc-key en la carga útil de APNS.

Para obtener más información, consulta Referencia de la clave de carga útil y Localiza el contenido de las notificaciones remotas.

Valores de string variables que se usarán en lugar de los especificadores de formato en body_loc_key para localizar el cuerpo del texto en la localización actual del usuario.

Corresponde a loc-args en la carga útil de APNS.

Para obtener más información, consulta Referencia de la clave de carga útil y Localiza el contenido de las notificaciones remotas.

La clave de la string del título en los recursos de string de la app que se usa para localizar el texto del título en la localización actual del usuario.

Corresponde a title-loc-key en la carga útil de APNS.

Para obtener más información, consulta Referencia de la clave de carga útil y Localiza el contenido de las notificaciones remotas.

Valores de string variables que se usarán en lugar de los especificadores de formato en title_loc_key para localizar el título del texto en la localización actual del usuario.

Corresponde a title-loc-args en la carga útil de APNS.

Para obtener más información, consulta Referencia de la clave de carga útil y Localiza el contenido de las notificaciones remotas.

El título de la notificación.

El texto del cuerpo de la notificación.

El ID de canal de la notificación (nuevo en Android O).

La app debe crear un canal con este ID antes de que se reciba cualquier notificación con él.

Si no envías este ID de canal en la solicitud o si la app aún no crea el ID proporcionado, FCM usa el ID de canal que especifica el manifiesto de la app.

El ícono de la notificación.

Configura el ícono de la notificación como myicon para el elemento de diseño myicon. Si no envías esta clave en la solicitud, FCM muestra el ícono de selector que se especifica en el manifiesto de la app.

El sonido que se reproduce cuando el dispositivo recibe la notificación.

Admite "default" o el nombre de archivo de un recurso de sonido incluido en la app. Los archivos de sonido deben alojarse en /res/raw/.

Identificador que se usa para reemplazar las notificaciones existentes en el panel lateral de notificaciones.

Si no se configura, cada solicitud crea una nueva notificación.

Si se especifica y ya se muestra una notificación con la misma etiqueta, la notificación nueva reemplaza la existente en el panel lateral de notificaciones.

El color del ícono de la notificación, expresado en formato #rrggbb.

La acción asociada con el clic de un usuario en la notificación.

Si se especifica, se lanza una actividad con un filtro de intents que coinciden cuando un usuario hace clic en la notificación.

La clave de la string del cuerpo en los recursos de string de la app que se usa para localizar el texto del cuerpo en la localización actual del usuario.

Consulta los recursos de string para obtener más información.

Valores de string variables que se usarán en lugar de los especificadores de formato en body_loc_key para localizar el cuerpo del texto en la localización actual del usuario.

Consulta la sección sobre formato y estilo para obtener más información.

La clave de la string del título en los recursos de string de la app que se usa para localizar el texto del título en la localización actual del usuario.

Consulta los recursos de string para obtener más información.

Valores de string variables que se usarán en lugar de los especificadores de formato en title_loc_key para localizar el título del texto en la localización actual del usuario.

Consulta la sección sobre formato y estilo para obtener más información.

El título de la notificación.

El texto del cuerpo de la notificación.

La URL que se usará para el ícono de la notificación.

La acción asociada con el clic de un usuario en la notificación.

Para todos los valores de URL, debe usarse el protocolo HTTPS.

Este parámetro especifica el emisor de la respuesta.

El valor es el token de registro de la app cliente.

Este parámetro especifica un mensaje ack o nack desde FCM al servidor de apps.

Si el valor es nack, el servidor de apps debe buscar en error y error_description para obtener información de fallas.

• Si la app cliente deja de estar registrada en FCM.
• Si se anula el registro de la app cliente automáticamente, que puede ocurrir si el usuario desinstala la aplicación. Por ejemplo, en iOS, si el APNS reportó el token del APNS como no válido.
• Si el token de registro caduca (por ejemplo, porque Google decidió actualizar los tokens de registro o porque caducó el token del APNS para los dispositivos que usan iOS).
• Si la app cliente se actualiza, pero la nueva versión no está configurada para recibir mensajes.

El servidor no pudo procesar la solicitud a tiempo. Vuelve a intentarlo con la misma solicitud, pero:

• Implementa la retirada exponencial en el mecanismo de reintento. (p. ej., si esperaste un segundo antes del primer intento, espera al menos dos segundos antes del próximo, luego, cuatro segundos y así sucesivamente). Si envías varios mensajes, agrega una demora independiente a cada uno con un valor aleatorio adicional, a fin de evitar emitir una nueva solicitud para todos los mensajes de manera simultánea.
• La demora después del primer intento debe configurarse en un segundo.

Nota: Los remitentes que causen problemas corren el riesgo de ser incluidos en una lista negra.

Este parámetro especifica el emisor del mensaje.

El valor es el token de registro de la app cliente.

Este parámetro especifica el destinatario de un mensaje de respuesta.

El valor debe ser el token de registro de la app cliente que envió el mensaje ascendente.

Este parámetro especifica el tipo de mensaje: confirmación de entrega o control.

Cuando se configura en receipt, el mensaje incluye los campos from, message_id, category y data para proporcionar información adicional.

Cuando se configura en control, el mensaje incluye el control_type para indicar el tipo de control.

• message_status: Este parámetro especifica el estado del mensaje de recibo. Se define en MESSAGE_SENT_TO_DEVICE para indicar que el dispositivo confirmó la recepción del mensaje original.
• original_message_id: Este parámetro especifica el ID del mensaje original que el servidor de apps envió a la app cliente.
• device_registration_id: Este parámetro especifica el token de registro de la app cliente a la que se envió el mensaje original.

Este parámetro especifica el tipo de mensaje de control enviado desde FCM.

Actualmente, solo se admite CONNECTION_DRAINING. FCM envía este mensaje de control antes de cerrar una conexión para ejecutar el balanceo de cargas. Cuando se agota la conexión, no se pueden enviar más mensajes a ella, pero continuarán procesándose los existentes en la canalización.