Protocolo HTTP do Firebase Cloud Messaging

Este parâmetro especifica o destinatário de uma mensagem.

O valor pode ser um token de registro de dispositivo, uma chave de notificação de grupo de dispositivos ou um único tópico (prefixado com /topics/ ). Para enviar para vários tópicos, use o parâmetro condition .

Este parâmetro especifica o destinatário de uma mensagem multicast, uma mensagem enviada para mais de um token de registro.

O valor deve ser uma matriz de tokens de registro para os quais a mensagem multicast será enviada. A matriz deve conter no mínimo 1 e no máximo 1.000 tokens de registro. Para enviar uma mensagem para um único dispositivo, use o parâmetro to .

Mensagens multicast só são permitidas usando o formato HTTP JSON.

Este parâmetro especifica uma expressão lógica de condições que determinam o destino da mensagem.

Condição suportada: Tópico, formatado como "'yourTopic' em tópicos". Este valor não diferencia maiúsculas de minúsculas.

Operadores suportados: && , || . Máximo de dois operadores por mensagem de tópico suportados.

Este parâmetro está obsoleto. Em vez disso, use to para especificar os destinatários da mensagem. Para obter mais informações sobre como enviar mensagens para vários dispositivos, consulte a documentação da sua plataforma.

Este parâmetro identifica um grupo de mensagens (por exemplo, collapse_key: "Updates Available" ) que podem ser recolhidas, de modo que apenas a última mensagem seja enviada quando a entrega puder ser retomada. O objetivo é evitar o envio de muitas mensagens iguais quando o dispositivo voltar a ficar on-line ou ficar ativo.

Observe que não há garantia da ordem em que as mensagens são enviadas.

Nota: São permitidas no máximo 4 chaves de recolhimento diferentes a qualquer momento. Isso significa que o FCM pode armazenar simultaneamente 4 mensagens diferentes por aplicativo cliente. Se você exceder esse número, não há garantia de quais 4 chaves de recolhimento o FCM manterá.

Define a prioridade da mensagem. Os valores válidos são “normal” e “alto”. Nas plataformas Apple, correspondem às prioridades 5 e 10 dos APNs.

Por padrão, as mensagens de notificação são enviadas com prioridade alta e as mensagens de dados são enviadas com prioridade normal. A prioridade normal otimiza o consumo de bateria do aplicativo cliente e deve ser usada a menos que seja necessária entrega imediata. Para mensagens com prioridade normal, o aplicativo pode receber a mensagem com atraso indeterminado.

Quando uma mensagem é enviada com alta prioridade, ela é enviada imediatamente e o aplicativo pode exibir uma notificação.

Nas plataformas Apple, use este campo para representar content-available na carga útil dos APNs. Quando uma notificação ou mensagem é enviada e definida como true , um aplicativo cliente inativo é ativado e a mensagem é enviada por meio de APNs como uma notificação silenciosa e não por meio de FCM. Observe que as notificações silenciosas em APNs não têm garantia de entrega e podem depender de fatores como o usuário ativar o modo de baixo consumo, forçar o encerramento do aplicativo, etc. No Android, as mensagens de dados ativam o aplicativo por padrão. No Chrome, atualmente não é compatível.

Nas plataformas Apple, use este campo para representar mutable-content na carga útil dos APNs. Quando uma notificação é enviada e está definida como true , o conteúdo da notificação pode ser modificado antes de ser exibido, usando uma extensão de aplicativo do Notification Service . Este parâmetro será ignorado para Android e web.

Este parâmetro especifica por quanto tempo (em segundos) a mensagem deve ser mantida no armazenamento FCM se o dispositivo estiver offline. O tempo máximo de vida suportado é de 4 semanas e o valor padrão é de 4 semanas. Para obter mais informações, consulte Configurando a vida útil de uma mensagem .

Este parâmetro, quando definido como true , permite que os desenvolvedores testem uma solicitação sem realmente enviar uma mensagem.

O valor padrão é false .

Este parâmetro especifica os pares de valores-chave personalizados da carga útil da mensagem.

Por exemplo, com data:{"score":"3x1"}:

Nas plataformas Apple, se a mensagem for enviada via APNs, ela representa os campos de dados personalizados. Se for enviado via FCM, será representado como dicionário de valor-chave em AppDelegate application:didReceiveRemoteNotification: .

No Android, isso resultaria em uma score extra nomeada de intenção com o valor da string 3x1 .

A chave não deve ser uma palavra reservada ("from", "message_type" ou qualquer palavra que comece com "google" ou "gcm"). Não use nenhuma das palavras definidas nesta tabela (como collapse_key ).

Valores em tipos de string são recomendados. Você deve converter valores em objetos ou outros tipos de dados que não sejam string (por exemplo, inteiros ou booleanos) em string.

O título da notificação.

Este campo não está visível em telefones e tablets.

O texto do corpo da notificação.

O som a ser reproduzido quando o dispositivo recebe a notificação.

String especificando arquivos de som no pacote principal do aplicativo cliente ou na pasta Library/Sounds do contêiner de dados do aplicativo. Consulte a Biblioteca de Desenvolvedores iOS para obter mais informações.

O valor do selo no ícone do aplicativo na tela inicial.

Se não for especificado, o emblema não será alterado.

Se definido como 0 , o emblema será removido.

A ação associada a um clique do usuário na notificação.

Corresponde à category na carga útil dos APNs.

O subtítulo da notificação.

A chave para a string do corpo nos recursos de string do aplicativo a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

Corresponde à loc-key na carga útil dos APNs.

Consulte Referência de chave de carga útil e localização do conteúdo de suas notificações remotas para obter mais informações.

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em body_loc_key a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

Corresponde a loc-args na carga útil dos APNs.

Consulte Referência de chave de carga útil e localização do conteúdo de suas notificações remotas para obter mais informações.

A chave para a string de título nos recursos de string do aplicativo a serem usados ​​para localizar o texto do título para a localização atual do usuário.

Corresponde à title-loc-key na carga útil dos APNs.

Consulte Referência de chave de carga útil e localização do conteúdo de suas notificações remotas para obter mais informações.

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em title_loc_key a serem usados ​​para localizar o texto do título para a localização atual do usuário.

Corresponde a title-loc-args na carga útil dos APNs.

Consulte Referência de chave de carga útil e localização do conteúdo de suas notificações remotas para obter mais informações.

O título da notificação.

O texto do corpo da notificação.

O ID do canal da notificação (novo no Android O).

O aplicativo deve criar um canal com esse ID de canal antes que qualquer notificação com esse ID de canal seja recebida.

Se você não enviar esse ID de canal na solicitação ou se o ID de canal fornecido ainda não tiver sido criado pelo aplicativo, o FCM usará o ID de canal especificado no manifesto do aplicativo.

O ícone da notificação.

Define o ícone de notificação como myicon para o recurso drawable myicon . Se você não enviar essa chave na solicitação, o FCM exibirá o ícone do iniciador especificado no manifesto do seu aplicativo.

O som a ser reproduzido quando o dispositivo recebe a notificação.

Suporta "default" ou o nome do arquivo de um recurso de som incluído no aplicativo. Os arquivos de som devem residir em /res/raw/ .

Identificador usado para substituir notificações existentes na gaveta de notificações.

Se não for especificado, cada solicitação criará uma nova notificação.

Se especificado e uma notificação com a mesma tag já estiver sendo mostrada, a nova notificação substituirá a existente na gaveta de notificações.

A cor do ícone da notificação, expressa no formato #rrggbb .

A ação associada a um clique do usuário na notificação.

Se especificado, uma atividade com um filtro de intenção correspondente será iniciada quando um usuário clicar na notificação.

A chave para a string do corpo nos recursos de string do aplicativo a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

Consulte Recursos de String para obter mais informações.

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em body_loc_key a serem usados ​​para localizar o texto do corpo para a localização atual do usuário.

Consulte Formatação e estilo para obter mais informações.

A chave para a string de título nos recursos de string do aplicativo a serem usados ​​para localizar o texto do título para a localização atual do usuário.

Consulte Recursos de String para obter mais informações.

Valores de string variáveis ​​a serem usados ​​no lugar dos especificadores de formato em title_loc_key a serem usados ​​para localizar o texto do título para a localização atual do usuário.

Consulte Formatação e estilo para obter mais informações.

O título da notificação.

O texto do corpo da notificação.

A URL a ser usada para o ícone da notificação.

A ação associada a um clique do usuário na notificação.

Para todos os valores de URL, HTTPS é obrigatório.

Este parâmetro especifica os aplicativos cliente (tokens de registro) que recebem a mensagem.

Mensagens multicast (envio para mais de um token de registro) são permitidas somente no formato HTTP JSON.

Este parâmetro especifica os pares de valores-chave da carga útil da mensagem. Não há limite para o número de parâmetros de valor-chave, mas há um limite total de tamanho de mensagem de 4.000 bytes.

Por exemplo, no Android, "data.score"."3x1" resultaria em uma score extra nomeada de intenção com o valor da string 3x1 .

A chave não deve ser uma palavra reservada ("from", "message_type" ou qualquer palavra que comece com "google" ou "gcm"). Não use nenhuma das palavras definidas nesta tabela (como collapse_key ).

• message_id : String especificando um ID exclusivo para cada mensagem processada com sucesso.
• error : String especificando o erro ocorrido ao processar a mensagem para o destinatário. Os valores possíveis podem ser encontrados na tabela 9 .

• Se o aplicativo cliente cancelar o registro no FCM.
• Se o registro do aplicativo cliente for automaticamente cancelado, o que pode acontecer se o usuário desinstalar o aplicativo. Por exemplo, no iOS, se o Serviço de Feedback de APNs reportar o token de APNs como inválido.
• Se o token de registro expirar (por exemplo, o Google pode decidir atualizar os tokens de registro ou o token APNs expirou para dispositivos iOS).
• Se o aplicativo cliente estiver atualizado, mas a nova versão não estiver configurada para receber mensagens.

• Cabeçalho de autorização ausente ou com sintaxe inválida na solicitação HTTP.
• O projeto do Firebase ao qual pertence a chave do servidor especificada está incorreto.
• Somente chaves de servidor herdadas: a solicitação originada de um servidor que não está na lista de permissões nos IPs de chave do servidor.

O servidor não conseguiu processar a solicitação a tempo. Tente novamente a mesma solicitação, mas você deve:

• Respeite o cabeçalho Retry-After se ele estiver incluído na resposta do FCM Connection Server.
• Implemente a retirada exponencial em seu mecanismo de nova tentativa. (por exemplo, se você esperou um segundo antes da primeira tentativa, espere pelo menos dois segundos antes da próxima, depois 4 segundos e assim por diante). Se você estiver enviando várias mensagens, atrase cada uma delas de forma independente por um valor aleatório adicional para evitar a emissão de uma nova solicitação para todas as mensagens ao mesmo tempo.

Remetentes que causam problemas correm o risco de serem colocados na lista negra.

A taxa de mensagens para um determinado dispositivo é muito alta. Se um aplicativo da Apple enviar mensagens a uma taxa que excede os limites de APNs, ele poderá receber esta mensagem de erro

Reduza o número de mensagens enviadas para este dispositivo e use a espera exponencial para tentar enviar novamente.