- Payler

addSender
api/project/addSender
Создание запроса на подтверждение имени отправителя
Аргументы
data
idproject-idID проекта
sendertextотправитель
Ответ
{"error": false, "data": "ok"}
Ошибки
Отправитель уже существует
{"error": true, "data": "alreadyExists"}
Проект с указанным id не существует
{"error": true, "data": "noSuchProject"}
create
api/project/create
Создание проекта
Аргументы
data
nametextимя проекта (для отображения в системе)
fullNametextполное название
descriptiontextописание проекта
avatarimgSrcаватарка проекта
Ответ
{"error": false, "data": "project-id"}
edit
api/project/edit
Редактирование проекта
Аргументы
data
idproject-idID редактируемого проекта
[любые данные]
Ответ
{"error": false, "data": "true"}
Ошибки
Проект с указанным id не существует || нет прав на редактирование
{"error": true, "data": "noSuchProject"}
get
api/project/get
Получить данные проекта по id
Аргументы
idproject-idID проекта
Ответ
{"error": false, "data": {"name": "projectName"... все данные}}
Ошибки
Проект с указанным id не существует || нет прав на удаление
{"error": true, "data": "noSuchProject"}
getBalance
api/project/getBalance
Получение баланса проекта проекту
Аргументы
idhashproject id
Ответ
{"error": false, "data": {"amount": balance}}
Ошибки
Проект с данным id отсутствует
{"error": true, "data": "noSuchProject"}
getMessageLog
api/project/getMessageLog
Получить лог отправленных смс
Аргументы
idproject-idID проекта
pageintстраница
Ответ
{
pages: pageCount,
page: currentPage,
items: [
{id: id, text: text, phone: to, status: messageStatus, date: timestamp},
...
]
}
getStat
api/project/getStat
Получение статистики по проекту
Аргументы
idhashproject id
Ответ
{"error": false, "data": {"created": timestamp,"smsCount":
smsSendedCount,"balance":{"amount": balance}}}
Ошибки
Проект с данным id отсутствует
{"error": true, "data": "noSuchProject"}
list
api/project/list
Получить список проектов
Ответ
{"error": false, "data": [{"name": "projectName", smsPrice: цена в копейках, ... все
данные}, ...]}
remove
api/project/remove
Удаление проекта
Аргументы
idproject-idID удаляемого проекта
Ответ
{"error": false, "data": "true06"}
Ошибки
Проект с указанным id не существует || нет прав на удаление
{"error": true, "data": "noSuchProject"}
removeResponse
api/project/removeResponse
Удалить настройки ассинхронного ответ
Аргументы
idproject-idID проекта
typetextсобытие оповещения (например, mc)
Ответ
{"error": false, "data": "ok"}
Ошибки
Проект с указанным id не существует
{"error": true, "data": "noSuchProject"}
Нет такого события
{"error": true, "data": "noSuchType"}
removeSender
Удаление имени отправителя
Аргументы
data
idproject-idID проекта
sendertextотправитель
Ответ
{"error": false, "data": "ok"}
Ошибки
Отправитель не существует
{"error": true, "data": "noSuchPrefix"}
Проект с указанным id не существует
{"error": true, "data": "noSuchProject"}
schema
api/project/schema
Project scheme
Аргументы
idhash,pid,iid,project-idproject id deprecated
nametextимя проекта
createDatedateдата создания
creatorhashсоздатель. deprecated
smsPriceintцена смс в копейках
fullNametextполное имя проекта
descriptiontextописание проекта
senderarrayсписок отправителей смс
sendertextотправитель
approvedboolподтверждено
datedateдата создания
api/project/removeSender
requestobjectоповещения
!nameobjectназвание
typetextназвание
methodtextтип запроса
urltplадрес запроса
bodytplтело сообщения
boxobjectнастройки плугинов
!namejsonимя модуля. любые данные. документация в схеме модуля
setResponse
api/project/setResponse
Добавить\отредактировать настройки ассинхронного ответ
Аргументы
idproject-idID проекта
typetextсобытие оповещения (например, mc)
response
urltextадрес
methodenumGET или POST
[body]textдля POST запроса
Ответ
{"error": false, "data": "ok"}
Ошибки
Проект с указанным id не существует
{"error": true, "data": "noSuchProject"}