룰렛

채널의 룰렛과 항목을 조회하고 만들고 고치고 지우는 API입니다. 룰렛은 채널 안에서 이름으로 구분하며, 바꾼 내용은 1초 안에 봇에 반영됩니다.

룰렛 객체

단건 조회·만들기·수정 API는 룰렛을 아래 객체로 돌려줍니다. 각 설정의 동작은 룰렛 가이드와 같습니다.

목록 조회의 각 룰렛에는 아래 세 필드가 더 있습니다. 단건 조회·만들기·수정 응답에는 없습니다.

룰렛 목록 조회

채널의 룰렛을 모두 가져옵니다. 대시보드 탭 순서(index 오름차순)로 정렬되며 페이지 없이 한 번에 옵니다.

요청

요청 파라미터가 없습니다.

GET /api/v1/developer/roulettes
Authorization: Bearer ACCESS_TOKEN

응답

[
  {
    "streamer_uid": "4f2a8c1e9b7d4e3fa6c5b0d1e2f3a4b5",
    "roulette_name": "간식 룰렛",
    "send_message": true,
    "index": 0,
    "trigger_donation_min_amount": 1000,
    "trigger_donation_max_amount": null,
    "trigger_donation_text": null,
  "trigger_donation_allow_remainder": false,
    "trigger_donation_allow_remainder": false,
    "max_multi_roulette_limit": 10,
    "allowed_multi_list": [],
    "multi_bonus_enabled": false,
    "multi_bonus_trigger_count": 10,
    "multi_bonus_extra_count": 1,
    "command_id": 4,
    "activate": true,
    "tts_enabled": false,
    "multi_collect_enabled": false,
    "command_text": "!룰렛",
    "items": [
      {"data": "꽝", "weight": 70},
      {"data": "간식", "weight": 25, "ticket": true},
      {"data": "음료", "weight": 5}
    ]
  }
]

오류

룰렛 조회

이름으로 룰렛 하나를 가져옵니다.

요청

GET /api/v1/developer/roulettes/%EA%B0%84%EC%8B%9D%20%EB%A3%B0%EB%A0%9B
Authorization: Bearer ACCESS_TOKEN

응답

{
  "roulette_name": "간식 룰렛",
  "send_message": true,
  "trigger_donation_min_amount": 1000,
  "trigger_donation_max_amount": null,
  "trigger_donation_text": null,
  "trigger_donation_allow_remainder": false,
  "max_multi_roulette_limit": 10,
  "allowed_multi_list": [],
  "multi_bonus_enabled": false,
  "multi_bonus_trigger_count": 10,
  "multi_bonus_extra_count": 1,
  "command_id": 4,
  "activate": true,
  "tts_enabled": false,
  "multi_collect_enabled": false,
  "items": [
    {"data": "꽝", "weight": 70},
    {"data": "간식", "weight": 25, "ticket": true},
    {"data": "음료", "weight": 5}
  ]
}

오류

룰렛 만들기

새 룰렛을 만듭니다. 새 룰렛은 탭 맨 뒤에 붙습니다.

요청

weight가 0인 항목은 뽑히지 않으며, 항목이 하나라도 있으면 weight 합계가 0보다 커야 합니다. 32비트 정수는 -2,147,483,648~2,147,483,647입니다. 항목 하나마다 JSON 키가 2~3개 들어가므로 항목이 수백 개면 JSON 키 1,000개 한도에 걸릴 수 있습니다.

POST /api/v1/developer/roulettes
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "roulette_name": "간식 룰렛",
  "items": [
    {"data": "꽝", "weight": 70},
    {"data": "간식", "weight": 25, "ticket": true},
    {"data": "음료", "weight": 5}
  ],
  "send_message": true,
  "command_id": 4,
  "max_multi_roulette_limit": 10
}

응답

성공 상태는 201이 아니라 200입니다.

{
  "roulette_name": "간식 룰렛",
  "send_message": true,
  "trigger_donation_min_amount": null,
  "trigger_donation_max_amount": null,
  "trigger_donation_text": null,
  "trigger_donation_allow_remainder": false,
  "max_multi_roulette_limit": 10,
  "allowed_multi_list": [],
  "multi_bonus_enabled": false,
  "multi_bonus_trigger_count": 10,
  "multi_bonus_extra_count": 1,
  "command_id": 4,
  "activate": true,
  "tts_enabled": false,
  "multi_collect_enabled": false,
  "items": [
    {"data": "꽝", "weight": 70},
    {"data": "간식", "weight": 25, "ticket": true},
    {"data": "음료", "weight": 5}
  ]
}

오류

룰렛 수정

룰렛 하나를 고칩니다. 본문의 roulette_name은 바꾼 뒤의 이름이라 항상 보내고, 나머지는 바꿀 필드만 보냅니다.

요청

items를 보내면 만들기와 같은 확률 검사를 다시 합니다.

PUT /api/v1/developer/roulettes/%EA%B0%84%EC%8B%9D%20%EB%A3%B0%EB%A0%9B
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "roulette_name": "주말 간식 룰렛",
  "trigger_donation_min_amount": 2000
}

응답

{
  "roulette_name": "주말 간식 룰렛",
  "send_message": true,
  "trigger_donation_min_amount": 2000,
  "trigger_donation_max_amount": null,
  "trigger_donation_text": null,
  "trigger_donation_allow_remainder": false,
  "max_multi_roulette_limit": 10,
  "allowed_multi_list": [],
  "multi_bonus_enabled": false,
  "multi_bonus_trigger_count": 10,
  "multi_bonus_extra_count": 1,
  "command_id": 4,
  "activate": true,
  "tts_enabled": false,
  "multi_collect_enabled": false,
  "items": [
    {"data": "꽝", "weight": 70},
    {"data": "간식", "weight": 25, "ticket": true},
    {"data": "음료", "weight": 5}
  ]
}

오류

룰렛 삭제

룰렛 하나를 지웁니다. 지운 룰렛은 되돌릴 수 없지만 그동안의 실행 기록은 룰렛 내역에 남습니다.

요청

DELETE /api/v1/developer/roulettes/%EA%B0%84%EC%8B%9D%20%EB%A3%B0%EB%A0%9B
Authorization: Bearer ACCESS_TOKEN

응답

{"ok": true}

오류