Добавление контактов

Функция: contact/create
Адрес: https://mainsms.ru/api/mainsms/contact/create
Параметры запроса:
Параметр Описание Обязательный Формат Пример
project Имя проекта Да Строка mainsms
phone Один или нексколько* тел. номеров Да Строка или массив 89599224424
group ID (номер) группы Нет Строка 1
lastname Фамилия Нет Строка Иванов
firstname Имя Нет Строка Иван
patronymic Отчество Нет Строка Иванович
birthday Дата рождения Нет Строка 29.01.1987
param1 Параметр 1 Нет Строка Некая информация 1
param2 Параметр 2 Нет Строка Некая информация 2
sign Подпись запроса Да Строка, в нижнем регистре e2271659a8b05d3

* - Вы можете передать несколько номеров разделённых запятой либо массивом, до 1000 номеров за один запрос.


Пример:
https://mainsms.ru/api/mainsms/contact/create?project=mainsms&phone=89599224424&firstname=Иван&sign=e2271659a8b05d3

При передаче нескольких номеров параметры [lastname, firstname, patronymic, birthday, param1, param2] задатут одинаковые данные для всех созданных контактов.

Пример с передачей нескольких номеров через запятую:
https://mainsms.ru/api/mainsms/contact/create?project=mainsms&phone=89599224424,+79539232444,79528002020&sign=e2271659a8b05d3

Пример c передачей нескольких номеров массивом:
https://mainsms.ru/api/mainsms/contact/create?project=mainsms&phone[]=89599224421&phone[]=+79539232444&phone[]=79528002020&sign=e2271659a8b05d3


Контакт с данным phone, всегда будет помещён в системную группу Все. Если указан ID группы в параметре group, то контакт будет помещён в данную группу.


Варианты ответа:
Успех
Параметр Описание Формат Пример
phones Массив из номеров (номера могут отличаться от переданных, после форматирования) Массив 1
group id группы или массив из id групп, в которых находиться контакт с данным телефоном Массив или число 1 или [1,5]
Ошибка В случае, ошибки ответ будет параметром "errors", в него могут входить одна или несколько возможных ошибок.
Код Текст Описание
1 param project is blank Параметр project пуст
2 invalid signature or not set Не верная подпись запроса(параметр sign)
15 param phone is blank Параметр phone пуст или не задан
16 param phone not valid Параметр phone имеет неверное значение
17 param phones is too large Параметр phone имеет неверное значение
14 group not found Группа с данным ID в параметре group не найдена
5 project not found Проект с таким именем не найден
10 project is paused Проект выключен

Удаление контактов

Функция: contact/remove
Адрес: https://mainsms.ru/api/mainsms/contact/remove
Параметры запроса:
Параметр Описание Обязательный Формат Пример
project Имя проекта Да Строка mainsms
phone Один или нексколько тел. номеров Да Строка или массив 89599224424
sign Подпись запроса Да Строка, в нижнем регистре e2271659a8b05d3

Пример:
https://mainsms.ru/api/mainsms/contact/remove?project=mainsms&phone=89599224424&sign=e2271659a8b05d3

Варианты ответа:
Успех
phones Массив из номеров (номера могут отличаться от переданных, после форматирования) Массив 1
group массив из id групп, в которых находиться контакт с данным телефоном(и) Массив [1,5]

в случае, если телефоны указанные для удаления небылли найдены, в ответ прийдёт phones с значением false

Ошибка В случае, ошибки ответ будет параметром "errors", в него могут входить одна или несколько возможных ошибок.
Код Текст Описание
1 param project is blank Параметр project пуст
2 invalid signature or not set Не верная подпись запроса(параметр sign)
15 param phone is blank Параметр phone пуст или не задан
16 param phone not valid Параметр phone имеет неверное значение
17 param phones is too large Параметр phone имеет неверное значение
14 group not found Группа с данным ID в параметре group не найдена
5 project not found Проект с таким именем не найден
10 project is paused Проект выключен

Получить или проверить существование контакта

Функция: contact/exists
Адрес: https://mainsms.ru/api/mainsms/contact/exists
Параметры запроса:
Параметр Описание Обязательный Формат Пример
project Имя проекта Да Строка mainsms
phone номер или номера телефонов через запятую, или массивом Да Строка или Массив 89539224424
sign Подпись запроса Да Строка, в нижнем регистре e2271659a8b05d318b4b53c644ba8b47

Пример:
https://mainsms.ru/api/mainsms/contact/exists?project=mainsms&phone=89539224424&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа: Если номеров телефонов больше одного, то массив.
Успех
Параметр Описание Формат Пример
phone Телефон Строка 89539224424
exists Существует Логическое true или false true
В случае exists=true
lastname Фамилия Строка Иванов
firstname Имя Строка Иван
patronymic Отчество Строка Иванович
birthday Дата рождения Строка 29.01.1987
param1 Параметр 1 Строка Некая информация 1
param2 Параметр 2 Строка Некая информация 2
groups Группы контакта массив [1]