SMS API, SMPP API MS Scheduler API
Кіраўніцтва карыстальніка
SMS API, SMPP API MS Scheduler API
| Зменена: | 6г |
| Версія: | 1.7 |
| Аўтар: | Кені Каландер Нордэн, KCN |
Гэты дакумент прызначаны толькі для пазначанага атрымальніка і можа ўтрымліваць прывілеяваную, канфідэнцыяльную ці іншую прыватную інфармацыю. Калі вы атрымалі яго памылкова, неадкладна паведаміце пра гэта адпраўніку і выдаліце арыгінал. Любое іншае выкарыстанне вамі дакумента забаронена.
Гісторыя змяненняў
| Рэв | Дата | By | Змены ў параўнанні з папярэднім выпускам |
| 1.0 | 2010-03-16 | KCN | Створана |
| 1. | 2019-06-11 | TPE | Абноўлены лагатыпы LINK |
| 1. | 2019-09-27 | PNI | Дададзена спасылка на спецыфікацыю SMPP 3.4 |
| 1. | 2019-10-31 | EP | Заўвага аб тэрміне дзеяння tag |
| 1. | 2020-08-28 | KCN | Дададзена інфармацыя аб падтрымоўваных версіях TLS |
| 2. | 2022-01-10 | KCN | Дададзена дадатковая інфармацыя адносна справаздач аб дастаўцы Абноўленая інфармацыя адносна TLS 1.3 |
| 2. | 2025-06-03 | GM | Дададзены код выніку 2108 |
| 2. | 2025-06-24 | AK | Дададзеная квота |
Уводзіны
LINK Mobility з'яўляецца дыстрыбутарам SMS з 2001 года і мае вялікі вопыт працы як з аператарамі, так і з агрэгатарамі злучэнняў. Гэтая платформа прызначана для апрацоўкі вялікіх аб'ёмаў трафіку, падтрымання высокай даступнасці і палягчэння маршрутызацыі трафіку праз некалькі злучэнняў.
У гэтым дакуменце апісваецца інтэрфейс SMPP да платформы SMSC, а таксама неабходныя параметры і каманды, а таксама падтрымліваюцца параметры.
У гэтым дакуменце не разглядаюцца канкрэтныя выпадкі выкарыстання, такія як аб'яднаныя паведамленні, WAPpush, Flash SMS і г.д. Больш падрабязную інфармацыю пра гэтыя выпадкі можна атрымаць, звярнуўшыся ў службу падтрымкі.
Падтрымліваюцца каманды
СПАСЫЛКА Сервер Mobility павінен разглядацца як SMPP 3.4. Афіцыйную спецыфікацыю можна знайсці па адрасе https://smpp.org/SMPP_v3_4_Issue1_2.pdf.
Усе метады не падтрымліваюцца, і ўсе адрозненні пазначаны ніжэй.
4.1 Звязаць
Падтрымліваюцца наступныя каманды прывязкі.
- Перадатчык
- трансівер
- Прыёмнік
Абавязковыя параметры:
- system_id – атрыманы ад службы падтрымкі
- пароль – атрыманы ў падтрымцы
Дадатковыя параметры:
- addr_ton – значэнне па змаўчанні, калі TON усталяваны ў Невядомы падчас адпраўкі.
- addr_npi – значэнне па змаўчанні, калі NPI усталяваны ў Невядомы падчас адпраўкі.
Параметры, якія не падтрымліваюцца:
- дыяпазон_адрасоў
4.2 Развязаць
Падтрымліваецца каманда unbind.
4.3 Спасылка на запыт
Каманда inquire link падтрымліваецца і яе трэба выклікаць кожныя 60 секунд.
4.4 Адправіць
Для дастаўкі паведамленняў трэба выкарыстоўваць метад адпраўкі.
Абавязковыя параметры:
- зыходны_адрас_тон
- крыніца_addr_npi
- крыніца_адрас
- адрас_прызначэння
- dest_addr_npi
- адрас_прызначэння
- esm_клас
- кадзіраванне даных
- см_даўжыня
- кароткае_паведамленне
Параметры, якія не падтрымліваюцца:
- тып_службы
- ідэнтыфікатар_пратаколу
- сцяг_прыярытэту
- расклад_час_дастаўкі
- замяніць_калі_прысутнічае_сцяг
- sm_default_msg_id
Заўвага што карысная нагрузка tag не падтрымліваецца, і толькі адно SMS можа быць дастаўлена за выклік, і рэкамендуецца выкарыстоўваць validity_period tag мае значэнне як мінімум 15 хвілін.
4.4.1 Рэкамендуемыя TON і NPI
Пры адпраўцы паведамленняў з дапамогай каманды адпраўкі варта выкарыстоўваць наступныя TON і NPI.
4.4.1.1 Крыніца
Для зыходнага адраса падтрымліваюцца наступныя камбінацыі TON і NPI. Усе астатнія камбінацыі будуць лічыцца няправільнымі. Калі TON мае значэнне Невядома (0), будзе выкарыстоўвацца каманда TON з прывязкі па змаўчанні. Калі NPI мае значэнне Невядома (0), будзе выкарыстоўвацца каманда NPI з прывязкі па змаўчанні.
| ТОНА | НПІ | Апісанне |
| Літарна-лічбавы (5) | Невядома (0) ISDN (1) |
Будзе разглядацца як літарна-лічбавы тэкст адпраўніка |
| Міжнародны (1) | Невядома (0) ISDN (1) |
Будзе разглядацца як MSISDN |
| Нацыянальны (2) Спецыфічны для сеткі (3) Нумар абанента (4) Скарочаны (6) |
Невядома (0) ISDN (1) Нацыянальны (8) |
Будзе разглядацца як кароткі нумар краіны. |
4.4.1.2 Пункт прызначэння
Для адраса прызначэння падтрымліваюцца наступныя камбінацыі TON і NPI. Усе іншыя камбінацыі будуць разглядацца як несапраўдныя. Калі для TON усталявана значэнне Unknown (0), будзе выкарыстоўвацца стандартная каманда TON з прывязкі. Будзе выкарыстоўвацца NPI па змаўчанні з каманды bind, калі NPI усталяваны ў Невядомы (0).
| ТОНА | НПІ | Апісанне |
| Міжнародны (1) | Невядома (0) ISDN (1) |
Будзе разглядацца як MSISDN |
4.4.2 Кадыроўкі, якія падтрымліваюцца
Падтрымліваюцца наступныя кадоўкі. X можа ўтрымліваць любое значэнне.
| DCS | Кадзіроўка |
| 0xX0 | Алфавіт GSM па змаўчанні з пашырэннем |
| 0xX2 | 8-бітны двайковы файл |
| 0xX8 | UCS2 (ISO-10646-UCS-2) |
Квота
5.1 Квота перавышанаview
Квота вызначае максімальную колькасць SMS-паведамленняў, якія можна адправіць на працягу пэўнага прамежку часу (напрыклад, за дзень, тыдзень, месяц або бясконца). Кожная квота мае унікальны ідэнтыфікатар quotaId (UUID) і скідаецца ў залежнасці ад гадзіннага пояса кліента. Квоты можна прызначаць на ўзроўні краіны, рэгіёна або па змаўчанні праз Quota Pro.fileКвоту таксама можна дынамічна прызначаць з дапамогай Quota Mapping. Гэта прыводзіць да супастаўлення бацькоўскага QuotaId (UUID) і ўнікальнай квоты Key (напрыклад, адпраўніка або карыстальніка) з пэўным quotaId.
Квота ўстанаўліваецца ў адпаведнасці з вашай мясцовай службай падтрымкі, прызначаным вам мэнэджарам па ўліковым запісе або па змаўчанні, калі нічога не пазначана.
5.2 Статус 106 – Квота перавышана
SMS-паведамленне можа быць заблакавана з кодам стану 106 («квота перавышана»), калі:
- Паведамленне перавышае вызначаны ліміт для адпаведнага quotaId у бягучым інтэрвале.
- Краіна або рэгіён прызначэння не маюць прызначанай квоты (г.зн. відавочна заблакіраваны з нулявым адлюстраваннем квоты ў праграмеfile).
- Няма адпаведнай квоты і не вызначана квота па змаўчанні, што прыводзіць да адхілення.
У такіх выпадках сістэма прадухіляе далейшую апрацоўку паведамленняў, каб забяспечыць выкананне абмежаванняў, звязаных з кліентам або пунктам прызначэння, і пазбегнуць злоўжыванняў.
Справаздачу аб дастаўцы
Падтрымліваецца толькі адсутнасць або канчатковая дастаўка з паспяховым/няўдалым вынікам.
Фармат справаздачы аб дастаўцы: ідэнтыфікатар: ххххххххххххххххххххххххх дата выканання: ггММДдЧЧхмм статыстыка:
Даступныя значэнні ў статусе:
- ДЭЛІВРД
- ТЭРМІН ТЭРМІНУ МІНУЎСЯ
- АДМОЎЛЕНЫ
- НЕДАЖЫВАЦЬ
- ВЫДАЛЕНА
6.1 Пашыраны фармат справаздачы аб дастаўцы
Пашыраную інфармацыю ў справаздачах аб дастаўцы можна запытаць, звязаўшыся з вашым гандлёвым прадстаўніком.
Фармат справаздачы аб дастаўцы: id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx sub:000 dlvrd:000 дата адпраўкі:
ггММддГГхм дата выканання: ггММддГГхм статыстыка: памылка: тэкст:
Даступныя значэнні ў статусе:
- ДЭЛІВРД
- ТЭРМІН ТЭРМІНУ МІНУЎСЯ
- АДМОЎЛЕНЫ
- НЕДАЖЫВАЦЬ
- ВЫДАЛЕНА
Палі «sub» і «dlvrd» заўсёды будуць мець значэнне 000, а поле «text» заўсёды будзе пустым.
Значэнні для поля «памылка» глядзіце ў раздзеле «Коды памылак».
Падтрымліваюцца версіі TLS
Для ўсіх злучэнняў TLS праз SMPP патрабуецца TLS 1.2 або TLS 1.3.
Падтрымка TLS 1.0 і 1.1 спынена з 2020 лістапада 11 г. Версіі 15 і 1.0 TLS - гэта старыя пратаколы, якія састарэлі і лічацца рызыкай бяспекі ў інтэрнэт-супольнасці.
LINK настойліва рэкамендуе выкарыстоўваць TLS, калі сёння выкарыстоўваюцца незашыфраваныя злучэнні SMPP. Незашыфраваныя SMPP-злучэнні састарэлі з 2020 па LINK і будуць выдалены ў будучыні. Дата выдалення незашыфраваных злучэнняў яшчэ не вызначана.
Падключэнне да сервера SMPP для TLS ажыццяўляецца праз порт 3601 замест незашыфраванага порта 3600.
Вы ўсё яшчэ можаце выкарыстоўваць TLS, нават калі ваша рэалізацыя SMPP не падтрымлівае TLS з выкарыстаннем stunnel, гл https://www.stunnel.org/
Коды памылак
Наступныя коды памылак могуць быць уведзены ў поле err, калі поле ўключана.
| Код памылкі | Апісанне |
| 0 | Невядомая памылка |
| 1 | Часовая памылка маршрутызацыі |
| 2 | Пастаянная памылка маршрутызацыі |
| 3 | Перавышана максімальнае рэгуляванне |
| 4 | Тайм-аўт |
| 5 | Невядомая памылка аператара |
| 6 | Памылка аператара |
| 100 | Служба не знойдзена |
| 101 | Карыстальнік не знойдзены |
| 102 | Уліковы запіс не знойдзены |
| 103 | Няправільны пароль |
| 104 | Памылка канфігурацыі |
| 105 | Унутраная памылка |
| 106 | Квота перавышана |
| 200 | OK |
| 1000 | Адпраўлена |
| 1001 | Дастаўлены |
| 1002 | Пратэрмінаваны |
| 1003 | Выдалены |
| 1004 | Мабільны поўны |
| 1005 | У чарзе |
| 1006 | Не дастаўлены |
| 1007 | Дастаўлена, плата адкладзена |
| 1008 | Спагнана, паведамленне не адпраўлена |
| 1009 | Спагнана, паведамленне не дастаўлена |
| 1010 | Пратэрмінаваны, адсутнасць справаздачы аб дастаўцы ад аператара |
| 1011 | Спагнана, паведамленне адпраўлена (аператару) |
| 1012 | Дыстанцыйна ў чарзе |
| 1013 | Паведамленне адпраўлена аператару, плата затрымліваецца |
| 2000 | Няправільны нумар крыніцы |
| 2001 | Кароткі нумар не падтрымліваецца ў якасці крыніцы |
| 2002 | Альфа-версія не падтрымліваецца ў якасці крыніцы |
| 2003 | MSISDN не падтрымліваецца ў якасці зыходнага нумара |
| 2100 | Кароткі нумар не падтрымліваецца ў якасці пункта прызначэння |
| 2101 | Альфа не падтрымліваецца ў якасці прызначэння |
| 2102 | MSISDN не падтрымліваецца ў якасці прызначэння |
| 2103 | Аперацыя заблакіравана |
| 2104 | Невядомы падпісчык |
| 2105 | Пункт прызначэння заблакіраваны |
| 2106 | Памылка нумара |
| 2107 | Пункт прызначэння часова заблакіраваны |
| 2108 | Няправільны пункт прызначэння |
| 2200 | Памылка зарадкі |
| 2201 | У абанента нізкі баланс |
|
2202 |
Абаненту заблакіравана за пераплату (прэміум)
паведамленні |
|
2203 |
Падпісчык занадта малады (для гэтага канкрэтнага
змест) |
| 2204 | Абанент з папярэдняй аплатай не дапускаецца |
| 2205 | Паслуга адхілена абанентам |
| 2206 | Абанент не зарэгістраваны ў плацежнай сістэме |
| 2207 | Абанент дасягнуў максімальнага балансу |
| 2208 | Патрабуецца пацвярджэнне канчатковага карыстальніка |
| 2300 | Грошы вернуты |
|
2301 |
Не ўдалося вярнуць грошы з-за незаконнага або адсутнага
MSISDN |
| 2302 | Немагчыма вярнуць грошы з-за адсутнасці messageId |
| 2303 | У чарзе на вяртанне грошай |
| 2304 | Час чакання вяртання сродкаў |
| 2305 | Збой вяртання сродкаў |
| 3000 | Кадзіроўка GSM не падтрымліваецца |
| 3001 | Кадзіроўка UCS2 не падтрымліваецца |
| 3002 | Двайковае кадзіраванне не падтрымліваецца |
| 4000 | Справаздача аб дастаўцы не падтрымліваецца |
| 4001 | Няправільны змест паведамлення |
| 4002 | Няправільны тарыф |
| 4003 | Няправільныя дадзеныя карыстальніка |
| 4004 | Няправільны загаловак дадзеных карыстальніка |
| 4005 | Няправільнае кадзіраванне даных |
| 4006 | Несапраўдны ПДВ |
| 4007 | Непадтрымоўваны кантэнт для прызначэння |
Дакументы / Рэсурсы
 |
Link Mobility SMS API, SMPP API MS Scheduler API [pdfКіраўніцтва карыстальніка SMS API SMPP API MS Scheduler API, SMS API SMPP API, MS Scheduler API, Scheduler API, API |