Tutorial de Integração PHP

Transcrição

1 Tutorial de Integração PHP

2 Sumário Tutorial de Integração - PHP... 3 Configurando Envio... 4 Enviando Múltiplos SMS... 5 Enviando Múltiplos SMS a partir de um arquivo CSV... 7 Consultando status de SMS Múltiplos... 8 Obtendo respostas de requisições... 9 Glossário

3 Tutorial de Integração - PHP 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 suas aplicações PHP enviarem SMS por meio da API de integração que disponibilizamos para facilitar os envios. Pré-requisitos Para executar a biblioteca de integração, basta ter instalado um servidor HTTP que interprete PHP, tal como Apache, TomCat, entre outros. Sempre utilizar o método HTTP Post para realizar os envios. Nenhuma alteração nas configurações do PHP será necessária. Entendendo a biblioteca PHP A biblioteca PHP é 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. 3

4 Configurando Envio 1º Passo Faça o download da biblioteca de integração por meio do link ; descompacte o conteúdo do arquivo dentro da pasta onde se encontrão os códigos-fontes de sua aplicação. 2º Passo Para manipulação de SMS (envios e consultas), inclua em seu código PHP o arquivo HumanClientMain.php, que se encontra na raiz do diretório da biblioteca de integração. include_once( human_gateway_client_api/humanclientmain.php ); 3º Passo Para qualquer operação do gateway de SMS, é preciso identificar-se com sua conta e código de acesso. Trabalharemos com a instância da classe HumanMultipleSend para manipulação múltipla 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 área de produtos da Zenvia juntamente com a negociação do contrato firmado com a empresa. $humanmultiplesend = new HumanMultipleSend("human.fake.hc", "abc123"); 4

5 Enviando Múltiplos SMS 1º Passo Vamos trabalhar com a instância da classe HumanMultipleSend. $humanmultiplesend = new HumanMultipleSend("human.fake.hc", "abc123"); 2º Passo Escolheremos um layout de mensagem que será passado ao gateway, pois essa configuração influencia no formato da string que passaremos por parâmetro para o envio. Esse será passado como o primeiro parâmetro, podendo ser uma constante da classe HumanMultipleSend. $tipo = HumanMultipleSend::TYPE_C 3º Passo Em nosso exemplo, escolheremos o layout C, que é padrão da API, que consiste em to;message;id. Para adicionar mais de uma mensagem, inclua o caractere \n entre as strings. $msg_list = " ;teste0;004"."\n"; $msg_list.= " ;teste1;005"."\n"; $msg_list.= " ;teste2;006"; 4º Passo Configuraremos o Retorno de Status por Callback, que por padrão será inativo, ou seja, igual a zero (esse parâmetro não é obrigatório). Ele pode ser passado como uma constante da classe HumanMultipleSend. $callback = HumanMultipleSend::CALLBACK_INACTIVE ou $callback = HumanMultipleSend::CALLBACK_FINAL_STATUS ou $callback = HumanMultipleSend::CALLBACK_INTERMEDIARY_STATUS 5º Passo Para enviar o SMS, basta chamar o método sendmultiplelist da classe HumanMultipleSend e passar os parâmetros que acabamos de definir. $responses = $humanmultiplesend->sendmultiplelist($tipo, $msg_list, $callback); 5

6 6º Passo Para obter as respostas das requisições, veja o item Obtendo respostas das requisições. 6

7 Enviando Múltiplos SMS a partir de um arquivo CSV 1º Passo Vamos trabalhar com a instância da classe HumanMultipleSend. $humanmultiplesend = new HumanMultipleSend("human.fake.hc", "abc123"); 2º Passo O envio de múltiplas mensagens a partir de um arquivo CSV é muito semelhante ao envio de SMS múltiplos a partir de uma string. Passaremos por parâmetro o caminho do arquivo, respeitando os layouts de mensagens. Utilizaremos o layout C como exemplo ;teste0; ;teste1; ;teste2;005 $path = C:\arquivo.csv ; 3º Passo Configuraremos o Retorno de Status por Callback, que, por padrão, será inativo, ou seja, igual a zero (esse parâmetro não é obrigatório). Ele pode ser passado como uma constante da classe HumanMultipleSend. id.9hruw58bco07 $callback = HumanMultipleSend:: CALLBACK_INACTIVE ou $callback = HumanMultipleSend:: CALLBACK_FINAL_STATUS ou $callback = HumanMultipleSend:: CALLBACK_INTERMEDIARY_STATUS 4º Passo Para enviar os SMS, basta chamar o método sendmultiplefilecsv da classe HumanMultipleSend e passar os parâmetros que acabamos de definir. $responses = $humanmultiplesend->sendmultiplefilecsv($tipo, $path, $callback); 5º Passo Para obter as respostas das requisições, veja o item Obtendo respostas das requisições. 7

8 Consultando status de SMS Múltiplos 1º Passo Vamos trabalhar com a instância da classe HumanMultipleSend. $humanmultiplesend = new HumanMultipleSend("human.fake.hc", "abc123"); 2ºPasso Para consultar o status das mensagens enviadas, basta passarmos por parâmetro um array com os ids dos SMS enviados. $msg_list = array(); $msg_list[] = "001"; $msg_list[] = "002"; $msg_list[] = "003"; $msg_list[] = "004"; Obs.: Fica a cargo de sua aplicação salvar os ids dos SMS ao serem enviados com o layout C, (lembrando que nesse layout o id dos SMS é passado por sua aplicação), pois assim será possível fazer a consulta de status de cada SMS. 3ºPasso Vamos chamar o método querymultiplestatus, passando por parâmetro a nossa lista de ids de SMS enviados. $responses = $humanmultiplesend->querymultiplestatus($msg_list) 4ºPasso Para obter as respostas das requisições, veja o item Obtendo respostas das requisições. 8

9 Obtendo respostas de requisições Todas as requisições feitas pela API retornaram um array de objetos Response com seus respectivos códigos e descrições da mensagem de resposta. foreach ($responses as $response) { echo $response->getcode(); echo $response->getmessage(); } 9

10 Glossário Item Propriedade Descrição 1 To Número de telefone do SMS no formato DDI + DDD + Telefone ( ). 2 Message Mensagem que será enviada ao telefone. Terá no máximo 150 caracteres (sem o campo From). 3 From Identificação do remetente que será atribuído à mensagem. O campo Message + o campo From devem ter tamanho máximo de 150 caracteres. 4 Id Sua identificação do SMSpara fins de consulta. 5 Schedule Data de agendamento de envio do SMS. 6 Tipos de callback INACTIVE(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. 7 String Conjunto de caracteres. 8 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 10