Zenvia



Tutorial de Integra??oJAVASumário TOC \h \z \t "Titulo;1" Tutorial de Integra??o - JAVA PAGEREF _Toc336869372 \h 3Configurando Envio PAGEREF _Toc336869373 \h 4Enviando SMS individualmente PAGEREF _Toc336869374 \h 5Consultando status de SMS individualmente PAGEREF _Toc336869375 \h 6Enviando Múltiplos SMS a partir de um arquivo CSV PAGEREF _Toc336869376 \h 7Enviando Múltiplos SMS a partir de uma lista PAGEREF _Toc336869377 \h 8Consultando status de SMS múltiplos PAGEREF _Toc336869378 \h 9Obtendo respostas das requisi??es PAGEREF _Toc336869379 \h 10Glossário PAGEREF _Toc336869380 \h 11Tutorial de Integra??o - JAVAObjetivoO 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 suas aplica??es Java enviarem SMS por meio da API de integra??o que disponibilizamos para facilitar os envios.Pré-requisitosPara executar a biblioteca de integra??o, basta ter instalado uma JVM.Sempre utilizar o método HTTP Post para realizar os envios.Entendendo a biblioteca JAVAA biblioteca Java é um conjunto de classes que tem como principal fun??o fazer requisi??es HTTP da forma mais organizada e simplificada possível, fazendo com que poucas informa??es sejam passadas por sua aplica??o.Configurando Envio1? PassoFa?a o download da biblioteca de integra??o por meio do link descompacte o arquivo HumanGatewayClient.jar referente ao cliente de integra??o com o gateway de SMS.2? passoAdicionar a pasta de lib do seu projeto.3? passoAdicionar ao build path a biblioteca HumanGatewayClient.jar.4? PassoPara qualquer opera??o do gateway de SMS, é preciso identificar-se com sua conta e código de acesso.Trabalharemos com as inst?ncias das classes SimpleMessageService e MultipleMessageService para manipula??o de SMS (envio e consulta), passando por par?metros de seu construtor a sua conta e o código de acesso. Tais dados s?o cedidos pela Zenvia juntamente com a negocia??o do contrato firmado com a empresa.Exemplo:SimpleMessageService cliente = new SimpleMessageService("conta", "senha");Enviando SMS individualmente1? PassoInstancie a classe SimpleMessageService, informando a sua conta e senha.Exemplo:SimpleMessageService cliente = new SimpleMessageService("conta", "senha");2?PassoAdicione as informa??es To (obrigatório), Message (obrigatório), From (opcional), Id (opcional), Schedule (opcional) e Callback (opcional).Exemplo:SimpleMessage mensagem = new SimpleMessage();mensagem.setTo("555199990101");mensagem.setMessage("Minha mensagem de teste");mensagem.setSchedule(new Date());3?PassoChame o método SimpleMessageService.send ,passando por par?metro a classe SimpleMessage.Exemplo:List<Response> retornos = cliente.send(mensagem);4?PassoPara obter as respostas das requisi??es, veja o item “Obtendo respostas das requisi??es”.Consultando status de SMS individualmente1? PassoInstancie a classe SimpleMessageService, informando a sua conta e senha.Exemplo:SimpleMessageService cliente = new SimpleMessageService("conta", "senha");2? PassoChame o método SimpleMessageService.query, passando por par?metro o id do SMS que deseja consultar.Exemplo:String id = "010";List<Response> retornos = cliente.query(id);3? PassoPara obter as respostas das requisi??es, veja o item “Obtendo respostas das requisi??es”.Enviando Múltiplos SMS a partir de um arquivo CSV1? PassoInstancie a classe MultipleMessageService, informando a sua conta e senha.Exemplo:MultipleMessageService cliente = new MultipleMessageService("conta", "senha");2? PassoInstancie a FileResource, informando o arquivo a ser enviado e o tipo de layout do arquivo. Você pode, também, informar o tipo de callback para todos os SMS; todavia, n?o é obrigatório. Em nosso exemplo, escolheremos o layout A, que consiste em “ HYPERLINK \l "Message" to;message”. Para adicionar mais de um SMS, inclua o caractere \n entre as strings.Exemplo:MultipleMessage fileMessage = new FileResource(new File("nome-do-arquivo.txt"), LayoutTypeEnum.TYPE_A);fileMessage.setCallback(CallbackTypeEnum.FULL);3? PassoChame o método MultipleMessageService.send, passando por par?metro a classe FileResource.Exemplo:List<Response> retornos = cliente.send(fileMessage);4? PassoPara obter as respostas das requisi??es, veja o item “Obtendo respostas das requisi??es”.Enviando Múltiplos SMS a partir de uma lista1? PassoInstancie a classe MultipleMessageService, informando a sua conta e senha.Exemplo:MultipleMessageService cliente = new MultipleMessageService("conta", "senha");2? PassoInstancie a ListResource, informando uma string com a lista de SMS a serem enviados e o tipo de layout da lista. Você pode, também, informar o tipo de callback para todas as mensagens; todavia, n?o é obrigatório. Em nosso exemplo, escolheremos o layout A, que consiste em “ HYPERLINK \l "Message" to;message”. Para adicionar mais de um SMS, inclua o caractere \n entre as strings.Exemplo:String data = "555199990101;Mensagem de teste\n555199990102;Mensagem de teste";MultipleMessage listMessage = new ListResource(data, LayoutTypeEnum.TYPE_A);listMessage.setCallback(CallbackTypeEnum.FULL);3? PassoChame o método MultipleMessageService.send, passando por par?metro a classe ListResource.Exemplo:List<Response> retornos = cliente.send(listMessage);4? PassoPara obter as respostas das requisi??es, veja o item “Obtendo respostas das requisi??es”.Consultando status de SMS múltiplos1? PassoInstancie a classe MultipleMessageService, informando a sua conta e senha.Exemplo:MultipleMessageService cliente = new MultipleMessageService("conta", "senha");2? PassoChame o método MultipleMessageService.query, passando por par?metro um array de ids dos SMS que deseja consultar.Exemplo:String[] ids = {"010", "009", "008"};List<Response> retornos = cliente.query(ids);3? PassoPara obter as respostas das requisi??es, veja o item “Obtendo respostas das requisi??es”.Obtendo respostas das requisi??esO retorno do método de consulta é uma lista de objetos da classe Response. Nessa classe é possível resgatar o código e a descri??o da requisi??o e do estado do SMS desejado.Exemplo:for(Response retorno : retornos) { System.out.print(retorno.getReturnCode()); System.out.println(retorno.getReturnDescription());}GlossárioItemPropriedadeDescri??o1ToNúmero de telefone do SMS no formato DDI + DDD + Telefone (Exemplo: 555199990101).2MessageMensagem que será enviada ao telefone. Terá no máximo 150 caracteres (sem o campo From).3FromIdentifica??o do remetente que será atribuído à mensagem. O campo “Message” + o campo “From” devem ter tamanho máximo de 150 caracteres.4IdSua identifica??o do SMS para fins de consulta.5ScheduleData de agendamento de envio do SMS.6Tipos de callbackINACTIVE(0) (Padr?o): N?o será enviada mensagem de callback para a sua aplica??o.FINAL(1): Será enviada a mensagem de callback com somente o estado final de cada mensagem enviada.FULL(2): Será enviada a mensagem de callback com os estados intermediários e o estado final de cada mensagem enviada.Observa??o: Para os callbacks Final e Full, deverá ser cadastrado no atendimento da Zenvia um host ao qual ser?o enviadas as requisi??es.7StringConjunto de caracteres.8Tipos de layoutTipo A: to;messageTipo B: to;message;fromTipo C: to;message;idTipo D: to;message;id;fromTipo E: to;message;from;id;schedule ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download