INTEGRITY Документация

Получение вебхуков о прямых трансляциях

Stream Live предлагает вебхуки, которые уведомляют вашу службу при подключении, отключении Input или возникновении ошибки в Stream Live.

Stream Live Notifications

Для кого это предназначено?

Клиенты, которые используют Stream и хотят получать webhooks со статусом своих видео.

Другие параметры / фильтры

Вы можете указать Stream Live ID, чтобы получать уведомления только об этих live input. Если поле оставить пустым, вы будете получать уведомления обо всех live input.

Следующие состояния входного сигнала вызывают отправку уведомлений. Их можно включать и отключать:

Входит в

Подписка на Stream.

Что делать при получении такого уведомления?

Уведомления Stream полностью настраиваются клиентом. Конкретное поведение зависит от включённых настроек.

Подпишитесь на Stream Live Webhooks

  1. На панели управления Cloudflare перейдите к разделу Уведомления страницу.

    Перейдите в Уведомления ↗
  2. Выберите Назначения на вкладке.

  3. На Назначения странице в разделе Webhooks, выберите Создание.

  4. Введите данные вебхука и выберите Save and Test.

  5. Чтобы создать уведомление, на Уведомления странице выберите All Notifications на вкладке.

  6. Рядом с Уведомления, выберите Add.

  7. В списке продуктов найдите Stream и выберите Выбрать.

  8. Введите имя и необязательное описание.

  9. В разделе Webhooks, выберите Добавить webhook и выберите только что созданный вебхук.

  10. Выберите Далее.

  11. По умолчанию уведомления вебхуков приходят для всех Live Inputs. Если вы хотите получать вебхуки только для отдельных входов, укажите в текстовом поле список Input ID через запятую.

  12. Когда закончите, выберите Создание.

Пример полезной нагрузки вебхука
{
  "name": "Live Webhook Test",
  "text": "Notification type: Stream Live Input\nInput ID: eb222fcca08eeb1ae84c981ebe8aeeb6\nEvent type: live_input.disconnected\nUpdated at: 2022-01-13T11:43:41.855717910Z",
  "data": {
    "notification_name": "Stream Live Input",
    "input_id": "eb222fcca08eeb1ae84c981ebe8aeeb6",
    "event_type": "live_input.disconnected",
    "updated_at": "2022-01-13T11:43:41.855717910Z"
  },
  "ts": 1642074233
}

event_type свойство объекта данных будет либо live_input.connected, live_input.disconnected, или live_input.errored.

Если с Live Input обнаружены проблемы, event_type будет live_input.errored. Дополнительные данные будут находиться в live_input_errored JSON-ключ и будет включать code одним из значений, перечисленных ниже.

Коды ошибок

Пример полезной нагрузки вебхука live_input.errored
{
  "name": "Live Webhook Test",
  "text": "Notification type: Stream Live Input\nInput ID: 2c28dd2cc444cb77578c4840b51e43a8\nEvent type: live_input.errored\nUpdated at: 2024-07-09T18:07:51.077371662Z\nError Code: ERR_GOP_OUT_OF_RANGE\nError Message: Input GOP size or keyframe interval is out of range.\nVideo Codec: \nAudio Codec: ",
  "data": {
    "notification_name": "Stream Live Input",
    "input_id": "eb222fcca08eeb1ae84c981ebe8aeeb6",
    "event_type": "live_input.errored",
    "updated_at": "2024-07-09T18:07:51.077371662Z",
    "live_input_errored": {
      "error": {
        "code": "ERR_GOP_OUT_OF_RANGE",
        "message": "Input GOP size or keyframe interval is out of range."
      },
      "video_codec": "",
      "audio_codec": ""
    }
  },
  "ts": 1720548474,
}