Водич за имплементација на LINK Mobility REST API SMS
LINK Mobility обезбедува услуга за испорака на пораки, микро плаќања и услуги засновани на локација. Платформата делува како транспарентен стекнувач на содржина со бела ознака и рутер за трансакции помеѓу давателите на услуги и операторите.
LINK Mobility обезбедува RESTful API што може да се користи за пристап до услугите на LINK Mobility како што се испраќање СМС. Овој API е дизајниран да биде лесен за користење и компатибилен со сите современи јазици и рамки. Користејќи го јазикот по ваш избор, вашата апликација може да го користи Link Mobility REST API за да имплементира моќни можности за пораки и плаќање
© ЛИНК Мобилност, 10 март 2021 година
Правни информации
Информациите дадени во овој документ се единствена сопственост и авторско право на Netsize. Тој е доверлив и е наменет за строго информативна употреба. Не е обврзувачки и може да биде предмет на промени без претходна најава. Секое неовластено откривање или употреба ќе се смета за незаконско.
Netsize™ и linkmobility™ се заштитени со француските, EEC и меѓународните закони за интелектуална сопственост.
Сите други цитирани трговски марки се единствена сопственост на нивните соодветни сопственици.
Ништо содржано овде нема да се толкува како да дава лиценца или право според патент, авторско право или заштитен знак на Netsize.
NETSIZE
Анонимно друштво или капитал од 5 478 070 евра
Опсада социјална :62, авенија Емил Зола92100 Булоњ – Франција
418 712 477 RCS Нантер
http://www.LinkMobility.com
http://www.linkmobility.com
Опсег на документот
Овој документ опишува како давателот на услуги го користи LINK Mobility REST API за СМС. Наменет е за технички архитекти и дизајнери кои ги спроведуваат услугите на Давателот на услуги.
1. Основна употреба
Многу е лесно да се испрати СМС. Испраќате барање за HTTP до LINK Mobility што може да се постигне само со користење на a web прелистувач.
2. Функционално надview
Системот LINK Mobility ја обезбедува следната основна функционалност за СМС пораки:
Испраќање мобилни терминирани (MT) SMS пораки, како што се текстуални или бинарни (на пр. WAP Push) премиум и пораки со стандардна стапка.
Примање извештаи за испорака за доставени МТ пораки.
Примање СМС пораки со потекло од мобилни (MO), премиум и стандардна стапка.
SMS REST API е посветен на испраќање MT SMS пораки со стандардна стапка.
API ги испраќа сите СМС пораки асинхроно, овозможувајќи функции како што се:
„Запали-и-заборави“ – Давателот на услуги сака да има попредвидливи времиња на одговор и не сака да го чека резултатот од операторот.
Обидете се повторно со функционалност – LINK Mobility повторно ќе ја испрати пораката доколку операторот има привремени проблеми.
2.1 Испраќање СМС порака
Давател на услуги Netsize Consumer
- Испрати MT порака
- ИД за враќање на пораката
- Испратете СМС порака
- Доставете извештај за испорака
- Испрати извештај за испорака
Основниот тек за испраќање СМС пораки е опишан на следниов начин:
Давателот на услуги бара да испрати SMS порака до примачот преку системот LINK Mobility.
ИД на пораката се враќа на давателот на услуги. Овој ID може да се користи за на пр. корелација на пораката со точниот извештај за испорака.
LINK Mobility се справува со рутирање и ја доставува СМС пораката до адресираниот потрошувач.
Се активира извештај за испорака, на пр. кога СМС пораката се доставува до уредот на потрошувачот.
Извештајот за испорака се испраќа до давателот на услуги. Извештајот го содржи истиот ID на порака како што е вратена во чекор 2.
Алтернативен тек: неважечко барање
Ако доставените параметри или корисничките акредитиви во барањето се неважечки, грешката се враќа на давателот на услуги. Грешката ја означува причината за одбивањето и протокот завршува. ИД на пораките не се враќаат.
3. Крајна точка
До ресурсот на СМС се пристапува преку патеката:
/restapi/v1/sms
Example URL
https://europe.ipx.com/restapi/v1/sms
За безбедност на поврзувањето, LINK Mobility REST API е достапен само преку HTTPS.
Сертификатот на серверот Link Mobility е потпишан од Thawte Server CA.
4. Операции
СМС услугата ги обезбедува следните операции:
| Име | Пат |
| Испрати | /restapi/v1/sms/send |
4.1 Испрати
Операцијата за испраќање се користи за испраќање СМС на еден примач.
Оваа операција е наменета и за основни и за напредни корисници. Во наједноставниот случај, само адресата на дестинацијата и текстот на пораката се потребни за да се достави СМС. 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
За прampле, Здраво свет! е кодирана како Hello+World%21.
6.2 Параметри за задолжителни барања
| Име | Максимална должина | Опис |
| дестинацијаАдреса | 40 | MSISDN до кој треба да се испрати СМС пораката, почнувајќи од кодот на државата. Прampле: 46123456789. За некои пазари (каде што потрошувачот MSISDN мора да биде заматен) оваа вредност може да биде и алфанумерички алијас, со префикс „#“. |
| поракаТекст | 1600 | Содржината на СМС пораката. |
6.3 Изборни параметри за барање (за напредна употреба)
| Име | Максимална должина | Опис |
| потекло Адреса | 16 | Почетната адреса за појдовната СМС порака. Типот на почетна адреса е дефиниран со параметарот originatorTON. Максималната должина на краткиот број е 16. Алфа нумеричкиот испраќач е ограничен на стандардната GSM азбука со максимална должина од 11 знаци. Максималната должина на испраќачот MSISDN е 15 (со користење на истиот формат како елементот на дестинацијаАдреса). Може да се изостави кога системот ги избира originatingAddress и originatingTON. Оваа функција зависи од пазарот и конфигурацијата. Однесувањето може да се разликува со интеграциите на операторот. |
| зачетникТОН | 1 | Тип на број на почетната адреса (TON): 0 – краток број 1 – Алфа нумерички (максимална должина 11) 2 - MSISDN Може да се изостави кога системот ќе го избере originatingAddress и originatingTON. Оваа функција зависи од пазарот и конфигурацијата. Однесувањето може да се разликува со интеграциите на операторот. |
| userDataHeader | 280 | Заглавието на кориснички податоци заедно со корисничките податоци може да содржи до 140, односно 280 кога е шифрирано со хексадецимален пат, октети. Овој параметар е секогаш хексодиран. |
| DCS | 3 | Шема за кодирање на податоци. Однесувањето може да се разликува со интеграциите на операторот. |
| PID | 3 | ID на протокол. Однесувањето може да се разликува со интеграциите на операторот. |
| relativeValidityTime | 6 | Релативна важност во секунди (во однос на времето за поднесување до ЛИНК Мобилност). Максималната вредност е 604800 (7 дена), а стандардната вредност е 48 часа. Однесувањето може да се разликува со интеграциите на операторот. |
| време на испорака | 20 | Навременamp кога треба да се достави СМС порака (одложено време на испорака). Видете го делот за форматот на датумот на времето. |
| статусИзвештај Знамиња | 1 | Барање за доставување извештај: 0 – Нема извештај за испорака (стандардно) 1 – Побаран извештај за испорака 9 – Баран извештај за испорака на серверот (LINK Mobility не го проследува извештајот до давателот на услуги, туку го прави достапен во извештаите итн.) |
| campиме на име | 50 | Трансакциите на ЛИНК Мобилност се tagГед со ова име. Се користи за групирање на трансакции во извештаите на Link Mobility. |
| maxConcatenated Messages | 1 | Вредност помеѓу 1 и 10 која дефинира колку поврзани пораки се дозволени. Стандардно е 3. |
| корелацијаId | 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 ПОСТ
Кодираната низа за барање се испраќа во телото на пораката за барање HTTP. Содржината-тип е апликација/x-www-form-urlкодирани.
ПОСТАВЕТЕ https://europe.ipx.com/restapi/v1/sms/send
Домаќин: europe.ipx.com
Тип на содржина: апликација / x-www-форма-urlкодирани
Овластување: Основен am9objpjaGFuZ2VtZSA=
Содржина-должина: 57
дестинацијаАдреса=46123456789&messageText=Здраво+Свет%21
6.5 Датум и време
Параметрите во REST API што ги претставуваат датумот и времето се секогаш во временската зона UTC (Координирано универзално време). Тајмстamps се претставени како низа со овој точен формат:
2017-04-25T23:20:50Z
Ова претставува 20 минути и 50 секунди по 23-тиот час на 25 април 2017 година во UTC.
7. Порака за одговор
По примањето и толкувањето на пораката за барање, API одговара со порака за одговор HTTP.
7.1 HTTP статусен код
REST API секогаш враќа HTTP статусен код 200 OK за обработени барања. Телото на пораката содржи параметар одговор Код кој се користи за одредување на точниот исход.
7.2 Тело на пораката
Телото на пораката се состои од JSON кој го опишува исходот од барањето.
http://json.org/
Link Mobility JSON е во согласност со Google JSON Style Guide.
https://google.github.io/styleguide/jsoncstyleguide.xml
7.3 Параметри на одговор
| Име | Максимална должина | Опис |
| Код за одговор | 3 | 0 означува успешна трансакција. |
| одговор Порака | 255 | Текстуален опис на одговор, на пр. текст за грешка. |
| времеamp | 20 | Датум и време кога LINK Mobility го обработи барањето. (Погледнете во делот за формат на датум/време). |
| traceId | 36 | Внатрешен идентификатор на Link Mobility. Се користи за поддршка и решавање проблеми. |
| ИД на пораки | 10 x 36 | Низа ЛИНК Мобилност уникатни идентификатори на пораки за секоја успешна порака (идентификациите на повеќе пораки се враќаат ако пораката е споена). Испуштен во случај на неуспех. |
7.4 Прampодговорите
Успех
HTTP/1.1 200 ОК
Тип на содржина: апликација/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 ОК
Тип на содржина: апликација/json
Содржина-должина: 148
Датум: четврток, 15 септември 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Невалидно најавување или неовластено користење API”,”timestamp”:”2016-09-15T13:20:31Z”,”traceId”:”f678d30879fd4adc25f2″}
Успех
HTTP/1.1 200 ОК
Тип на содржина: апликација/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 ОК
Тип на содржина: апликација/json
Содржина-должина: 148
Датум: четврток, 15 септември 2016 13:20:31 GMT
{“responseCode”:1,”responseMessage”:” Невалидно најавување или неовластено користење API”,”timestamp”:”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. |
| 14 | ID на протокол не е поддржан од сметката | ID на протокол не е поддржан. |
| 15 | Надминато е ограничувањето за поврзување на пораките | Бројот на поврзани пораки го надминува максималниот баран број. |
| 16 | Не може да се насочи пораката. | LINK Mobility не можеше да ја насочи пораката. |
| 17 | Забранет временски период | Не е дозволено да се испраќа порака во временски период |
| 18 | Премногу ниско салдо на сметката на давателот на услугата | Давателот на услугата е блокиран поради прениско салдо |
| 50 | Делумен успех | Делумен успех при испраќање СМС порака до повеќе примачи. |
| 99 | Грешка на внатрешен сервер | Друга грешка во мобилноста на врската, контактирајте со поддршката на LINK Mobility за повеќе информации. |
| 100 | Неважечка дестинација адреса | Одредишната адреса (MSISDN или алијас) е неважечка. |
| 102 | Неважечки референциран (поврзан) ID | Референтниот ID е неважечки, можеби референтниот ID е веќе користен, премногу стар или непознат. |
| 103 | Неважечко име на сметката | Името на сметката е неважечко. |
| 105 | Неважечки мета податоци на услугата | Мета-податоците на услугата се неважечки. |
| 106 | Неважечка почетна адреса | Почетната адреса е неважечка. |
| 107 | Неважечка алфанумеричка почетна адреса | Алфанумеричката почетна адреса е неважечка. |
| 108 | Неважечко време на важност | Времето на важност е неважечко. |
| 109 | Неважечко време за испорака | Времето на испорака е неважечко. |
| 110 | Неважечка содржина на порака/кориснички податоци | Корисничките податоци, односно СМС пораката се невалидни. |
| 111 | Неважечка должина на пораката | Должината на СМС пораката е неважечка. |
| 112 | Неважечко заглавие на кориснички податоци | Заглавието на корисничките податоци е неважечко. |
| 113 | Неважечка шема за кодирање на податоци | DCS е неважечки. |
| 114 | Неважечки ID на протокол | PID е неважечки. |
| 115 | Знамиња за неважечки извештај за статус | Знамињата на извештајот за статус се неважечки. |
| 116 | Неважечки TON | Иницијаторот TON е неважечки. |
| 117 | Неважечки вampиме на аген | Вampимето на aign е неважечко. |
| 120 | Неважечко ограничување за максимален број на поврзани пораки | Максималниот број на поврзани пораки е неважечки. |
| 121 | Неважечка почетна адреса на msisdn | Почетната адреса на MSISDN е неважечка. |
| 122 | Неважечки ID на корелација | ИД на корелација е неважечки. |
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) 702233445aaa | 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 доколку се побара.
Оваа функција ќе ги преведе знаците од азбуката што не се GSM во корисничките податоци (текст SMS) на еквивалентни знаци на GSM азбука кога DCS е поставен на „GSM“ (17). За прamp„Seqüência de teste em Português“ ќе се преведе на „Seqüencia de teste em Portugues“.
9. Извештаи за испорака
Давателот на услуги може, доколку е обезбеден, да бара извештаи за испорака на СМС пораки или известувања за испорака за испратените MT пораки. Овие извештаи се активираат во SMSC на операторот кога MT пораката е или доставена до целниот потрошувач или избришана, на пр., истечена или, поради некоја причина, не може да се рутира.
Само конечниот статус на СМС пораката се пријавува до Давателот на услуги, т.е. испорачана или избришана. Се генерира само еден извештај по МТ порака. Со избришаниот статус, може да се примени код за причина. Оваа шифра за причина ја одредува причината поради која СМС пораката не се доставува.
Извештаите се пренасочуваат преку LINK Mobility и се испраќаат до давателот на услуги користејќи го протоколот HTTP.
За да прима извештаи, Давателот на услуги треба да имплементира на прampод Java Servlet или ASP.NET страница. И двете добиваат барања за HTTP GET или POST.
Параметри
Барањето ги вклучува следните параметри:
| Параметар | Тип | M/O/I* | Стандардна вредност | Максимална должина | Опис |
| Идентификација на пораката | низа | M | – | 22 | ИД на пораката на MT пораката на која одговара овој извештај. |
| Адреса на дестинација | низа | M | – | 40 | MSISDN на потрошувачот, односно одредишната адреса на оригиналната MT порака. |
| Статус Код | цел број | M | 1 | Статусната шифра го означува статусот на MT пораката. Применливите статусни кодови се: 0 – Доставено 2 – Избришано (важи кодот за причина) |
|
| TimeStamp | низа | M | – | 20 | Време кое покажува кога извештајот за испорака бил примен од LINK Mobility. Временската зона на времетоamp е CET или CEST (со летно сметање на времето како што е дефинирано за ЕУ). Формат: yyyyMMdd HH:mm:ss. |
| Оператор | низа | M | – | 100 | Името на операторот што се користи при испраќање на SMS пораката или името на сметката што се користи при испраќање на SMS пораката. Списокот на достапни оператори е обезбеден од поддршката на LINK Mobility. |
| ReasonCode | цел број | 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 (со летно сметање на времето како што е дефинирано за ЕУ). Формат: yyyyMMdd HH:mm:ss. |
| СтатусТекст | низа | O | – | 255 | Место за дополнителни информации од Операторот, на пр. јасен текстуален опис на статусот/причината. Однесувањето може да се разликува со интеграциите на операторот. |
| КорелацијаId | низа | O | – | 100 | ИД на корелација дадена во SendRequest или SendTextRequest. |
| Мрежен код на операторот | цел број | O | – | 6 | Кодот на мобилната мрежа (MCC + MNC) на операторот. |
* М = Задолжително, О = Изборно, Јас = Игнорирано.
Давателот на услуги треба да обезбеди LINK Mobility со целта URL за извештаи за испорака (опционално вклучувајќи акредитиви за основна автентикација на HTTP). Давателот на услуги може да избере кој претпочитан HTTP метод да го користи:
HTTP POST (препорачано)
HTTP GET.
Exampсо користење на HTTP GET (успешно испорачано):
https://user:password@www.serviceprovider.com/receivereport?%20MessageId=122&DestinationAddress=46762050312&Operator=Vodafone&TimeStamp=20100401%2007%3A47%3A44&StatusCode=0
Exampсо користење на HTTP GET (не е испорачан, операторот го испорача времетоamp за настанот):
Параметрите се URL кодирани.
Кодирање на знаци:
Давателот на услуги може да избере кое претпочитано кодирање на знаци да го користи:
UTF-8 (препорачано)
ISO-8859-1.
9.1 Потврда за давател на услуги
Давателот на услуги треба да го потврди секој извештај за испорака. Потврдата може да биде позитивна, односно успешно примен извештај за испорака или негативна, односно неуспешна.
Ве молиме имајте предвид: LINK Mobility има истек на читање за потврда од 30 секунди за извештаи за испорака. Истекот на времето ќе предизвика повторен обид за испорака (ако е овозможен повторно обид) или откажување на испораката (ако повторното обид е оневозможено). Ова значи дека апликацијата Давател на услуги мора да обезбеди брзи времиња на одговор, особено при големо оптоварување.
Силно се препорачува да го потврдите извештајот за испорака до LINK Mobility пред да го обработите.
Правилото за позитивно и негативно признание е опишано на следниов начин:
Позитивна потврда, ACK, доставен извештај за испорака:
Код за одговор на опсегот HTTP 200 во комбинација со следната XML форматирана содржина:
Негативна потврда, NAK, извештај за испорака не е доставен:
Секој одговор освен позитивното признание, на прampтака, негативното потврдување се активира од кој било код за грешка на HTTP или следнава XML содржина:
Содржината на XML може да се користи за контролирање на механизмот за повторување на LINK Mobility. NAK ќе предизвика обид за повторен обид, ако е овозможено. За давателите на услуги кои не се конфигурирани за механизмот за повторно обид, содржината на XML е изборна.
Подолу е барање и одговор HTTP POST, прampле од извештај за испорака доставен до давател на услуги:
Барање HTTP:
POST /контекст/апликација HTTP/1.1
Тип на содржина: апликација / x-www-форма-urlкодирани;charset=utf-8
Домаќин: сервер: порта
Содржина-должина: xx
MessageId=213123213&DestinationAddress=46762050312&Operator=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 порака со стандардна стапка.
Давателите на услуги со овозможен повторен обид мора да го проверат единствениот ID на MT пораката за да се осигураат дека пораката не е веќе примена.
Важно е давателот на услуги да се придржува до овие едноставни правила кога ќе се појави грешка при обработката на извештајот за испорака, ако причината за грешката е: Привремена, на пр. базата на податоци не е достапна, NAK треба да се врати. LINK Mobility повторно ќе ја испрати пораката.
Постојаниот и обидот за повторен обид веројатно ќе предизвикаат ист вид на проблем, ACK треба да се врати. За прample, кога пораката не можеше правилно да се анализира или предизвика неочекувана грешка во времето на траење.
Постапувањето соодветно ќе осигури дека нема блокирање или деградација на пропусната моќ поради постојано испраќање на извештај за испорака.
10. Совети за имплементација
1. Можно е да го користите вашиот web прелистувач за поднесување барања до API. Ова го олеснува истражувањето и оценувањето на услугите без никакви алатки за развој.
2. Chrome или Firefox се препорачуваат заедно со екстензија како што е JSONView за прикажување на убаво форматиран 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 \
–податоци „destinationAddress=46123456789&messageText=Здраво+Свет%21“
_______________
Трансформирање на персонализирани комуникации
Документи / ресурси
 |
Водич за имплементација на LINK Mobility REST API SMS [pdf] Упатство за корисникот Водич за имплементација на мобилност REST API SMS, Мобилност, Водич за имплементација REST API SMS, REST API SMS, API SMS, SMS |
