Menu
Menu
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.
https://api.iagentesms.com.br/webservices/http.php
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.
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=12345
&celular=5199999999
&mensagem=teste+integracao+http
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().
$api_http = file_get_contents("
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=12345
&celular=5199999999
&mensagem=teste");
echo $api_http; // A resposta desta requisição será impressa na tela
Lembre-se de que requisições HTTP não interpretam alguns caracteres especiais/reservados e para isso utilize a função urlencode().
// codifica os dados no formato de um formulário www
$mensagem = urlencode("teste de requisicao http");
// concatena a url da api com a variável carregando o conteúdo da mensagem
$url_api = "https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=12345
&celular=5199999999
&mensagem={$mensagem}";
// realiza a requisição http passando os parâmetros informados
$api_http = file_get_contents($url_api);
// imprime o resultado da requisição
echo $api_http;
?>
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.
Caso você possua sua conta na modalidade PRÉ-PAGA, é possível consultar o saldo da conta utilizando o método creditos.
https://api.iagentesms.com.br/webservices/http.php?metodo=creditos
&usuario=iagente
&senha=12345
Importante lembrar que os parâmetros devem ser enviados no formato URL ENCODE.
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=1234
&celular=5199999999
&mensagem=teste
Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:
Importante lembrar que os parâmetros devem ser enviados no formato URL ENCODE.
https://api.iagentesms.com.br/webservices/http.php?metodo=lote
&usuario=iagente
&senha=1234
&celular=5199999999,5188888888
&mensagem=teste
Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:
https://api.iagentesms.com.br/webservices/http.php?metodo=consulta
&usuario=iagente
&senha=1234
&codigosms=2023
Após o envio de sua requisição a nossa plataforma uma resposta será devolvida, conforme tabela abaixo:
A plataforma disponibiliza o envio automático de:
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.
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=1234
&celular=5199999999
&mensagem=teste
&codigosms=010
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=1234
&celular=5199998888
&mensagem=teste
&codigosms=020
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=1234
&celular=5199997777
&mensagem=teste
&codigosms=030
https://api.iagentesms.com.br/webservices/http.php?metodo=envio
&usuario=iagente
&senha=1234
&celular=5199996666
&mensagem=teste
&codigosms=040
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:
http://www.seudominio.com.br/recebeSMS.php
O consumo de métodos do WEBSERVICE IAGENTEsms deve ser feito através da URL:
https://api.iagentesms.com.br/webservices/ws.php
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.
$options = array(
'location' => 'https://api.iagentesms.com.br/webservices/ws.php',
'uri' => 'https://api.iagentesms.com.br/webservices/',
'encoding' => 'ISO-8859-1',
'trace' => 1,
'exceptions'=> 0 );
Este array de opções deve ser passada como parâmetro para a classe SoapClient e armazená-la em uma variável.
$ws = new SoapClient(NULL, $options);
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:
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().
$ws->Auth("iagente","1234");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
1: OK, 0: FALHA
Caso você possua sua conta na modalidade PRÉ-PAGA, é possível consultar o saldo da conta utilizando o método consulta_saldo().
$ws->consulta_saldo();
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
http://www.seudominio.com.br/recebeSMS.php
Para criar novos grupos em sua conta, utilize o método adicionar_grupo().
$ws->adicionar_grupo("Novos clientes");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para renomear um grupo é necessário utilizar o método atualizar_grupo().
$ws->atualizar_grupo("739", "Clientes antigos");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
http://www.seudominio.com.br/recebeSMS.php
Para listar todos os grupos de sua conta, utilize o método listar_grupos().
$ws->listar_grupos();
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para remover um grupo de sua conta, utilize o método remover_grupo().
$ws->remover_grupo("739");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para adicionar um contato a um grupo, utilize o método adicionar_contato().
$ws->adicionar_contato("João","5199999999","739");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para remover um contato de algum grupo, utilize o método remover_contato().
$ws->remover_contato("5199999999","739");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para remover todos os contatos de um grupo, utilize o método limpar_grupo().
$ws->limpar_grupo("739");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para enviar uma mensagem utilizando o método SOAP, utilize o método enviar_sms().
$ws->enviar_sms("avulso", "5199999999", "Teste de SMS", "", "2034");
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.
Para enviar mensagens em lote, utilize o método enviar_lote().
$ws->enviar_lote("lote", array("5199999999","5198888888","5197777777"), "Teste de SMS", "", "2034");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para enviar mensagem para um grupo de sua conta, utilize o método enviar_sms_grupo().
$ws->enviar_sms_grupo("grupo", "739", "Teste de SMS", "", "1020");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
Para consultar o status de um SMS enviado, utilize o método verifica_status().
$ws->verifica_status("1020");
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
A plataforma disponibiliza o envio automático de:
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.
http://www.seudominio.com.br/recebeSMS.php?codigosms=0&celular=5100000000
&statusid=3&mensagem=Teste+envio+sms&status=Entregue&data=06/07/2012+10:00:00
data
Data do envio
É 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 @.
5199999999@api.iagentesms.com.br
5199999999-5188888888-5177777777@api.iagentesms.com.br
Após o envio da requisição, o IAGENTEsms devolverá uma resposta em formato de vetor (array), conforme abaixo.
O conteúdo do SMS será o assunto ou o texto do email. Caso ambos tenham sido informados, os conteúdos serão unidos e enviados os primeiros 150 caracteres.
De: ti@iagente.com.br
Para: 5199999999@api.iagentesms.com.br
Assunto: Todos os serviços foram reestabelecidos
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..
De: ti@iagente.com.br
Para: 5199999999@api.iagentesms.com.br
Assunto: Todos os serviços foram reestabelecidos.
