API SMS

API SMS - HTTP
Sumário
1.
Envio SMS-MT............................................................................................................................................................................................................................ 3
2.
Parâmetros para Envio .............................................................................................................................................................................................................. 3
3.
Exemplos de envio de SMS MT ................................................................................................................................................................................................. 4
4.
Exemplos de retorno da API ao enviar SMS .............................................................................................................................................................................. 4
5.
Recebendo Respostas (MO SMS) .............................................................................................................................................................................................. 5
1. Envio SMS-MT
Para envio de SMS-MT através do API pode-se usar o método HTTP POST ou HTTP GET, a URL para envio é http://sms.bfttelecom.com.br:1401/send
2. Parâmetros para Envio
O Envio de SMS pode ter vários parâmetros, sendo alguns obrigatórios e outros opcionais, abaixo a tabela de parâmetros.
Parametro
Valor
Exemplo
Obrigatório /
Opcional
5511999997777
Obrigatório
10000
Opcional
SMS_username
Obrigatório
SMS_password
Obrigatório
0
Opcional
yes
Opcional
http://host/dlr.php Obrigatório se
usar DLR
to
from
username
password
priority
dlr
dlr-url
Destination address
Originating address
Text (30 char. max)
Text (30 char. max)
0, 1, 2 or 3
yes or no
HTTP(s) URL
dlr-level
1, 2 or 3
2
dlr-method
GET or POST
GET
content
Text
Hello world !
Obrigatório se
usar DLR
Obrigatório se
usar DLR
Obrigatório
Description / Notes
Número de destino para enviar SMS
Número de origem informado para enviar SMS
Usuário BFT SMS para envio
Senha BFT SMS para envio
Prioridade, de acordo com as opções informadas
Padrão é No, se precisar de DLR informar yes
Se configurar dlr=yes esse campo deve ser informato com a URL para
retornar os dados da DLR. Caso esse parâmetro não seja informado o
sistema não irá retornar DLR
1: SMS-C level, 2: Terminal level, 3: Ambos, para receber apenas os
STATUS das mensagens enviar opção 2.
Formato que o DLR vai ser enviado para a URL
Mensagem a ser enviada
3. Exemplos de envio de SMS MT
Solicitando DLR 2:
http://sms.bfttelecom.com.br:1401/send?username=1234abcder&password=123456678&priority=0&to=5511999998888&content=TESTESMS&dlr=yes&dlr-level=2&dlr-url=http://sms.seudominio.com.br/dlr.php
Sem Solicitação de DLR ou prioridade:
http://sms.bfttelecom.com.br:1401/send?username=1234abcder&password=123456678&to=5511999998888&content=TESTE-SMS
4. Exemplos de retorno da API ao enviar SMS
Quando a requisição de SMS é validada através dos parâmetros o sistema vai retornar um STATUS segue os exemplos e tabela de status.
Em caso de sucesso: Success "07033084-5cfd-4812-90a4-e4d24ffb6e3d"
Em caso de erro: Error "No route found"
Tabela de códigos:
HTTP Code
200
400
400
400
400
400
403
403
403
412
500
HTTP Body
Success “07033084-5cfd-4812-90a4-e4d24ffb6e3d”
Error “Mandatory arguments not found, please refer to the HTTPAPI specifications.”
Error “Argument _ is unknown.”
Error “Argument _ has an invalid value: _.”
Error “Mandatory argument _ is not found.”
dynamic messages
Error “Authentication failure for username:_”
Error “Authorization failed for username:_”
Error “Cannot charge submit_sm, check RouterPB log file for details”
Error “No route found”
Error “Cannot send submit_sm, check SMPPClientManagerPB log file for details”
Significado
Mensagem enviada para fila com sucesso
Validação de parâmetros está incorreta
Validação de parâmetros está incorreta
Validação de parâmetros está incorreta
Validação de parâmetros está incorreta
Dados de autenticação incorretos
Dados de autenticação incorretos
Dados de autenticação incorretos
Conta sem saldo
Erro no roteamento
Erro do sistema ou bloqueio da conta
5. Recebendo Respostas (MO SMS)
Para o recebimento de MO’s (Respostas) deve-se informar uma URL para retorno, essa URL será cadastrada no sistema BFT SMS e irá retornar
automaticamente os SMS MO.
Exemplo de URL: http://seudominio.com.br/mo
Sempre que o sistema BFT SMS enviar uma URL MO, é necessário que seja retornado uma mensagem no corpo do HTML, assim o sistema BFT SMS irá
interpretar a MO como recebida e não irá tentar novamente reenviar.
Exemplo de HTML Body: ACK/Jasmin
Os campos que o sistema irá retornar para as MO’s:
Parâmetros
Valores
id
from
to
origin-connector
priority
coding
validity
content
binary
Universally Unique IDentifier (UUID)
Originating address
Destination address
Alphanumeric id
1, 2 or 3
Numeric
YYYY-MM-DD hh:mm:ss
Text
Hexlified binary content
Exemplos
Sempre ou
Opcional
16fd2706-8baf-433b-82eb-8c7fada847da Always
+21620203060, 20203060, Jasmin
Always
+21620203060, 20203060, Jasmin
Always
23, bcd, MTN, clickatell, beepsend
Always
2
Optional
8
Optional
2013-07-16 00-46:54
Optional
Hello world !
Always
062A063062A
Always
Description / Notes
ID do sistema BFT
Número de Origem
Número de Destino
ID do usuário de origem
Prioridade, Default é 1
Default 0
Tempo de Validade da SMS
Texto da mensagem
Texto da mensagem codificado