| Ответ сервера и коды ошибокВ случае ошибки Сервер возвращает следующую строку:
- ERROR = N (описание)
- При fmt = 1:
0,-N
- При fmt = 2:
<result>
<error>описание</error>
<error_code>N</error_code>
</result> |
- При fmt = 3:
{
"error": "описание",
"error_code": N
} |
N – номер ошибки, может принимать следующие значения:
| Значение | Описание
|
|---|
| 1 | Ошибка в параметрах.
|
|---|
| 2 | Неверный логин или пароль. Также возникает при попытке отправки сообщения с IP-адреса, не входящего в список разрешенных Клиентом (если такой список был настроен Клиентом ранее).
|
|---|
| 3 | Записи не найдены.
|
|---|
| 4 | IP-адрес временно заблокирован.
|
|---|
| 5 | Ошибка выполнения операции.
|
|---|
| 9 | Попытка отправки более трех одинаковых запросов на операции с группами, контактами или записями "черного" списка в течение минуты.
Данная ошибка возникает также при попытке отправки пятнадцати и более запросов одновременно с разных подключений под одним логином (too many concurrent requests).
|
|---|
В случае успешного запроса Сервер возвращает ответ в виде строки.
При создании контакта, группы контактов, записи "черного" списка:
- при fmt = 0: ID = <id>
- при fmt = 1: <id>
- при fmt = 2 (создание контакта, записи "черного" списка):
<phone>
<id>id</id>
</phone> |
- при fmt = 2 (создание группы):
<group>
<id>id</id>
</group> |
- при fmt = 3:
Где <id> – идентификатор контакта, группы или записи "черного" списка, назначенный Сервером автоматически.
При изменении или удалении контакта (группы), удалении записи "черного" списка:
- при fmt = 0,1: OK
- при fmt = 2: <result>OK</result>
- при fmt = 3:
При запросе списка контактов:
- при 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>"
},
...] |
Где:
<phone> – список номеров телефонов через любой разделитель. Для e-mail адресов заменяется на <mail>.
<name> – название контакта.
<group> – идентификатор группы, к которой принадлежит контакт.
<first_name> – имя.
<last_name> – фамилия.
<middle_name> – отчество.
<birthday> – дата рождения в формате дд.мм.гггг.
<id> – id контакта, назначенный Клиентом.
<comments> – комментарии.
<tags> – теги (метки).
<phone_other> – другие номера телефонов. По данным номерам рассылка сообщений не выполняется. Для e-mail
адресов заменяется на <mail_other>.
При запросе списка групп:
- при fmt = 0:
id = <id>, name = <name>, number = <number>
... |
- при fmt = 1:
- при fmt = 2:
<list>
<group>
<id>id</id>
<name>name</name>
<number>number</number>
</group>
...
</list> |
- при fmt = 3:
[{
"id": <id>,
"name": "<name>",
"number": <number>
},
...] |
Где:
<id> – идентификатор группы, назначенный Сервером при создании.
<name> – название группы.
<number> – номер группы для рассылок. |
Ответ сервера и коды ошибок