HTTP/HTTPS ïðîòîêîë

Îòïðàâêà ñîîáùåíèé

Îòïðàâêà SMS-ñîîáùåíèÿ

Âñå ïàðàìåòðû, êîòîðûå ñîäåðæàò ñïåöèàëüíûå ñèìâîëû (ïëþñ, ïðîáåë è ò.ä.), äîëæíû áûòü çàêîäèðîâàíû ïðè ïîìîùè ôóíêöèè urlencode äëÿ ïåðåäà÷è â HTTP-çàïðîñå.

Îòïðàâêà ñîîáùåíèé. Îòâåò ñåðâåðà è êîäû îøèáîê

• ERROR = N (îïèñàíèå) – äëÿ îøèáîê 1,2,4,5,9;
  
  
• ERROR = N (îïèñàíèå), ID - <id ñîîáùåíèÿ> – äëÿ îøèáîê 3,6,7,8.

• 0,-N – äëÿ îøèáîê 1,2,4,5,9;
• <id ñîîáùåíèÿ>,-N – äëÿ îøèáîê 3,6,7,8.

• Äëÿ îøèáîê 1,2,4,5,9:
  
  

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Äëÿ îøèáîê 3,6,7,8:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> <id>id ñîîáùåíèÿ</id> </result>

• Äëÿ îøèáîê 1,2,4,5,9:

  { "error": "îïèñàíèå", "error_code": N }

  
  
• Äëÿ îøèáîê 3,6,7,8:

  { "error": "îïèñàíèå", "error_code": N, "id": <id ñîîáùåíèÿ> }

• ïðè cost = 0 è fmt = 0: OK - <n> SMS, ID - <id>
  
  
• ïðè cost = 1 è fmt = 0: <cost> (<n> SMS)
  
  
• ïðè cost = 2 è fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>
  
  
• ïðè cost = 3 è fmt = 0: OK - <n> SMS, ID - <id>, COST - <cost>, BALANCE - <balance>
  
  
• ïðè cost = 0 è fmt = 1: <id>,<n>
  
  
• ïðè cost = 1 è fmt = 1: <cost>,<n>
  
  
• ïðè cost = 2 è fmt = 1: <id>,<n>,<cost>
  
  
• ïðè cost = 3 è fmt = 1: <id>,<n>,<cost>,<balance>
  
  
• ïðè cost = 0 è fmt = 2:

  <result> <id>id</id> <cnt>n</cnt> </result>

  
  
• ïðè cost = 1 è fmt = 2:

  <result> <cost>cost</cost> <cnt>n</cnt> </result>

  
  
• ïðè cost = 2 è fmt = 2:

  <result> <id>id</id> <cnt>n</cnt> <cost>cost</cost> </result>

  
  
• ïðè cost = 3 è fmt = 2:

  <result> <id>id</id> <cnt>n</cnt> <cost>cost</cost> <balance>balance</balance> </result>

  
  
• ïðè cost = 0 è fmt = 3:

  { "id": <id>, "cnt": <n> }

  
  
• ïðè cost = 1 è fmt = 3:

  { "cost": "<cost>", "cnt": <n> }

  
  
• ïðè cost = 2 è fmt = 3:

  { "id": <id>, "cnt": <n>, "cost": "<cost>" }

  
  
• ïðè cost = 3 è fmt = 3:

  { "id": <id>, "cnt": <n>, "cost": "<cost>", "balance": "<balance>" }

  
  
• ïðè op = 1 è fmt = 0 èëè 1, èíôîðìàöèÿ äîáàâëÿåòñÿ â êîíåö îáû÷íîãî âûâîäà ñ íîâîé ñòðîêè:
  <phone>,<mccmnc>,<cost>,<status>,<error>
  
  
• ïðè op = 1 è fmt = 2, â îòâåò äîáàâëÿåòñÿ ìàññèâ:

  <phones> <phone mccmnc="mccmnc" cost="cost" status="status" error="error">phone</phone> ... </phones>

  
  
• ïðè op = 1 è fmt = 3, â îòâåò äîáàâëÿåòñÿ ìàññèâ:

  "phones": [{ "phone": "<phone>", "mccmnc": "<mccmnc>", "cost": "<cost>", "status": "<status>", "error": "<error>" }, ... ]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå îäíîãî îäèíàêîâîãî çàïðîñà íà îòïðàâêó SMS-ñîîáùåíèé â òå÷åíèå ìèíóòû äëÿ çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà äëÿ òîãî, ÷òîáû ñíèçèòü íàãðóçêó è íå ðàñõîäîâàòü ñðåäñòâà Êëèåíòà, à òàêæå íå äîïóñòèòü ìíîãîêðàòíîé îòïðàâêè ñîîáùåíèÿ îäíîìó àáîíåíòó.

Ñåðâåð òàêæå áëîêèðóåò îòïðàâêó áîëåå 50 ñîîáùåíèé îäíîìó àáîíåíòó, êîòîðûå áûëè îòïðàâëåíû ñ ïåðåðûâîì ìåæäó ñîîáùåíèÿìè ìåíåå 60-òè ñåêóíä, äëÿ çàùèòû îò ôëóäà è ëèøíåãî ñïèñàíèÿ ñðåäñòâ ñî ñ÷åòà Êëèåíòà, òàê êàê ìíîãèå îïåðàòîðû íå ïðîïóñêàþò áîëüøîå êîëè÷åñòâî ñîîáùåíèé îäíîìó àáîíåíòó çà êîðîòêèé ïðîìåæóòîê âðåìåíè.

Ïðèìåðû îòïðàâêè ñîîáùåíèé

Êîììåíòàðèè â SMS-ñîîáùåíèÿõ

Îòïðàâêà íà ãðóïïó íîìåðîâ

Îòïðàâêà HLR-çàïðîñà

Îòïðàâêà e-mail ñîîáùåíèÿ

Ïðèìåðû îòïðàâêè e-mail ñîîáùåíèé

Îòïðàâêà ãîëîñîâîãî ñîîáùåíèÿ (çâîíîê)

• voice = m – ìóæñêîé ãîëîñ.
• voice = m2 – ìóæñêîé ãîëîñ 2.
• voice = m3 – ìóæñêîé ãîëîñ 3 (ïî óìîë÷àíèþ).
• voice = m4 – ìóæñêîé ãîëîñ 4.
• voice = w – æåíñêèé ãîëîñ.
• voice = w2 – æåíñêèé ãîëîñ 2.
• voice = w3 – æåíñêèé ãîëîñ 3.
• voice = w4 – æåíñêèé ãîëîñ 4.

Èñïîëüçîâàíèå ãîëîñîâîãî ìåíþ (IVR)

Ïðèìåðû îòïðàâêè ãîëîñîâûõ ñîîáùåíèé

Îòïðàâêà viber-ñîîáùåíèÿ

Ïåðåäà÷à ôàéëîâ

• â âèäå ïîëíîãî http(s)-àäðåñà âíåøíåãî ôàéëà, óêàçàííîãî â òåêñòå ñîîáùåíèÿ, â ôîðìàòå <file http(s)://...> (òîëüêî äëÿ êàðòèíîê è ôàéëîâ äîêóìåíòîâ);
• ìåòîäîì POST â òåëå http(s)-çàïðîñà ê ñåðâåðó. Ïðè äàííîì ñïîñîáå îòïðàâêè ïðèêðåïëÿåìûå ôàéëû íåîáõîäèìî îáîçíà÷èòü â òåêñòå ñîîáùåíèÿ ñïåöèàëüíûì îáðàçîì â âèäå "<file n>", ãäå n - íîìåð ôàéëà â ôîðìèðóåìîì ñïèñêå íà÷èíàÿ ñ åäèíèöû;
• äîáàâëåíèåì â http(s)-çàïðîñ ñïåöèàëüíîãî äîïîëíèòåëüíîãî ïàðàìåòðà fileurl, ñîäåðæàùåãî ïîëíûé http(s)-àäðåñ ïåðåäàâàåìîãî âíåøíåãî ôàéëà. Ïðè èñïîëüçîâàíèè fileurl ïåðåäà÷à â çàïðîñå ïàðàìåòðà mes íåîáÿçàòåëüíà;
• ïðè îòïðàâêå ñ ëè÷íîãî êàáèíåòà èëè ÷åðåç API âñòàâêîé â òåêñò ñîîáùåíèÿ ïîëíîé http(s)-ññûëêè ðàíåå çàãðóæåííîãî ôàéëà, óçíàòü êîòîðóþ ìîæíî â ëè÷íîì êàáèíåòå íà ñòðàíèöå îòïðàâêè, íàæàâ ïîñëåäîâàòåëüíî "ïðèêðåïèòü ôàéë" – "Çàãðóæåííûå ôàéëû".

• jpg, jpeg, gif, png – äëÿ êàðòèíîê;
• doc, docx, rtf, dotx, dot, odf, fodt, odt, txt, info, pdf, xps, eps, pdax, xlsx, xlsm, fods, ods, csv, xltx – äëÿ ôàéëîâ äîêóìåíòîâ;
• 3gp, m4v, mov, mp4 – äëÿ âèäåî.

Äîáàâëåíèå êíîïêè

Òèïû ñîîáùåíèé

• Òîëüêî òåêñò – àáîíåíò ïîëó÷àåò òåêñòîâîå ñîîáùåíèå.
• Òîëüêî êàðòèíêà – àáîíåíò ïîëó÷àåò êàðòèíêó.
• Òåêñò+êíîïêà – àáîíåíò ïîëó÷àåò òåêñòîâîå ñîîáùåíèå, ïîä êîòîðûì ðàñïîëîæåíà êíîïêà. Ïðè íàæàòèè íà êíîïêó ïðîèñõîäèò ïåðåõîä ïî çàäàííîé ññûëêå.
• Òåêñò+êíîïêà+êàðòèíêà – àáîíåíò ïîëó÷àåò òåêñòîâîå ñîîáùåíèå, ïîä êîòîðûì ðàñïîëîæåíû êàðòèíêà è êíîïêà. Ïðè íàæàòèè íà êíîïêó ïðîèñõîäèò ïåðåõîä ïî çàäàííîé ññûëêå.
• Òîëüêî ôàéë – àáîíåíòó ïåðåäàåòñÿ ôàéë îäíîãî èç ïîääåðæèâàåìûõ ôîðìàòîâ.
• Êàðòèíêà+âèäåî – àáîíåíò ïîëó÷àåò âèäåî-ôàéë, çàñòàâêîé ê êîòîðîìó ÿâëÿåòñÿ ïåðåäàâàåìàÿ êàðòèíêà.
• Òåêñò+êàðòèíêà+âèäåî – àáîíåíò ïîëó÷àåò âèäåî-ôàéë ñ êàðòèíêîé-çàñòàâêîé è óêàçàííûì òåêñòîì.
• Òåêñò+êàðòèíêà+âèäåî+êíîïêà – àáîíåíò ïîëó÷àåò âèäåî-ôàéë ñ êàðòèíêîé-çàñòàâêîé, óêàçàííûì òåêñòîì è êíîïêîé. Ïðè íàæàòèè íà êíîïêó ïðîèñõîäèò ïåðåõîä ïî çàäàííîé ññûëêå.

• Hello! This is test message
• Çäðàâñòâóéòå! Ýòî òåñòîâîå ñîîáùåíèå
• Test
• Òåñò
• Test {button,https://m.smsc.ru,site}
• Òåñò {button,https://m.smsc.ru,ñàéò}
• Picture <file http://m.smsc.ru/im/smsc_logo_tiny.gif>
• Êàðòèíêà <file http://m.smsc.ru/im/smsc_logo_tiny.gif>

Ïðèìåðû îòïðàâêè viber-ñîîáùåíèé

Îòïðàâêà ñîîáùåíèÿ â Telegram

Ïðèìåðû îòïðàâêè ñîîáùåíèé â Telegram

Îòïðàâêà ñîîáùåíèÿ â ÷àò-áîò Telegram

Ïðèìåðû îòïðàâêè ñîîáùåíèé â ÷àò-áîò Telegram

Èñïîëüçîâàíèå ïðåôèêñîâ ïðè îòïðàâêå ñîîáùåíèé

Óïðàâëåíèå øàáëîíàìè ñîîáùåíèé

• ïðè fmt = 0:
  ERROR = N (îïèñàíèå)
  
  
• ïðè fmt = 1:
  0,-N
  
  
• ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: ID - <id>
  
  
• ïðè fmt = 1: <id>
  
  
• ïðè fmt = 2:

  <template> <id>id</id> </template>

  
  
• ïðè fmt = 3:

  { "id": <id> }

• ïðè fmt = 0, 1: OK
  
  
• ïðè fmt = 2:
  <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  
  

• ïðè fmt = 0:

  id = <id>, name = <name>, format = <format>, sender = <sender>, flag = <flag>, message = <message> ...

  
  
• ïðè fmt = 1:

  <id>,<name>,<format>,<sender>,<flag>,<message> ...

  
  
• ïðè fmt = 2:

  <list> <template> <id>id</id> <name>name</name> <format>format</format> <sender>sender</sender> <flag>flag</flag> <message>message</message> </template> ... </list>

  
  
• ïðè fmt = 3:

  [{ "id": <id>, "name": "<name>", "format": "<format>", "sender": "<sender>", "flag": <flag>, "message": "<message>" }, ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ íà äåéñòâèÿ ñ øàáëîíàìè â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Óïðàâëåíèå øàáëîíàìè îïåðàòîðîâ

• ïðè fmt = 0:
  ERROR = N (îïèñàíèå)
  
  
• ïðè fmt = 1:
  0,-N
  
  
• ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  name = <status>, id = <id> ...

  
  
• ïðè fmt = 1:

  <name>,<status>,<id> ...

  
  
• ïðè fmt = 2:

  <result> <template> <name>name</name> <status>status</status> <id>id</id> </template> ... </result>

  
  
• ïðè fmt = 3:

  [{ "name": <status>, "id": <id> }, ...]

• ïðè fmt = 0:

  name = <status>, id = <id> ...

  
  
• ïðè fmt = 1:

  <name>,<status>,<id> ...

  
  
• ïðè fmt = 2:

  <result> <template> <name>name</name> <status>status</status> <id>id</id> </template> ... </result>

  
  
• ïðè fmt = 3:

  [{ "name": <status>, "id": <id> }, ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå äåñÿòè îäèíàêîâûõ çàïðîñîâ íà äåéñòâèÿ ñ øàáëîíàìè â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Âèðòóàëüíàÿ îòïðàâêà (ðåæèì òåñòèðîâàíèÿ)

Óâåäîìëåíèÿ î ñîáûòèÿõ

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0 è fmt = 1: OK
  
  
• ïðè fmt = 2:

  <result>OK</result>

  
  
• ïðè fmt = 3:

  { "result": "OK" }

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå ïÿòè îäèíàêîâûõ çàïðîñîâ íà îòïðàâêó óâåäîìëåíèÿ â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Äåéñòâèÿ ñ ðàññûëêàìè

Âñå ïàðàìåòðû, êîòîðûå ñîäåðæàò ñïåöèàëüíûå ñèìâîëû (ïëþñ, ïðîáåë è ò.ä.), äîëæíû áûòü çàêîäèðîâàíû ïðè ïîìîùè ôóíêöèè urlencode äëÿ ïåðåäà÷è â HTTP-çàïðîñå.

Ðàññûëêè. Îòâåò ñåðâåðà è êîäû îøèáîê

• ERROR = N (îïèñàíèå) – äëÿ îøèáîê 1,2,3,4,5,9.

• 0,-N – äëÿ îøèáîê 1,2,3,4,5,9.

• Äëÿ îøèáîê 1,2,3,4,5,9:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

• Äëÿ îøèáîê 1,2,3,4,5,9:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè cost = 0 è fmt = 0: OK, ID - <id>
  
  
• ïðè cost = 1 è fmt = 0: OK, ID - <id>, COST - <cost>
  
  
• ïðè cost = 0 è fmt = 1: <id>
  
  
• ïðè cost = 1 è fmt = 1: <id>,<cost>
  
  
• ïðè cost = 0 è fmt = 2:

  <result> <id>id</id> </result>

  
  
• ïðè cost = 1 è fmt = 2:

  <result> <id>id</id> <cost>cost</cost> </result>

  
  
• ïðè cost = 0 è fmt = 3:

  { "id": <id> }

  
  
• ïðè cost = 1 è fmt = 3:

  { "id": <id>, "cost": "<cost>" }

• ïðè fmt = 0,1: OK
  
  
• ïðè fmt = 2:

  <result>OK</result>

  
  
• ïðè fmt = 3:

  { "result": "OK" }

• ïðè fmt = 0: <id>|<name>|<subject>|<repeat_send>|<repeat_cnt>|<created>|<changed>|<need_date>|<last_sent>|<phones>|<message>|<format>|<validity>|<period>|<frequency>|<status>|<sender_id>
  
  
• ïðè fmt = 1: <id>;<name>;<subject>;<repeat_send>;<repeat_cnt>;<created>;<changed>;<need_date>;<last_sent>;<phones>;<message>;<format>;<validity>;<period>;<frequency>;<status>;<sender_id>
  
  
• ïðè fmt = 2:

  <job> <id>id</id> <name>name</name> <subject>subject</subject> <repeat_send>repeat_send</repeat_send> <repeat_cnt>repeat_cnt</repeat_cnt> <created>created</created> <changed>changed</changed> <need_date>need_date</need_date> <last_sent>last_sent</last_sent> <phones>phones</phones> <message>message</message> <format>format</format> <validity>validity</validity> <period>period</period> <frequency>frequency</frequency> <status>status</status> <sender_id>sender_id</sender_id> </job>

  
  
• ïðè fmt = 3:

  [ { "id": <id>, "name": "<name>", "subject": "<subject>", "repeat_send": <repeat_send>, "repeat_cnt": <repeat_cnt>, "created": "<created>", "changed": "<changed>", "need_date": "<need_date>", "last_sent": "<last_sent>", "phones": "<phones>", "message": "<message>", "format": <format>, "validity": <validity>, "period": "<period>", "frequency": <frequency>, "status": <status>, "cost": "<cost>", "sms_sent": <sms_sent>, "sms_ok": <sms_ok>, "sender_id": "<sender_id>" } ]

  
  

• ïðè fmt = 0: <id>|<name>|<changed>|<need_date>|<last_sent>|<phones>|<message>|<phones_cnt>|<cost>|<status>|<sender_id>|<format>
  
  
• ïðè fmt = 1: <id>;<name>;<changed>;<need_date>;<last_sent>;<phones>;<message>;<phones_cnt>;<cost>;<status>;<sender_id>;<format>
  
  
• ïðè fmt = 2:

  <sms_jobs> <job> <id>id</id> <name>name</name> <changed>changed</changed> <need_date>need_date</need_date> <last_sent>last_sent</last_sent> <phones>phones</phones> <message>message</message> <phones_cnt>phones_cnt</phones_cnt> <cost>cost</cost> <status>status</status> <sender_id>sender_id</sender_id> <format>format</format> </job> ... </sms_jobs>

  
  
• ïðè fmt = 3:

  [ { "id": <id>, "name": "<name>", "changed": "<changed>", "need_date": "<need_date>", "last_sent": "<last_sent>", "phones": "<phones>", "message": "<message>", "phones_cnt": <phones_cnt>, "cost": "<cost>", "status": <status>, "sender_id": "<sender_id>", "format": <format>, "sms_sent": <sms_sent>, "sms_ok": <sms_ok> }, ... ]

  
  

Ïðèìåðû îïåðàöèé ñ ðàññûëêàìè

Ïðîâåðêà ñòàòóñà

Ñòàòóñû ñîîáùåíèé. Îòâåò ñåðâåðà è êîäû îøèáîê

• Ïðè fmt = 0:
  ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0 è all = 0: Status = <status>, check_time = <last_date>, err = <err>
  
  
• ïðè fmt = 1 è all = 0: <status>,<last_timestamp>,<err>
  
  
• ïðè fmt = 2 è all = 0:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> </sms>

  
  
• ïðè fmt = 3 è all = 0:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err> }

  
  
• ïðè fmt = 0 è all = 1:

  Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, comment = <comment>, type = <type>

  
  
• ïðè fmt = 1 è all = 1:
  <status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<cost>,<sender>,<status_name>,<message>, <comment>, <type>
  
  
• ïðè fmt = 2 è all = 1:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> <send_date>send_date</send_date> <send_timestamp>send_timestamp</send_timestamp> <phone>phone</phone> <cost>cost</cost> <sender_id>sender</sender_id> <status_name>status_name</status_name> <message>message</message> <comment>comment</comment> <type>type</type> <sms_cnt>sms_cnt</sms_cnt> </sms>

  
  
• ïðè fmt = 3 è all = 1:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err>, "send_date": "<send_date>", "send_timestamp": <send_timestamp>, "phone": "<phone>", "cost": "<cost>", "sender_id": "<sender>", "status_name": "<status_name>", "message": "<message>", "comment": "<comment>", "type": <type>, "sms_cnt": <sms_cnt> }

  
  
• ïðè fmt = 0 è all = 2:

  Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, mccmnc = <mccmnc>, country = <country>, operator = <operator>, operator_orig= <operator_orig>, region = <region>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, comment = <comment>, type = <type>

  
  
• ïðè fmt = 1 è all = 2:

  <status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<country>,<operator>,<region>,<cost>,<sender>,<status_name>,<message>, <comment>, <type>

  
  
• ïðè fmt = 2 è all = 2:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> <send_date>send_date</send_date> <send_timestamp>send_timestamp</send_timestamp> <phone>phone</phone> <cost>cost</cost> <sender_id>sender</sender_id> <status_name>status_name</status_name> <message>message</message> <comment>comment</comment> <mccmnc>mccmnc</mccmnc> <country>country</country> <operator>operator</operator> <operator_orig>operator_orig</operator_orig> <region>region</region> <type>type</type> <sms_cnt>sms_cnt</sms_cnt> </sms>

  
  
• ïðè fmt = 3 è all = 2:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err>, "send_date": "<send_date>", "send_timestamp": <send_timestamp>, "phone": "<phone>", "cost": "<cost>", "sender_id": "<sender>", "status_name": "<status_name>", "message": "<message>", "comment": "<comment>", "mccmnc": "<mccmnc>", "country": "<country>", "operator": "<operator>", "operator_orig": "<operator_orig>", "region": "<region>", "type": <type>, "sms_cnt": <sms_cnt> }

• ïðè fmt = 0 è all = 0:

  Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>

  
  
• ïðè fmt = 1 è all = 0: <status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>
  
  
• ïðè fmt = 2 è all = 0:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> <imsi>imsi</imsi> <msc>msc</msc> <mcc>mcc</mcc> <mnc>mnc</mnc> <cn>cn</cn> <net>net</net> <rcn>rcn</rcn> <rnet>rnet</rnet> </sms>

  
  
• ïðè fmt = 3 è all = 0:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err>, "imsi": "<imsi>", "msc": "<msc>", "mcc": "<mcc>", "mnc": "<mnc>", "cn": "<cn>", "net": "<net>", "rcn": "<rcn>", "rnet": "<rnet>" }

  
  
• ïðè fmt = 0 è all = 1:

  Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>, send_date = <send_date>, phone = <phone>, cost = <cost>, sender_id = <sender_id>, status_name = <status_name>, message = <message>, type = <type>

  
  
• ïðè fmt = 1 è all = 1:

  <status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>, <send_timestamp>,<phone>,<cost>,<sender_id>,<status_name>,<message>,<type>

  
  
• ïðè fmt = 2 è all = 1:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> <imsi>imsi</imsi> <msc>msc</msc> <mcc>mcc</mcc> <mnc>mnc</mnc> <cn>cn</cn> <net>net</net> <rcn>rcn</rcn> <rnet>rnet</rnet> <send_date>send_date</send_date> <send_timestamp>send_timestamp</send_timestamp> <phone>phone</phone> <cost>cost</cost> <sender_id>sender_id</sender_id> <status_name>status_name</status_name> <message>message</message> <type>type</type> </sms>

  
  
• ïðè fmt = 3 è all = 1:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err>, "imsi": "<imsi>", "msc": "<msc>", "mcc": "<mcc>", "mnc": "<mnc>", "cn": "<cn>", "net": "<net>", "rcn": "<rcn>", "rnet": "<rnet>", "send_date": "<send_date>", "send_timestamp": <send_timestamp>, "phone": "<phone>", "cost": "<cost>", "sender_id": "<sender>", "status_name": "<status_name>", "message": "<message>", "type": <type> }

  
  
• ïðè fmt = 0 è all = 2:

  Status = <status>, check_time = <check_time>, err = <err>, imsi = <imsi>, msc = <msc>, mcc = <mcc>, mnc = <mnc>, cn = <cn>, net = <net>, rcn = <rcn>, rnet = <rnet>, send_date = <send_date>, phone = <phone>, country = <country>, operator = <operator>, region = <region>, cost = <cost>, sender_id = <sender_id>, status_name = <status_name>, message = <message>, type = <type>

  
  
• ïðè fmt = 1 è all = 2:

  <status>,<last_timestamp>,<err>,<imsi>,<msc>,<mcc>,<mnc>,<cn>,<net>,<rcn>,<rnet>, <send_timestamp>,<phone>,<country>,<operator>,<region>,<cost>,<sender_id>,<status_name>,<message>,<type>

  
  
• ïðè fmt = 2 è all = 2:

  <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <flag>flag</flag> <err>err</err> <imsi>imsi</imsi> <msc>msc</msc> <mcc>mcc</mcc> <mnc>mnc</mnc> <cn>cn</cn> <net>net</net> <rcn>rcn</rcn> <rnet>rnet</rnet> <send_date>send_date</send_date> <send_timestamp>send_timestamp</send_timestamp> <phone>phone</phone> <cost>cost</cost> <sender_id>sender_id</sender_id> <status_name>status_name</status_name> <message>message</message> <country>country</country> <operator>operator</operator> <region>region</region> <type>type</type> </sms>

  
  
• ïðè fmt = 3 è all = 2:

  { "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "flag": <flag>, "err": <err>, "imsi": "<imsi>", "msc": "<msc>", "mcc": "<mcc>", "mnc": "<mnc>", "cn": "<cn>", "net": "<net>", "rcn": "<rcn>", "rnet": "<rnet>", "send_date": "<send_date>", "send_timestamp": <send_timestamp>, "phone": "<phone>", "cost": "<cost>", "sender_id": "<sender>", "status_name": "<status_name>", "message": "<message>", "country": "<country>", "operator": "<operator>", "region": "<region>", "type": <type> }

  
  

• äëÿ fmt = 0 è fmt = 1 â ðåçóëüòàòå âîçâðàùàåòñÿ ñïèñîê ñòðîê, êàæäàÿ èç êîòîðûõ ñîäåðæèò èíôîðìàöèþ î ñòàòóñå ñîîòâåòñòâóþùåãî ñîîáùåíèÿ.
• äëÿ fmt = 2 ôîðìàò âîçâðàùàåìûõ ñòàòóñîâ àíàëîãè÷åí ôîðìàòó äëÿ îäèíî÷íûõ ñîîáùåíèé, ïðè ýòîì âåñü ñïèñîê ñòàòóñîâ çàêëþ÷àåòñÿ â òåã "<list>".
• äëÿ fmt = 3 ôîðìàò òàêæå àíàëîãè÷åí ôîðìàòó äëÿ îäèíî÷íûõ ñîîáùåíèé, ñòàòóñû ïåðå÷èñëÿþòñÿ ÷åðåç çàïÿòóþ, è âåñü ñïèñîê îáðàìëÿåòñÿ êâàäðàòíûìè ñêîáêàìè.

Êîäû ñòàòóñîâ

Çàïðîñ ñòàòóñîâ ñîîáùåíèé íåîáõîäèìî îñóùåñòâëÿòü â òå÷åíèå ñóòîê ñ ìîìåíòà îòïðàâêè. Ïî èñòå÷åíèè äàííîãî âðåìåíè ñîîáùåíèÿ ïîìåùàþòñÿ â àðõèâíóþ áàçó.  03:00 ïî ìîñêîâñêîìó âðåìåíè ïåðåíîñÿòñÿ ñîîáùåíèÿ ñ êîíå÷íûì ñòàòóñîì, îòïðàâëåííûå äî 18:00 ïðîøåäøåãî äíÿ. Äëÿ âîçìîæíîñòè ïîëó÷åíèÿ ðåàëüíûõ ñòàòóñîâ òàêèõ ñîîáùåíèé íåîáõîäèìî îáðàòèòüñÿ â ñëóæáó ïîääåðæêè.

Òàêæå ñåðâåð íå ïðèíèìàåò áîëåå ïÿòè îäèíàêîâûõ çàïðîñîâ íà ïîëó÷åíèå ñòàòóñà îäíîãî è òîãî æå ñîîáùåíèÿ èëè áîëåå îäíîãî ìàññîâîãî çàïðîñà â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Êîäû îøèáîê â ñòàòóñå

Óäàëåíèå ñîîáùåíèÿ

• ïðè fmt = 0,1: OK
  
  
• ïðè fmt = 2:
  <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  

Óäàëåíèå ñîîáùåíèé íåîáõîäèìî ïðîèçâîäèòü äî ïåðåíîñà â àðõèâíóþ áàçó.

Ïðîâåðêà ñîñòîÿíèÿ áàëàíñà

Çàïðîñ áàëàíñà

Áàëàíñ. Îòâåò ñåðâåðà è êîäû îøèáîê

• Ïðè fmt = 0:
  ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0 èëè 1: <balance>
  
  
• ïðè fmt = 2: <balance>balance</balance>
  
  
• ïðè fmt = 3:

  { "balance": "<balance>" }

• ïðè fmt = 0: <balance> <currency>
  
  
• ïðè fmt = 1: <balance>,<currency>
  
  
• Ïðè fmt = 2:

  <result> <balance>balance</balance> <credit>credit</credit> <currency>currency</currency> </result>

  
  
• ïðè fmt = 3:

  { "balance": "<balance>", "credit": "<credit>", "currency": "<currency>" }

Ñåðâåð íå ïðèíèìàåò áîëåå äåñÿòè çàïðîñîâ íà ïîëó÷åíèå áàëàíñà â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Äåéñòâèÿ ñ êîíòàêòàìè è ãðóïïàìè

Êîíòàêòû è ãðóïïû. Îïèñàíèå ïàðàìåòðîâ

Êîíòàêòû è ãðóïïû. Îòâåò ñåðâåðà è êîäû îøèáîê

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: ID = <id>
  
  
• ïðè fmt = 1: <id>
  
  
• ïðè fmt = 2 (ñîçäàíèå êîíòàêòà, çàïèñè "÷åðíîãî" ñïèñêà):

  <phone> <id>id</id> </phone>

  
  
• ïðè fmt = 2 (ñîçäàíèå ãðóïïû):

  <group> <id>id</id> </group>

  
  
• ïðè fmt = 3:

  { "id": <id> }

  
  

• ïðè fmt = 0,1: OK
  
  
• ïðè fmt = 2: <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  
  

• ïðè fmt = 0:

  phone = <phone>, name = <name>, group = <group>, first_name = <first_name>, last_name = <last_name>, middle_name = <middle_name>, birthday = <birthday>, id = <id>, comments = <comments>, tags = <tags>, phone_other = <phone_other> ...

  
  
• ïðè fmt = 1:

  <phone>,<name>,<group>,<first_name>,<last_name>,<middle_name>,<birthday>,<id>,<comments>,<tags>,<phone_other> ...

  
  
• ïðè fmt = 2:

  <list> <contact> <phone>phone</phone> <name>name</name> <group>group</group> <first_name>first_name</first_name> <last_name>last_name</last_name> <middle_name>middle_name</middle_name> <birthday>birthday</birthday> <id>id</id> <comments>comments</comments> <tags>tags</tags> <phone_other>phone_other</phone_other> </contact> ... </list>

  
  
• ïðè fmt = 3:

  [{ "phone": "<phone>", "name": "<name>", "group": <group>, "first_name": "<first_name>", "last_name": "<last_name>", "middle_name": "<middle_name>", "birthday": "<birthday>", "id": "<id>", "comments": "<comments>", "tags": "<tags>", "phone_other": "<phone_other>" }, ...]

  
  

• ïðè fmt = 0:

  id = <id>, name = <name>, number = <number>, cnt = <cnt> ...

  
  
• ïðè fmt = 1:

  <id>,<name>,<number>,<cnt> ...

  
  
• ïðè fmt = 2:

  <list> <group> <id>id</id> <name>name</name> <number>number</number> <cnt>number</cnt> </group> ... </list>

  
  
• ïðè fmt = 3:

  [{ "id": <id>, "name": "<name>", "number": <number>, "cnt": "<cnt>" }, ...]

  
  

• ïðè fmt = 0:

  id = <id>, phone = <phone>, type = <type>, comment = <comment> ...

  
  
• ïðè fmt = 1:

  <id>,<phone>,<type>,<comment> ...

  
  
• ïðè fmt = 2:

  <list> <record> <id>id</id> <phone>phone</phone> <type>type</type> <comment>comment</comment> </record> ... </list>

  
  
• ïðè fmt = 3:

  [{ "id": <id>, "phone": "<phone>", "type": <type>, "comment": "<comment>" }, ...]

  
  

Ïðèìåðû îïåðàöèé ñ êîíòàêòàìè

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà îïåðàöèè ñ ãðóïïàìè, êîíòàêòàìè èëè çàïèñÿìè "÷åðíîãî" ñïèñêà äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïåðå÷åíü äîñòóïíûõ îïåðàöèé

Ñóáêëèåíòû. Îïèñàíèå ïàðàìåòðîâ

Îòâåò ñåðâåðà è êîäû îøèáîê

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: ID = <id>
  
  
• ïðè fmt = 1: <id>
  
  
• ïðè fmt = 2:

  <user <id>id</id> </user>

  
  
• ïðè fmt = 3:

  { "id": <id> }

  
  

• ïðè fmt = 0,1: OK
  
  
• ïðè fmt = 2:
  <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  
  

• ïðè fmt = 0 è get_stat = 1:

  login = <login>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency> ...

  
  
• ïðè fmt = 0 è get_stat_all = 1:

  login = <login>, description = <description>, operator = <operator>, mccmnc = <mccmnc>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency> ...

  
  
• ïðè fmt = 1 è get_stat = 1:

  <login>,<cnt>,<credit>,<debit>,<currency> ...

  
  
• ïðè fmt = 1 è get_stat_all = 1:

  <login>,<description>,<operator>,<mccmnc>,<cnt>,<credit>,<debit>,<currency> ...

  
  
• ïðè fmt = 2 è get_stat = 1:

  <list> <stat> <login>login</login> <sms>cnt</sms> <credit>credit</credit> <debit>debit</debit> <currency>currency</currency> </stat> ... </list>

  
  
• ïðè fmt = 2 è get_stat_all = 1:

  <list> <user login="login"> <item> <description>description</description> <operator>operator</operator> <mccmnc>mccmnc</mccmnc> <sms>cnt</sms> <credit>credit</credit> <debit>debit</debit> <currency>currency</currency> </item> ... </user> ... </list>

  
  
• ïðè fmt = 3 è get_stat = 1:

  [{ "login": "<login>", "sms": "<cnt>", "credit": "<credit>", "debit": "<debit>", "currency": "<currency>" }, ...]

  
  
• ïðè fmt = 3 è get_stat_all = 1:

  [{ "login": "<login>", "items": [{ "description": "<description>", "operator": "<operator>", "mccmnc": "<mccmnc>", "sms": "<cnt>", "credit": "<credit>", "debit": "<debit>", "currency": "<currency>" }, ...] }, ...]

  
  

Ïðèìåðû äåéñòâèé ñ ñóáêëèåíòàìè

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ çàïðîñîâ â òå÷åíèå ìèíóòû íà äîáàâëåíèå ñóáêëèåíòîâ èëè èçìåíåíèå îäíîãî è òîãî æå ñóáêëèåíòà äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ñîçäàíèå è âûãðóçêà ñ÷åòîâ è àêòîâ

{ "error": "îïèñàíèå", "error_code": N }

Ñåðâåð íå ïðèíèìàåò áîëåå îäíîãî çàïðîñà íà ñîçäàíèå èëè èçìåíåíèå ñ÷åòà èëè àêòà â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïåðå÷åíü äîñòóïíûõ îïåðàöèé ñ èìåíàìè îòïðàâèòåëåé

Îïèñàíèå ïàðàìåòðîâ

Îòâåò ñåðâåðà è êîäû îøèáîê

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0 è all = 0:

  name = <sender>, id = <id> ...

  
  
• ïðè fmt = 1 è all = 0:

  <sender>,<id> ...

  
  
• ïðè fmt = 2 è all = 0:

  <list> <sender id="<id>">sender</sender> ... </list>

  
  
• ïðè fmt = 3 è all = 0:

  [{ "sender": "<sender>", "id": <id> }, ...]

  
  
• ïðè fmt = 0 è all = 1:

  name = <sender>, status = <status>, id = <id> ...

  
  
• ïðè fmt = 1 è all = 1:

  <sender>,<status>,<id> ...

  
  
• ïðè fmt = 2 è all = 1:

  <list> <sender status="<status>" id="<id>">sender</sender> ... </list>

  
  
• ïðè fmt = 3 è all = 1:

  [{ "sender": "<sender>", "status": <status>, "id": <id> }, ...]

  
  
• ïðè fmt = 0 è operators = 1:

  name = <sender>, mega_step = <mega_step_status>, bee_step = <bee_step_status>, motiv_step = <motiv_step_status>, sber_step = <sber_step_status>, winmob_step = <winmob_step>, volnamob_step = <volnamob_step>, mts_step = <mts_step_status>, tele2_step = <tele2_step_status>, tele2 = <tele2_status>, ua_reg = <ua_reg_status>, ua_int = <ua_int_status>, mega_int = <mega_int_status>, motiv_int = <motiv_int_status>, mts_int = <mts_int_status>, motiv = <motiv_status>, by_reg = <by_reg_status>, by_int = <by_int_status>, tele2_int = <tele2_int_status>, sber_int = <sber_int_status>, id = <id> ...

  
  
• ïðè fmt = 2 è operators = 1:

  <list> <sender mega_step="<mega_step_status>" bee_step="<bee_step_status>" motiv_step="<motiv_step_status>" sber_step="<sber_step_status>" winmob_step="<winmob_step_status>" volnamob_step="<volnamob_step_status>" mts_step="<mts_step_status>" tele2_step="<tele2_step_status>" tele2="<tele2_status>" ua_reg="<ua_reg_status>" ua_int="<ua_int_status>" mega_int="<mega_int_status>" motiv_int="<motiv_int_status>" mts_int="<mts_int_status>" motiv="<motiv_status>" by_reg="<by_reg_status>" by_int="<by_int_status>" tele2_int="<tele2_int_status>" sber_int="<sber_int_status>" id="<id>">sender</sender> ... </list>

  
  
• ïðè fmt = 3 è operators = 1:

  [{ "sender": "<sender>", "mega_step": "<mega_step_status>", "mega_int": "<mega_int_status>", "bee_step": "<bee_step_status>", "motiv": "<motiv_status>", "motiv_step": "<motiv_step_status>", "motiv_int": "<motiv_int_status>", "sber_step": "<sber_step_status>", "sber_int": "<sber_int_status>", "winmob_step": "<winmob_step_status>", "volnamob_step": "<volnamob_step_status>", "mts_step": "<mts_step_status>", "mts_int": "<mts_int_status>", "tele2_step": "<tele2_step_status>", "tele2": "<tele2_status>", "tele2_int": "<tele2_int_status>", "ua_reg": "<ua_reg_status>", "ua_int": "<ua_int_status>", "by_reg": "<by_reg_status>", "by_int": "<by_int_status>", "id": "<id>" }, ...]

  
  

• ïðè fmt = 0: ID = <id>
  
  
• ïðè fmt = 1: <id>
  
  
• ïðè fmt = 2:

  <sender> <id>id</id> </sender>

  
  
• ïðè fmt = 3:

  { "sender": <id> }

  
  

• ïðè fmt = 0, 1: OK
  
  
• ïðè fmt = 2:
  <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  
  

Ïðèìåðû äåéñòâèé ñ èìåíàìè îòïðàâèòåëåé

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå ñïèñêà äîñòóïíûõ èìåí îòïðàâèòåëåé è ïÿòè çàïðîñîâ íà ñîçäàíèå íîâîãî èìåíè îòïðàâèòåëÿ äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïîëó÷åíèå èñòîðèè îòïðàâëåííûõ ñîîáùåíèé

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  Status = <status>, check_time = <last_date>, err = <err>, send_date = <send_date>, phone = <phone>, mccmnc = <mccmnc>, country = <country>, operator = <operator>, region = <region>, cost = <cost>, sender_id = <sender>, status_name = <status_name>, message = <message>, type = <type>, ID = <id>, int_id = <int_id>, sms_cnt = <sms_cnt>, format = <format>, crc = <crc> ...

  
  
• ïðè fmt = 1:

  <status>,<last_timestamp>,<err>,<send_timestamp>,<phone>,<mccmnc>,<country>,<operator>,<region>,<cost>,<sender>,<status_name>, <message>,<type>,<id>,<int_id>,<sms_cnt>,<format>,<crc> ...

  
  
• ïðè fmt = 2:

  <list> <sms> <status>status</status> <last_date>last_date</last_date> <last_timestamp>last_timestamp</last_timestamp> <err>err</err> <send_date>send_date</send_date> <send_timestamp>send_timestamp</send_timestamp> <phone>phone</phone> <cost>cost</cost> <sender_id>sender</sender_id> <status_name>status_name</status_name> <message>message</message> <mccmnc>mccmnc</mccmnc> <country>country</country> <operator>operator</operator> <region>region</region> <type>type</type> <id>id</id> <int_id>int_id</int_id> <sms_cnt>sms_cnt</sms_cnt> <format>format</format> <crc>crc</crc> </sms> ... </list>

  
  
• ïðè fmt = 3:

  [{ "status": <status>, "last_date": "<last_date>", "last_timestamp": <last_timestamp>, "err": <err>, "send_date": "<send_date>", "send_timestamp": <send_timestamp>, "phone": "<phone>", "cost": "<cost>", "sender_id": "<sender>", "status_name": "<status_name>", "message": "<message>", "mccmnc": "<mccmnc>", "country": "<country>", "operator": "<operator>", "region": "<region>", "type": <type>, "id": <id>, "int_id": "<int_id>", "sms_cnt": <sms_cnt>, "format": <format>, "crc": <crc> ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû ëèáî òðèäöàòè çàïðîñîâ â òå÷åíèå ÷àñà íà ïîëó÷åíèå èñòîðèè èñõîäÿùèõ ñîîáùåíèé äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïîëó÷åíèå âõîäÿùèõ ñîîáùåíèé

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  id = <id>, received = <received>, phone = <phone>, message = <message>, to_phone = <to_phone>, sent = <sent> ...

  
  
• ïðè fmt = 1:

  <id>,<received>,<phone>,<to_phone>,<sent>,<message> ...

  
  
• ïðè fmt = 2:

  <sms_answers> <sms> <id>id</id> <received>received</received> <phone>phone</phone> <message>message</message> <to_phone>to_phone</to_phone> <sent>sent</sent> </sms> ... </sms_answers>

  
  
• ïðè fmt = 3:

  [{ "id": <id>, "received": "<received>", "phone": "<phone>", "message": "<message>", "to_phone": "<to_phone>", "sent": "<sent>" }, ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå ñïèñêà âõîäÿùèõ ñîîáùåíèé äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïîëó÷åíèå ñòàòèñòèêè

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  login = <login>, sms = <cnt>, credit = <credit>, debit = <debit>, currency = <currency> ...

  
  
• ïðè fmt = 1:

  <login>,<cnt>,<credit>,<debit>,<currency> ...

  
  
• ïðè fmt = 2:

  <list> <stat> <login>login</login> <sms>cnt</sms> <credit>credit</credit> <debit>debit</debit> <currency>currency</currency> </stat> ... </list>

  
  
• ïðè fmt = 3:

  [{ "login": "<login>", "sms": "<cnt>", "credit": "<credit>", "debit": "<debit>", "currency": "<currency>" }, ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå ñòàòèñòèêè äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Çàïðîñ òàðèôîâ

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  zone = <zone>, name = <name>, api = <api>, mass = <mass>, mms = <mms>, hlr = <hlr>, call = <call> ...

  
  ïðè íàëè÷èè óñòàíîâëåííûõ èíäèâèäóàëüíûõ òàðèôîâ ïî îïðåäåëåííûì îïåðàòîðàì ê îòâåòó äîáàâëÿåòñÿ íàáîð ñòðîê:
  

  mccmnc = <mccmnc>, cost = <cost> ... mail = <mail>

  
  
• ïðè fmt = 1:

  <zone>,<name>,<api>,<mass>,<mms>,<hlr>,<call> ... <mccmnc>,<cost> ... <mail>

  
  
• ïðè fmt = 2:

  <price> <zones> <zone name="<name>" api="<api>" mass="<mass>" mms="<mms>" hlr="<hlr>" call="<call>">zone</zone> ... </zones> <codes> <mccmnc cost="<cost>">mccmnc</mccmnc> ... </codes> <mail>mail</mail> </price>

  
  
• ïðè fmt = 3:

  { "zones": [{ "zone": "<zone>", "name": "<name>", "api": "<api>", "mass": "<mass>", "mms": "<mms>", "hlr": "<hlr>", "call": "<call>" }, ... { ... }], "codes": [{ "mccmnc": "<mccmnc>", "cost": "<cost>" }, ... { ... }], "mail": "<mail>" }

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå ñïèñêà òàðèôîâ äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïîëó÷åíèå èíôîðìàöèè îá îïåðàòîðå

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: country = <country>, operator = <operator>, region = <region>, mcc = <mcc>, mnc = <mnc>, tz = <tz>
  
  
• ïðè fmt = 1: <country>,<operator>,<region>,<mcc>,<mnc>,<tz>
  
  
• ïðè fmt = 2:

  <info> <country>country</country> <operator>operator</operator> <region>region</region> <mcc>mcc</mcc> <mnc>mnc</mnc> <tz>tz</tz> </info>

  
  Ïðè ìíîæåñòâåííîì çàïðîñå êîíñòðóêöèè <info> çàêëþ÷àþòñÿ â òåã <list>.
  
  
• ïðè fmt = 3:

  { "country": "<country>", "operator": "<operator>", "region": "<region>", "mcc": "<mcc>", "mnc": "<mnc>", "tz": "<tz>" }

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå èíôîðìàöèè îá îïåðàòîðå àáîíåíòà äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ñåðâåð òàêæå áëîêèðóåò îòïðàâêó áîëåå 100 çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå äàííûõ îá îïåðàòîðå äëÿ ñíèæåíèÿ íàãðóçêè íà áàçó äàííûõ.

Ïîëó÷åíèå äàííûõ î êîðîòêîé ññûëêå

Âñå ïàðàìåòðû, êîòîðûå ñîäåðæàò ñïåöèàëüíûå ñèìâîëû (ïëþñ, ïðîáåë, ñèìâîëû êèðèëëèöû è ò.ä.), äîëæíû áûòü çàêîäèðîâàíû ïðè ïîìîùè ôóíêöèè urlencode äëÿ ïåðåäà÷è â HTTP-çàïðîñå.

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: id = <id>, cnt = <cnt>, cnt_mon = <cnt_mon>, cnt_day = <cnt_day>, cnt_yes = <cnt_yes>, cnt_pmon = <cnt_pmon>, link = <link>
  
  
• ïðè fmt = 1: <id>,<cnt>,<cnt_mon>,<cnt_day>,<cnt_yes>,<cnt_pmon>,<link>
  
  
• ïðè fmt = 2:

  <result> <id>id</id> <cnt>cnt</cnt> <cnt_mon>cnt_mon</cnt_mon> <cnt_day>cnt_day</cnt_day> <cnt_yes>cnt_yes</cnt_yes> <cnt_pmon>cnt_pmon</cnt_pmon> <link>link</link> </result>

  
  
• ïðè fmt = 3:

  { "id": "<id>", "cnt": "<cnt>", "cnt_mon": "<cnt_mon>", "cnt_day": "<cnt_day>", "cnt_yes": "<cnt_yes>", "cnt_pmon": "<cnt_pmon>", "link": "<link>" }

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå èíôîðìàöèè î êîðîòêîé ññûëêå äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïîäêëþ÷åíèå âûäåëåííûõ íîìåðîâ äëÿ ïðèåìà ñîîáùåíèé

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0:

  phone = <phone>, type = <type>, cost = <cost>, current_cost = <current_cost>, info = <info> ...

  
  
• ïðè fmt = 1:

  <phone>,<type>,<cost>,<current_cost>,<info> ...

  
  
• ïðè fmt = 2:

  <list> <receive_phone> <phone>phone</phone> <type>type</type> <cost>cost</cost> <current_cost>current_cost</current_cost> <info>info</info> </receive_phone> ... </list>

  
  
• ïðè fmt = 3:

  [{ "phone": "<phone>", "type": <type>, "cost": "<cost>", "current_cost": "<current_cost>" "info": "<info>" }, ...]

  
  

• ïðè fmt = 0: cost = <cost>
  
  
• ïðè fmt = 1: <cost>
  
  
• ïðè fmt = 2:

  <phone> <cost>cost</cost> </phone>

  
  
• ïðè fmt = 3:

  { "cost": "<cost>" }

  
  

• ïðè fmt = 0,1: OK
  
  
• ïðè fmt = 2:
  <result>OK</result>
  
  
• ïðè fmt = 3:
  

  { "result": "OK" }

  
  
  

Ñåðâåð íå ïðèíèìàåò áîëåå äâóõ îäèíàêîâûõ çàïðîñîâ â òå÷åíèå ìèíóòû íà ïîëó÷åíèå ñïèñêà ñâîáîäíûõ äëÿ àðåíäû íîìåðîâ èëè ïîäêëþ÷åíèå íîìåðà, ëèáî èçìåíåíèå ñâîéñòâ âûäåëåííîãî íîìåðà äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Ïåðåäà÷à ñòàòóñîâ è ñîîáùåíèé íà îáðàáîò÷èê Êëèåíòà

Ïåðåñûëêà ñòàòóñîâ íà îáðàáîò÷èê Êëèåíòà îñóùåñòâëÿåòñÿ òîëüêî ïðè îòïðàâêå ñîîáùåíèé ïî ïðîòîêîëàì HTTP/HTTPS, SMTP èëè SMPP. Ïðè îòïðàâêå ñîîáùåíèé ñ ëè÷íîãî êàáèíåòà ïåðåäà÷à ñòàòóñîâ íà îáðàáîò÷èê Êëèåíòà íå ïðîèñõîäèò.

 ñëó÷àå åñëè îò îáðàáîò÷èêà Êëèåíòà âåðíåòñÿ îòâåò ñ êîäîì îøèáêè, îòëè÷íûì îò 200 èëè 404, òî Ñåðâåð ñ îïðåäåëåííîé ïåðèîäè÷íîñòüþ áóäåò ïîâòîðÿòü çàïðîñ íà îáðàáîò÷èê (1 çàïðîñ êàæäûå 4 ìèíóòû, âñåãî 50 ïîïûòîê).

Ïîäêëþ÷åíèå àíòèñïàì ïðîâåðêè (captcha) ê ñàéòó

Ïîäòâåðæäåíèå íîìåðà òåëåôîíà ñ ïîìîùüþ çâîíêà

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: phone = <phone>, all_phones = <all_phones>
  
  
• ïðè fmt = 1 (ïåðâûì èäåò íîìåð, íà êîòîðûé íåîáõîäèìî ïîçâîíèòü àáîíåíòó): <all_phones>
  
  
• ïðè fmt = 2:

  <result> <phone>phone</phone> <all_phones> <phone>phone</phone> ... <phone>phone</phone> </all_phones> </result>

  
  
• ïðè fmt = 3:

  { "phone": "<phone>", "all_phones": [ <phone>", ... "<phone>" ] }

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå ïÿòèäåñÿòè îäèíàêîâûõ çàïðîñîâ íà ïîëó÷åíèå íîìåðà òåëåôîíà äëÿ ïîäòâåðæäåíèÿ â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.

Äåéñòâèÿ ñ îòëîæåííûìè çàäàíèÿìè

• ERROR = N (îïèñàíèå)
  
  
• Ïðè fmt = 1:
  0,-N
  
  
• Ïðè fmt = 2:

  <result> <error>îïèñàíèå</error> <error_code>N</error_code> </result>

  
  
• Ïðè fmt = 3:

  { "error": "îïèñàíèå", "error_code": N }

• ïðè fmt = 0: id = <id>, name = <name>, status = <status>, created = <created>, time = <time>, file = <file>
  
  
• ïðè fmt = 1: <id>,<name>,<status>,<created>,<time>,<file>
  
  
• ïðè fmt = 2:

  <list> <task> <id>id</id> <name>name</name> <status>status</status> <created>created</created> <time>time</time> <file>file</file> </task> ... </list>

  
  
• ïðè fmt = 3:

  [{ "id": id, "name": "name", "status": "status", "created": "created", "time": "time", "file": "file" }, ...]

  
  

Ñåðâåð íå ïðèíèìàåò áîëåå òðåõ îäèíàêîâûõ çàïðîñîâ íà ïîëó÷åíèå ñïèñêà çàäàíèé èëè íà ñêà÷èâàíèå ôàéëà â òå÷åíèå ìèíóòû äëÿ ñíèæåíèÿ íàãðóçêè è çàùèòû îò îøèáîê è çàöèêëèâàíèé â ïðîãðàììå íà ñòîðîíå Êëèåíòà.