| Управление контактамиДействия с контактами и группамиДля управления контактами или группами необходимо вызвать методом GET или POST соответствующий адрес с указанием
требуемой команды и параметров.
Для создания контакта:
http://my.smsc.dp.ua/sys/phones.php?add=1&login=<login>&psw=<password>&phone=<phone>&name=<name>
Для создания новой группы:
http://my.smsc.dp.ua/sys/phones.php?add_group=1&login=<login>&psw=<password>&name=<name>
Для изменения номера телефона в контакте:
http://my.smsc.dp.ua/sys/phones.php?chg=1&login=<login>&psw=<password>&phone=<phone>&new_phone=<new_phone>
Для изменения названия группы:
http://my.smsc.dp.ua/sys/phones.php?chg_group=1&login=<login>&psw=<password>&grp=<group_id>&name=<name>
Для переноса контакта в новую группу:
http://my.smsc.dp.ua/sys/phones.php?move_group=1&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для добавления новой группы к контакту:
http://my.smsc.dp.ua/sys/phones.php?move_group=2&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для удаления контакта из группы:
http://my.smsc.dp.ua/sys/phones.php?move_group=3&login=<login>&psw=<password>&grp=<group_id>&phone=<phone>
Для удаления контакта:
http://my.smsc.dp.ua/sys/phones.php?del=1&login=<login>&psw=<password>&phone=<phone>
Для удаления группы:
http://my.smsc.dp.ua/sys/phones.php?del_group=1&login=<login>&psw=<password>&grp=<group_id>
Для вывода списка контактов:
http://my.smsc.dp.ua/sys/phones.php?get=1&login=<login>&psw=<password>
Для вывода списка групп:
http://my.smsc.dp.ua/sys/phones.php?get_group=1&login=<login>&psw=<password>
Для добавления телефона в "черный" список:
http://my.smsc.dp.ua/sys/phones.php?add_black=1&login=<login>&psw=<password>&phone=<phone>
Для удаления телефона из "черного" списка:
http://my.smsc.dp.ua/sys/phones.php?del_black=1&login=<login>&psw=<password>&phone=<phone>
Описание параметровОписание параметров, передаваемых Серверу:
| Параметр | Значение
|
|---|
| login | Логин Клиента.
|
|---|
| psw | Пароль Клиента (можно добавить или изменить на данной странице).
|
|---|
| name | Название контакта или группы.
|
|---|
| grp | Идентификатор группы, которой принадлежит создаваемый контакт. Можно привязать контакт
сразу к нескольким группам, указав их идентификаторы через запятую.
|
|---|
| num | Номер группы для рассылок сообщений.
|
|---|
| phone | Список номеров телефонов через любой разделитель (команда add), либо номер телефона
(команды move_group, add_black). Используется для операций с номерами телефонов в скрипте phones.php.
|
|---|
| mail | Список e-mail адресов через любой разделитель (команда add), либо e-mail адрес
(команды move_group, add_black). Используется для операций с e-mail адресами в скрипте mails.php.
Формат запросов аналогичен формату для phones.php.
|
|---|
| new_phone | Новый список номеров телефонов через любой разделитель (команда chg).
|
|---|
| new_mail | Новый список e-mail адресов через любой разделитель (команда chg).
|
|---|
| lnm | Фамилия.
|
|---|
| fnm | Имя.
|
|---|
| mnm | Отчество.
|
|---|
| fio | ФИО контакта. Данный параметр используется в команде get для получения списка контактов по любому из
инициалов (фамилии, имени и (или) отчеству).
|
|---|
| search | Выборка контактов для команды get по названию контакта и (или) номеру телефона.
|
|---|
| after_id | Идентификатор контакта (int_id), начиная с которого необходимо вернуть список контактов (команда get, формат fmt=3), за исключением самого
after_id.
|
|---|
| bd | Дата рождения в формате дд.мм.гггг.
|
|---|
| myid | ID контакта, назначенный Клиентом.
|
|---|
| cmt | Комментарии.
|
|---|
| tags | Теги (метки).
|
|---|
| pho | Другие номера телефонов. По данным номерам рассылка SMS-сообщений не выполняется.
|
|---|
| type | Тип блокировки (команда add_black):
0 – все сообщения.
1 – массовые рассылки.
2 – одиночные сообщения.
Либо тип группы (команды add_group и get_group):
0 – группа для номеров телефонов.
1 – группа для e-mail адресов.
|
|---|
| fmt | Формат ответа сервера:
0 – (по умолчанию) в виде строки (ID = 12345).
1 – в виде строки (12345).
2 – в xml формате.
3 – в json формате.
|
|---|
Ответ сервера и коды ошибокВ случае ошибки Сервер возвращает следующую строку:
- 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 | Попытка отправки более трех одинаковых запросов на операции с группами, контактами или записями "черного" списка в течение минуты.
Данная ошибка возникает также при попытке отправки более 15 любых запросов одновременно.
|
|---|
В случае успешного запроса Сервер возвращает ответ в виде строки.
При создании контакта, группы контактов, записи "черного" списка:
- при 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> – номер группы для рассылок.Примеры операций с контактамиПримеры:
Создание контакта с именем "Contact", принадлежащего группе с ID = 321:
http://my.smsc.dp.ua/sys/phones.php?add=1&login=alex&psw=123&phone=79999999999&name=Contact&grp=321
Создание группы с именем "Group":
http://my.smsc.dp.ua/sys/phones.php?add_group=1&login=alex&psw=123&name=Group
Изменение имени контакта с номером телефона "79999999999" на новое имя "Contact1":
http://my.smsc.dp.ua/sys/phones.php?chg=1&login=alex&psw=123&phone=79999999999&name=Contact1
Изменение названия группы с ID = 321 на новое название "Group1":
http://my.smsc.dp.ua/sys/phones.php?chg_group=1&login=alex&psw=123&grp=321&name=Group1
Удаление контакта с номером телефона "79999999999":
http://my.smsc.dp.ua/sys/phones.php?del=1&login=alex&psw=123&phone=79999999999
Удаление группы с ID = 321:
http://my.smsc.dp.ua/sys/phones.php?del_group=1&login=alex&psw=123&grp=321
Получение списка контактов, принадлежащих группе с ID = 321:
http://my.smsc.dp.ua/sys/phones.php?get=1&login=alex&psw=123&grp=321
Получение данных контакта с номером телефона "79999999999":
http://my.smsc.dp.ua/sys/phones.php?get=1&login=alex&psw=123&phone=79999999999
Получение списка всех групп:
http://my.smsc.dp.ua/sys/phones.php?get_group=1&login=alex&psw=123
Добавление телефона "79999999999" в "черный" список с блокировкой только массовых рассылок:
http://my.smsc.dp.ua/sys/phones.php?add_black=1&login=alex&psw=123&phone=79999999999&type=1
Удаление телефона "79999999999" из "черного" списка:
http://my.smsc.dp.ua/sys/phones.php?del_black=1&login=alex&psw=123&phone=79999999999
Сервер не принимает более трех одинаковых запросов в течение минуты на операции с группами,
контактами или записями "черного" списка для снижения нагрузки и защиты от ошибок и зацикливаний в программе на стороне Клиента.
|
УПРАВЛЕНИЕ КОНТАКТАМИ