SMS API

SMS API

Documentação completa para você enviar e receber SMS utilizando a nossa API

  1. REST
  2. HTTP
  3. SOAP
  4. SMPP

REST

URL:

https://api.gtisms.com/rest/SMS/EnviarSMS?email=email@mail.com&token=seutoken&id=2&mensagem=oi&numeros=999999999

RETORNOS

  • { “reason”: “success”, “message”: “mensagem enviada com sucesso!”, “code”: 6 }
  • .
  • { “reason”: “error”, “message”: “o parametro Email e vazio ou invalido!”, “code”: 1 }
  • { “reason”: “error”, “message”: “o parametro Token e vazio ou invalido!”, “code”: 1 }
  • { “reason”: “error”, “message”: “o usuário não foi encontrado!”, “code”: 1 }
  • { “reason”: “error”, “message”: “Não há creditos suficientes!”, “code”: 5 }
  • { “reason”: “error”, “message”: “o parametro Mensagem e vazio ou invalido!”, “code”: 2 }
  • { “reason”: “error”, “message”: “o parametro Numeros e vazio ou invalido!”, “code”: 3 }

URL:

https://api.gtisms.com/rest/SMS/VerificaStatus?email=seu@email.com&token=seutoken&id=1

RETORNOS

  • { “result”: “success”, “status”: “entregue” }
  • .
  • { “result”: “error”, “message”: “usuário inválido” }
  • { “reason”: “error”, “message”: “o parametro Email e vazio ou invalido!” }
  • { “reason”: “error”, “message”: “o parametro Token e vazio ou invalido” }
  • { “reason”: “error”, “message”: “o parametro id e vazio ou invalido” }
URL:

https://api.gtisms.com/rest/SMS/ChecarRetorno?email=seuemail@email.com&token=seutoken&DataInicio=01/01/2000&DataFinal=01/01/2018

RETORNOS

  • { “reason”: “success”, “data”: [ { “data”: “01/02/2017”, “numero”: “9999999999”, “mensagem”: “Mensagem um” }, { “data”: “01/06/2017”, “numero”: “9999999999”, “mensagem”: “Mensagem dois” } ] }
  • .
  • { “reason”: “error”, “message”: “usuário não foi encontrado” }
  • { “reason”: “error”, “message”: “o parametro Email e vazio ou invalido!” }
  • { “reason”: “error”, “message”: “o parametro Token e vazio ou invalido” }
URL:

https://api.gtisms.com/rest/SMS/ConsultarCreditos?email=email@mail.com&token=seutoken

RETORNOS

  • { “reason”: “success”, “creditos”: 5561 }
  • .
  • { “reason”: “error”, “message”: “usuário não foi encontrado” }
  • { “reason”: “error”, “message”: “o parametro Email e vazio ou invalido!” }
  • { “reason”: “error”, “message”: “o parametro Token e vazio ou invalido” }

HTTP

URL:

https://api.gtisms.com/gti/API/send.aspx?user=xxxxxx&senha=xxx&msg=xxxx&n=xxx&id=xxx

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso
  • msg: texto da mensagem a ser enviada
  • n: numero do destino (11 caracteres numéricos)
  • id: identificação NUMÉRICA para checar o envio

RETORNOS

  • 1. Usuário/Senha inválidos
  • 2. Mensagem em branco
  • 3. Número em branco
  • 4. Número inválido: o campo n deve ser numero e conter 10 ou 11 dígitos
  • 5. Usuário sem créditos disponíveis
  • 6. Encaminhado para Envio: mensagem aceita e encaminhada para envio
URL:

https://api.gtisms.com/gti/API/check.aspx?user=xxx&senha=xxx&id=xxx

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso
  • id: identificação para checar o envio

RETORNOS

  • 1. Usuário/Senha inválidos
  • 2. PENDENTE: aguardando status de retorno
  • 3. ERRO: falha ao enviar a mensagem
  • 4. ENVIADO: envio realizado com sucesso
  • 5. ENTREGUE: mensagem entregue com sucesso
URL:

https://api.gtisms.com/gti/API/check_recebidas.aspx?user=xxx&senha=xxx&datainicial=2017-01-01&datafinal=2017-01-31

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso
  • datainicial: data inicial para busca no formato aaaa-mm-dd
  • datafinal: data final para busca no formato aaaa-mm-dd

RETORNOS

  • 1. Usuário/Senha inválidos
  • 2. Mensagens no formato data , numero, mensagem com quebra de linha no fim da mensagem
URL:

https://api.gtisms.com/gti/API/verificacredito.aspx?user=xxx&senha=xxx

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso

RETORNOS

  • 0. Erro de usuário ou senha.

SOAP

URL:

https://api.gtisms.com/gti/API/SMSService.asmx

OPERAÇÃO:

envioMessagem

PARÂMETROS

  • email: e-mail de acesso
  • senha: senha de acesso
  • mensagem: texto da mensagem a ser enviada
  • numeros: numero do destino (11 caracteres numéricos)
  • id: identificação NUMÉRICA para checar o envio

RETORNOS

  • 1. Usuário/Senha inválidos
  • 2. Mensagem em branco
  • 3. Número em branco
  • 4. Número inválido: o campo n deve ser numero e conter 10 ou 11 dígitos
  • 5. Usuário sem créditos disponíveis
  • 6. Encaminhado para Envio: mensagem aceita e encaminhada para envio
URL:

https://api.gtisms.com/gti/API/SMSService.asmx

OPERAÇÃO:

verificaStatus

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso
  • id: identificação para checar o envio

RETORNOS

  • 1. ID inválido
  • 2. PENDENTE: aguardando status de retorno
  • 3. ERRO: falha ao enviar a mensagem
  • 4. ENVIADO: envio realizado com sucesso
  • 5. ENTREGUE: mensagem entregue com sucesso
URL:

https://api.gtisms.com/gti/API/SMSService.asmx

OPERAÇÃO:

ChecarRecebidas

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso
  • datainicial: data inicial para busca no formato aaaa-mm-dd
  • datafinal: data final para busca no formato aaaa-mm-dd

RETORNOS

  • 1. Usuário/Senha inválidos
  • 2. Mensagens no formato data , numero, mensagem com quebra de linha no fim da mensagem
URL:

https://api.gtisms.com/gti/API/SMSService.asmx

OPERAÇÃO:

verificaCredito

PARÂMETROS

  • user: e-mail de acesso
  • senha: senha de acesso

RETORNOS

  • 0. Erro de usuário ou senha.
  • Quantidade de crédito do usuário.

SMPP

Por padrão, a conexão SMPP está bloqueada para os usuários. Caso queira utilizar, favor solicitar ao seu gerente de conta.

 

SMPP versão 3.4

Nonme Descrição

system_id

usuário

password

senha

IP address

smpp0.gtisms.com

port

5022

timeout (keep alive ou msg)

30 segundos

system_type

deixar em branco

Importante:

Pode-se conectar utilizando transmitter, receiver ou transceiver.

Por padrão, estão liberadas 8 sessões por usuário. Não há outra limitação de throughput (TPS) além da velocidade da sua conexão.

PDUS Suportados:

  • bind_transmitter
  • bind_receiver
  • bind_transceiver
  • unbind
  • submit_sm
  • deliver_sm
  • enquire_link

DELIVERY REPORT

Format
“id:<message_id> sub:<message_sub> dlvrd:<message_dlvrd>
submit date:<message_submit_date> done date:<message_done_date> 
stat:<message_stat> err:<message_err>”

DELIVERY STATUSES (MESSAGE_STAT):

  • DELIVRD
  • EXPIRED
  • UNDELIV
  • ACCEPTD
  • UNKNOWN
  • ENROUTE
  • REJECTD

Encoding / Data coding

Se você setar DCS 0 ou DCS 1 quando enviar uma mensagem, o nosso servidor reconhecerá como padrão GSM7 encoding (SMSC Default Alphabet ou IA5).

Para encoding Latin1 (ISO-8859-1) setar DCS 3.
E DCS 8 para mensagens no formato Unicode (ISO/IEC-10646).