API SMS, API SMPP API MS Scheduler
Guida d'usu
API SMS, API SMPP API MS Scheduler
| Modificatu: | 6/24/2025 |
| Versione: | 1.7 |
| Autore: | Kenny Colander Norden, KCN |
Stu documentu hè solu per u destinatariu designatu è pò cuntene infurmazione privilegiata, propietaria o altrimenti privata. Se l'avete ricevutu per errore, avvisate immediatamente u mittente è sguassate l'uriginale. Ogni altru usu di u documentu da voi hè pruibitu.
Cambia a storia
| Rev | Data | By | Cambiamenti da a versione precedente |
| 1.0 | 2010-03-16 | KCN | Criatu |
| 1. | 2019-06-11 | TPE | Loghi LINK aghjurnati |
| 1. | 2019-09-27 | PNI | Riferimentu aghjuntu à a specificazione SMPP 3.4 |
| 1. | 2019-10-31 | EP | Osservazione nantu à u periodu di validità tag |
| 1. | 2020-08-28 | KCN | Aghjunghje infurmazione nantu à e versioni TLS supportate |
| 2. | 2022-01-10 | KCN | Aghjuntu infurmazioni supplementari riguardu à i rapporti di consegna Infurmazioni aghjurnate riguardu à TLS 1.3 |
| 2. | 2025-06-03 | GM | Codice di risultatu aghjuntu 2108 |
| 2. | 2025-06-24 | AK | Quota aghjunta |
Introduzione
LINK Mobility hè un distributore di SMS dapoi u 2001 è hà assai sperienza in u travagliu cù l'operatori è l'aggregatori di cunnessione. Questa piattaforma hè pensata per trattà grandi volumi di trafficu, mantene una alta dispunibilità è rende più faciule per indirizzà u trafficu via parechje cunnessione.
Questu documentu descrive l'interfaccia SMPP à a piattaforma SMSC è quali parametri è cumandamenti sò richiesti è quali parametri sò supportati.
Stu documentu ùn tratta micca casi d'usu specifichi cum'è missaghji concatenati, WAPpush, Flash SMS, ecc. Più infurmazioni nantu à questi casi ponu esse furnite cuntattendu l'assistenza.
Cumandamenti supportati
U servitore di LINK Mobility deve esse trattatu cum'è SMPP 3.4. A specificazione ufficiale pò esse truvata à https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Tutti i metudi ùn sò micca supportati, è tutte e differenze sò specificate quì sottu.
4.1 Ligà
I seguenti cumandamenti ligami sò supportati.
- Trasmettitore
- Transceiver
- Ricevitore
Parametri richiesti:
- system_id - ottenutu da u supportu
- password - ottenuta da u supportu
Parametri opzionali:
- addr_ton - valore predeterminatu se TON hè stabilitu à Unknown durante l'invio.
- addr_npi - valore predeterminatu se NPI hè stabilitu à Unknown durante l'invio.
Parametri micca supportati:
- intervallu_indirizzu
4.2 Unbind
U cumandamentu di unbind hè supportatu.
4.3 Inquire link
U cumandamentu di ligame inquire hè supportatu è deve esse chjamatu ogni 60 seconde.
4.4 Invia
U metudu di sottumissione deve esse usatu per trasmette i missaghji.
Parametri richiesti:
- source_addr_ton
- source_addr_npi
- indirizzu_source
- dest_addr_ton
- dest_addr_npi
- dest_addr
- esm_class
- codifica_dati
- sm_lunghezza
- missaghju_cortu
Parametri micca supportati:
- tipu di serviziu
- protocol_id
- priorità_bandiera
- schedule_delivery_time
- rimpiazzà_se_present_flag
- sm_default_msg_id
Nota chì a carica tag ùn hè micca supportatu è solu un SMS pò esse mandatu per chjama è hè cunsigliatu chì u validity_period tag hà un valore di 15 minuti longu almenu.
4.4.1 Cunsigliu TON è NPI
I seguenti TON è NPI devenu esse utilizati quandu invià missaghji cù u cumandimu di sottumette.
4.4.1.1 Fonte
E seguenti cumminazzioni TON è NPI sò supportate per l'indirizzu surghjente. Tutte l'altre cumminazzioni seranu trattate cum'è invalide. U TON predefinitu da u cumandamentu bind serà utilizatu se TON hè impostu à Scunnisciutu (0). U NPI predefinitu da u cumandamentu bind serà utilizatu se NPI hè impostu à Scunnisciutu (0).
| TON | NPI | Descrizzione |
| Alfanumericu (5) | Inconnu (0) ISDN (1) |
Serà trattatu cum'è testu di mittente Alfanumericu |
| Internaziunale (1) | Inconnu (0) ISDN (1) |
Serà trattatu cum'è MSISDN |
| Naziunale (2) Specificu di a rete (3) Numeru d'abbonatu (4) Abbreviatu (6) |
Inconnu (0) ISDN (1) Naziunale (8) |
Serà trattatu cum'è un numeru breve specificu di u paese. |
4.4.1.2 Destinazione
E seguenti combinazioni TON è NPI sò supportate per l'indirizzu di destinazione. Tutti l'altri cumminzioni seranu trattati cum'è invalidu. U TON predeterminatu da u cumandamentu di ligame serà utilizatu se TON hè stabilitu à Unknown (0). L'NPI predeterminatu da u cumandamentu bind serà utilizatu se NPI hè stabilitu à Unknown (0).
| TON | NPI | Descrizzione |
| Internaziunale (1) | Inconnu (0) ISDN (1) |
Serà trattatu cum'è MSISDN |
4.4.2 Encodings supportati
I seguenti codificazioni sò supportati. X pò cuntene ogni valore.
| DCS | Encoding |
| 0xX0 | Alfabetu GSM predeterminatu cù estensione |
| 0xX2 | 8-bit binariu |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Quota
5.1 Quota Oltreview
Una quota definisce u numeru massimu di missaghji SMS chì ponu esse mandati in un intervallu di tempu specificatu (cum'è per ghjornu, settimana, mese, o indefinitamente). Ogni quota hè identificata in modu unicu da un quotaId (UUID) è hè resettata secondu u fusu orariu di u cliente. E quote ponu esse assignate à u livellu di paese, regione o predefinitu per mezu di un Quota Pro.fileA quota pò ancu esse assignata dinamicamente aduprendu a Mappatura di Quote. Questu mappa un QuotaId parente (UUID) è una Chiave di quota unica (per esempiu, mittente o utilizatore) à un quotaId specificu.
Una quota hè stabilita secondu u vostru supportu lucale, u vostru gestore di contu assignatu o per difettu s'ellu ùn hè specificatu nunda.
5.2 Statutu 106 – Quota superata
Un missaghju SMS pò esse bluccatu cù u codice di statutu 106 ("quota superata") quandu:
- U missaghju supera u limite definitu per u so quotaId currispundente in l'intervallu attuale.
- U paese o a regione di destinazione ùn hà micca quota assignata (vale à dì, hè bluccatu esplicitamente cù una mappatura di quota nulla in u prugramma).file).
- Ùn ci hè micca quota currispundente è nisuna quota predefinita hè definita, ciò chì risulta in un rifiutu.
In questi casi, u sistema impedisce l'ulteriore trasfurmazione di i missaghji per applicà i limiti basati nantu à u cliente o a destinazione è evità l'usu impropriu.
Rapportu di consegna
Solu nimu o consegna finale cù u risultatu successu / fallimentu sò supportati.
Formatu nantu à u rapportu di consegna: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx data di fattu: aaMMddHHmm stat:
Valori dispunibuli in statu:
- DELIVRD
- scadutu
- REJECTD
- UNELIV
- Sguassatu
6.1 Formatu di rapportu di consegna allargata
L'infurmazione estesa in i rapporti di consegna pò esse dumandata in cuntattu cù u vostru rappresentante di vendita.
Furmatu di u rapportu di consegna: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 data di presentazione:
aaMMddHHmm data di fine: aaMMddHHmm stat: sbaglià: testu:
Valori dispunibuli in statu:
- DELIVRD
- scadutu
- REJECTD
- UNELIV
- Sguassatu
I campi "sub" è "dlvrd" seranu sempre stabilitu à 000, è u campu "text" serà sempre viotu.
Vede u capitulu Codici d'errore per i valori per u campu "err".
Versioni TLS supportate
TLS 1.2 o TLS 1.3 hè necessariu per tutte e cunnessione TLS nantu à SMPP.
U supportu per TLS 1.0 è 1.1 hè interdettu da u 2020-11-15. E versioni 1.0 è 1.1 di TLS sò protokolli più antichi chì sò stati deprecati è sò cunsiderati cum'è risichi di sicurezza in a cumunità Internet.
LINK ricumandemu fermamente d'utilizà TLS se e cunnessione SMPP non criptate sò aduprate oghje. E cunnessioni SMPP non criptate sò obsolete da u 2020-09-01 da LINK, è seranu eliminate in u futuru. A data per a rimozione di e cunnessione non criptate ùn hè ancu decisa.
A cunnessione versu u servitore SMPP per TLS hè in u portu 3601 invece di micca criptatu à u portu 3600.
Pudete ancu aduprà TLS ancu se a vostra implementazione SMPP ùn sustene micca TLS cù stunnel, vede https://www.stunnel.org/
Codici d'errore
I seguenti codici d'errore ponu esse risposti in u campu err se u campu hè attivatu.
| Codice di errore | Descrizzione |
| 0 | Errore scunnisciutu |
| 1 | Errore di routing tempurale |
| 2 | Errore di routing permanente |
| 3 | U throttling massimu superatu |
| 4 | Pausa |
| 5 | Errore di l'operatore scunnisciutu |
| 6 | Errore di l'operatore |
| 100 | U serviziu ùn hè micca truvatu |
| 101 | L'utilizatore ùn hè micca truvatu |
| 102 | Cuntu micca trovu |
| 103 | Password invalida |
| 104 | Errore di cunfigurazione |
| 105 | Errore internu |
| 106 | Quota superata |
| 200 | OK |
| 1000 | Mandatu |
| 1001 | Cunsegnatu |
| 1002 | Scadutu |
| 1003 | Sguassatu |
| 1004 | Mobile pienu |
| 1005 | In fila |
| 1006 | Ùn hè micca mandatu |
| 1007 | Consegna, carica ritardata |
| 1008 | Charged, missaghju micca mandatu |
| 1009 | Incaricatu, missaghju micca mandatu |
| 1010 | Scadutu, assenza di rapportu di consegna di l'operatore |
| 1011 | Charged, missaghju mandatu (à l'operatore) |
| 1012 | In fila remota |
| 1013 | Missaghju mandatu à l'operatore, carica ritardata |
| 2000 | Numeru fonte invalidu |
| 2001 | U numeru curtu ùn hè micca supportatu cum'è fonte |
| 2002 | Alpha ùn hè micca supportatu cum'è fonte |
| 2003 | MSISDN ùn hè micca supportatu cum'è numeru fonte |
| 2100 | U numeru curtu ùn hè micca supportatu cum'è destinazione |
| 2101 | Alpha ùn hè micca supportatu cum'è destinazione |
| 2102 | MSISDN ùn hè micca supportatu cum'è destinazione |
| 2103 | Operazione bluccata |
| 2104 | Abbonatu scunnisciutu |
| 2105 | A destinazione bluccata |
| 2106 | Errore di numeru |
| 2107 | Destinazione bluccata temporaneamente |
| 2108 | Destinazione invalida |
| 2200 | Errore di carica |
| 2201 | L'abbonatu hà un equilibriu bassu |
|
2202 |
Abbonatu pruibitu per sovraccaricu (premium)
missaghji |
|
2203 |
Abbonatu troppu ghjovanu (per questu particulare
cuntenutu) |
| 2204 | Abbonatu prepaid ùn hè micca permessu |
| 2205 | U serviziu rifiutatu da l'abbonatu |
| 2206 | L'abbonatu ùn hè micca registratu in u sistema di pagamentu |
| 2207 | L'abbonatu hà righjuntu u massimu equilibriu |
| 2208 | A cunferma di l'utilizatore finale hè necessaria |
| 2300 | Rimbursatu |
|
2301 |
Ùn hè statu pussibule rimbursà per via di cose illegali o mancanti
MSISDN |
| 2302 | Ùn si pò micca rimbursà per via di missing messageId |
| 2303 | In fila per u rimborsu |
| 2304 | Timeout di rimborsu |
| 2305 | fallimentu di rimborsu |
| 3000 | A codificazione GSM ùn hè micca supportata |
| 3001 | A codificazione UCS2 ùn hè micca supportata |
| 3002 | A codificazione binaria ùn hè micca supportata |
| 4000 | U rapportu di consegna ùn hè micca supportatu |
| 4001 | Cuntenutu di missaghju invalidu |
| 4002 | Tariffa invalida |
| 4003 | Dati d'utilizatore invalidi |
| 4004 | Intestazione di dati d'utilizatore invalida |
| 4005 | Codificazione di dati invalida |
| 4006 | TVA non valide |
| 4007 | Cuntinutu micca supportatu per destinazione |
Documenti / Risorse
 |
link mobility SMS API,SMPP API MS Scheduler API [pdfGuida di l'utente SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |