Управление алертами

Скип текущего доната

POSThttps://donatex.gg/api/v1/donations/skip-current

Останавливает донат, который сейчас показывается на стриме (анимация, озвучка, кружочек), — как кнопка «Скип» в кабинете. Если на стриме ничего не идёт, скипается первый донат в очереди.

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

OAuth-токену нужен scope donations.write. External token работает без scopes.

Ответы

skippedboolean

true, если донат был и его скипнули; false, если очередь пуста

skippedDonationIduuid | null

ID скипнутого доната

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

POST/v1/donations/skip-current

curl -X POST "https://donatex.gg/api/v1/donations/skip-current" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

{
  "skipped": true,
  "skippedDonationId": "4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b"
}

Скип доната по ID

POSThttps://donatex.gg/api/v1/donations/{id}/skip

Скипает конкретный донат — неважно, играет он сейчас или ждёт в очереди. Если он на экране, алерт остановится; если в очереди — просто не будет показан.

Ошибки этого метода исторически приходят со статусом 400 — различайте их по полю code.

OAuth-токену нужен scope donations.write. External token работает без scopes.

Path-параметры

iduuidобязательный

ID доната

Ответы

Тело ответа пустое — проверяйте только статус.

{
  "error": "Донат не найден"
}

{
  "error": "У вас нет прав на редактирование этого доната"
}

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "id": [
      "The value 'abc' is not valid."
    ]
  },
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"
}

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

POST/v1/donations/{id}/skip

curl -X POST "https://donatex.gg/api/v1/donations/4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b/skip" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

// Пустое тело ответа

Скип всех донатов

POSThttps://donatex.gg/api/v1/donations/skip-all

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

Треки из скипнутых донатов попадают в очередь музыкального виджета — донатеры за них заплатили.

OAuth-токену нужен scope donations.write. External token работает без scopes.

Ответы

skippedCountinteger

Сколько донатов скипнуто; 0, если очередь была пуста

skippedDonationIdsuuid[]

ID скипнутых донатов

{
  "error": "Не удалось пропустить все донаты"
}

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

POST/v1/donations/skip-all

curl -X POST "https://donatex.gg/api/v1/donations/skip-all" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

{
  "skippedCount": 2,
  "skippedDonationIds": [
    "4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b",
    "d8c91fe2-d1d3-4fe7-b2f2-26a66b27250a"
  ]
}

Повтор доната

POSThttps://donatex.gg/api/v1/donations/{id}/rerun

Ставит уже показанный донат в начало очереди — алерт, озвучка и кружочек проиграются ещё раз. Работает только для донатов владельца токена.

Скипнутый донат при повторе снова считается непропущенным. В realtime-хаб придёт событие DonationRerun.

Донаты, которые модерация пометила небезопасными, и возвращённые донатеру повторить через API нельзя — стример решает это вручную в кабинете.

OAuth-токену нужен scope donations.write. External token работает без scopes.

Path-параметры

iduuidобязательный

ID своего доната

Ответы

donationIduuid

ID доната

unskippedboolean

true, если донат был скипнут и с него сняли эту отметку

{
  "error": "Донат не найден"
}

{
  "error": "Донат помечен модерацией как потенциально небезопасный. Одобрите его в панели стримера"
}

{
  "error": "Донат возвращён донатеру, повторить его нельзя"
}

{
  "error": "Не найден пресет для доната"
}

{
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "id": [
      "The value 'abc' is not valid."
    ]
  },
  "traceId": "00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-00"
}

Общие для всех методов: 401 — нет токена или он недействителен, 403 — у OAuth-токена нет нужного scope, 429 — превышен лимит запросов. Подробнее об ошибках

POST/v1/donations/{id}/rerun

curl -X POST "https://donatex.gg/api/v1/donations/4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b/rerun" \
  -H "Authorization: Bearer $DONATEX_TOKEN"

{
  "donationId": "4fd9677b-8b17-4c9d-9a9f-c2a7a3f9960b",
  "unskipped": false
}