Formatação dos arquivos de entrada para envio de mensagem¶
O Avisa 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 de um parâmetro precisa estar estritamente igual ao nome do parâmetro definido no template.
- As colunas email e telefone terão os seus valores utilizados exclusivamente como dados de envio para o sistema Avisa BR.
Canal E-MAIL:¶
- Caso 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 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 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.
- Caso 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 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 | ||
SMS | X | X | |
X | X |