NAV

Introdução

Bem-vindo a Documentação API da SMSDev! Você pode usar no API para acessar os serviços Sms.

A comunicação é feita através de protocolo HTTP. Você pode ver exemplos de código na area escura a direita.

Qualquer dúvida na utilização dessa documentação entre em contato através do e-mail suporte@smsdev.com.br.

Você encontra sua CHAVE KEY no menu Minha Conta ou clique em http://painel.smsdev.com.br/MeusDados

Sms

Envio

<?php
    $ch = curl_init();

    $data = array('key'         => 'SUA_CHAVE_KEY', 
                  'type'        => '9',
                  'number'      => '11988887777',
                  'msg'         => 'Teste de envio.');

    curl_setopt($ch, CURLOPT_URL, 'https://api.smsdev.com.br/send');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $res    = curl_exec ($ch);
    $err    = curl_errno($ch);
    $errmsg = curl_error($ch);
    $header = curl_getinfo($ch);

    curl_close($ch);

    print_r($res); 
?>  

O comando acima retorna estrutura JSON como esta:

{"situacao":"OK","codigo":"1","id":"175570049","descricao":"MENSAGEM NA FILA"}

Esse método é utilizado para enviar uma única mensagem por requisição.

No retorno já é disponibilizado o ID único da mensagem na SMSDev.

Ideal quando as mensagens são diferentes para cada destinatário.

HTTP Request

GET ou POST https://api.smsdev.com.br/send

Parâmetros

Nome Tipo Padrão Obrigatório Descrição
key varchar(16) true Chave de identificação do usuário.
type number true Tipo de serviço: 9-Sms.
number number(13) true Número destinatário. Não é necessário inserir código do país ‘55’.
msg varchar true Texto da mensagem.
jobdate varchar data atual false Data de agendamento para envio. '01/01/2016’.
jobtime varchar hora atual false Hora de agendamento para envio. '10:30’.
refer varchar(100) false Referência do usuário para identificação da mensagem.
flash number false &flash=1 para enviar mensagens FLASH.

Situação

<?php
    $ch = curl_init();

    $data = array('key'         => 'SUA_CHAVE_KEY', 
                  'action'      => 'status',
                  'id'          => '175570049');

    curl_setopt($ch, CURLOPT_URL, 'https://api.smsdev.com.br/get');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $res    = curl_exec ($ch);
    $err    = curl_errno($ch);
    $errmsg = curl_error($ch);
    $header = curl_getinfo($ch);

    curl_close($ch);

    print_r($res); 
?>  

O comando acima retorna estrutura JSON como esta:

{"situacao":"OK","codigo":"1","data_envio":"20\/01\/2016 10:33:39","operadora":"VIVO-PORTABILIDADE","descricao":"RECEBIDA"}

Esse método é utilizado para consultar a situação da mensagem.

Você deve guardar o ID único da mensagem na SMSDev no momento do envio para utilizar esse método.

HTTP Request

GET ou POST https://api.smsdev.com.br/get

Parâmetros

Nome Tipo Padrão Obrigatório Descrição
key varchar(16) true Chave de identificação do usuário.
action varchar true Definir 'status’ para consulta de situação.
id number true ID único da mensagem na SMSDev.

Retorno

Situação Descrição
RECEBIDA Mensagem entregue no aparelho do cliente.
ENVIADA Mensagem enviada a operadora.
ERRO Erro de validação da mensagem.
FILA Mensagem aguardando processamento.
CANCELADA Mensagem cancelada pelo usuário.
BLACK LIST Destinatário ativo no grupo 'Black List’.

Caixa de Entrada

<?php
    $ch = curl_init();

    $data = array('key'         => 'SUA_CHAVE_KEY', 
                  'action'      => 'inbox',
                  'status'      => '0');

    curl_setopt($ch, CURLOPT_URL, 'https://api.smsdev.com.br/get');
    curl_setopt($ch, CURLOPT_POST, true);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

    $res    = curl_exec ($ch);
    $err    = curl_errno($ch);
    $errmsg = curl_error($ch);
    $header = curl_getinfo($ch);

    curl_close($ch);

    print_r($res); 
?>  

O comando acima retorna estrutura JSON como esta:

[
  {"situacao":"OK","data_read":"01\/01\/2016 11:35:14","telefone":"5511988887777","id":"","refer_id":"","nome":"","msg_sent":"","id_sms_read":"2515973","descricao":"Reposta 1"},
  {"situacao":"OK","data_read":"01\/01\/2016 11:36:11","telefone":"5521977776666","id":"","refer_id":"","nome":"","msg_sent":"","id_sms_read":"2515974","descricao":"Reposta 2"},
  {"situacao":"OK","data_read":"01\/01\/2016 11:39:24","telefone":"556288887777","id":"","refer_id":"","nome":"","msg_sent":"","id_sms_read":"2515975","descricao":"Reposta 3"}
]

Esse método é utilizado para consultar as respostas recebidas.

HTTP Request

GET ou POST https://api.smsdev.com.br/get

Parâmetros

Nome Tipo Padrão Obrigatório Descrição
key varchar(16) true Chave de identificação do usuário.
action varchar true Definir 'inbox’ para consulta da caixa de entrada.
status number 0 false Situação da resposta: 0-Somente novas respostas ; 1-Todas as respostas.
date_from date false Data início para filtro '01/01/2016’.
date_to date false Data fim para filtro '02/01/2016’.
id number false ID único da mensagem na SMSDev.

CallBack

O método deve estar ser ativado no menu INBOX -> Configuração CallBack.

Esse método é utilizado para que o servidor da SMSDev realize uma chamada via POST ou GET para uma URL definida pelo usuário a cada nova resposta.

É necessário definir a URL no menu INBOX -> Configuração CallBack.

Parâmetros

Nome Tipo Descrição
from number Remetente da resposta.
message varchar Texto da resposta.
id number ID único da resposta.
id_sent number ID único da mensagem enviada origem da resposta.
refer varchar Referência do usuário utilizado na mensagem de origem da resposta.

Códigos de Retorno

Abaixo a tabela de códigos de retornos.

Caso o código recebido não esteja listado abaixo entre em contato através dos e-mail suporte@smsdev.com.br .

Código Descrição
1 Operação realizada com sucesso.
400 Texto ou Url da mensagem não definida.
401 Campo ACTION valor inválido.
402 Campo NUMBER sem valor definido.
403 Chave Key não e válida e/ou usuário não autenticado.
405 Campo ID sem valor definido.
407 Campo NUMBER erro de validação.
408 Saldo insuficiente. – Realize uma nova recarga.
409 Campo TYPE valor inválido.
414 Conta não confirmada ou bloqueada. – Efetue login no site confirmar sua conta.
416 Campo REFER máximo de caracteres permitido.
420 Campo MSG máximo de caracteres permitido.
435 Campo ACTION sem valor definido.
436 Campo ID não encontrado.