Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Enviando SMS pela API

Este Ponto de Acesso irá permitir que você realize o Envio de SMS utilizando os Provedores de SMS cadastrados na Plataforma.

Antes de um Assinante conseguir utilizar a API de SMS, será necessário que você habilite o mesmo em seu cadastro.
Para liberar o acesso a API de SMS para um Assinante, acesse o cadastro do Assinante, vá até a opção Editar e ajuste as seguintes informações:

...


Image Added

Ainda nesta tela, você poderá travar o acesso à API de Envio de SMS para um Endereço IP em específico, aumentando ainda mais a camada de segurança para o Token do Assinante.

Para nosso exemplo, iremos deduzir que o endereço do servidor será sip.nextbilling.com.br. Nesse caso, o endereço da API seria:

Info
titleEndereço da API exemplo

GET https://sip.nextbilling.com.br/api/sms/API_TOKEN/DESTINO?message=Teste+de+Mensagem

...


A chamada para enviar um SMS é realizada utilizando um HTTP GET para o endereço de consumo da API. Um exemplo de chamada a essa API seria:

Panel
titleExemplo de chamada a API utilizando cURL
$ curl -X GET 'https://sip.nextbilling.com.br/api/sms/7cb40d54-4ebf-55a6-875a-5f57234e97cc-9990/5521980984000?message=Mensagem+de+Teste'


Utilizando essa chamada, você obteria o retorno em JSON semelhante a saída a seguir:

Code Block
languagegroovy
themeMidnight
titleRetorno JSON
{

...


   "RESULT":"0",

...


   "MSG":"CONTA NAO ENCONTRADA"

...


}


CampoDescrição
RESULT0 em Caso de Erro, 1 caso o envio esteja correto
MSGDescrição caso tenha ocorrido algum erro