API DE ENVIO DE SMS

Parâmetros obrigatórios:

O consumo dos métodos através de requisições HTTP serão feitos através da URL abaixo. Importante lembrar que todos os parâmetros devem ser enviados no formato URLENCODE para evitar os caracteres reservados do protocolo.

A forma mais simples para realizar testes e saber se os parâmetros passados estão corretos é apenas colocar a url com todos os parâmetros na barra de endereço de seu navegador de Enter. O resultado da requisição será impresso na tela com sua mensagem de sucesso ou erro.

Existem várias maneiras que permitem realizar estas requisições, onde a mais simples pode ser considerada a função nativa do próprio PHP, chamada de file_get_contents().

Exemplo de requisição:

Lembre-se de que requisições HTTP não interpretam alguns caracteres especiais/reservados e para isso utilize a função urlencode().

Outra informação importante é que requisições HTTP possuem tamanho máximo de caracteres. Este valor varia entre navegadores, caso a requisição seja feita por eles, e também varia entre servidores. Para o IAGENTEsms, o tamanho máximo de uma requisição HTTP é de 2.000 caracteres. Vale lembrar que este valor se refere apenas a requisições HTTP.

CHARSET e problemas de compatibilidade:

É importante certificar-se que todas as requisições sejam feitas utilizando o charset UTF-8. Há diversas limitações nos dispositivos de usuários finais que podem prejudicar a visualização de mensagens que contenham caracteres especiais (ex: cedilha, acentos, cifrão, etc).

Também é importante verificar se sua mensagem não possui caracteres ocultos trafegados no formato URL-Encoded, como por exemplo, %C2%A0, pois podem acarretar no corte da mensagem. O cliente deve seguir as melhores práticas para evitar prejuízos com o conteúdo trafegado, uma vez que este tipo de conteúdo pode gerar problemas de envio não reembolsáveis.

Saiba mais sobre codificações ASCII e URL-Encode clicando aqui.

Caso você possua sua conta na modalidade PRÉ-PAGA, é possível consultar o saldo da conta utilizando o método creditos.

Parâmetros obrigatórios:

Exemplo de requisição:

Parâmetros obrigatórios:

Importante lembrar que os parâmetros devem ser enviados no formato URL ENCODE.

Parâmetros opcionais:

Exemplo de requisição:

Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:

Códigos de retorno a sua requisição

Parâmetros obrigatórios:

Importante lembrar que os parâmetros devem ser enviados no formato URL ENCODE.

Exemplo de requisição:

Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:

Códigos de retorno a sua requisição

Parâmetros obrigatórios:

Exemplo de requisição:

Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:

Códigos de retorno a sua requisição

A plataforma disponibiliza o envio automático de: ​

• • Status de mensagens (todas as contas);
• • Mensagens recebidas por keyword (canal corporativo);
• • Respostas (canal corporativo).

Para receber essas informações em seu site ou sistema todas as mensagens devem ser identificadas, ou seja, devem conter seu próprio e único codigosms. Sendo assim o callback está disponível apenas para envios avulsos.

Exemplo:

Também é necessário configurar sua URL de retorno em seu painel web no menu "CONFIGURAÇÕES> INTEGRACAO" que deverá receber as requisições enviadas por nossa plataforma. Todas requisição são enviadas utilizando o método GET.

Exemplo de url para receber o call back:

Parâmetros enviados:

O consumo de métodos do WEBSERVICE IAGENTEsms deve ser feito através da URL:

Para instanciar um método SOAP você pode utilizar a classe nativa do PHP SoapClient, ao qual necessita de 2 parâmetros: A URI do arquivo WSDL e um array de opções.

Como a API da IAGENTEsms não utiliza modo WSDL, então é necessário informar um array de opções.

Este array de opções deve ser passada como parâmetro para a classe SoapClient e armazená-la em uma variável.

Desta maneira você estará pronto para consumir todos os métodos disponíveis em nossa API.

Para saber sobre mais como funciona o SoapClient e o parâmetro WSDL acesse:

• http://php.net/manual/pt_BR/soapclient.soapclient.php
• http://fabriciosanchez.com.br/2/wsdl-o-que-e-pra-que-serve-onde-utilizo/

Todos os métodos do WEBSERVICE só devem ser invocados após autenticação da conta, que pode ser feita uma única vez a cada sessão.

Para realizar a autenticação de sua conta através do método SOAP, é necessário utilizar o método Auth().

Parâmetros obrigatórios:

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Caso você possua sua conta na modalidade PRÉ-PAGA, é possível consultar o saldo da conta utilizando o método consulta_saldo().

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição consulta_saldo()

Para criar novos grupos em sua conta, utilize o método adicionar_grupo().

Parâmetros obrigatórios:

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para renomear um grupo é necessário utilizar o método atualizar_grupo().

Parâmetros obrigatórios

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para listar todos os grupos de sua conta, utilize o método listar_grupos().

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para remover um grupo de sua conta, utilize o método remover_grupo().

Parâmetros obrigatórios:

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para adicionar um contato a um grupo, utilize o método adicionar_contato().

Parâmetros disponíveis

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para remover um contato de algum grupo, utilize o método remover_contato().

Parâmetros obrigatórios:

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para remover todos os contatos de um grupo, utilize o método limpar_grupo().

Parâmetros obrigatórios:

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para enviar uma mensagem utilizando o método SOAP, utilize o método enviar_sms().

Parâmetros disponíveis

Exemplo de invocação do método:

Apesar do parâmetro Código ser opcional vale lembrar que, caso não seja passado, futuramente não será possível realizar a consulta de status deste envio.

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para enviar mensagens em lote, utilize o método enviar_lote().

Parâmetros disponíveis

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para enviar mensagem para um grupo de sua conta, utilize o método enviar_sms_grupo().

Parâmetros disponíveis

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Para consultar o status de um SMS enviado, utilize o método verifica_status().

Parâmetros disponíveis

Exemplo de invocação do método:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Resposta a requisição

Códigos de retorno a sua requisição

A plataforma disponibiliza o envio automático de: ​

• • Status de mensagens (todas as contas);
• • Mensagens recebidas por keyword (canal corporativo);
• • Respostas (canal corporativo).

Para receber essas informações em seu site ou sistema informe uma URL em seu painel web no menu "CONFIGURAÇÕES> INTEGRACAO" que deverá receber as requisições enviadas por nossa plataforma. Todas requisição são enviadas utilizando o método GET.

Exemplo de url para receber o call back:

Parâmetros enviados no Call Back de mensagens:

É possível realizar envios de SMS através de email (smtp). Basta o email do remetente estar cadastrado como usuário no sistema.

O email deve ser enviado para @api.iagentesms.com.br com o celular antes do @.

Exemplos:

Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.

Aplicações:

Para realizar envios de SMS através de SMTP, é preciso que o email do remetente esteja cadastrado em sua conta como um usuário.

Para cadastrar um novo usuário como remetente, acesse o menu de configurações de sua e clique em Usuários

Após isso basta envia um email a partir desta conta para nossa api que a mensagem será automaticamente convertida em um SMS..

Exemplo: