Documentação API

IAGENTEsms API

SMS transacional e marketing via HTTP, SOAP e SMTP. Envio individual, em lote, callbacks e consultas de status.

API HTTP

A API HTTP e a forma mais simples de integrar o envio de SMS ao seu sistema. Todas as requisições sao feitas via GET ou POST para a URL base.

Base URL

https://api.iagentesms.com.br/webservices/http.php

Autenticação

Todas as requisições devem incluir os parâmetros usuario e senha fornecidos no painel do IAGENTEsms.

Consulta de Créditos

GET /webservices/http.php?metodo=creditos Consultar saldo

Retorna o saldo de créditos disponível na conta.

Parâmetros

Parâmetro Tipo Obrigatório Descrição
metodo string Sim Valor fixo: créditos
usuario string Sim Usuario da conta
senha string Sim Senha da conta

Exemplos

https://api.iagentesms.com.br/webservices/http.php?metodo=creditos&usuario=SEU_USUARIO&senha=SUA_SENHA
curl "https://api.iagentesms.com.br/webservices/http.php?metodo=creditos&usuario=SEU_USUARIO&senha=SUA_SENHA"
<?php
$params = [
    'metodo'  => 'creditos',
    'usuario' => 'SEU_USUARIO',
    'senha'   => 'SUA_SENHA'
];

$url = 'https://api.iagentesms.com.br/webservices/http.php?' . http_build_query($params);

$response = file_get_contents($url);
echo $response;
// Sucesso: "CREDITOS: 1500"
?>
Codigos de Resposta
Resposta Descrição
CREDITOS: 1500 Saldo atual de créditos
ERROR 01 Usuario ou senha invalidos
ERROR 99 Erro interno do servidor

Envio Individual

GET /webservices/http.php?metodo=envio Enviar SMS individual

Envia um SMS individual para um número de celular.

Parâmetros

Parâmetro Tipo Obrigatório Descrição
metodo string Sim Valor fixo: envio
usuario string Sim Usuario da conta
senha string Sim Senha da conta
celular string Sim Numero do celular com DDD (ex: 5551999999999)
mensagem string Sim Texto da mensagem (max 160 caracteres por SMS)
agendamento string Nao Data/hora para envio agendado no formato DD/MM/AAAA HH:MM

Exemplos

https://api.iagentesms.com.br/webservices/http.php?metodo=envio&usuario=SEU_USUARIO&senha=SUA_SENHA&celular=5551999999999&mensagem=Ola!+Este+e+um+teste.
curl "https://api.iagentesms.com.br/webservices/http.php?metodo=envio&usuario=SEU_USUARIO&senha=SUA_SENHA&celular=5551999999999&mensagem=Ola!+Este+e+um+teste."
<?php
$params = [
    'metodo'   => 'envio',
    'usuario'  => 'SEU_USUARIO',
    'senha'    => 'SUA_SENHA',
    'celular'  => '5551999999999',
    'mensagem' => 'Ola! Este e um SMS de teste via API.'
];

$url = 'https://api.iagentesms.com.br/webservices/http.php?' . http_build_query($params);

$response = file_get_contents($url);
echo $response;
// Sucesso: "OK 123456"
// Erro: "ERROR 03"
?>
Codigos de Resposta
Codigo Descrição
OK ID_MENSAGEM Envio realizado com sucesso (retorna o ID da mensagem)
ERROR 01 Usuario ou senha invalidos
ERROR 02 Créditos insuficientes
ERROR 03 Numero de celular invalido
ERROR 04 Mensagem vazia
ERROR 05 Mensagem muito longa
ERROR 06 Data de agendamento invalida
ERROR 99 Erro interno do servidor

Envio em Lote

POST /webservices/http.php?metodo=lote Enviar SMS em lote

Envia SMS para múltiplos números de uma vez. Os números e mensagens devem ser enviados separados por ponto e virgula.

Parâmetros

Parâmetro Tipo Obrigatório Descrição
metodo string Sim Valor fixo: lote
usuario string Sim Usuario da conta
senha string Sim Senha da conta
celulares string Sim Numeros separados por ; (ex: 5551999999999;5551888888888)
mensagens string Sim Mensagens separadas por ;. Se uma única mensagem, ela será enviada para todos os números.
agendamento string Nao Data/hora para envio agendado no formato DD/MM/AAAA HH:MM

Exemplos

curl -X POST "https://api.iagentesms.com.br/webservices/http.php" \
  -d "metodo=lote" \
  -d "usuario=SEU_USUARIO" \
  -d "senha=SUA_SENHA" \
  -d "celulares=5551999999999;5551888888888;5551777777777" \
  -d "mensagens=Ola Joao!;Ola Maria!;Ola Pedro!"
curl -X POST "https://api.iagentesms.com.br/webservices/http.php" \
  -d "metodo=lote" \
  -d "usuario=SEU_USUARIO" \
  -d "senha=SUA_SENHA" \
  -d "celulares=5551999999999;5551888888888;5551777777777" \
  -d "mensagens=Promocao especial! Desconto de 20%% em todos os produtos."
<?php
$url = 'https://api.iagentesms.com.br/webservices/http.php';

$data = [
    'metodo'    => 'lote',
    'usuario'   => 'SEU_USUARIO',
    'senha'     => 'SUA_SENHA',
    'celulares' => '5551999999999;5551888888888;5551777777777',
    'mensagens' => 'Ola Joao!;Ola Maria!;Ola Pedro!'
];

$options = [
    'http' => [
        'header'  => "Content-type: application/x-www-form-urlencoded\r\n",
        'method'  => 'POST',
        'content' => http_build_query($data)
    ]
];

$context = stream_context_create($options);
$response = file_get_contents($url, false, $context);
echo $response;
// Sucesso: "OK 789012"
?>
Codigos de Resposta
Codigo Descrição
OK LOTE_ID Lote enviado com sucesso (retorna o ID do lote)
ERROR 01 Usuario ou senha invalidos
ERROR 02 Créditos insuficientes
ERROR 07 Quantidade de celulares e mensagens nao corresponde
ERROR 08 Lista de celulares vazia
ERROR 99 Erro interno do servidor

Consulta de Status

GET /webservices/http.php?metodo=consulta Consultar status de entrega

Consulta o status de entrega de um SMS enviado.

Parâmetros

Parâmetro Tipo Obrigatório Descrição
metodo string Sim Valor fixo: consulta
usuario string Sim Usuario da conta
senha string Sim Senha da conta
id string Sim ID da mensagem retornado no envio

Exemplos

https://api.iagentesms.com.br/webservices/http.php?metodo=consulta&usuario=SEU_USUARIO&senha=SUA_SENHA&id=123456
curl "https://api.iagentesms.com.br/webservices/http.php?metodo=consulta&usuario=SEU_USUARIO&senha=SUA_SENHA&id=123456"
<?php
$params = [
    'metodo'  => 'consulta',
    'usuario' => 'SEU_USUARIO',
    'senha'   => 'SUA_SENHA',
    'id'      => '123456'
];

$url = 'https://api.iagentesms.com.br/webservices/http.php?' . http_build_query($params);

$response = file_get_contents($url);
echo $response;
// Sucesso: "ENTREGUE"
?>
Codigos de Resposta
Codigo Descrição
ENVIADO Mensagem enviada para a operadora
ENTREGUE Mensagem entregue ao destinatario
FILA Mensagem na fila de envio
ERRO Falha no envio da mensagem
CANCELADO Envio cancelado
ERROR 01 Usuario ou senha invalidos
ERROR 09 ID de mensagem invalido
ERROR 99 Erro interno do servidor

API SOAP

A API SOAP oferece funcionalidades adicionais como gerenciamento de grupos, contatos e metodos de envio avancados.

WSDL e Autenticação

https://api.iagentesms.com.br/webservices/soap.php?wsdl

Todas as chamadas SOAP requerem os parâmetros usuario e senha como os dois primeiros argumentos de cada metodo.

Metodos de Grupos

SOAP criarGrupo Criar grupo de contatos

Cria um novo grupo de contatos.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
nome string Nome do grupo
SOAP listarGrupos Listar todos os grupos

Lista todos os grupos da conta.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
SOAP editarGrupo Editar nome de grupo

Edita o nome de um grupo existente.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_grupo int ID do grupo
nome string Novo nome do grupo
SOAP excluirGrupo Remover grupo

Remove um grupo e desvincula seus contatos.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_grupo int ID do grupo

Exemplo PHP - Grupos

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Criar grupo
$resultado = $client->criarGrupo(
    'SEU_USUARIO',
    'SUA_SENHA',
    'Clientes VIP'
);
echo $resultado;

// Listar grupos
$resultado = $client->listarGrupos(
    'SEU_USUARIO',
    'SUA_SENHA'
);
print_r($resultado);
?>

Metodos de Contatos

SOAP criarContato Adicionar contato a grupo

Adiciona um contato a um grupo.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_grupo int ID do grupo
nome string Nome do contato
celular string Numero com DDD
SOAP listarContatos Listar contatos de grupo

Lista contatos de um grupo.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_grupo int ID do grupo
SOAP editarContato Editar dados de contato

Edita os dados de um contato.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_contato int ID do contato
nome string Novo nome
celular string Novo numero
SOAP excluirContato Remover contato

Remove um contato.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_contato int ID do contato

Exemplo PHP - Contatos

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Adicionar contato ao grupo
$resultado = $client->criarContato(
    'SEU_USUARIO',
    'SUA_SENHA',
    42, // id_grupo
    'Joao Silva',
    '5551999999999'
);
echo $resultado;
?>

Envio Avulso (SOAP)

SOAP enviarSMS Enviar SMS individual via SOAP

Envia SMS individual via SOAP.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
celular string Numero do celular com DDD
mensagem string Texto da mensagem
agendamento string Data/hora opcional (DD/MM/AAAA HH:MM)

Exemplo

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Envio individual
$resultado = $client->enviarSMS(
    'SEU_USUARIO',
    'SUA_SENHA',
    '5551999999999',
    'Ola! SMS via SOAP.',
    '' // agendamento (vazio = imediato)
);
echo $resultado;
?>

Envio em Lote (SOAP)

SOAP enviarSMSLote Enviar SMS em lote via SOAP

Envia SMS em lote via SOAP.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
celulares string Numeros separados por ;
mensagens string Mensagens separadas por ;
agendamento string Data/hora opcional (DD/MM/AAAA HH:MM)

Exemplo

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Envio em lote
$resultado = $client->enviarSMSLote(
    'SEU_USUARIO',
    'SUA_SENHA',
    '5551999999999;5551888888888',
    'Msg para Joao;Msg para Maria',
    ''
);
echo $resultado;
?>

Envio para Grupo (SOAP)

SOAP enviarSMSGrupo Enviar SMS para grupo

Envia SMS para todos os contatos de um grupo.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id_grupo int ID do grupo
mensagem string Texto da mensagem
agendamento string Data/hora opcional (DD/MM/AAAA HH:MM)

Exemplo

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Envio para grupo
$resultado = $client->enviarSMSGrupo(
    'SEU_USUARIO',
    'SUA_SENHA',
    42, // id_grupo
    'Mensagem para todo o grupo!',
    ''
);
echo $resultado;
?>

Consulta de Status (SOAP)

SOAP consultarStatus Consultar status de entrega via SOAP

Consulta status de entrega via SOAP.

Parâmetro Tipo Descrição
usuario string Usuario da conta
senha string Senha da conta
id string ID da mensagem

Exemplo

<?php
$wsdl = 'https://api.iagentesms.com.br/webservices/soap.php?wsdl';
$client = new SoapClient($wsdl);

// Consultar status
$resultado = $client->consultarStatus(
    'SEU_USUARIO',
    'SUA_SENHA',
    '123456' // id da mensagem
);
echo $resultado;
?>

Callback HTTP

O IAGENTEsms pode enviar notificacoes de status de entrega para uma URL configurada no seu painel. Quando o status de um SMS muda, o sistema faz uma requisição GET para a URL configurada com os seguintes parâmetros.

Parâmetros do Callback

Parâmetro Tipo Descrição
id string ID da mensagem
celular string Numero do destinatario
status string Status da entrega: ENTREGUE, ERRO, CANCELADO
data string Data/hora da atualizacao (DD/MM/AAAA HH:MM:SS)
operadora string Nome da operadora

Exemplo de Callback

GET https://seusite.com.br/callback/sms?id=123456&celular=5551999999999&status=ENTREGUE&data=26/03/2026+14:32:10&operadora=VIVO

Recebendo Callback

<?php
// callback.php - Configure esta URL no painel do IAGENTEsms

$id        = $_GET['id'] ?? '';
$celular   = $_GET['celular'] ?? '';
$status    = $_GET['status'] ?? '';
$data      = $_GET['data'] ?? '';
$operadora = $_GET['operadora'] ?? '';

// Registre o callback no seu banco de dados
$pdo = new PDO('mysql:host=localhost;dbname=seudb', 'usuario', 'senha');
$stmt = $pdo->prepare(
    "INSERT INTO sms_callbacks (msg_id, celular, status, data_status, operadora)
     VALUES (?, ?, ?, ?, ?)"
);
$stmt->execute([$id, $celular, $status, $data, $operadora]);

// Retorne 200 OK para confirmar o recebimento
http_response_code(200);
echo 'OK';
?>

Email para SMS (SMTP)

O IAGENTEsms tambem permite o envio de SMS por email. Basta enviar um email para o endereco especial, e o conteudo será convertido em SMS.

Formato do Endereco

NUMERO@sms.iagentesms.com.br

Onde NUMERO e o celular do destinatario com DDD (ex: 5551999999999@sms.iagentesms.com.br).

Configuração

Campo Valor
Para NUMERO@sms.iagentesms.com.br
De Email cadastrado no painel do IAGENTEsms
Assunto Sera ignorado
Corpo Texto da mensagem SMS (max 160 caracteres)

O email remetente deve estar previamente cadastrado e autorizado no painel para que o envio por SMTP funcione.

Precisa de ajuda? Entre em contato com nosso suporte tecnico pelo WhatsApp ou acesse a Central de Ajuda.