Тіркеу

Әртүрлі

API жауап кодтары

Глоссарий

SMS-хабарламалардың мүмкін болатын мәртебелерінің тізімі

URL кодтау жолдары

API жауап кодтары

Әрбір API сұрауына жауап үш өрістен тұратын массивты қайтарады, оның бірі code. Бұл өріс сұрауды өңдеудің күйін қамтиды және клиент қосымшасы тарапынан одан әрі әрекеттерге нұсқаулық бола алады. Келесі кестеде API кодтары және олардың мағыналары келтірілген:

КодСипаттама
0Операция сәтті аяқталды.
1Кейбір мәндерді жасау немесе жаңарту кезінде берілген деректерді тексеру қатесі. data өрісінде қандай өрістердің дұрыс толтырылмағандығы туралы ақпарат берілген. Қателерді түзетіп, жаңа деректермен сұрауды қайталау керек.
2Көрсетілген жазба табылмады. Мүмкін, ол жойылған, жазба ID-і дұрыс емес немесе жазбаға қол жеткізуге тырысқан пайдаланушының оған қол жеткізу құқықтары жоқ.
3Белгісіз қолданба қатесі. Қолдау қызметіне хабарласып, алынған сұраудың егжей-тегжейін хабарлаңыз.
4module параметрі дұрыс көрсетілмеген. Параметрдің дұрыс жазылуын API құжаттамасында тексеріңіз.
5method параметрі дұрыс көрсетілмеген. Параметрдің дұрыс жазылуын API құжаттамасында тексеріңіз.
6format параметрі дұрыс көрсетілмеген. Параметрдің дұрыс жазылуын API құжаттамасында тексеріңіз.
8Жүйеге кіру қатесі. Бұл келесі жағдайларда пайда болады:
  • Кіру деректері дұрыс көрсетілмеген;
  • Жүйемен жұмыс істеу кезінде пайдаланушының сессиясы аяқталған немесе сервермен мәжбүрлі түрде жабылған.
Қосымша ақпаратты message өрісінен көруге болады.
9Көрсетілген API әдісіне қол жеткізу қатесі.
10Дәл осы операцияны орындау барысында деректерді серверге сақтау қатесі. Әдетте, бұл қате деректерге бірнеше клиенттердің бір мезгілде қол жеткізуімен немесе деректерді сақтау шарттарының өзгеруімен байланысты.
11Сұрауда кейбір міндетті параметрлер жоқ. Параметрлердің дұрыс жазылуын API құжаттамасында тексеріп, сұрауға қажетті параметрлерді қосыңыз.
12Сұраудың кіріс параметрі белгіленген шарттар немесе шектеулерге сәйкес келмейді. Бұл қате коды параметрлердің бірі шектеулерді бұзған кезде пайда болады. Бұл атрибуттарды тексеру қатесіне ұқсас, бірақ деректерді жасау немесе өзгерту жасамайтын сұрауларда болуы мүмкін.
13API серверіне осы пайдаланушыны қызмет көрсетпейтін сұрауды орындау әрекеті. Бұл кодты алған жағдайда, дұрыс доменді data өрісінен алуға болады.
14Бұл қате пайдаланушының аккаунты бұғатталған немесе жойылған жағдайда пайда болады.
15Деректерді жаңартумен байланысты емес операцияны орындау қатесі. Бұл қатенің егжей-тегжейі API жауабының message өрісінде көрсетілген.
30Сұрау жылдамдығының шекті мәнінен асу қатесі. Бұл қате белгілі бір уақыт аралығында API әдісіне шамадан тыс жиі жүгіну кезінде пайда болады. Қате туындаған жағдайда, сұрау жиілігін азайту керек.
98Операция толық орындалмады, тек деректердің бір бөлігі өңделді. Бұл код әдетте қандай да бір жаппай операциялар кезінде қайсыбір элементтер қателер немесе шектеулерге байланысты өңделмеген, бірақ кейбір элементтер өңделген жағдайда қайтарылады. Бұл кодты алған жағдайда, қандай элементтердің өңделгенін, ал қайсысы қателермен және қандай қателермен өңделмегенін data өрісінің мазмұнынан алуға болады.
99Жаппай операция элементтерінің ешқайсысы өңделмеген. Әрбір нақты элементтегі қателер туралы толық ақпаратты data өрісінен, ал жалпы қате сипаттамасын message өрісінен алуға болады.
100Бұл код қате емес және операцияның фондық орындауға жіберілгенін білдіреді. Бұл жағдайда data өрісі фондық операцияның ID-ін қамтиды, оның процесін және аяқталуын API TaskQueue/GetStatus арқылы бақылауға болады.
999Қызметтің жалпы қатесі. Егжей-тегжейін message өрісінен алуға болады.

Глоссарий

ID – бірегей идентификатор, ізделетін объектіні бірегей анықтауға мүмкіндік береді: науқан, топ және т.б.

Байланыс картасы – Байланыс кітабындағы жазба, клиенттің мәліметтерін қамтиды, мысалы: Аты-жөні, email, туған күні және басқа ақпараттар. Міндетті түрде телефон нөмірін қамтуы керек.

Жіберушінің қолтаңбасы (Sender ID, альфанумерлік атау) – алушының телефонында SMS жіберуші ретінде телефон нөмірінің орнына көрсетіледі.
Жіберушінің қолтаңбаларына бірқатар талаптар бар.

Жалпы қолтаңба (SMS жіберушінің) – егер пайдаланушының қолтаңбалары жоқ болса немесе таңдалған қолтаңба көрсетілген телефон нөміріне жіберуге қолжетімсіз болса, хабарлама жіберілгенде қолданылатын қызметтің қолтаңбаларының бірі.

Алушы (абонент) – SMS-хабарлама жіберілетін мобильді байланыс қызметтерінің пайдаланушысы.

Қысқа сілтеме – WEB-бетке кіру үшін қысқартылған (альтернативті) URL-мекенжайы.

Қысқа сілтемені қолдану URL-дің кездейсоқ бұрмалануын азайтады – қысқа сілтемені есте сақтау, көшіру немесе қолмен енгізу оңайырақ.

Статистикалық мәліметтер ыңғайлы түрде беріледі: соңғы 2 сағат, күн, апта, 30 күн немесе барлық уақыт бойынша басылымдар санын көруге болады (толығырақ қысқа сілтемелер бөлімін қараңыз).

Сондай-ақ, қысқа сілтемелерді SMS-те пайдалану ыңғайлы. Олар хабарламадағы символдардың азаюына байланысты жіберу құнын азайтуға мүмкіндік береді.

Біздің қызметте жасалған қысқа сілтемені пайдаланғанда, сілтемені ашқан алушыларды бақылау функциясын іске қосу мүмкіндігі бар.

Жеке сілтеме (алушыны бақылау сілтемесі) – біздің қызметіміз арқылы жасалған арнайы қысқа сілтеме, ол SMS тарату алушыларының нақты кім екенін бақылауға мүмкіндік береді. Сілтеме әрбір жеке SMS алушысы үшін бірегей.

Алушыларды бақылау функциясы – хабарламада орналастырылған қысқа сілтеме бойынша өткен алушылар туралы статистикалық мәліметтерді жинау құралы.

Бұл мақсатты аудиторияның аналитикасы және SMS-науқанның тиімділігін бағалау үшін ыңғайлы және тиімді құрал.

Бұл функция гиперсілтемелері бар SMS-хабарламалар үшін қол жетімді. Функцияны белсендіру үшін SMS жіберу формасында қысқа сілтемеге ауыстыру түймесін басып, «алушыларды бақылау» опциясының қасында белгі бар-жоғын тексеру қажет.

Хабарлама жеткізу есебі (DLR) – алушыға SMS-хабарламаның жеткізілу мәртебесі туралы байланыс операторынан ақпарат.

SMS Науқан – бір SMS-тің көптеген алушыларын топтастырып, SMS тарату нәтижелерін талдауға мүмкіндік береді.

Жеке науқан – бір нөмірге хабарлама жіберу.

Жаппай науқан – екі немесе одан да көп нөмірлерге хабарлама жіберу.

Функционалды (қызметтік) науқан – оған функционалды немесе басқаша айтқанда, жүйенің қызметтік хабарламалары, мысалы, формалардан телефон нөмірін растау коды бар хабарламалар кіреді.

Үлгілік науқан – SMS-науқанының түрі, онда әрбір алушы үшін жеке мәтінге ауыстырылатын орны толтырғыштары бар ерекше хабарлама формасы қолданылады.

Үлгі мысалы

Қисық жақшалар {} ішінде толтырғыштар орналасқан.

Орны толтырғыштары бар үлгі мәтінАлушыға жеткізілетін мәтін
Сәлеметсіз бе, {name}! {date} бойынша балансыңыз {balance}{currency}.Сәлеметсіз бе, Иван! Сіздің 12.09.2019 жылғы балансыңыз 15.50 грн.
{name}, көлік келіп жетті ({carNumber}). Жүргізушінің телефоны: {driverPhone}.Алексей, көлік келіп жетті (АА 4444). Жүргізушінің телефоны: 099 999 99 99.
Еске саламыз, сіз {place} қабылдауына жазылдыңыз. Қабылдау күні: {date}.Еске саламыз, сіз 11.11.2019 күні 11:30-да Клиникада қабылдауға жазылдыңыз.

Форма – клиенттер туралы деректерді жинауға, электрондық сауалнамалар жүргізуге, тарату үшін нөмірлер базасын құруға және басқа көптеген тапсырмаларға арналған ыңғайлы құрал.

Формалар арқылы сіздің клиенттеріңіз SMS таратуға, жаңалықтарға, акцияларға және т.б. жазыла алады.

Икемді және интуитивті өріс құрастырушысын пайдалана отырып, сіз өз міндеттеріңіз үшін барынша тиімді Форманы оңай жасай аласыз.

Сонымен қатар, сіз Форманың дизайнын реттей аласыз: мәтіннің, түймелердің, фонның түсін және т.б. таңдай аласыз. Формаларды жасауды толығырақ “Формалар” бөлімінен біле аласыз.

SMS-хабарламалардың мүмкін болатын мәртебелерінің тізімі

МәртебеОң мәртебеСипаттама
NEWжоқЖаңа хабарлама, әлі жіберілмеген.
ENQUEUDжоқЖіберуге кезекке қойылған.
ACCEPTDжоқЖүйеден жіберілген және алушыға әрі қарай жеткізу үшін оператор қабылдаған.
UNDELIVиәАлушыға жеткізілмеген.
REJECTDиәОператор тарапынан әртүрлі себептермен қабылданбаған – алушының нөмірі қате, тыйым салынған мәтін, жіберушінің қолтаңбасы тіркелмеген, т.б.
PDLIVRDжоқХабарламаның барлық сегменттері алушыға жеткізілмеген (бұл мәртебе тек хабарламаларға қатысты, бірақ сегменттерге емес). Кейбір операторлар тек бірінші жеткізілген сегмент туралы есеп береді, сондықтан мұндай хабарлама өмір сүру мерзімі аяқталғаннан кейін бірінші сегмент үшін орнатылған мәртебеге ауысады.
DELIVRDиәАлушыға толық жеткізілді.
EXPIREDиәЖеткізу күту мерзімі аяқталғандықтан алушыға жеткізу сәтсіз болды. Жеткізу әдетте алушының телефоны өшірулі болса, желі аймағынан тыс жерде болса немесе құрылғы жады толы болса мүмкін болмайды. Жеткізуді күту мерзімі – жіберу сәтінен бастап 1 тәулік.
DELETEDиәБайланыс операторының шектеулері себебінен жойылған және алушыға жеткізілмеген.

URL кодтау жолдары

Әрбір серверлік тілде цифрлық-әріптік емес барлық таңбалар, - _ . таңбаларынан басқа, пайыз белгісімен (%) ауыстырылған жолды қайтаратын функция бар, одан кейін екі он алтылық сан, ал бос орындар қосу белгісімен (+) кодталады. Жол веб-форманың POST деректері сияқты кодталады, яғни контент түрі бойынша application/x-www-form-urlencoded. Бұл RFC 3986 бойынша кодтаудан өзгеше, өйткені тарихи себептерге байланысты бос орындар "плюс" (+) белгісімен кодталады.

Әртүрлі бағдарламалау тілдерінде жүзеге асырылуы

ТілФункцияҚұжаттама сілтемесі
PHPurlencodehttp://php.net/manual/ru/function.urlencode.php
.NetHttpUtility.UrlEncode
WebUtility.UrlEncode
https://docs.microsoft.com/en-us/dotnet/api/system.web.httputility.urlencode
https://docs.microsoft.com/en-us/dotnet/api/system.net.webutility.urlencode
Pythonurllib.parse.quote_plushttps://docs.python.org/3/library/urllib.parse.html#urllib.parse.quote_plus
JavaURLEncoder.encodehttps://docs.oracle.com/javase/8/docs/api/java/net/URLEncoder.html
JavaScriptencodeURIComponenthttps://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent