LINK Mobility іске асыру нұсқаулығы REST API SMS
LINK Mobility хабарды жеткізуге, микро төлемдерге және орынға негізделген қызметтерге арналған қызметті ұсынады. Платформа Сервис провайдерлері мен Операторлар арасындағы мөлдір, ақ белгі мазмұнды эквайер және транзакция маршрутизаторы ретінде әрекет етеді.
LINK Mobility SMS жіберу сияқты LINK Mobility қызметтеріне қол жеткізу үшін пайдаланылатын RESTful API ұсынады. Бұл API пайдалану оңай және барлық заманауи тілдермен және фреймворктермен үйлесімді болу үшін жасалған. Сіз таңдаған тілді пайдалана отырып, қолданба қуатты хабар алмасу және төлем мүмкіндіктерін іске асыру үшін Link Mobility REST API пайдалана алады.
© LINK Mobility, 10 жылғы 2021 наурыз
Құқықтық ақпарат
Осы құжатта берілген ақпарат Netsize компаниясының жалғыз меншігі және авторлық құқығы болып табылады. Ол құпия болып табылады және қатаң ақпараттық пайдалануға арналған. Ол міндетті емес және ескертусіз өзгертілуі мүмкін. Кез келген рұқсат етілмеген ашу немесе пайдалану заңсыз болып саналады.
Netsize™ және linkmobility™ француз, ЕЭК және халықаралық зияткерлік меншік заңдарымен қорғалған.
Келтірілген барлық басқа сауда белгілері олардың тиісті иелерінің жалғыз меншігі болып табылады.
Мұнда қамтылған ештеңе Netsize патенті, авторлық құқық немесе сауда белгісі бойынша қандай да бір лицензияны немесе құқықты беру ретінде түсіндірілмеуі керек.
NETSIZE
5 478 070 еуроның астаналық қоғамы
Қоршау әлеуметтік: 62, Эмиль Зола даңғылы92100 Булон – Франция
418 712 477 RCS Nanterre
http://www.LinkMobility.com
http://www.linkmobility.com
Құжаттың қолданылу аясы
Бұл құжат Қызмет провайдерінің SMS үшін LINK Mobility REST API интерфейсін қалай пайдаланатынын сипаттайды. Ол Қызмет көрсетушінің қызметтерін жүзеге асыратын техникалық сәулетшілер мен дизайнерлерге арналған.
1. Негізгі қолдану
SMS жіберу өте оңай. Сіз LINK Mobility қызметіне HTTP сұрауын жібересіз, оны тек a арқылы орындауға болады web браузер.
2. Функционалдық аяқталдыview
LINK Mobility жүйесі SMS хабарламалары үшін келесі негізгі функцияларды қамтамасыз етеді:
Мәтіндік немесе екілік (мысалы, WAP Push) премиум және стандартты тарифтік хабарлар сияқты мобильді тоқтатылған (MT) SMS хабарламаларын жіберу.
Жіберілген МТ хабарламаларын жеткізу есептерін алу.
Mobile Originated (MO) SMS хабарламаларын, премиум және стандартты тарифті алу.
SMS REST API стандартты MT SMS хабарламаларын жіберуге арналған.
API барлық SMS хабарламаларын асинхронды түрде жіберіп, келесі мүмкіндіктерді қосады:
«Өрт және ұмыт» – Қызмет провайдері болжамды жауап беру уақытына ие болғысы келеді және Оператордан нәтиже күткісі келмейді.
Қайталау мүмкіндігі – Операторда уақытша ақаулықтар болса, LINK Mobility хабарды қайта жібереді.
2.1 SMS хабарлама жіберу
Қызмет провайдері Netsize Consumer
- MT хабарламасын жіберіңіз
- Хабарлама идентификаторын қайтару
- SMS хабарлама жіберіңіз
- Жеткізу туралы есеп беру
- Жеткізу есебін жіберу
SMS хабарламаларын жіберудің негізгі ағыны келесідей сипатталған:
Қызмет провайдері LINK Mobility жүйесі арқылы алушыға SMS хабарлама жіберуге сұраныс жасайды.
Хабарлама идентификаторы қызмет провайдеріне қайтарылады. Бұл идентификаторды хабарды дұрыс жеткізу есебімен салыстыру үшін пайдалануға болады.
LINK Mobility маршруттауды өңдейді және адрестелген Тұтынушыға SMS хабарламасын жеткізеді.
Жеткізу есебі іске қосылады, мысалы, SMS хабарлама тұтынушының құрылғысына жеткізілгенде.
Жеткізу туралы есеп Қызмет көрсетушіге жіберіледі. Есепте 2-қадамда қайтарылған бірдей хабар идентификаторы бар.
Балама ағын: жарамсыз сұрау
Сұраудағы берілген параметрлер немесе пайдаланушы тіркелгі деректері жарамсыз болса, қате Қызмет провайдеріне қайтарылады. Қате бас тарту себебін көрсетеді және ағын аяқталады. Хабарлама идентификаторлары қайтарылмайды.
3. Соңғы нүкте
SMS ресурсына келесі жол арқылы қол жеткізіледі:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
Қосылым қауіпсіздігі үшін LINK Mobility REST API протоколы HTTPS арқылы ғана қолжетімді.
Link Mobility сервер сертификатына Thawte Server CA қол қойған.
4. Операциялар
SMS қызметі келесі операцияларды қамтамасыз етеді:
| Аты | Жол |
| Жіберу | /restapi/v1/sms/send |
4.1 Жіберу
Жіберу операциясы бір алушыға SMS жіберу үшін қолданылады.
Бұл операция негізгі және қосымша пайдаланушыларға арналған. Ең қарапайым жағдайда SMS жеткізу үшін тек тағайындалған мекенжай және хабарлама мәтіні қажет. LINK Mobility деректерді кодтау схемасын анықтайды және қажет болған жағдайда хабарламаны бірнеше хабарлама бөліктеріне автоматты түрде біріктіруді орындайды.
Жетілдірілген пайдалану үшін Қызмет провайдері пайдаланушы деректерінің тақырыбын қоса, хабарлама пішімдеуін жалпы бақылау үшін қосымша параметрлерді пайдалана алады.
Қызмет провайдері біріктірілген хабарламаларды жібере алады, бірақ пайдаланушы деректері мен пайдаланушы деректерінің тақырыбын дайындауды Қызмет провайдері орындауы керек және хабарды LINK Mobility бағытына бірнеше жіберу сұраулары арқылы жіберу керек.
5. Аутентификация
Пайдаланушы аты мен құпия сөз HTTP негізгі аутентификация схемасы арқылы әрбір сұрауда жіберіледі.
https://www.w3.org/Protocols/HTTP/1.0/spec.html#BasicAA
Тіркелгі деректері HTTP сұрауындағы Авторизация тақырыбына жіберіледі. Клиент тақырып өрісін мына жерде сипатталғандай жасайды:
https://en.wikipedia.org/wiki/Basic_access_authentication#Client_side
Мысалыample, егер пайдаланушы аты john болса және changeme - құпия сөз болса, нәтижесінде авторизация тақырыбы:
Авторизация: Негізгі am9objpjaGFuZ2VtZSA=
Пайдаланушы аты мен құпия сөзді кері қайтару ретінде сұрау параметрлері ретінде жіберуге болады. Бұл тек негізгі аутентификацияны қолдамайтын клиенттер үшін ұсынылады.
6. Сұраныс жіберу
6.1 Сұрау жолы
Сұрау параметрлері атау/мән жұптарын қамтитын сұрау жолы ретінде жіберіледі. Сұрау жолы Пайыздық кодтау арқылы кодталған (URL кодтау).
http://www.w3schools.com/tags/ref_urlencode.asp
Мысалыample, Сәлем әлем! Hello+World% 21 ретінде кодталған.
6.2 Сұраныстың міндетті параметрлері
| Аты | Максималды ұзындық | Сипаттама |
| destination Address | 40 | Ел кодынан бастап SMS хабарлама жіберілетін MSISDN. Мысалыampле: 46123456789. Кейбір нарықтар үшін (Тұтынушы MSISDN анық емес болуы керек) бұл мән «#» префиксі бар әріптік-сандық бүркеншік ат болуы мүмкін. |
| хабарлама мәтіні | 1600 | SMS хабарламасының мазмұны. |
6.3 Қосымша сұрау параметрлері (қосымша пайдалану үшін)
| Аты | Максималды ұзындық | Сипаттама |
| бастапқы мекенжай | 16 | Шығыс SMS хабарламасының бастапқы мекенжайы. Бастапқы мекенжай түрі originalatorTON параметрімен анықталады. Қысқа санның максималды ұзындығы - 16. Альфа-сандық жіберуші ұзындығы 11 таңбадан тұратын GSM әдепкі әліпбиімен шектеледі. MSISDN жіберушінің максималды ұзындығы - 15 (destinationAddress элементімен бірдей пішімді пайдалану). OriginatingAddress және originatingTON жүйе арқылы таңдалған кезде өткізіп жіберуге болады. Бұл функция нарыққа және конфигурацияға байланысты. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| оригинаторТОН | 1 | Бастапқы мекенжайдың нөмір түрі (TON): 0 – қысқа сан 1 – альфа-сандық (макс. ұзындығы 11) 2 – MSISDN OriginatingAddress және originatingTON жүйесі жүйе таңдаған кезде өткізіп жіберуге болады. Бұл функция нарыққа және конфигурацияға байланысты. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| userDataHeader | 280 | Пайдаланушы деректерінің тақырыбы Пайдаланушы деректерімен бірге 140-қа дейін, яғни алтылық кодталғанда 280-ге дейін, октеттерді қамтуы мүмкін. Бұл параметр әрқашан он алтылық кодталады. |
| DCS | 3 | Мәліметтерді кодтау схемасы. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| PID | 3 | Протокол идентификаторы. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| салыстырмалыValidityTime | 6 | Салыстырмалы жарамдылық уақыты секундтармен (LINK Mobility жіберу уақытына қатысты). Максималды мән 604800 (7 күн) және әдепкі 48 сағат. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| жеткізу уақыты | 20 | Уақытamp SMS хабарлама қашан жеткізілуі керек (кешіктірілген жеткізу уақыты). Күн-уақыт пішімі бөлімін қараңыз. |
| statusReportFlags | 1 | Есеп сұрауын жеткізу: 0 – Жеткізу есебі жоқ (әдепкі) 1 – Жеткізу туралы есеп сұралды 9 – Серверді жеткізу есебі сұралды (LINK Mobility есепті қызмет провайдеріне жібермейді, бірақ оны есептерде қолжетімді етеді, т.б.) |
| campaignName | 50 | LINK Mobility транзакциялары болып табылады tagосы атпен гед. Ол Link Mobility есептеріндегі транзакцияларды топтау үшін пайдаланылады. |
| maxConcatenatedMessages | 1 | 1 мен 10 арасындағы мән, қанша біріктірілген хабарларға рұқсат етілгенін анықтайды. Әдепкі 3. |
| корреляция идентификаторы | 100 | Жеткізу есебінде қайталанатын қызмет провайдері берген идентификатор. |
| пайдаланушы аты | 100 | HTTP негізгі аутентификациясына балама ретінде берілген. |
| құпия сөз | 100 | HTTP негізгі аутентификациясына балама ретінде берілген. |
6.4 HTTP сұрау әдістері
Максималды өзара әрекеттесу үшін API HTTP GET және POST сұрау әдістерін қолдайды. Басқа HTTP әдістеріне рұқсат етілмейді.
6.4.1 АЛУ
Кодталған сұрау жолы келесіге қосылады URL.
АЛУ
https://europe.ipx.com/restapi/v1/sms/send?destinationAddress=461234
56789&messageText=Сәлем+Әлем%21
Авторизация: Негізгі am9objpjaGFuZ2VtZSA=
6.4.2 POST
Кодталған сұрау жолы HTTP сұрау хабарының мәтінінде жіберіледі. Мазмұн түрі қолданба/x-www-form-urlкодталған.
POST https://europe.ipx.com/restapi/v1/sms/send
Хост: europe.ipx.com
Мазмұн түрі: қосымша / х-www-форма-urlкодталған
Авторизация: Негізгі am9objpjaGFuZ2VtZSA=
Мазмұн ұзындығы: 57
destinationAddress=46123456789&messageText=Hello+World%21
6.5 Күні мен уақыты
Күн мен уақытты білдіретін REST API параметрлері әрқашан UTC уақыт белдеуінде (Үйлестірілген әмбебап уақыт) болады. Уақытamps дәл осы пішіммен жол ретінде ұсынылған:
2017-04-25T23:20:50Z
Бұл UTC бойынша 20 жылдың 50 сәуіріндегі 23 сағаттан кейінгі 25 минут 2017 секундты білдіреді.
7. Жауап хабары
Сұрау хабарын қабылдап, түсінгеннен кейін API HTTP жауап хабарымен жауап береді.
7.1 HTTP күй коды
REST API әрқашан өңделген сұраулар үшін HTTP күй кодын 200 OK қайтарады. Хабарламада нақты нәтижені анықтау үшін пайдаланылатын жауап коды параметрі бар.
7.2 Хабардың негізгі бөлігі
Хабарлама мәтіні сұраудың нәтижесін сипаттайтын JSON файлынан тұрады.
http://json.org/
Link Mobility JSON Google JSON мәнері нұсқаулығына сәйкес келеді.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Жауап параметрлері
| Аты | Максималды ұзындық | Сипаттама |
| жауап коды | 3 | 0 сәтті транзакцияны көрсетеді. |
| жауап хабары | 255 | Жауаптың мәтіндік сипаттамасы, мысалы, қате мәтіні. |
| уақытamp | 20 | LINK Mobility сұрауды өңдеген күн мен уақыт. (Күн/уақыт пішімі бөлімін қараңыз). |
| traceId | 36 | Link Mobility ішкі идентификаторы. Қолдау және ақаулықтарды жою үшін пайдаланылады. |
| хабарлама идентификаторлары | 10 x 36 | Әрбір сәтті хабар үшін LINK Mobility бірегей хабар идентификаторларының массиві (хабар біріктірілген болса, бірнеше хабар идентификаторлары қайтарылады). Сәтсіздік жағдайында қабылданбайды. |
7.4 Мысampжауаптар
Сәттілік
HTTP/1.1 200 Жарайды
Мазмұн түрі: application/json
Мазмұн ұзындығы: 144
Күні: 15 қыркүйек 2016 ж. 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Сәттілік”,”уақытamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Міне оқылу үшін пішімделген бірдей JSON:
{
“жауап коды«:0,
“жауап хабары«:» Сәттілік»,
“уақытamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“хабарлама идентификаторлары“:[“1-4850879008”] }
Сәтсіздік
HTTP/1.1 200 Жарайды
Мазмұн түрі: application/json
Мазмұн ұзындығы: 148
Күні: 15 қыркүйек 2016 ж. 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Жарамсыз кіру немесе рұқсат етілмеген API пайдалану”,”timeestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Сәттілік
HTTP/1.1 200 Жарайды
Мазмұн түрі: application/json
Мазмұн ұзындығы: 144
Күні: 15 қыркүйек 2016 ж. 13:20:31 GMT
{“responseCode”:0,”responseMessage”:”Сәттілік”,”уақытamp”:”2016-09-15T13:20:31Z”, “traceId”:”f678d30879fd4adc25f2″,”messageIds”:[“1-4850879008”]}
Міне оқылу үшін пішімделген бірдей JSON:
{
“жауап коды«:0,
“жауап хабары«:» Сәттілік»,
“уақытamp“:”2016-0915T13:20:31Z”,
“traceId“:”f678d30879fd4adc25f2”,
“хабарлама идентификаторлары“:[“1-4850879008”] }
Сәтсіздік
HTTP/1.1 200 Жарайды
Мазмұн түрі: application/json
Мазмұн ұзындығы: 148
Күні: 15 қыркүйек 2016 ж. 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Жарамсыз кіру немесе рұқсат етілмеген API пайдалану”,”timeestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
7.5 Жауап кодтары
Жіберу жауабында келесі жауап кодтарын қайтаруға болады:
| Код | Мәтін | Сипаттама |
| 0 | Сәттілік | Сәтті орындалды. |
| 1 | Жарамсыз кіру немесе рұқсат етілмеген API пайдалану | Қате пайдаланушы аты немесе құпия сөз немесе Қызмет провайдеріне LINK Mobility тыйым салған. |
| 2 | Тұтынушы Link Mobility арқылы бұғатталған | Тұтынушы LINK Mobility арқылы бұғатталған. |
| 3 | Операция LINK Mobility арқылы қамтамасыз етілмейді | Қызмет провайдері үшін операция бұғатталған. |
| 4 | Тұтынушы LINK Mobility үшін белгісіз | Тұтынушы LINK Mobility үшін белгісіз. Немесе сұрауда бүркеншік ат қолданылған болса; бүркеншік ат табылмады. |
| 5 | Тұтынушы бұл қызметті LINK Mobility қолданбасында бұғаттады | Тұтынушы бұл қызметті LINK Mobility қолданбасында бұғаттады. |
| 6 | Бастапқы мекенжайға қолдау көрсетілмейді | Бастапқы мекенжайға қолдау көрсетілмейді. |
| 7 | Альфа бастапқы мекенжайы есептік жазбаға қолдау көрсетпейді | Альфа бастапқы мекенжайына тіркелгі қолдау көрсетпейді. |
| 8 | MSISDN бастапқы мекенжайына қолдау көрсетілмейді | MSISDN бастапқы мекенжайына қолдау көрсетілмейді. |
| 9 | GSM кеңейтілгеніне қолдау көрсетілмейді | GSM кеңейтілгеніне қолдау көрсетілмейді. |
| 10 | Юникодқа қолдау көрсетілмейді | Юникодқа қолдау көрсетілмейді. |
| 11 | Күй есебіне қолдау көрсетілмейді | Күй есебіне қолдау көрсетілмейді. |
| 12 | Қажетті мүмкіндікке қолдау көрсетілмейді | Хабарды жіберу үшін қажетті мүмкіндікке (жоғарыда айтылғандардан басқа) қолдау көрсетілмейді. |
| 13 | Мазмұн провайдерінің максималды шектеу жылдамдығынан асып кетті | Қызмет провайдері LINK Mobility қызметіне SMS хабарламаларын тым жылдам жіберуде. |
| 14 | Протокол идентификаторы тіркелгіге қолдау көрсетпейді | Протокол идентификаторына қолдау көрсетілмейді. |
| 15 | Хабарды біріктіру шегінен асып кетті | Біріктірілген хабарлар саны сұралған максималды саннан асып кетті. |
| 16 | Хабарды бағыттау мүмкін емес. | LINK Mobility хабарды бағыттай алмады. |
| 17 | Тыйым салынған уақыт кезеңі | Уақыт аралығында хабарлама жіберуге рұқсат етілмейді |
| 18 | Қызмет провайдерінің есептік жазбасындағы теңгерім тым төмен | Теңгерім тым төмен болғандықтан қызмет провайдері бұғатталған |
| 50 | Жартылай табыс | Бірнеше алушыға SMS хабарлама жіберу кезінде жартылай сәтті. |
| 99 | Ішкі қате | Басқа Link Mobility қатесі, қосымша ақпарат алу үшін LINK Mobility қолдау қызметіне хабарласыңыз. |
| 100 | Жарамсыз тағайындалған мекенжай | Тағайындалған мекенжай (MSISDN немесе бүркеншік ат) жарамсыз. |
| 102 | Жарамсыз сілтеме (байланыстырылған) идентификатор | Анықтама идентификаторы жарамсыз, мүмкін сілтеме идентификаторы бұрыннан пайдаланылған, тым ескі немесе белгісіз. |
| 103 | Тіркелгі аты жарамсыз | Есептік жазба аты жарамсыз. |
| 105 | Жарамсыз қызмет метадеректері | Қызмет метадеректері жарамсыз. |
| 106 | Бастапқы мекенжай жарамсыз | Бастапқы мекенжай жарамсыз. |
| 107 | Жарамсыз әріптік-сандық бастапқы мекенжай | Әріптік-сандық мекенжай жарамсыз. |
| 108 | Жарамсыз жарамдылық уақыты | Жарамдылық уақыты жарамсыз. |
| 109 | Жарамсыз жеткізу уақыты | Жеткізу уақыты жарамсыз. |
| 110 | Хабарлама мазмұны/пайдаланушы деректері жарамсыз | Пайдаланушы деректері, яғни SMS хабарламасы жарамсыз. |
| 111 | Хабарлама ұзындығы жарамсыз | SMS хабарламасының ұзындығы жарамсыз. |
| 112 | Жарамсыз пайдаланушы деректерінің тақырыбы | Пайдаланушы деректерінің тақырыбы жарамсыз. |
| 113 | Жарамсыз деректерді кодтау схемасы | DCS жарамсыз. |
| 114 | Жарамсыз протокол идентификаторы | PID жарамсыз. |
| 115 | Күй туралы есеп жалаушалары жарамсыз | Күй есебінің жалаушалары жарамсыз. |
| 116 | Жарамсыз TON | Оригинатор TON жарамсыз. |
| 117 | Жарамсыз campаты | сampaign атауы жарамсыз. |
| 120 | Біріктірілген хабарлардың максималды санына шектеу жарамсыз | Біріктірілген хабарлардың ең көп саны жарамсыз. |
| 121 | Жарамсыз msisdn бастапқы мекенжайы | MSISDN бастапқы мекенжайы жарамсыз. |
| 122 | Жарамсыз корреляция идентификаторы | Корреляция идентификаторы жарамсыз. |
8. Қосымша мүмкіндіктер
8.1 MSISDN түзетуі
MSISDN түзетуі сұралған жағдайда LINK Mobility қолдауы арқылы қосуға болатын қосымша мүмкіндік болып табылады.
Бұл мүмкіндік тағайындау мекенжайларын түзетеді және оларды қажетті E.164 пішіміне туралайды. Форматты түзетуден басқа, жүйе қажет болған жағдайда DOM-TOM (départements et territoires d'outre-mer) нөмірлерін түзету үшін халықаралық француз нөмірлерін аудару сияқты нарыққа тән функцияларды орындауы мүмкін.
Төменде бірнеше бұрынғыampтүзетулер:
| Жіберілген тағайындау мекенжайы | Түзетілген тағайындау мекенжайы |
| +46(0)702233445 | 46702233445 |
| (0046)72233445 | 46702233445 |
| +460702233445 | 46702233445 |
| 46(0)702233445 | 46702233445 |
| 46070-2233445 | 46702233445 |
| 0046702233445 | 46702233445 |
| +46(0)702233445ааа | 46702233445 |
| 336005199999 | 2626005199999 (Француз нөмірі DOM-TOM нөміріне аударылған) |
Сонымен қатар, таңдалған нарық үшін ұлттық телефон нөмірлеріне рұқсат беруге болады. Бұл мүмкіндік қосылған кезде басқа нарықтарға арналған кез келген халықаралық нөмірлер таңдалған нарықтан ажырату үшін бастапқы «+» белгісімен жіберілуі керек.
Төменде бірнеше бұрынғыampШвецияны (ел коды 46) ұлттық нөмірлер үшін әдепкі нарық ретінде пайдалану кезінде жасалған түзетулер.
| Жіберілген тағайындау мекенжайы | Түзетілген тағайындау мекенжайы |
| 0702233445 | 46702233445 |
| 070-2233 445 | 46702233445 |
| 070.2233.4455 | 46702233445 |
| 460702233445 | 46702233445 |
| +460702233445 | 46702233445 |
| +458022334455 | 458022334455 |
| 45802233445 | "+" белгісі жоқ болғандықтан жарамсыз |
Түзетілген MSISDN LINK Mobility арқылы пайдаланылатынын және ол жеткізу есептерінде қайтарылатынын ескеріңіз.
Қосымша ақпарат алу үшін LINK Mobility қолдау қызметіне хабарласыңыз.
8.2 Таңбаларды ауыстыру
Таңбаларды ауыстыру қажет болса, LINK Mobility қолдауы арқылы қосуға болатын қосымша мүмкіндік болып табылады.
Бұл мүмкіндік DCS «GSM» (17) күйіне орнатылған кезде пайдаланушы деректеріндегі (SMS мәтіні) GSM емес әліпби таңбаларын GSM әліпбиінің балама таңбаларына аударады. Мысалыample “Seqüência de teste em Portugues” сөзі “Seqüencia de teste em Portugues” деп аударылады.
9. Жеткізу туралы есептер
Қызмет провайдері, егер қамтамасыз етілсе, жіберілген MT хабарламалары үшін SMS хабарламаларын жеткізу есептерін немесе жеткізу хабарландыруларын сұрай алады. Бұл есептер SMSC операторында МТ хабары мақсатты Тұтынушыға жеткізілгенде немесе жойылғанда іске қосылады, мысалы, мерзімі өтіп кеткен немесе қандай да бір себептермен бағытталмайтын.
Қызмет провайдеріне SMS хабарламаның соңғы күйі ғана хабарланады, яғни жеткізілген немесе жойылған. Әр МТ хабарына бір ғана есеп жасалады. Жойылған күйде себеп коды қолданылуы мүмкін. Бұл себеп коды SMS хабарламасының жеткізілмеуі себебін көрсетеді.
Есептер LINK Mobility арқылы бағытталады және HTTP протоколы арқылы қызмет провайдеріне жіберіледі.
Есептерді алу үшін Қызмет провайдері мысалы үшін орындауы керекampJava Servlet немесе ASP.NET беті. Екеуі де HTTP GET немесе POST сұрауларын алады.
Параметрлер
Сұраныс келесі параметрлерді қамтиды:
| Параметр | Түр | M/O/I* | Әдепкі мән | Максималды ұзындық | Сипаттама |
| MessageId | жол | M | – | 22 | Бұл есеп сәйкес келетін МТ хабарламасының хабарлама идентификаторы. |
| Destination Address | жол | M | – | 40 | Тұтынушының MSISDN, яғни бастапқы MT хабарламасының тағайындалған мекенжайы. |
| Күй коды | бүтін сан | M | 1 | Күй коды МТ хабарламасының күйін көрсетеді. Қолданылатын күй кодтары: 0 – жеткізілді 2 – Жойылған (себеп коды қолданылады) |
|
| УақытStamp | жол | M | – | 20 | Жеткізу есебінің LINK Mobility арқылы алынғанын көрсететін уақыт. Уақыттың уақыт белдеуіamp CET немесе CEST (ЕО үшін анықталған жазғы уақытпен). Пішім: жжжжжжжжжжжжжжжжжжжжжжжжжжда |
| Оператор | жол | M | – | 100 | SMS хабарлама жіберу кезінде пайдаланылатын Оператордың аты немесе SMS хабарламасын жіберу кезінде пайдаланылатын есептік жазбаның аты. Қолжетімді Операторлар тізімін LINK Mobility қолдау қызметі қамтамасыз етеді. |
| Себеп коды | бүтін сан | O | – | 3 | Себеп коды хабардың неліктен жойылған күйде аяқталғанын көрсетеді. Қолданылатын себептер кодтары: 100 – мерзімі бітті 101 – қабылданбады 102 – Формат қатесі 103 – Басқа қате 110 – жазылушы белгісіз 111 – жазылушыға тыйым салынды 112 – Абонент қамтамасыз етілмеген 113 – Абонент қолжетімсіз 120 – SMSC қатесі 121 – SMSC кептелісі 122 – SMSC роуминг 130 – Телефон тұтқасының қатесі 131 – Телефонның жадысы асып кетті Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| OperatorTimeStamp | жол | O | – | 20 | Оператордың SMSC жүйесінде есептің қашан іске қосылғанын көрсететін уақыт (егер Оператор ұсынған болса). Уақыттың уақыт белдеуіamp CET немесе CEST (ЕО үшін анықталған жазғы уақытпен). Пішім: жжжжжжжжжжжжжжжжжжжжжжжжжжда |
| Күй мәтіні | жол | O | – | 255 | Оператордан қосымша ақпарат алу үшін толтырғыш, мысалы, күйдің/себептің анық мәтіндік сипаттамасы. Оператор интеграциясына байланысты мінез-құлық әртүрлі болуы мүмкін. |
| Корреляция идентификаторы | жол | O | – | 100 | SendRequest немесе SendTextRequest ішінде берілген корреляция идентификаторы. |
| Оператор желі коды | бүтін сан | O | – | 6 | Оператордың мобильді желі коды (MCC + MNC). |
* M = Міндетті, O = Қосымша, I = Еленбейді.
Қызмет провайдері мақсатпен LINK Mobility қамтамасыз етуі керек URL жеткізу есептері үшін (міндетті түрде HTTP негізгі аутентификациясы үшін тіркелгі деректерін қоса). Қызмет провайдері қолданылатын HTTP әдісін таңдай алады:
HTTP POST (ұсынылады)
HTTP GET.
ExampHTTP GET арқылы (сәтті жеткізілді):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
ExampHTTP GET көмегімен (жеткізілмеген, Оператор уақыт көрсеткішін бердіamp оқиға үшін):
Параметрлері болып табылады URL кодталады.
Таңбаларды кодтау:
Қызмет провайдері таңдаулы таңба кодтамасын пайдалануды таңдай алады:
UTF-8 (ұсынылады)
ISO-8859-1.
9.1 Қызмет провайдерін растау
Қызмет көрсетуші әрбір жеткізу есебін растауы керек. Растау оң болуы мүмкін, яғни жеткізілім туралы есеп сәтті алынды немесе теріс, яғни сәтсіздік.
Назар аударыңыз: LINK Mobility жеткізу есептері үшін растау үшін 30 секунд оқу күту уақыты бар. Күту уақыты жеткізуді қайталау әрекетін (қайталау әрекеті қосылса) немесе жеткізуден бас тартуды (қайталау әрекеті өшірілсе) іске қосады. Бұл Қызмет провайдері қолданбасы жылдам жауап беру уақытын, әсіресе жоғары жүктеме кезінде қамтамасыз етуі керек дегенді білдіреді.
Өңдеу алдында LINK Mobility компаниясына жеткізу есебін растау ұсынылады.
Оң және теріс тану ережесі келесідей сипатталған:
Оң растау, ACK, жеткізілім туралы есеп:
Келесі XML пішімделген мазмұнмен біріктірілген HTTP 200 ауқымының жауап коды:
Теріс растау, NAK, жеткізілім туралы есеп жеткізілмеді:
Оң растаудан басқа кез келген жауап, мысалыample, теріс растау кез келген HTTP қате коды немесе келесі XML мазмұны арқылы іске қосылады:
XML мазмұны LINK Mobility қайта әрекет ету механизмін басқару үшін пайдаланылуы мүмкін. Қосылған болса, NAK әрекетті қайталау әрекетін тудырады. Қайталау механизмі үшін конфигурацияланбаған қызмет жеткізушілері үшін XML мазмұны міндетті емес.
Төменде HTTP POST сұрауы және жауабы барampҚызмет провайдеріне жеткізілген жеткізу есебінің le:
HTTP сұрауы:
POST /контекст/қолданба HTTP/1.1
Мазмұн түрі: қосымша / х-www-форма-urlкодталған;charset=utf-8
Хост: сервер: порт
Мазмұн ұзындығы: xx
MessageId=213123213&DestinationAddress=46762050312&Оператор=Telia&OperatorTimeStamp=20130607%2010%3A45%3A00&TimeStamp=20130607%2010%3A 45%3A02&StatusCode=0
HTTP жауабы:
HTTP/1.1 200 Жарайды
Мазмұн түрі: мәтін/жазық
9.2 Қайталап көріңіз
LINK Mobility жүйесі сәтсіз, яғни расталмаған жеткізу есебін жеткізу үшін қайталау әрекеттерін орындай алады. Қызмет провайдері таңдаулы қайталау әрекетін таңдай алады:
Қайталау жоқ (әдепкі) – қосылу әрекеті сәтсіз аяқталса, оқу күту уақыты немесе кез келген HTTP қате коды үшін хабар жойылады.
Қайталап көріңіз – хабар қосылым мәселесінің әрбір түріне, оқу күту уақыты немесе теріс растау үшін қайта жіберіледі.
NAK үшін қайталау әрекеті қосылған кезде, LINK Mobility қолданбасынан қайталау әрекетін жасайтын қандай сценарийлерді және қайталау әрекетінің қалай жұмыс істейтінін түсіну маңызды. Әрбір қызмет жеткізушісінің қайталау кезегі болады, мұнда хабарламалар хабардың уақытына сәйкес реттеледіamp. Қызмет провайдеріне жеткізілетін хабарлардың жеке тәртібіне кепілдік берілмесе де, Link Mobility әрқашан ескі хабарларды жеткізуге тырысады. Қайталау кезегінен хабарларды алып тастаудың негізгі себебі екі себептің бірі болып табылады: TTL хабарының мерзімі аяқталады немесе (теориялық тұрғыдан) қайталау кезегі толады. TTL операторға және тіркелгіге байланысты, яғни Операторға және немесе хабар түріне байланысты өзгеруі мүмкін, мысалы, премиум SMS немесе стандартты тарифтік SMS хабарлама.
Қайталау әрекеті қосылған қызмет жеткізушілері хабардың әлі қабылданбағанына сенімді болу үшін MT хабарының бірегей идентификаторын тексеруі керек.
Жеткізу есебін өңдеу кезінде қате орын алған кезде Қызмет провайдерінің осы қарапайым ережелерді сақтауы маңызды, егер қатенің себебі мынада болса: Уақытша, мысалы, дерекқор қолжетімді емес, NAK қайтарылуы керек. LINK Mobility хабарды қайта жібереді.
Тұрақты және қайталау әрекеті бірдей ақаулықты тудыруы мүмкін, ACK қайтарылуы керек. Мысалыample, хабарды дұрыс талдау мүмкін болмағанда немесе күтпеген орындалу қатесін тудырғанда.
Тиісінше әрекет ету жеткізу есебінің қайта-қайта жіберілуіне байланысты блоктаудың немесе өткізу қабілетінің нашарлауының туындамауын қамтамасыз етеді.
10. Іске асыру бойынша кеңестер
1. Сіздің пайдалануыңызға болады web API сұрауларын жіберу үшін шолғыш. Бұл ешқандай әзірлеу құралдарынсыз қызметтерді зерттеуді және бағалауды өте оңай етеді.
2. Chrome немесе Firefox JSON сияқты кеңейтіммен бірге ұсыныладыView жақсы пішімделген JSON көрсету үшін.
3. Біз SoapUI қолданбасын POST, негізгі аутентификацияны сынау және шикі HTTP сұрауы мен жауап хабарларын тексеру үшін қолдандық.
4. сURL құрал негізгі аутентификациямен POST сұрауларын жіберу үшін пайдалы. Бұрын қараңызampтөменде.
curl ПОСТ \
-H «Мазмұн түрі: қолданба/x-www-form-urlкодталған» \
-H “Авторизация: Негізгі am9objpjaGFuZ2VtZSA=” \
https://europe.ipx.com/restapi/v1/sms/send \
–деректер “тағайындалған мекенжай=46123456789&messageText=Hello+World%21”
_______________
Жекеленген коммуникацияларды түрлендіру
Құжаттар / Ресурстар
 |
LINK Mobility іске асыру нұсқаулығы REST API SMS [pdf] Пайдаланушы нұсқаулығы Mobility енгізу нұсқаулығы REST API SMS, Mobility, Implementation Guide REST API SMS, REST API SMS, API SMS, SMS |
