SMSTeam

Управление контактами

Для управления контактами или группами необходимо вызвать методом GET или POST соответствующий адрес с указанием требуемой команды и параметров.

Для создания контакта:
http://cp.smsteam.ru/sys/phones.php?add&login=<login>&psw=<password>&phone=<phone>&name=<name>

Для создания новой группы:
http://cp.smsteam.ru/sys/phones.php?add_group&login=<login>&psw=<password>&name=<name>

Для изменения названия контакта:
http://cp.smsteam.ru/sys/phones.php?chg&login=<login>&psw=<password>&phone=<phone>&name=<name>

Для изменения названия группы:
http://cp.smsteam.ru/sys/phones.php?chg_group&login=<login>&psw=<password>&grp=<group_id>&name=<name>

Для удаления контакта:
http://cp.smsteam.ru/sys/phones.php?del&login=<login>&psw=<password>&phone=<phone>

Для удаления группы:
http://cp.smsteam.ru/sys/phones.php?del_group&login=<login>&psw=<password>&grp=<group_id>

Для вывода списка контактов:
http://cp.smsteam.ru/sys/phones.php?get&login=<login>&psw=<password>

Для вывода списка групп:
http://cp.smsteam.ru/sys/phones.php?get_group&login=<login>&psw=<password>

Описание параметров, передаваемых Серверу:

Параметр Значение
login Логин Клиента.
psw Пароль Клиента или MD5-хеш пароля в нижнем регистре.
name Название контакта или группы.
grp Идентификатор группы, к которой принадлежит создаваемый контакт.
phone Список номеров телефонов через любой разделитель.
lnm Фамилия.
fnm Имя.
mnm Отчество.
bd Дата рождения в формате дд.мм.гггг.
myid ID контакта, назначенный Клиентом.
cmt Комментарии.
tags Теги (метки).
pho Другие номера телефонов. По данным номерам рассылка SMS-сообщений не выполняется.
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 Неверный логин или пароль.
3 Записи не найдены.
4 IP-адрес временно заблокирован.
5 Ошибка выполнения операции.

В случае успешного запроса Сервер возвращает ответ в виде строки.

При создании контакта(группы):

  • при 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>
    }

Где <id> – идентификатор контакта или группы, назначенный Сервером автоматически.

При изменении или удалении контакта(группы):

  • при fmt = 0,1,2,3: 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>»
    },
    …]

Где:

<phone> – список номеров телефонов через любой разделитель.
<name> – название контакта.
<group> – идентификатор группы, к которой принадлежит контакт.
<first_name> – имя.
<last_name> – фамилия.
<middle_name> – отчество.
<birthday> – дата рождения в формате гггг-мм-дд.
<id> – id контакта, назначенный Клиентом.
<comments> – комментарии.
<tags> – теги (метки).
<phone_other> – другие номера телефонов. По данным номерам рассылка сообщений не выполняется.

При запросе списка групп:

  • при fmt = 0:
    id = <id>, name = <name>
  • при fmt = 1:
    <id>,<name>
  • при fmt = 2:
    <list>
    <group>
    <id>id</id>
    <name>name</name>
    </group>

    </list>
  • при fmt = 3:
    [{
    «id»: <id>
    «name»: «<name>»
    },
    …]

Где:

<id> – идентификатор группы, назначенный Сервером при создании.
<name> – название группы.

Примеры:

Создание контакта с именем «Contact», принадлежащего группе с ID = 321:

http://cp.smsteam.ru/sys/phones.php?add&login=alex&psw=123&phone=79999999999&name=Contact&grp=321

Создание группы с именем «Group»:

http://cp.smsteam.ru/sys/phones.php?add_group&login=alex&psw=123&name=Group

Изменение имени контакта с номером телефона «79999999999» на новое имя «Contact1»:

http://cp.smsteam.ru/sys/phones.php?chg&login=alex&psw=123&phone=79999999999&name=Contact1

Изменение названия группы с ID = 321 на новое название «Group1»:

http://cp.smsteam.ru/sys/phones.php?chg_group&login=alex&psw=123&grp=321&name=Group1

Удаление контакта с номером телефона «79999999999»:

http://cp.smsteam.ru/sys/phones.php?del&login=alex&psw=123&phone=79999999999

Удаление группы с ID = 321:

http://cp.smsteam.ru/sys/phones.php?del_group&login=alex&psw=123&grp=321

Получение списка контактов, принадлежащих группе с ID = 321:

http://cp.smsteam.ru/sys/phones.php?get&login=alex&psw=123&grp=321

Получение списка всех групп:

http://cp.smsteam.ru/sys/phones.php?get_group&login=alex&psw=123

Сервер не принимает более трех одинаковых запросов в течение минуты на операции с группами или контактами для снижения нагрузки и защиты от ошибок и зацикливаний в программе на стороне Клиента.