gateway
Уровень доступа: admin
Результат: список элементов
Шлюзы отправки и получения сообщений
| Параметры |
|---|
| Наименование | Описание |
| id | Id |
| module | Тип шлюза |
| gateway_type | Назначение шлюза |
| identifier | Идентификатор |
| project | Провайдер |
| status | Состояние |
Параметры шлюза
Функция: gateway.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта
Результат: список параметров объекта
| Параметры |
|---|
| Наименование | Описание |
| elid | уникальный идентификатор (элемент id из функции gateway) |
Создание объекта
Результат: успешное выполнение операции или сообщение об ошибке
| Параметры |
|---|
| Наименование | Описание |
| sok | значение параметра должно быть не пустым, обычно "ok" |
дополнительные параметры запроса |
Изменение объекта
Результат: успешное выполнение операции или сообщение об ошибке
| Параметры |
|---|
| Наименование | Описание |
| elid | уникальный идентификатор (элемент id из функции gateway) |
| sok | значение параметра должно быть не пустым, обычно "ok" |
дополнительные параметры запроса |
Список параметров объекта или дополнительных параметров запроса
| Параметры |
|---|
| Наименование | Обязательный | Описание |
| gateway_type |
| Использовать для. Тип использования шлюза |
| user |
| Отдел, на который будут назначаться запросы, полученные на указанный почтовый адрес |
| abuse | нет | Чтобы включить данную опцию используйте значение "on". Опция включает перемещение полученных сообщений в раздел нарушений |
| active | нет | Чтобы включить данную опцию используйте значение "on". Использовать шлюз |
gateway.create
Создание шлюза
Уровень доступа: admin
gateway.resume
Включить
Уровень доступа: admin
Результат: успешное выполнение операции или сообщение об ошибке
| Параметры |
|---|
| Наименование | Описание |
| elid | один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway |
gateway.suspend
Выключить
Уровень доступа: admin
Результат: успешное выполнение операции или сообщение об ошибке
| Параметры |
|---|
| Наименование | Описание |
| elid | один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway |
gateway.delete
Удаление шлюза
Уровень доступа: admin
Результат: успешное выполнение операции или сообщение об ошибке
| Параметры |
|---|
| Наименование | Описание |
| elid | один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции gateway |