Страницы регистрации, подписчики и рассылка

22 августа 2025 года структура API была обновлена: добавлена новая версия v2.0.

Запросы версии v1.0 продолжают работать только для Бизон ID пользователей, зарегистрированных до 22.08.2025, и только при наличии одного проекта. Это же условие распространяется и на сотрудников таких проектов. Однако могут появляться дополнительные условия, при которых запросы v1.0 не будут работать.

В будущем планируется отключение поддержки версии v1.0.
Рекомендуем заранее перейти на API версии v2.0, чтобы избежать перебоев в работе и обеспечить совместимость с будущими обновлениями.

« API v2.0

  1. getSubpages
  2. getSubscribers
  3. Пересылка данных (webhook)
  4. addSubscriber
  5. removeSubscriber
Запросы POST работают, если подключена услуга Страницы регистрации и рассылка. В ином случае возвращается код 403.

1. getSubpages

Получение списка страниц регистрации и их рассылок.

https://online.bizon365.ru/api/v2/XXXX/subpages/getSubpages?skip=0&limit=50, где XXXX - номер проекта

Параметры skip и limit определяют срез записей:

  • skip — количество записей, которые нужно пропустить [необязательный параметр]
  • limit — количество записей, которые нужно получить [необязательный параметр]

Пример ответа:

{

  • skip: 0, — использованное значение параметра skip
  • limit: 50, — использованное значение параметра limit
  • total: 1, — найдено записей

  • pages:  [

    • {

      • pageId: "XXXX:test",   — идентификатор страницы регистрации
      • title: "Заголовок страницы регистрации",

      • stat: {

        • removed: 0,  — количество удаленных подписчиков
        • registered: 10  — количество всех когда-либо регистрировавшихся подписчиков

        },

      • sessionControl: true,  — разрешать заходить только на свой сеанс
      • protectedLink: false,   — индивидуальные ссылки не используются (true - используются)
      • isOn: true,   — регистрация на вебинар включена (false - выключена)
      • room: "XXXX:superwebinar", — идентификатор комнаты, в которой будет вебинар, где XXXX - номер аккаунта
      • daysNum: 7,   — диапазон предлагаемых дат для регистрации (дней, после текущего)
      • author: "Имя автора",
      • authorEmail: "email@avtora.net", — контактный е-мейл автора вебинара
      • redirectOnReg: "",  — страница переадресации после успешной регистрации
      • redirectOnInput: "",  — страница переадресации после заполнения формы
      • redirectIfVizited: "",  — страница переадресации, если подписчик уже посещал вебинар
      • closestTimeToSkip: 2, — количество часов до начала вебинара, за которое прекращается регистрация.
      • multiroom: "",   — использование мультикомнат
      • webhook_url: "",   — URL-адрес для пересылки данных о подписчике после его регистрации
      • url_marker_name: "refid" — название Маркера партнера в URL на странице регистрации, значение которого нужно запомнить
      • url_param_name: "my_param" — название Произвольного параметра в URL на странице регистрации, значение которого нужно запомнить

      },

  • rooms:  {

    • XXXX:superwebinar:  — тот же идентификатор комнаты, что указан выше в поле room.
      {

      • title: "Название вебинара",
      • isAutowebinar: false, — запланирован автовебинар или "живой" вебинар
      • closestDate: "2021-07-08T17:00:00.000Z"  — ближайшая дата сеанса

      },

    }

}

2. getSubscribers

Получение списка подписчиков в заданной странице регистрации.

https://online.bizon365.ru/api/v2/XXXX/subpages/getSubscribers?pageId=pageId&skip=0&limit=50, где XXXX - номер проекта

Параметры:

  • pageId — идентификатор страницы регистрации (его получают с помощью метода getSubpages)
  • registeredTimeMin / registeredTimeMax — нижняя и верхняя граница для времени регистрации подписчика (поле registeredTime). Задается в формате ISO, например: 2018-09-26T15:00:00Z — 26 сент. в 15:00 по UTC.   [необязательный параметр] В случае если эти параметры указаны, в ответе появятся одноименные поля, содержащие дату, как ее поняла система.
  • webinarTimeMin / webinarTimeMax — нижняя и верхняя граница для времени сеанса, на который зарегистрированы подписчики (поле webinarTime). Задается в формате ISO, например: 2018-06-01T12:00:00 — 1 июня в 12:00 мск.   [необязательный параметр] В случае если эти параметры указаны, в ответе появятся одноименные поля, содержащие дату, как ее поняла система.
  • url_marker — значение  Маркера партнера из URL, идентификатор партнера.  [необязательный параметр]
  • url_param — значение Произвольного параметра в URL (параметр подписчика). [необязательный параметр]
  • skip — количество записей, которые нужно пропустить [необязательный параметр]
  • limit — количество записей, которые нужно получить [необязательный параметр]

Пример ответа:

{

  • skip: 0,
  • limit: 50,
  • total: 1, — найденное количество записей

  • list: [

    •  

      {

      • uid: "a12b34...",   — внутренний идентификатор подписчика. Поле может быть полезным для сопоставления со зрителем из отчетов.
      • email: "user@example.com",
      • confirmed: true,  — подтверждена ли подписка
      • username: "",  — имя пользователя
      • phone: "", — телефон пользователя
      • secret: "secret", — секретный ключ для формирования персональных ссылок
      • webinarTime: "2016-11-30T20:33:37.198Z",  — дата вебинара, на который зарегистрирован зритель
      • registeredTime: "2016-11-30T20:33:37.232Z", — дата осуществления регистрации на вебинар
      • vizitWebinar: 0, — посетил ли вебинар
      • vizitWebinarEnd: 0, — был ли на вебинаре до конца
      • url_marker: "",  — значение Маркера партнера
      • url_param: "", — значение Произвольного параметра в URL (параметр подписчика)
      • utm_source
      • utm_medium
      • utm_campaign
      • utm_term
      • utm_content
      • utm_keyword
      • utm_banner
      • utm_phrase
      • utm_group

      },

    ]

    }

     

3. Пересылка данных (webhook)

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

Пересылка делается POST-запросом с заголовком 'Content-Type': 'application/json',

тело запроса имеет следующий формат:

{

  • sublistId: "12345:page1", — идентификатор страницы регистрации
  • room: "12345:room", — идентификатор комнаты, которая подключена к странице регистрации
  • email: "user@example.com",
  • username: "",  — имя пользователя
  • phone: "", — телефон пользователя
  • webinarTime: "2016-11-30T20:33:37.198Z",  — дата вебинара, на который зарегистрирован зритель
  • secret: "some_symbols", — персональный ключ подписчика, для формирования индивидуальных ссылок на вебинар, а также на страницу отписки.
  • url_marker:"" — значение Маркера партнера в URL
  • url_marker_name:"", — название Маркера партнера в URL (например, refid)
  • url_param:"", — значение Произвольного параметра в URL (параметр подписчика)
  • url_param_name:"", — название Произвольного параметра в URL (параметр подписчика)
  • utm_source
  • utm_medium
  • utm_campaign
  • utm_term
  • utm_content
  • utm_keyword
  • utm_banner
  • utm_phrase
  • utm_group

}

Вебхук считается успешно отправленным, если сервер-получатель отвечает кодом 200.
Если код ответа отличается от 200, будет происходить повторная отправка с увеличивающимся интервалом - 1, 5, 15, 60, 120, 240, 480 минут. После последней попытки задача перестаёт отправляться автоматически. 
Если сервер-получатель не отвечает на первый запрос (появляется ошибка ETimedOut), то повторной отправки не будет. 

Персональные ссылки на вебинар формируются следующим образом:
http://online.bizon365.ru/click/secret
или на вашем домене: http://webinar.вашдомен/click/secret.

Обратите внимание, что функциональность индивидуальных ссылок настраивается на странице регистрации.

 

4. addSubscriber 

Добавляет подписчика в базу, регистрируя его на конкретный сеанс вебинара.

Важно!

Предусмотрены два режима добавления подписчика:  без подтверждения и с подтверждением электронного адреса (e-mail).

Режим "без подтверждения e-mail":
В этом режиме подписчик добавляется сразу, без каких-либо проверок. Он отмечается в списке оранжевым плюсом. 
Для возможности рассылки такому подписчику у вас должны быть выполнены условия для отключения подтверждения подписки. Если эти условия не выполнены, рассылка не будет уходить.
Этот режим активен по умолчанию.

Режим "с подтверждением e-mail":
В этом режиме подписчик добавляется так, как если он сам регистрировался в форме регистрации. Для активации этого режима, укажите параметр confirm (см.ниже).
После вызова addSubscriber подписчику сначала будет отправлено письмо-подтверждение. После перехода по ссылке из письма, подписчик станет подтвержденным и ему начнет отправляться составленная серия писем. 
Такой подписчик отображается в списке с зеленым плюсом.

 

Возможность добавления подписчика зависит от настроек страницы регистрации в Бизоне. 

  1. Дату ближайшего сеанса (вебинара) можно получить с помощью метода getSubpages. Также вы можете генерировать дату сами. Важно, чтобы она совпадала с реальным расписанием в комнате.  
  2. Подписчика можно зарегистрировать только на будущий сеанс.  
  3. Проверьте, указана ли длительность вебинара в комнате, привязанной к странице регистрации.
    Если указана, то "дата ближайшего вебинара" (из getSubpages) не будет меняться после начала сеанса вплоть до его окончания.
    Если не указана, то "дата ближайшего вебинара" сразу переключится на следующий сеанс.
    Если вы формируете дату сами, то данный пункт можно пропустить.
  4. Опции "Индивидуальные ссылки" и "Разрешить заходить только на выбранный сеанс" можно изменять в любое время. Действуют они в момент перехода подписчика по своей ссылке.
    Если "индивидуальные ссылки" выключены, то подписчик перейдет на открытую ссылку комнаты. 
  5. Подписчика можно регистрировать повторно (на тот же или другой сеанс). При этом его персональная ссылка не меняется. 
  6. После добавления подписчиков нельзя менять расписание в комнате больше чем на 1 час!
    В противном случае при включенной опции "Разрешить заходить только на выбранный сеанс" подписчик не сможет попасть на вебинар! Потому что его сеанса уже не будет существовать.
    Правильно:  сначала задать четкое расписание, которое не будет меняться, и затем добавлять подписчиков.

Вызов: POST запрос. Аргументы можно передавать как в body, так и в URL:

https://online.bizon365.ru/api/v2/XXXX/subpages/addSubscriber?pageId=pageId&email=email&time=ISODate, где XXXX - номер проекта

Параметры:

    • pageId
      Идентификатор страницы регистрации в Бизоне. 
    • email 
      Электронная почта подписчика
    • phone (не обязательное поле)
      Номер телефона
    • time
      Выбранное время сеанса. Формат: ISO, например:
      2017-10-11T20:00:00.000  или
      2017-10-11T17:00:00.000Z 
      (оба времени эквивалентны 20:00 по Москве)
    • username (необязательное)
      Имя подписчика 
    • confirm (не обязательное)
      Если параметр указан, например, confirm = 1, то подписчик добавляется в режиме "с подтверждением e-mail" (так, как если бы он сам заполнил форму регистрации). Ему на почту придет письмо со ссылкой на подтверждение регистрации.
    • url_marker (не обязательное)
      Значение Маркера партнера в URL. Тот параметр, название которого задается в настройках страницы регистрации. Например, если вы используете это поле как метку партнера (refid), то можно задать url_marker = id партнера.
    • url_param (не обязательное)
      Значение Произвольного параметра в URL (параметр подписчика). Параметр, название которого задается в настройках страницы регистрации.
    • utm_* (не обязательное)
      Поддерживаются utm-метки. Они должны быть переданы обязательно в теле запроса (не в URL).
    • autoNext=1
      регистрация на следующий сеанс, если на текущий закончена в соответствии с настройками страницы регистрации.

      Параметр autoNext=1 добавляется в URL (.../addSubscriber?autoNext=1)
      или в тело запроса со значением 1 - {“autoNext”: “1” }
      Если следующего сеанса нет, то регистрация продолжается на указанное время.

 

Ответ в случае ошибки: 

{ message: "текст ошибки" }

Ответ в случае успеха:

{
  hash: "ключ_подписчика",
  url_default: "https://online.bizon365.ru/click/ключ_подписчика",
  url_userdomain: "http://ваш.домен/click/ключ_подписчика"
}

Ссылки url_default и url_userdomain представляют собой индивидуальные ссылки этого подписчика на вебинар. Используйте их в своей рассылке.

 

5. removeSubscriber

Удаляет подписчика со страницы регистрации

Вызов: POST запрос. Аргументы можно передавать как в body, так и в URL:

https://online.bizon365.ru/api/v2/XXXX/subpages/removeSubscriber?pageId=pageId&email=email, где XXXX - номер проекта

Параметры:

  • pageId
    Идентификатор страницы регистрации в Бизоне. 
  • email 
    Электронная почта подписчика