Status da Mensagem
O Avisa BR utiliza os seguintes status para representar o ciclo de vida de uma mensagem:
Em Processamento: A mensagem está na fila do Avisa BR, aguardando para ser enviada ao provedor do canal de comunicação.
Enviada ao Provedor: O Avisa BR enviou a mensagem ao provedor do canal (operadora de SMS, servidor de e-mail, gateway de WhatsApp, etc.). Isso não garante que a mensagem foi entregue ao destinatário final, apenas que o provedor a recebeu.
Entregue no Aparelho: (Disponível apenas para SMS e WhatsApp) O provedor do canal confirmou que a mensagem foi entregue ao dispositivo do destinatário. Para SMS, significa que a mensagem chegou ao aparelho. Para WhatsApp, indica que a mensagem foi entregue ao aplicativo do destinatário.
Visualizada: (Disponível apenas para e-mail e WhatsApp) Confirma que o destinatário visualizou a mensagem. Para e-mail, indica que o e-mail foi aberto. Para WhatsApp, significa que o destinatário abriu a conversa. Este status normalmente inclui a data e hora da visualização. Note que "visualizada" não significa necessariamente "lida" ou "compreendida".
Não Enviada ao Provedor: A mensagem não pôde ser enviada ao provedor do canal. O "Detalhamento do Status" fornecerá o motivo específico do não envio.
Não Entregue no Aparelho: (Disponível apenas para SMS e WhatsApp) O provedor do canal confirmou que a mensagem não foi entregue ao dispositivo do destinatário. O "Detalhamento do Status" fornecerá informações adicionais sobre o motivo da não entrega.
É importante entender a diferença entre os status, principalmente entre Enviada ao Provedor e Entregue no Aparelho. Enviada ao Provedor indica que o Avisa BR fez sua parte, enquanto Entregue no Aparelho depende da confirmação do provedor do canal. Visualizada oferece um nível adicional de confirmação, mas lembre-se de que a visualização não garante a leitura ou compreensão da mensagem.
Detalhamento do Status¶
Os status de envio podem possuir um detalhamento, conforme a tabela abaixo. Na tabela, A coluna canal indica o canal de envio que pode possuir aquele detalhamento de status, uma vez que o detalhe do status que é oferecido depende do provedor do canal.
- NÃO ENVIADA AO PROVEDOR
| Canal | Detalhamento do Status | Descrição |
|---|---|---|
| TODOS | FALHA_TÉCNICA_AO_REALIZAR_O_ENVIO | Por motivos técnicos não foi possível realizar o envio |
| TODOS | MUDANÇA_PARÂMETROS_TEMPLATE | Os parâmetros do template foram modificados no cadastro do template |
| TODOS | SERVIÇO_NÃO_LOCALIZADO | Serviço não localizado |
| TODOS | SERVIÇO_NÃO_HABILITADO_PARA_ENVIO_CANAL | Serviço não habilitado para envio pelo canal |
| TODOS | ÓRGÃO_NÃO_LOCALIZADO | Órgão não localizado |
| TODOS | ÓRGÃO_NÃO_HABILITADO | Órgão não habilitado para utilizar dados gov.br |
| TODOS | ÓRGÃO_SEM_CONTRATO | Contrato não encontrado para o órgão |
| TODOS | QUOTA_DE_ENVIO_PELO_CANAL_EXCEDIDA | Quota de envio pelo canal excedida |
| TODOS | ARQUIVO_NÃO_ENCONTRADO | Arquivo não encontrado no sistema de arquivos |
| TODOS | ARQUIVO_SEM_CONTATO | Arquivo sem informações de contato para envio de mensagem |
| TODOS | FALHA_VALIDAÇÃO_CONTRATO | Falha durante a validação do contrato |
| TODOS | STATUS_LOTE_INVÁLIDO | O status do lote não permite a realização da operação |
| TODOS | STATUS_AGENDAMENTO_INVÁLIDO | O status do agendamento não permite a realização da operação |
| TODOS | STATUS_TEMPLATE_INVÁLIDO | O status do template não permite a realização da operação |
| TODOS | TEMPLATE_NÃO_APROVADO | Template não aprovado |
| TODOS | TEMPLATE_NÃO_LOCALIZADO | Template não localizado |
| TEMPLATE_NÃO_LOCALIZADO_WHATSAPP | Template não localizado na plataforma WhatsApp Business | |
| SMS | ARQUIVO_TAMANHO_MSG_CANAL_SMS_EXCEDIDA | Arquivo possui mensagem que excede o limite de caracteres |
| SMS | CANCELADO | O sistema Avisa BR/Notifica BR realiza o envio ao provedor e recebe retorno que o envio cancelado pelo provedor devido às regras internas do próprio provedor |
| SMS | MENSAGEM_EXCEDEU_LIMITE_CARACTERES | O conteúdo da mensagem excedeu o limite de caracteres. (valor maior que 512 caracteres) |
- NÃO ENTREGUE NO APARELHO
| Canal | Detalhamento do Status | Descrição |
|---|---|---|
| SMS | NAO_ENTREGUE_NO_APARELHO | Foi enviada ao provedor e o provedor retornou que não conseguiu realizar a entrega da mensagem ao aparelho do destinatário |
| SMS | SALDO_INSUFICIENTE | O contratante do provedor não possui saldo para envio da mensagem |
| SMS | NUMERO_INVALIDO ou INVALIDO | Número inválido |
| SMS | BLACKLIST | O sistema Avisa BR/Notifica BR realiza o envio ao provedor e recebe retorno que o número está na lista de bloqueio |
| SMS | REPETIDO | O sistema Avisa BR/Notifica BR realiza o envio ao provedor e recebe retorno que do provedor que é um envio repetido |
| SMS | NÃO_ENVIADO_PARA_OPERADORA | O sistema Avisa BR/Notifica BR realiza o envio ao provedor e recebe retorno que do provedor não realizou o envio a operadora telefônica |
| APP GOV.BR | CPF_DISPOSITIVO_NÃO_VINCULADO | O CPF não está vinculado a um dispositivo que possua o APP GOV.BR |
| APP GOV.BR | MENSAGEM_DUPLICADA | Já existe uma mensagem com esse remetente, título, conteúdo e CPF |
Fluxo de Mudança de Status¶
O fluxo de possíveis status de mensagens é representado na imagem abaixo:
As possíveis mudanças de status dependem do canal de envio da mensagem. Cada canal possui um fluxo específico de mudança de status, conforme detalhado nas seções a seguir.
Detalhando o fluxo geral¶
- A mensagem inicialmente está Em Processamento. Ela aguarda na fila do sistema para ser enviada ao provedor do canal de comunicação.
- Após a tentativa de envio da mensagem ao provedor, a mensagem pode ter os status:
2.1. Enviada ao Provedor caso o sistema envie com sucesso a mensagem para o provedor do canal;
2.2. Não Enviada ao Provedor, caso não seja possível enviar a mensagem para o provedor do canal. - Se a mensagem está Enviada ao Provedor, ela pode:
3.1 Se manter no status Enviada ao Provedor, caso o provedor do canal não forneça informações sobre o status da entrega;
3.2 Mudar de status para Entregue no Aparelho, caso o provedor do canal confirme que a mensagem foi entregue ao dispositivo do destinatário;
3.3 Mudar de status para Não Entregue no Aparelho, caso o provedor do canal confirme que a mensagem não foi entregue ao dispositivo do destinatário.
3.4 Mudar de status para Visualizada, caso o provedor do canal confirme que a mensagem foi visualizada pelo destinatário. - Se a mensagem está Entregue no Aparelho, ela pode mudar de status para Visualizada, caso o provedor do canal confirme que a mensagem foi visualizada pelo destinatário.
É importante entender que os status variam conforme o canal, e cada canal pode ter suas próprias regras e fluxos de mudança de status. A seguir, detalharemos os fluxos específicos para cada canal de envio.
Fluxo de Mudança de Status por Canal de Envio¶
Para este canal, a mensagem pode ter os status Em Processamento, Enviada ao Provedor, Não Enviada ao Provedor e Visualizada.
O fluxo de mudança de status é o que está representado na figura a seguir:
O provedor do canal não ofereçe detalhes sobre a entrega da mensagem, portanto, não é possível ter, para o canal E-mail, os status Entregue no Aparelho e Não Entregue no Aparelho.
Para este canal, a mensagem pode ter os status Em Processamento, Enviada ao Provedor, Entregue no Aparelho, Não Enviada ao Provedor e Não Entregue no Aparelho.
O fluxo de mudança de status é o que está representado na figura a seguir:
O provedor do canal não ofereçe detalhes sobre a visualização da mensagem, portanto, não é possível ter, para o canal SMS, o status Visualizada.
Para este canal, a mensagem pode ter todos os status possíveis Em Processamento, Enviada ao Provedor, Entregue no Aparelho, Visualizada, Não Enviada ao Provedor e Não Entregue no Aparelho.
O fluxo de mudança de status é o que está representado na figura a seguir:
