Para realizar um envio por arquivo no Zenvia Connect, é necessário escolher um dos 14 layouts disponíveis.
Layouts A, B, C, D e E
Os layouts A, B, C, D e E adotam o formato CSV (Comma-Separated Values), que são arquivos de texto com os campos separados por ponto-e-vírgula.
|
Nome
|
Campos em cada linha
|
|---|---|
|
Layout A
|
celular;msg
|
|
Layout B
|
celular;msg;remetente
|
|
Layout C
|
celular;msg;id
|
|
Layout D
|
celular;msg;id;remetente
|
|
Layout E
|
celular;msg;id;remetente;dataEnvio
|
|
Campo
|
Valor do Campo
|
|---|---|
|
celular
|
Código País + Código Área + Número Celular (ex: 555199999999).
|
|
msg
|
Corpo da mensagem junto com remetente deve conter no máximo 160 caracteres (para mensagens maiores entre em contato com o Atendimento para habilitar o Long Message)
|
|
remetente
|
Nome do remetente. Se vazio, puxa o remetente padrão da conta.
|
|
id
|
Código identificador que o usuário pode fornecer para evitar duplicação e poder consultar o status da mensagem. Caso não seja fornecido, não será possível a verificação de status (máx. 20 caracteres).
|
|
dataEnvio
|
Data e hora em que o SMS deve ser enviado à operadora.
Deve estar no formato dd/mm/aaaa hh/mm/ss.
|
Layouts FC1, FC1R e FC1R-V
Os layouts FC1 e FC1R, disponíveis em formato de coluna fixa (fixed-column), são arquivos de texto em que a mensagem é colocada no início do arquivo.
Em cada linha vai o celular destinatário junto com os dados variáveis que podem ser substituídos na mensagem.
|
Nome
|
Campos
|
Observação
|
|---|---|---|
|
Layout FC1
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, será enviada apenas a primeira.
|
|
Layout FC1R
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, ambas serão enviadas.
|
|
Layout FC1R-V
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, ambas serão enviadas.
|
O conteúdo da mensagem pode conter customização para cada pessoa a partir de dados variáveis contidos em cada linha do destinatário.
Os campos que permitem personalização são:
- $PRIMNOME$, $PRINOME$ ou $NOMECLI$: é substituído pelo primeiro nome do destinatário (coluna 13);
- $CODCLI$ ou $COD_CLI$: é substituído pelo código atribuído ao destinatário (coluna 43).
- $TELREC$ ou $TEL_REC$: é substituído pelo telefone de retorno (coluna 73).
Exemplo: Sr.(a) JOÃO MENDES, ligar urgente para (51)3346-8282 e mencionar o código 595518.
Linha 3 em diante: Destinatários
Layout FC1R
O FC1R é parecido com o FC1, mas permite que haja mais de um destinatário com o mesmo código atribuído, no caso de seu arquivo conter dois ou mais celulares de contato para cada pessoa.
Isto é, um destinatário pode estar em duas linhas, tendo um número celular (coluna 02) diferente para cada linha, mas com o mesmo código (coluna 43) atribuído.
Layout FC1R-V
Similar ao FC1R. Contudo, permite que haja mais de um destinatário com o mesmo código atribuído, no caso de seu arquivo conter dois ou mais celulares de contato para cada pessoa.
Isto é, um destinatário pode estar em duas linhas, tendo um número celular (coluna 02) diferente para cada linha, mas com o mesmo código (coluna 43) atribuído.
O layout FC1R-V ainda possui mais seis colunas de 15 caracteres cada, para que seja permitido importar as mais diversas informações e, consequentemente, usá-las na mensagem através das referências:
- $COLUNAA$
- $COLUNAB$
- $COLUNAC$
- $COLUNAD$
- $COLUNAE$
- $COLUNAF$
A $COLUNAA$ é a mesma TELREC do layout FC1R.
Layout FC2 e FC2R
Os layouts FC2 e FC2R, disponíveis em formato de coluna fixa (fixed-column), são arquivos de texto em que a mensagem é colocada no início do arquivo.
Em cada linha, vai o celular destinatário junto com os dados variáveis que podem ser substituídos na mensagem.
|
Nome
|
Campos
|
Observação
|
|---|---|---|
|
Layout FC2
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, será enviada apenas a primeira.
|
|
Layout FC2R
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, ambas serão enviadas.
|
Layout FC2
Linha 1: Cabeçalho
- $PRIMNOME$, $PRINOME$ ou $NOMECLI$: é substituído pelo primeiro nome do destinatário (coluna 13);
- $CODCLI$ ou $COD_CLI$: é substituído pelo código atribuído ao destinatário (coluna 73);
- $TELREC$ ou $TEL_REC$: é substituído pelo telefone de retorno (coluna 44);
Layout FC2R
Layout FC3
|
Nome
|
Campos
|
Observação |
|---|---|---|
|
Layout FC3
|
(abaixo)
|
Se houver duas linhas com mesmo CODCLI, será enviada apenas a primeira.
|
- $PRIMNOME$, $PRINOME$ ou $NOMECLI$: é substituído pelo primeiro nome do destinatário (coluna 21);
- $CODCLI$ ou $COD_CLI$: é substituído pelo código atribuído ao destinatário (coluna 51);
- $TELREC$ ou $TEL_REC$: é substituído pelo telefone de retorno (coluna 81);
- $AGENCIA$: é substituído pelo nome da agência (coluna 104).
Layout VC1
A principal característica desse layout é o suporte a múltiplos campos variáveis. Além disso, a mensagem não faz parte do arquivo, sendo informada na interface de upload.
Os campos contidos no layout se referem a:
|
Campo
|
Descrição
|
|---|---|
|
Celular
|
Código Área + Número Celular (ex.: 5190123456)
|
|
Variável 1
|
Campo variável 1
|
|
Variável 2
|
Campo variável 2
|
|
Variável 3
|
Campo variável 3
|
|
Variável (...)
|
Campos variáveis subsequentes (...)
|
Layout VC2
A diferença para o VC1 é que a mensagem deve vir na segunda linha do arquivo, e ele também conta com suporte a três campos variáveis.
Os campos contidos no layout se referem a:
|
Linha
|
Campo
|
Descrição
|
|---|---|---|
|
Linha 1
|
Identificador
|
Identificador do Remetente
|
|
Linha 2
|
Msg
|
Mensagem, utilizando as variáveis abaixo (A, B e C).
|
|
A partir da linha 3
|
Celular
|
Código Área + Número Celular (ex.: 5190123456)
|
|
A partir da linha 3
|
Coluna A
|
Campo variável 1
|
|
A partir da linha 3
|
Coluna B
|
Campo variável 2
|
|
A partir da linha 3
|
Coluna C
|
Campo variável 3
|
Arquivo de Retorno
O retorno é obtido através do acesso à lista de arquivos enviados, clicando no ícone de exportação de arquivo de retorno.
Arquivos enviados nos formatos A, B, C, D ou E têm o retorno no formato CSV. Arquivos enviados no formato FC1 e FC1R têm o retorno no formato FC1 (com o código de retorno na coluna 100).
| Status | Descrição | Mensagem será tarifada do cliente? |
|---|---|---|
|
1
|
Agendado
|
Não
|
|
2
|
Enviado
|
Sim
|
|
3
|
Entregue
|
Sim
|
|
4
|
Não recebido
|
Sim
|
|
5
|
Fora do plano de numeração
|
Não
|
|
6
|
Blacklist
|
Não
|
|
7
|
Limpeza preditiva
|
Não
|
|
8
|
Tempo de envio excedido
|
Não
|
|
9
|
Cancelado
|
Não
|