GUIA DE USO

GERENCIADOR WEB

Layouts

Sumrio
Layouts A, B, C, D e E ..................................................................................................... 3
Layouts FC1, FC1R e FC1R-V............................................................................................ 5
Layout FC2 e FC2R .......................................................................................................... 7
Layout VC1 ..................................................................................................................... 9
Layout VC2 ................................................................................................................... 10
Layout MV .................................................................................................................... 11
Arquivo de Retorno ....................................................................................................... 12

Layouts A, B, C, D e E
Os layouts A, B, C, D e E adotam o formato CSV (Comma-Separated Values), que so arquivos texto com
os campos separados por ponto-e-vrgula.

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

ATENO
Caso voc tenha interesse em trocar o delimitador de CSV ; para PIPE | entre em contato com nosso
atendimento ao cliente.

Os campos contidos no layout se referem :

Campo

Descries

Celular

Cdigo Pas + Cdigo rea + Nmero Celular (Ex: 555199999999)

Msg

Corpo da mensagem. Junto com remetente, deve ter no mximo

160 caracteres

Remetente

Nome do remetente. Se vazio, pega o remetente padro da conta

Id

Cdigo que o usurio pode fornecer para evitar duplicao e poder consultar o
status da mensagem. Caso no seja fornecido, no ser possvel a verificao
de status (mx. 20 caracteres)

Data Envio

Data e hora em que o SMS deve ser enviado operadora.

Deve estar no formato dd/mm/aaaa hh:mm:ss

ATENO
Caso duas linhas com o campo identificador idntico sejam enviadas em um mesmo arquivo, a primeira ser enviada
e a segunda ser considerada invlida.
3

Exemplo em Layout A
celular;mensagem
555199999999;Teste Envio para Joao
555199999999;Teste Envio para Jose

Exemplo em Layout B
celular;mensagem;remetente
555199999999;Teste Envio para Joao;Empresa X
555199999999;Teste Envio para Jos;Empresa X

Exemplo em Layout C
celular;mensagem;identificador
555199999999;Teste Envio para Joao;id0001
555199999999;Teste Envio para Jose;id0002

Exemplo em Layout D
celular;mensagem;identificador;remetente
555199999999;Teste Envio para Joo;id0001;Empresa X
555199999999;Teste Envio para Jos;id0002;Empresa X

Exemplo em Layout E
celular;mensagem;identificador;remetente;agendado para
555199999999;Teste Envio para Joo;id0001;Empresa ABC;15/05/2007 10:00:00
555199999999;Teste Envio para Jos;id0002;Empresa ABC;15/05/2007 11:00:00

Layouts FC1, FC1R e FC1R-V

Os layouts FC1 e FC1R, disponveis em formato de coluna fixa (fixed-column), so arquivos texto em que
a mensagem colocada no incio do arquivo e, em cada linha, o celular destinatrio junto aos dados
variveis que podem ser substitudos na mensagem.

Nome

Campos

Observao

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 sero

enviadas

Layout FC1R-V

(abaixo)

Se houver duas linhas com mesmo CODCLI, ambas sero

enviadas

Linha 1: Cabealho
120061024Empresa ABC
Coluna 10 mostra o nome da empresa (opcional)
Coluna 02 mostra a data no formato aaaammdd (opcional)
Coluna 01 indica o tipo da linha (obrigatrio)

Linha 2: Mensagem
2SR(a) $PRIMNOME$ ligar urgente para $TELREC$ e mencionar codigo $CODCLI$
Coluna 02 inicia o contedo da mensagem
Coluna 01 indica o tipo da linha (obrigatrio)

Observao: o contedo da mensagem pode conter personalizao para cada pessoa, a partir de dados
variveis contidos em cada linha do destinatrio. Os campos que permitem personalizao so:

$PRIMNOME$, $PRINOME$ ou $NOMECLI$ substitudo pelo primeiro nome do destinatrio

(coluna 13)
$CODCLI$ ou $COD_CLI$ substitudo pelo cdigo atribudo ao destinatrio (coluna 43)
$TELREC$ ou $TEL_REC$ substitudo pelo telefone de retorno (coluna 73)

Exemplo: Sr(a) JOAO MENDES ligar urgente para (51) 3346.8282 e mencionar o cdigo 595518

Linha 3 em diante: Destinatrios

35184220483 JOO MENDES

35184268856 MARCOS VASCONCELOS
311999999999 JOS SILVEIRA FERNANDES

595518
595519
595520

(51)3346.8282
(51)3346.8282
(51)3346.8282
Coluna 73 inicia o telefone de retorno (opcional)

Coluna 43 inicia o cdigo do destinatrio (obrigatrio)

Coluna 13 inicia o nome do destinatrio (opcional)
Coluna 02 inicia o nmero do celular (obrigatrio)
Coluna 01 indica o tipo da linha (obrigatrio)

ltima linha: Rodap

9000000003
Coluna 02 indica a quantidade de mensagens no arquivo (opcional)
Coluna 01 indica o tipo da linha (obrigatrio)

Exemplo final do arquivo:

120061024Empresa ABC
2SR(a) $PRIMNOME$ ligar urgente para $TELREC$ e mencionar cdigo $CODCLI$
35199999999 JOO MENDES
(51)3346.8282
595518
35199999999 MARCOS VASCONCELOS
(51)3346.8282
595519
311999999999JOS SILVEIRA FERNANDES
(11)3346.8282
595520
900000003

Exemplo em Layout FC1R

Idem ao FC1, contudo, permite que haja mais de um destinatrio com o mesmo cdigo atribudo, no
caso de seu arquivo conter dois ou mais celulares de contato para cada pessoa. Isto , um
destinatrio pode estar em duas linhas, tendo um nmero celular (coluna 02) diferente para cada
linha, mas com o mesmo cdigo (coluna 43) atribudo.

Exemplo em Layout FC1R-V

Idem ao FC1R, contudo, permite que haja mais de um destinatrio com o mesmo cdigo atribudo,
no caso de seu arquivo conter dois ou mais celulares de contato para cada pessoa. Isto , um
destinatrio pode estar em duas linhas, tendo um nmero celular (coluna 02) diferente para cada
linha, mas com o mesmo cdigo (coluna 43) atribudo. O layout FC1R-V ainda possui mais seis colunas
de 15 caracteres cada para que o cliente possa importar as mais diversas informaes que achar
necessrias e consequentemente us-las na mensagem fazendo atravs das referncias: $COLUNAA$,
$COLUNAB$, $COLUNAC$, $COLUNAD$, $COLUNAE$ e $COLUNAF$, sendo a coluna A a mesma
TELREC do layout FC1R.

Layout FC2 e FC2R

Os layouts FC2 e FC2R, disponveis em formato de coluna fixa (fixed-column), so arquivos texto
em que a mensagem colocada no incio do arquivo e, em cada linha, o celular destinatrio junto
aos dados variveis que podem ser substitudos na mensagem.

Nome

Campos

Observao

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 sero

enviadas

Exemplo em Layout FC2

Linha 1: Cabealho
120061024Empresa ABC
Coluna 10 mostra o nome da empresa (opcional)
Coluna 02 mostra a data no formato aaaammdd (opcional)
Coluna 01 indica o tipo da linha (obrigatrio)

Linha 2: Mensagem
2SR(a) $PRIMNOME$ ligar urgente para $TELREC$ e mencionar codigo $CODCLI$
Coluna 02 inicia o contedo da mensagem
Coluna 01 indica o tipo da linha (obrigatrio)

Observao: o contedo da mensagem pode conter personalizao para cada pessoa, a partir de dados
variveis contidos em cada linha do destinatrio. Os campos que permitem personalizao so:
$PRIMNOME$, $PRINOME$ ou $NOMECLI$ substitudo pelo primeiro nome do destinatrio
(coluna 13)
Linha 3 em$CODCLI$
diante: ou
Destinatrios
$COD_CLI$ substitudo pelo cdigo atribudo ao destinatrio (coluna 73)

$TELREC$ ou $TEL_REC$ substitudo pelo telefone de retorno (coluna 44)

Exemplo: Sr(a) JOAO MENDES ligar urgente para (51) 3346.8282 e mencionar o cdigo 595518

Linha 3 em diante: Destinatrios

35199999999 JOO MENDES
35199999999 MARCOS VASCONCELOS
311999999999 JOS SILVEIRA FERNANDES

(51)3346.8282
(51)3346.8282
(51)3346.8282

595518
595519
595520
Coluna 73 inicia o cdigo do destinatrio (opcional)

Coluna 44 inicia o telefone de retorno (opcional)

Coluna 13 inicia o nome do destinatrio (opcional)
Coluna 02 inicia o nmero do celular (obrigatrio)
Coluna 01 indica o tipo da linha (obrigatrio)

ltima linha: Rodap

9000000003
Coluna 02 indica a quantidade de mensagens no arquivo (opcional)
Coluna 01 indica o tipo da linha (obrigatrio)

Exemplo final do arquivo:

120061024Empresa ABC
2SR(a) $PRIMNOME$ ligar urgente para $TELREC$ e mencionar cdigo $CODCLI$
35199999999 JOO MENDES
(51)3346.8282
595518
35199999999 MARCOS VASCONCELOS
(51)3346.8282
595519
311999999999JOS SILVEIRA FERNANDES
(11)3346.8282
595520
900000003

Exemplo em Layout FC2R

Idem ao FC2, contudo, permite que haja mais de um destinatrio com o mesmo cdigo atribudo, no
caso de seu arquivo conter dois ou mais celulares de contato para cada pessoa. Isto , um
destinatrio pode estar em duas linhas, tendo um nmero celular (coluna 02) diferente para cada
linha, mas com o mesmo cdigo (coluna 73) atribudo.

Layout VC1
O layout VC1 adota o formato CSV (Comma-Separated Values), que um arquivo texto com os campos
separados por ponto-e-vrgula.
A principal caracterstica desse layout o suporte a mltiplos campos variveis. Alm disso, a mensagem
no faz parte do arquivo, sendo informada na interface de upload.
Os campos contidos no layout se referem a:

Campo

Descries

Celular

Cdigo rea + Nmero Celular (Ex: 5190123456)

Varivel 1

Campo varivel 1

Varivel 2

Campo varivel 2

Varivel 3

Campo varivel 3

Varivel (...)

Campos variveis subsequentes (...)

Exemplo em Layout VC1

celular;nome;var1;var2
5199999999;Joo;00001;(11)2222-2222
5199999999;Jos;00002;(11)2222-2222

Aps efetuar upload do arquivo, o sistema identifica os campos variveis e abre a tela de
digitao da mensagem, com a insero dos campos variveis no contedo da mensagem.

Layout VC2
O layout VC2 adota o formato CSV (Comma-Separated Values), que um arquivo texto com os campos
separados por ponto-e-vrgula.
A diferena para o VC1 que a mensagem deve vir na segunda linha do arquivo, e ele tambm conta
com suporte a trs campos variveis.
Os campos contidos no layout se referem a:

Linha

Campo

Descries

Linha 1

Identificador

Identificador do Remetente

Linha 2

Msg

Mensagem, utilizando as variveis abaixo (A, B e C)

Celular

Cdigo rea + Nmero Celular (Ex: 5190123456)

Coluna A

Campo varivel 1

Coluna B

Campo varivel 2

Coluna C

Campo varivel 2

A partir linha 3

Exemplo em Layout VC2

120914 Empresa ABC
$COLUNAA$, o seu acordo com a Empresa ABC n $COLUNAB$ com vencimento em DD/MM pode
ser pago com o cod. $COLUNAC$
11988888888;Dener;000000000;00000000000000000000000000000000000000000000000
11988888888;Alessandro;000000001;00000000000000000000000000000000000000000000001
11988888888;Cesar;000000002;00000000000000000000000000000000000000000000002

Aps efetuar upload do arquivo, o sistema identifica a mensagem e seus campos variveis e
realiza o envio automaticamente.

10

Layout MV
O layout MV um arquivo XML disponibilizado no Sistema de Gesto Hospitalar e possui seus campos
especficos. Alm disso, a mensagem no faz parte do arquivo, sendo informada na interface juntamente
com os campos desejados.

ATENO
O celular deve estar no formato: Cdigo rea + Nmero Celular (Ex:5199999999).

11

Arquivo de Retorno
Os arquivos de retorno permitem fazer o repique de celulares potencialmente invlidos, a fim
de limpar a base de dados e evitar reenvio para estes celulares.
O retorno obtido atravs do acesso lista de arquivos enviados, clicando-se no cone de exportao
de arquivo de retorno. Arquivos enviados nos formatos A, B, C, D ou E tm o retorno no formato CSV.
Arquivos enviados no formato FC1 e FC1R tm o retorno no formato FC1 (com o cdigo de retorno na
coluna 100).

Exemplo em Layout TXT (CSV)

celular;id;status
555199999999;id0001;1
555199999999;id0002;1

Exemplo em Formato FC1

120061024Empresa ABC
2SR(a) $PRIMNOME$ ligar urgente para 51 3333.2264. Assunto de seu interesse.
35199999999 JOO MENDES
595518
1
35199999999 MARCOS VASCONCELOS
595519
1
35199999999 JOS SILVEIRA FERNANDES
595520
1
900000003

Os cdigos de status possveis so:

Status

Descrio

Agendado

Enviado

Entregue

No recebido

Fora do Plano de Numerao

Blacklist

Limpeza preditiva

Erro

Cancelado

12