A primeira coisa a se fazer é consultar a sua chave de identificação, ela funciona como uma senha, para que saibamos automaticamente que você é você. Peça a sua em nosso WhatsApp.
De posse da sua chave, através de métodos HTTP POST/GET você poderá realizar 3 tipos de transações com a nossa API:
- Agendar o envio de mensagens SMS via API (send)
- Verificar o status do agendamento do SMS (status)
- Verificar seu saldo de SMS (saldo)
Todas as operações podem ser feitas tanto através do método GET como POST.
Abaixo listamos os parâmetros que cada operação necessita e suas possíveis respostas:
Enviar SMS através da API
https://sistema81.smsbarato.com.br/send
Exemplo de chamada da API:
https://sistema81.smsbarato.com.br/send?chave=SUA_CHAVE&dest=11988887777&text=Sua+mensagem+aqui
Parâmetros necessários:
- chave: sua chave de identificação
- dest: Número do destinatário, apenas NÚMEROS, com DDD, NÃO deve conter nenhum tipo de símbolo. Exemplo: 11988887777
- text: Sua mensagem, deve ter NO MÁXIMO 160 caracteres, aceita letras, números e sinais. NÃO deve conter nenhum tipo de acento e nem quebra de linha.
Possíveis respostas e seus significados:
- ERRO1-1: Problemas com a sua chave
- ERRO1-2: Problemas com seu IP (não autorizado)
- ERRO1-3: Saldo insuficiente para enviar mensagem
- ERRO2: Problemas com o número de destino (parâmetro dest)
- ERRO3: Problemas com o texto (parâmetro text)
- Em caso de sucesso, retornará apenas um NUMERO, que é o ID da sua mensagem em nosso sistema. Em seguida ela será automaticamente encaminhada para a operadora.
Verificando o STATUS da sua mensagem SMS via API
https://sistema81.smsbarato.com.br/status
Exemplo de chamada:
https://sistema81.smsbarato.com.br/status?chave=SUA_CHAVE&id=ID_DA_MENSAGEM
Parâmetros necessários:
- chave: sua chave de identificação
- id: o ID de agendamento da sua mensagem
Possíveis respostas e seus significados:
- ERRO2: O ID inválido.
- ERRO: O ID especificado não existe.
- N: mensagem nova, aguardando envio.
- R: Mensagem sendo enviada.
- S: mensagem foi enviada com Sucesso.
- F: Envio falhou. Não será tentado novamente.
Verificando seu SALDO de SMS API
https://sistema81.smsbarato.com.br/saldo
Exemplo de chamada:
https://sistema81.smsbarato.com.br/saldo?chave=SUA_CHAVE
Parâmetros necessários:
- chave: sua chave de identificação
Possíveis respostas e seus significados:
- Número de mensagens que você ainda pode enviar pela API SMS.