Formatação dos arquivos de entrada para envio de mensagem¶
O Notifica BR recebe um arquivo em formato .csv ou .txt que precisa estar de acordo com as regras de formatação listadas abaixo:
Para todos os canais:¶
- As colunas do arquivo são separadas por | (pipe).
- Os cabeçalhos das colunas do arquivo devem estar em letra minúscula.
- A primeira coluna deve ser obrigatoriamente o cpf para todos os canais de envios.
- O valor do cpf é obrigatório e deve conter 11 dígitos sem pontuação, incluindo o dígito verificador.
- As colunas email e telefone são reservadas ao sistema e, quando definidas, deverão vir em sequência após a coluna cpf.
- Após a definição das colunas utilizadas pelo sistema, deverão vir as colunas correspondentes aos parâmetros definidos no template.
- Para cada parâmetro definido no template, deve ser definida uma coluna correspondente, que possui preenchimento obrigatório.
- O nome da coluna no arquivo precisa estar estritamente igual ao nome do parâmetro definido no template.
- As colunas email e telefone, quando opcionais para o canal de envio e o órgão, e caso sejam definidas no arquivo, terão os seus valores utilizados exclusivamente como dados de envio para o sistema Notifica BR.
Canal E-MAIL:¶
- Caso a coluna email seja definida e não haja valor correspondente em uma determinada linha, se o órgão e serviço estiverem habilitados para uso dos dados gov.br e o template aprovado, então será utilizado o e-mail cadastrado no gov.br para o CPF definido na coluna cpf na mesma linha.
- Caso o órgão e serviço não estejam habilitados ao uso do gov.br ou o template não esteja aprovado, e o valor da coluna email não seja fornecido, o arquivo será recusado pelo sistema.
- A coluna email é obrigatória e a coluna telefone é opcional.
Canal SMS:¶
- Caso a coluna telefone seja definida e não haja valor correspondente em uma determinada linha, se o órgão e serviço estiverem habilitados para uso dos dados gov.br e o template aprovado, então será utilizado o telefone cadastrado no gov.br para o CPF definido na coluna cpf da mesma linha.
- Caso o órgão e serviço não estejam habilitados ao uso do gov.br ou o template não esteja aprovado, e o valor da coluna telefone não seja fornecido, o arquivo será recusado pelo sistema.
- A coluna telefone é obrigatória e a coluna email é opcional.
- O valor do telefone deve conter 11 dígitos sem pontuação, obedecendo ao formato DDXXXXXXXXX (número de telefone móvel), onde "DD" é o código de área (DDD) do número de telefone destinatário.
Canal APP GOV.BR:¶
- Só são realizados envios para o APP quando o órgão e serviço estão habilitados para uso dos dados gov.br e o template está aprovado.
- Para envios de mensagens para o App gov.br, as colunas email e telefone, são opcionais.
Canal WHATSAPP:¶
- Para cada parâmetro definido no cabeçalho do template no formato {{N}}, deverá ser definido um campo no cabeçalho do arquivo de envio com nome cabecalho{{N}}, onde N é o número ordinal do parâmetro no cabeçalho da mensagem WhatsApp.
- Para cada parâmetro definido no corpo do template no formato {{N}}, deverá ser definido um campo no cabeçalho do arquivo de envio com nome corpo{{N}}, onde N é o número ordinal do parâmetro no corpo da mensagem WhatsApp.
- A coluna telefone é obrigatória e a coluna email é opcional.
- O valor do telefone deve conter de 10 a 11 dígitos sem pontuação, obedecendo ao formato DDXXXXXXXX (número de telefone fixo, para destinatários que possuam WhatsApp Business) ou DDXXXXXXXXX (número de telefone móvel, para destinatários que possuam WhatsApp pessoal), onde "DD" é o código de área (DDD) do número de telefone destinatário.
A tabela ilustra a relação de obrigatoriedade entre as colunas reservadas ao sistema e os canais de envio.
Canal | cpf | telefone | |
---|---|---|---|
X | X | ||
APP GOV.BR | X | ||
SMS | X | X | |
X | X |