API SMS, API SMPP API MS Scheduler
Guia do usuário
API SMS, API SMPP API MS Scheduler
| Modificado: | 6/24/2025 |
| Versão: | 1.7 |
| Autor: | Kenny Colander Norden, KCN |
Este documento é apenas para o destinatário designado e pode conter informações privilegiadas, proprietárias ou privadas. Se você o recebeu por engano, notifique o remetente imediatamente e exclua o original. Qualquer outro uso do documento por você é proibido.
Histórico de alterações
| Rev | Data | By | Alterações da versão anterior |
| 1.0 | 2010-03-16 | KCN | Criado |
| 1. | 2019-06-11 | TPE | Logotipos LINK atualizados |
| 1. | 2019-09-27 | PNI | Referência adicionada à especificação SMPP 3.4 |
| 1. | 2019-10-31 | EP | Observação sobre o prazo de validade tag |
| 1. | 2020-08-28 | KCN | Adicionadas informações sobre as versões TLS suportadas |
| 2. | 2022-01-10 | KCN | Adicionadas informações adicionais sobre relatórios de entrega Informações atualizadas sobre TLS 1.3 |
| 2. | 2025-06-03 | GM | Adicionado código de resultado 2108 |
| 2. | 2025-06-24 | AK | Cota adicionada |
Introdução
A LINK Mobility é distribuidora de SMS desde 2001 e tem muita experiência em trabalhar com operadoras e agregadores de conexão. Esta plataforma foi projetada para lidar com grandes volumes de tráfego, manter uma alta disponibilidade e facilitar o roteamento do tráfego por meio de múltiplas conexões.
Este documento descreve a interface SMPP para a plataforma SMSC e quais parâmetros e comandos são necessários e quais parâmetros são suportados.
Este documento não abordará casos de uso específicos como mensagens concatenadas, WAPpush, Flash SMS, etc. Mais informações sobre esses casos podem ser fornecidas entrando em contato com o suporte.
Comandos compatíveis
O servidor da LINK Mobility deve ser tratado como SMPP 3.4. A especificação oficial pode ser encontrada em https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Nem todos os métodos são suportados e todas as diferenças são especificadas abaixo.
4.1 Vincular
Os seguintes comandos de ligação são suportados.
- Transmissor
- transceptor
- Receptor
Parâmetros necessários:
- system_id – obtido do suporte
- senha – obtida com o suporte
Parâmetros opcionais:
- addr_ton – valor padrão se TON for definido como Desconhecido durante o envio.
- addr_npi – valor padrão se NPI for definido como Desconhecido durante o envio.
Parâmetros não suportados:
- intervalo_de_endereços
4.2 Desvincular
O comando unbind é suportado.
4.3 Consultar link
O comando inquire link é suportado e deve ser chamado a cada 60 segundos.
4.4 Enviar
O método submit deve ser usado para entregar mensagens.
Parâmetros necessários:
- fonte_addr_ton
- fonte_addr_npi
- endereço_fonte
- destino_addr_ton
- destino_addr_npi
- endereço_dest
- esm_class
- codificação_dados
- comprimento_sm
- mensagem curta
Parâmetros não suportados:
- tipo de serviço
- protocolo_id
- prioridade_flag
- hora_de_entrega_agendamento
- substituir_se_presente_flag
- sm_default_msg_id
Observação que a carga útil tag não é suportado e apenas um SMS pode ser entregue por chamada e é recomendado que o valid_period tag tem um valor de 15 minutos de duração, pelo menos.
4.4.1 TON e NPI recomendados
Os seguintes TON e NPI devem ser usados ao enviar mensagens usando o comando submit.
4.4.1.1 Fonte
As seguintes combinações de TON e NPI são suportadas para o endereço de origem. Todas as outras combinações serão tratadas como inválidas. O TON padrão do comando bind será usado se TON estiver definido como Desconhecido (0). O NPI padrão do comando bind será usado se NPI estiver definido como Desconhecido (0).
| TONELADA | INP | Descrição |
| Alfanumérico (5) | Desconhecido (0) ISDN (1) |
Será tratado como texto alfanumérico do remetente |
| Internacional (1) | Desconhecido (0) ISDN (1) |
Será tratado como MSISDN |
| Nacional (2) Específico da rede (3) Número de assinante (4) Abreviado (6) |
Desconhecido (0) ISDN (1) Nacional (8) |
Será tratado como um número curto específico do país. |
4.4.1.2 Destino
As seguintes combinações TON e NPI são suportadas para o endereço de destino. Todas as outras combinações serão consideradas inválidas. O comando padrão TON from bind será usado se TON for definido como Desconhecido (0). O NPI padrão do comando bind será usado se o NPI for definido como Desconhecido (0).
| TONELADA | INP | Descrição |
| Internacional (1) | Desconhecido (0) ISDN (1) |
Será tratado como MSISDN |
4.4.2 Codificações suportadas
As seguintes codificações são suportadas. X pode conter qualquer valor.
| DCS | Codificação |
| 0xX0 | Alfabeto GSM padrão com extensão |
| 0xX2 | binário de 8 bits |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Contingente
5.1 Cota Excedidaview
Uma cota define o número máximo de mensagens SMS que podem ser enviadas dentro de um intervalo de tempo especificado (por exemplo, por dia, semana, mês ou indefinidamente). Cada cota é identificada exclusivamente por um quotaId (UUID) e é redefinida de acordo com o fuso horário do cliente. As cotas podem ser atribuídas por país, região ou nível padrão por meio de um Quota Pro.fileA cota também pode ser atribuída dinamicamente usando o Mapeamento de Cotas. Isso mapeia um QuotaId pai (UUID) e uma Chave de cota exclusiva (por exemplo, remetente ou usuário) para um quotaId específico.
Uma cota é definida de acordo com seu suporte local, seu gerente de conta designado ou por padrão, se nada for especificado.
5.2 Status 106 – Cota Excedida
Uma mensagem SMS pode ser bloqueada com o código de status 106 (“cota excedida”) quando:
- A mensagem excede o limite definido para seu quotaId correspondente dentro do intervalo atual.
- O país ou região de destino não tem cota atribuída (ou seja, está explicitamente bloqueado com um mapeamento de cota nulo no profile).
- Não há cota correspondente e nenhuma cota padrão é definida, resultando em rejeição.
Nesses casos, o sistema impede o processamento posterior de mensagens para impor limites baseados no cliente ou no destino e evitar o uso indevido.
Relatório de entrega
Apenas nenhuma entrega ou entrega final com resultado de sucesso/falha são suportados.
Formato no relatório de entrega: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx data de conclusão: aaMMddHHmm stat:
Valores disponíveis no status:
- ENTREGA
- EXPIRADO
- REJEITADO
- NÃO ENTREGUE
- EXCLUÍDO
6.1 Formato de relatório de entrega estendida
Informações estendidas em relatórios de entrega podem ser solicitadas em contato com seu representante de vendas.
Formato do relatório de entrega: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 data de envio:
yyMMddHHmm data de conclusão: yyMMddHHmm stat: errar: texto:
Valores disponíveis no status:
- ENTREGA
- EXPIRADO
- REJEITADO
- NÃO ENTREGUE
- EXCLUÍDO
Os campos “sub” e “dlvrd” serão sempre configurados para 000, e o campo “text” estará sempre vazio.
Consulte o capítulo Códigos de erro para obter os valores do campo “err”.
Versões de TLS suportadas
TLS 1.2 ou TLS 1.3 é necessário para todas as conexões TLS sobre SMPP.
O suporte para TLS 1.0 e 1.1 foi descontinuado desde 2020-11-15. As versões 1.0 e 1.1 do TLS são protocolos mais antigos que foram obsoletos e são considerados riscos de segurança na comunidade da Internet.
LINK recomenda fortemente o uso de TLS se conexões SMPP não criptografadas estiverem sendo usadas hoje. As conexões SMPP não criptografadas foram obsoletas a partir de 2020/09/01 por LINK e serão removidas no futuro. A data para remoção de conexões não criptografadas ainda não foi decidida.
As conexões com o servidor SMPP para TLS estão na porta 3601, em vez de não criptografadas na porta 3600.
Você ainda pode usar TLS mesmo que sua implementação SMPP não suporte TLS usando stunnel, consulte https://www.stunnel.org/
Códigos de erro
Os seguintes códigos de erro podem ser respondidos no campo err se o campo estiver habilitado.
| Código de erro | Descrição |
| 0 | Erro desconhecido |
| 1 | Erro de roteamento temporário |
| 2 | Erro de roteamento permanente |
| 3 | Limitação máxima excedida |
| 4 | Tempo esgotado |
| 5 | Erro desconhecido do operador |
| 6 | Erro do operador |
| 100 | Serviço não encontrado |
| 101 | Usuário não encontrado |
| 102 | Conta não encontrada |
| 103 | Senha inválida |
| 104 | Erro de configuração |
| 105 | Erro interno |
| 106 | Cota excedida |
| 200 | OK |
| 1000 | Enviado |
| 1001 | Entregue |
| 1002 | Expirado |
| 1003 | Excluído |
| 1004 | celular cheio |
| 1005 | Na fila |
| 1006 | Não entregue |
| 1007 | Entregue, cobrança atrasada |
| 1008 | Cobrado, mensagem não enviada |
| 1009 | Cobrado, mensagem não entregue |
| 1010 | Expirado, ausência de relatório de entrega do operador |
| 1011 | Cobrado, mensagem enviada (ao operador) |
| 1012 | Enfileirado remotamente |
| 1013 | Mensagem enviada ao operador, carregamento atrasado |
| 2000 | Número de origem inválido |
| 2001 | Número curto não é suportado como fonte |
| 2002 | Alpha não é suportado como fonte |
| 2003 | MSISDN não é suportado como número de origem |
| 2100 | Número curto não é suportado como destino |
| 2101 | Alfa não é suportado como destino |
| 2102 | MSISDN não é suportado como destino |
| 2103 | Operação bloqueada |
| 2104 | assinante desconhecido |
| 2105 | Destino bloqueado |
| 2106 | erro de número |
| 2107 | Destino temporariamente bloqueado |
| 2108 | Destino inválido |
| 2200 | Erro de carregamento |
| 2201 | O assinante está com saldo baixo |
|
2202 |
Assinante barrado por cobrança a maior (premium)
mensagens |
|
2203 |
Assinante muito jovem (para este caso em particular)
conteúdo) |
| 2204 | Assinante pré-pago não permitido |
| 2205 | Serviço rejeitado pelo assinante |
| 2206 | Assinante não cadastrado no sistema de pagamento |
| 2207 | O assinante atingiu o saldo máximo |
| 2208 | Confirmação do usuário final necessária |
| 2300 | Reembolsado |
|
2301 |
Não foi possível reembolsar devido a itens ilegais ou ausentes
MSISDN |
| 2302 | Não foi possível reembolsar devido à falta de messageId |
| 2303 | Na fila para reembolso |
| 2304 | Tempo limite de reembolso |
| 2305 | Falha no reembolso |
| 3000 | A codificação GSM não é suportada |
| 3001 | A codificação UCS2 não é suportada |
| 3002 | A codificação binária não é suportada |
| 4000 | O relatório de entrega não é suportado |
| 4001 | Conteúdo da mensagem inválido |
| 4002 | Tarifa inválida |
| 4003 | Dados de usuário inválidos |
| 4004 | Cabeçalho de dados do usuário inválido |
| 4005 | Codificação de dados inválida |
| 4006 | IVA inválido |
| 4007 | Conteúdo não suportado para o destino |
Documentos / Recursos
 |
API SMS de mobilidade de links, API SMPP API MS Scheduler [pdf] Guia do Usuário API SMS API SMPP API MS Scheduler, API SMS API SMPP, API MS Scheduler, API Agendador, API |