Tutorial de Integração HTML

Tutorial de
Integração
HTML
Sumário
Tutorial de Integração - HTML .............................................................................................. 3
Configurando Envio .............................................................................................................. 4
Enviando Múltiplas SMS ........................................................................................................ 6
Enviando Múltiplos SMS a partir de um arquivo CSV ............................................................... 7
Glossário ............................................................................................................................. 8
2
Tutorial de Integração - HTML
Objetivo
O objetivo do tutorial de integração é guiar os desenvolvedores que desejam integrar suas aplicações ao
gateway de SMS da Zenvia, automatizando assim seus envios de SMS conforme sua necessidade.
Mostraremos em simples passos como fazer seus sites em HTML enviarem SMS por meio da API de
integração que disponibilizamos para facilitar os envios.
Pré-requisitos
Para executar a biblioteca, basta abrir os arquivos com qualquer navegador (Internet Explorer,
Mozilla Firefox, Google Chrome, entre outros em quaisquer versões). A Zenvia recomenda o uso
de navegadores mais atuais, tais como Internet Explorer 8 ou superior, Mozilla Firefox 3 ou
superior, Google Chrome 8 ou superior.
Entendendo a biblioteca HTML
A biblioteca HTML é composta de arquivos no formato HTML que fazem o acesso direto aos serviços de
SMS que a Zenvia disponibiliza, facilitando o uso pelos clientes. Cada arquivo HTML contém um acesso
específico a um serviço, que pode ser utilizado diretamente do seu site ou de seu computador para
enviar SMS ou fazer consultas a status de envio. Pode-se também copiar seu código fonte e incluir
dentro de uma página HTML que já exista.
3
Configurando Envio
1º Passo
Faça o download da biblioteca de integração por meio do link
http://www.zenvia.com.br/desenvolvedores/bibliotecas/HTML.zip descompacte o conteúdo do arquivo
dentro da pasta onde se encontrão os arquivos do seu site ou em qualquer diretório de seu computador.
2º Passo
Para fazer o envio de SMS e/ou consultas ao gateway de SMS, serão necessárias algumas configurações
na tag FORM do arquivo, tais como:
METHOD
“POST”
CHARSET
"ISO-8859-1"
ACTION
ENCTYPE
“http://api.zenvia360.com.br/GatewayIntegration/msgSms.do”
"application/x-www-form-urlencoded"
ou em caso de envios de Mensagem de texto por arquivo:
ENCTYPE
"multipart/form-data"
Exemplo:
<form method="post" enctype="application/x-www-form-urlencoded" charset="ISO-88591"action="http://api.zenvia360.com.br/GatewayIntegration/msgSms.do">
Obs. As tags FORMs devem estar entre as tags BODY do código.
Exemplo:
<body...>
<form...>
</form>
</body>
4
3º Passo
Para qualquer operação do gateway de SMS, é preciso identificar-se com sua conta e código de acesso.
Trabalharemos com dois campos de texto obrigatórios, que terão os nomes de account e code e que
conterão os valores da conta e do código de acesso. Tais dados são cedidos pela Zenvia juntamente
com a negociação do contrato firmado com a empresa.
Exemplo:
<input type="text" name="account" />
<input type="text" name="code" />
5
Enviando Múltiplos SMS
1º Passo
Todos os campos a seguir deverão estar entre as tags FORM.
Um campo obrigatório, que também é comum a todos os serviços que acessaremos com HTML, é o
campo dispatch. Esse campo define o que a nossa página estará acessando no gateway de SMS da
Zenvia. Esse campo deverá estar escondido, ou seja, deve ser do tipo hidden, para que não seja
alterado, e deve ser chamado de dispatch. Para o envio múltiplo de SMS, o valor atribuído a esse
campo deve ser sendMultiple.
Exemplo:
<input type="hidden" name=" dispatch " />
2º Passo
Para que possamos escolher o tipo de layout de mensagem que enviaremos, será necessária a inclusão
de um campo de seleção com as opções de acordo com os tipos de layouts aceitos pelo gateway de
SMS.
Esse campo deve conter obrigatoriamente as opções A, B, C, D e E e o nome do campo deverá ser
type.
Exemplo:
<select name="type">
<option value="A">A - destino;mensagem</option>
<option value="B">B - destino;mensagem;origem</option>
<option value="C">C - destino;mensagem;id</option>
<option value="D">D - destino;mensagem;id;origem</option>
<option value="E">E - destino;mensagem;id;origem;data de agendamento</option>
</select>
3º Passo
Agora incluiremos o campo de texto que receberá o conteúdo da mensagem, número de telefone, entre
outras informações, conforme a escolha do tipo de layout de mensagem.
Basta incluir um campo do tipo textarea, com o nome list, e logo abaixo um botão para enviar as
informações do formulário, do tipo submit.
Exemplo:
<textarea name="list"></textarea>
<input type="submit" />
6
Enviando Múltiplos SMS a partir de um arquivo CSV
1º Passo
O envio de múltiplos SMS a partir de um arquivo CSV é muito semelhante ao envio de mensagens
múltiplas a partir de uma string. A diferença básica é que, em vez de uma string, passaremos por
parâmetro o caminho do arquivo. Para isso, precisamos de um campo do tipo file, em vez de um campo
textarea.
Exemplo:
<input type="file" name="file" />
2º Passo
Devemos agora trocar o valor parâmetro enctype da tag form, de "application/x-www-formurlencoded" para "multipart/form-data".
Exemplo:
<form method="post" enctype="multipart/form-data" charset="ISO-8859-1"
action="http://api.zenvia360.com.br/GatewayIntegration/msgSms.do">
7
Glossário
Item Propriedade
Descrição
1
String
Conjunto de caracteres.
2
Tipos de layout
Tipo A: to;message
Tipo B: to;message;from
Tipo C: to;message;id
Tipo D: to;message;id;from
Tipo E: to;message;from;id;schedule
8