Создание смс рассылки

Функция: create
Адрес: https://payforsms.ru/api/mainsms/sending/create
Параметры запроса:

Параметр	Описание	Обязательный	Формат	Пример
project	Имя проекта	Да	Строка	mainsms
include	Группы получателей	Да	Строка, список ID групп через запятую	1254,6565
exclude	Группы исключения контактов	Нет	Строка, список ID групп через запятую	1254,6565
message	Текст сообщения	Да	Строка в кодировке utf-8	Привет от payforsms.ru
sender	Имя отправителя	Нет	Строка (от 5 до 11 символов, латиница, цифры)	payforsms.ru
run_at	время отправки сообщения	Нет	Дата и время	03.10.2011 17:00
slowtime	время для плавной рассылки	Нет	минуты	10
slowsize	количество сообщений для плавной рассылки	Нет	число от 10 до 10000	500
name	Название рассылки	Нет	Строка	API рассылка
test	Тестовый режим, можно использовать для запроса цены рассылки	Нет	Число, 0 или 1	0
sign	Подпись запроса	Да	Строка, в нижнем регистре	e2271659a8b05d318b4b53c644ba8b47

Для запроса стоимости рассылки укажите параметр test равным 1 , рассылка в этом случае не будет создана, но в ответ вы получите полный расчёт рассылки, количество контактов.

Если сообщение должно быть отправлено в определенное время заполните параметр run_at. Время должно быть указано в Вашем часовом поясе (посмотреть и поменять свой часовой пояс можно на этой странице.

Если вы хотите использовать плавную рассылку, используйте параметры slowtime и slowsize. Время должно быть указано в минутах, а количество сообщений в цифрах.

Пример: https://payforsms.ru/api/mainsms/sending/create?project=mainsms&message=test&include=123&exclude=321,322&sign=e2271659a8b05d318b4b53c644ba8b47

Варианты ответа:
Успех

Параметр	Описание	Формат	Пример
id	ID (номер) рассылки. id=-1, когда указан test=1	Число	1
cost	Цена рассылки в руб.	Строка	22,05
parts	Количество частей в сообщении	Число	1
contacts	Общее количество получателей	Число	12345
include	ID (номера) групп получателей	Строка	123
exclude	ID (номера) групп исключенных контактов из рассылки	Строка	321,322
name	Название рассылки	Строка	Новая рассылка через API
test	тестовый режим	Число 0/1	0

Ошибка В случае, ошибки ответ будет одним параметром "errors", в него могут входить одна или несколько возможных ошибок:

Код	Текст	Описание
1	param project is blank	Параметр project пуст
2	invalid signature or not set	Не верная подпись запроса(параметр sign)
3	param message is blank	Параметр message пуст
4	param include is blank	Параметр include пуст
5	project not found	Проект с таким именем не найден
6	contacts not found	Не найдено контактов
7	not enough money	Не достаточно денег на счету
8	invalid sender	Параметр сендер пуст, содержит недопустимые символы или недопустимой длинны.
9	sender not verified	Имя отправителя не проверено
10	project is paused	Проект выключен
11	invalid scheduled date	Неверная дата параметра run_at
13	the cost of sending zero	Стоимость рассылки равна нулю.

Запрос статуса рассылки

Функция: status
Адрес: https://payforsms.ru/api/mainsms/sending/status
Параметры запроса:

Параметр	Описание	Обязательный	Формат	Пример
project	Имя проекта	Да	Строка	mainsms
id	ID (номер) рассылки	Да	Число	1
sign	Подпись запроса	Да	Строка, в нижнем регистре	e2271659a8b05d318b4b53c644ba8b47

Пример: https://payforsms.ru/api/mainsms/sending/status?project=mainsms&id=1&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа:
Успех

Параметр	Описание	Формат	Пример
id	ID (номер) рассылки	Число	1
sending_status	статус рассылки: calc disallow done pause process stop wait	Строка	done
total	Всего контактов получателей	Число	850
delivered	Количество доставленых смс	Число	849
undelivered	Количество не доставленых смс	Число	0
indelivered	Количество смс в статусе "Отправлено" (статус ещё не вернулся от оператора)	Число	1

Ошибка Возможные ошибки те же, что и для отправки рассылки по project и sign

Код	Текст	Описание
12	param id is blank or not found	Не задан id или рассылка с таким id не найдена.