Добавление имени отправителя
Функция: sender/create
Адрес: https://payforsms.ru/api/mainsms/sender/create
Параметры запроса:
Параметр |
Описание |
Обязательный |
Формат |
Пример |
project
|
Имя проекта |
Да |
Строка |
mainsms |
name |
Имя отправителя |
Да |
Строка |
mysite |
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d3 |
Пример:
https://payforsms.ru/api/mainsms/sender/create?project=mainsms&name=mysite&sign=e2271659a8b05d3
Имя отправителя будет создано и доступно только после проверки
модератором.
Варианты ответа:
Успех
Параметр |
Описание |
Формат |
Пример |
name |
Имя отправителя |
Строка |
mysite |
Ошибка В случае, ошибки ответ будет параметром "errors", в него
могут входить одна или несколько возможных ошибок.
Код |
Текст |
Описание |
1 |
param project is blank |
Параметр project пуст |
2 |
invalid signature or not set |
Не верная подпись запроса(параметр sign) |
18 |
param name is blank |
Параметр name пуст |
25 |
sender already exists |
Отправитель с таким именем уже существует |
5 |
project not found |
Проект с таким именем не найден |
10 |
project is paused |
Проект выключен |
Удаление имени отправителя
Функция: sender/remove
Адрес: https://payforsms.ru/api/mainsms/sender/remove
Параметры запроса:
Параметр |
Описание |
Обязательный |
Формат |
Пример |
project
|
Имя проекта |
Да |
Строка |
mainsms |
name |
Имя отправителя |
Да |
Строка |
mysite |
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d3 |
Пример:
https://payforsms.ru/api/mainsms/group/remove?project=mainsms&id=1&sign=e2271659a8b05d3
Варианты ответа:
Успех
Параметр |
Описание |
Формат |
Пример |
result |
ID (номер) группы |
Строка |
ok |
Ошибка В случае, ошибки ответ будет параметром "errors", в него
могут входить одна или несколько возможных ошибок.
Код |
Текст |
Описание |
1 |
param project is blank |
Параметр project пуст |
2 |
invalid signature or not set |
Не верная подпись запроса(параметр sign) |
18 |
param name is blank |
Параметр name пуст или не указан |
24 |
sender not found |
Отправитель не найден |
26 |
sender is default |
Отправитель по умолчанию, не может быть удалён |
5 |
project not found |
Проект с таким именем не найден |
10 |
project is paused |
Проект выключен |
Список отправителей
Функция:
sender/list
Адрес: https://payforsms.ru/api/mainsms/sender/list
Параметры запроса:
Параметр |
Описание |
Обязательный |
Формат |
Пример |
project
|
Имя проекта |
Да |
Строка |
mainsms |
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d318b4b53c644ba8b47 |
Пример:
https://payforsms.ru/api/mainsms/sender/list?project=mainsms&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа:
Успех Массив из имён отправителей(проверенных), например
["sendtest","ReSaler", "Magaz", "Taxi"]
Отправитель по
умолчанию
Функция: sender/default
Адрес: https://payforsms.ru/api/mainsms/sender/default
Параметры запроса:
Параметр |
Описание |
Обязательный |
Формат |
Пример |
project
|
Имя проекта |
Да |
Строка |
mainsms |
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d318b4b53c644ba8b47 |
Пример:
https://payforsms.ru/api/mainsms/sender/default?project=mainsms&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа:
Успех
Параметр |
Описание |
Формат |
Пример |
project |
имя проекта |
Строка |
mainsms |
sender |
Имя отправителя |
Строка |
sendertest |
Установить имя отправителя по
умолчанию для проекта
Функция: sender/set
Адрес: https://payforsms.ru/api/mainsms/sender/set
Параметры запроса:
Параметр |
Описание |
Обязательный |
Формат |
Пример |
project
|
Имя проекта |
Да |
Строка |
mainsms |
name |
Имя отправителя |
Да |
Строка |
sendertest |
sign
|
Подпись запроса |
Да |
Строка, в нижнем регистре |
e2271659a8b05d318b4b53c644ba8b47 |
Пример:
https://payforsms.ru/api/mainsms/sender/set?project=mainsms&sender=sendertest&sign=e2271659a8b05d318b4b53c644ba8b47
Варианты ответа:
Успех
Параметр |
Описание |
Формат |
Пример |
result |
результат |
Строка |
ок |
project |
имя проекта |
Строка |
mainsms |
sender |
Имя отправителя |
Строка |
sendertest |