Recomendações Iniciais

URL Base:

[http://app.smsapi.com.br/mensagens/service.json]

Descrição

API de integração para envio de mensagens SMS.

Autores

Alisson de Almeida Pissetti (alisson.pissetti@webasic.com.br)


Método: Receber

Descrição: método responsável pela leitura de retorno as mensagens recebidas. As mensagens recebidas para sua conta são retornadas durante 5 horas, após isso elas não virão mais via requisições REST.

Atenção! As mensagens são debitadas da sua conta de acordo com a quantidade enviada/recebida, no caso de envios/recebimentos de mensagens que sejam repartidas em várias a quantidade será debitada de acordo com a quantidade de mensagens transacionadas pelo sistema.

Request Requisição de envio

POSThttp://app.smsapi.com.br/mensagens/service.json

Parâmetros

Tipo de conteúdo: application/json

MensagensServiceRequest{
  acao VALOR: 'receber' - (string, requerido) : chamada de ação para requisição de envio de mensagem
  chave (int, requerido) : chave obtida através do método de login, ela identificará sua conta e debitará de seu saldo
}

Response Resposta de retorno

Tipo de conteúdo: application/json

MensagensServiceResponse{
  codigo (int) : código de retorno da execução, qualquer valor negativo representa falha
  inicio (datahora) : data/hora do início da execução
  fim (datahora) : data/hora do término da execução
  Mensagens (Array<Mensagem>) : listagem de execuções de alterações de itens
}
Mensagem{
  conta (string) : chave/nome da conta
  datahora (string) : data/hora de entrada no sistema
  from (string) : número que realizou este envio
  status (int>) : situação da mensagem no sistema
  texto (string) : conteúdo da mensagem
}

Método: Enviar

Descrição: método responsável pela requisição de envio de mensagens.

Atenção! As mensagens são debitadas da sua conta de acordo com a quantidade enviada/recebida, no caso de envios/recebimentos de mensagens que sejam repartidas em várias a quantidade será debitada de acordo com a quantidade de mensagens transacionadas pelo sistema.

Request Requisição de envio

POSThttp://app.smsapi.com.br/mensagens/service.json

Parâmetros

Tipo de conteúdo: application/json

MensagensServiceRequest{
  acao VALOR: 'enviar' - (string, requerido) : chamada de ação para requisição de envio de mensagem
  texto (string, requerido) : mensagem, quaisquer caracteres especiais serão removidos, o limite para cada mensagem é de 160 caracteres, o sistema repartirá a quantidade de mensagens de acordo com seu texto enviado
  chave (int, requerido) : chave obtida através do método de login, ela identificará sua conta e debitará de seu saldo
  destinos (Array(string), requerido) : array de destinos telefônicos para envio
}

Response Resposta de retorno

Tipo de conteúdo: application/json

MensagensServiceResponse{
  codigo (int) : código de retorno da execução, qualquer valor negativo representa falha
  mensagem (string) : mensagem amigável sobre o retorno da execução
  conta (int) : quantidade de execuções realizadas
  inicio (datahora) : data/hora do início da execução
  fim (datahora) : data/hora do término da execução
  Identificadores (Array<string>) : identificadores das mensagens enviadas
}