Рассылки (notificationlist)
notificationlist
Результат: список элементов
Рассылки
Уровень доступа: admin
Параметр | Значение |
|---|---|
| id | Id |
| subject | Заголовок |
| type | Тип уведомления |
| selectclients | Сегмент клиентов |
| project | Провайдер |
| status | Состояние |
| progress | Прогресс |
Включить автоматическую отправку рассылки
Функция: notificationlist.resume
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.
Результат: успешное выполнение операции или сообщение об ошибке
Переместить выбранные рассылки в архив
Функция: notificationlist.archive
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.
Результат: успешное выполнение операции или сообщение об ошибке
Имя. Рассылку получили
Функция: notificationlist.users
Результат: список элементов
Уровень доступа: admin
- name — Имя
- senddate — Дата
Создать
Функция: notificationlist.create
Уровень доступа: admin
Архив рассылок
Функция: notificationlist.archived
Результат: список элементов
Уровень доступа: admin
Параметр | Значение |
|---|---|
| id | Id |
| subject | Заголовок |
| type | Тип уведомления |
| selectclients | Сегмент клиентов |
| project | Провайдер |
Просмотр архивной рассылки
Функция: notificationlist.archived.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта. Просмотр параметров объекта:
- Параметры:
- plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
- elid — уникальный идентификатор (элемент id из функции notificationlist.archived)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- plid — уникальный идентификатор родительского списка (элемент id из функции notificationlist).
- elid — уникальный идентификатор (элемент id из функции notificationlist.archived)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Параметр | Значение |
|---|---|
| selectclients | Сегмент клиентов. Выберите, по каким условиям должны быть отобраны клиенты для уведомления |
| template | Шаблон уведомления, на основе которого будет сгенерировано итоговое сообщение |
| lang | Язык пользователя. Выберите, необходимо или нет точное соответствие языка клиента |
| subject | Заголовок уведомления |
| summary | Аннотация. Введите текст аннотации, которая будет отображаться в списке уведомлений в BILLmanager 6 |
| message | Текст уведомления, которое будет отправлено клиентам |
Удалить
Функция: notificationlist.archived.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.archived.
Результат: успешное выполнение операции или сообщение об ошибке
Редактирование рассылки
Функция: notificationlist.edit
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции notificationlist)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции notificationlist)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Список параметров объекта или дополнительных параметров запроса (см. выше):
Параметр | Значение |
|---|---|
| selectclients | Сегмент клиентов. Выберите, по каким условиям должны быть отобраны клиенты для уведомления |
| template | Шаблон уведомления, на основе которого будет сгенерировано итоговое сообщение |
| unsubscribed | (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправить рассылку клиентам, отписавшимся от новостных уведомелений |
| lang | Язык пользователя. Выберите, необходимо или нет точное соответствие языка клиента |
| email_from | Обратный адрес. На этот адрес будут приходить ответы клиентов на рассылку |
| repeat_period | Период повтора. Как часто рассылать сообщение клиентам, в днях |
| send_now | (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Сообщение будет сразу отправлено адресатам |
| active | (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Активные рассылки отправляются автоматически |
| check | (Необязательный параметр. Чтобы включить данную опцию используйте значение "on".) Отправить письмо с рассылкой на email тестирования |
| test_email | Email тестирования. Введите адрес электронной почты на который будет отправлено тестовое письмо |
| subject | Заголовок уведомления |
| summary | Аннотация. Введите текст аннотации, которая будет отображаться в списке уведомлений в BILLmanager 6 |
| message | Текст уведомления, которое будет отправлено клиентам |
Аудитория рассылки
Функция: notificationlist.check
Результат: список элементов
Уровень доступа: admin
Параметр | Значение |
|---|---|
| id | Id |
| name | Имя |
| account | Клиент |
Отправка сообщения
Функция: notificationlist.send
Уровень доступа: admin
Данная функция одновременно используется для просмотра параметров объекта, изменения объекта и создания нового объекта.
Просмотр параметров объекта:
- Параметры:
- elid — уникальный идентификатор (элемент id из функции notificationlist)
- Результат: список параметров объекта
Создание объекта:
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Изменение объекта
- Параметры:
- sok — значение параметра должно быть не пустым, обычно "ok".
- elid — уникальный идентификатор (элемент id из функции notificationlist)
- дополнительные параметры запроса ...
- Результат: успешное выполнение операции или сообщение об ошибке
Выключить автоматическую отправку рассылки
Функция: notificationlist.suspend
Выключить автоматическую отправку рассылки
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.
Результат: успешное выполнение операции или сообщение об ошибке
Удалить
Функция: notificationlist.delete
Уровень доступа: admin
Параметры:
- elid — один или несколько уникальных идентификаторов объекта, разделенных запятой и следующим за ней пробелом ", ". Уникальный идентификатор — это элемент id из функции notificationlist.
Результат: успешное выполнение операции или сообщение об ошибке