Добавление группы контактов
Функция: group/create
Адрес: https://payforsms.ru/api/mainsms/group/create
Параметры запроса:
| Параметр |
Описание |
Обязательный |
Формат |
Пример |
| project
|
Имя проекта |
Да |
Строка |
mainsms |
| name |
Название группы |
Да |
Строка |
Моя группа контактов |
|
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d3 |
Пример:
https://payforsms.ru/api/mainsms/group/create?project=mainsms&name=Моя группа контактов&sign=e2271659a8b05d3
Варианты ответа:
Успех
|
Параметр
|
Описание
|
Формат
|
Пример
|
|
id
|
ID (номер) группы
|
Число
|
1
|
|
name
|
Название группы
|
Строка
|
Моя группа контактов
|
Ошибка
В случае, ошибки ответ будет параметром "errors", в него могут входить одна или несколько возможных ошибок.
|
Код
|
Текст
|
Описание
|
|
1
|
param project is blank
|
Параметр project пуст
|
|
2
|
invalid signature or not set
|
Не верная подпись запроса(параметр sign)
|
|
18
|
param name is blank
|
Параметр name пуст
|
|
5
|
project not found
|
Проект с таким именем не найден
|
|
10
|
project is paused
|
Проект выключен
|
Удаление группы контактов
Функция: group/remove
Адрес: https://payforsms.ru/api/mainsms/group/remove
Параметры запроса:
|
Параметр
|
Описание
|
Обязательный
|
Формат
|
Пример
|
|
project
|
Имя проекта
|
Да
|
Строка
|
mainsms
|
|
id
|
id (уникальный номер) группы
|
Да
|
Число
|
1
|
|
sign
|
Подпись запроса
|
Да
|
Строка, в нижнем регистре
|
e2271659a8b05d3
|
Внимание! Только пользовательские группы могут быть удалены!
Пример:
https://payforsms.ru/api/mainsms/group/remove?project=mainsms&id=1&sign=e2271659a8b05d3
Варианты ответа:
Успех
|
Параметр
|
Формат
|
Пример
|
|
result
|
Строка
|
ok
|
Ошибка
В случае, ошибки ответ будет параметром "errors", в него могут входить одна или несколько возможных ошибок.
|
Код
|
Текст
|
Описание
|
|
1
|
param project is blank
|
Параметр project пуст
|
|
2
|
invalid signature or not set
|
Не верная подпись запроса(параметр sign)
|
|
19
|
param id is blank
|
Параметр id пуст или не указан
|
|
20
|
group is not found
|
Группа с таким id не найдена
|
|
5
|
project not found
|
Проект с таким именем не найден
|
|
10
|
project is paused
|
Проект выключен
|
Список групп
Функция: group/list
Адрес: https://payforsms.ru/api/mainsms/group/list
Параметры запроса:
|
Параметр
|
Описание
|
Обязательный
|
Формат
|
Пример
|
|
project
|
Имя проекта
|
Да
|
Строка
|
mainsms
|
|
type
|
Тип групп
|
Нет
|
Строка, варианты из all, system, user, main, stop
|
all
|
|
sign
|
Подпись запроса
|
Да
|
Строка, в нижнем регистре
|
e2271659a8b05d318b4b53c644ba8b47
|
Описание типов групп:
- all - все группы
- system - системные группы
- user - пользовательские группы
- main - системная группа Все
- stop - системная группа Чёрный список
Пример:
https://payforsms.ru/api/mainsms/group/list?project=mainsms&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа:
Успех
|
Параметр
|
Описание
|
Формат
|
Пример
|
|
id
|
ID (номер) группы
|
Число
|
1
|
|
name
|
Название группы
|
Строка
|
Моя группа контактов
|
|
type
|
Тип группы
|
Строка, варианты из user, main, stop
|
user
|
|
contacts
|
Количество контактов в группе
|
Число
|
550
|