명령어

채널의 커스텀 명령어를 조회하고 추가·수정·삭제하는 API입니다. 대시보드 명령어 화면과 같은 데이터를 다루며, 바꾼 내용은 1초 안에 봇에 반영됩니다.

명령어 객체

조회·추가·수정 API는 명령어를 아래 객체로 돌려줍니다. 각 설정이 채팅에서 어떻게 동작하는지는 커스텀 명령어 가이드와 같습니다.

새 명령어의 id는 채널 안의 가장 큰 id에 1을 더한 값입니다. 가장 큰 id의 명령어를 지우면 다음에 만드는 명령어가 같은 id를 받으니, 지운 명령어의 id를 계속 쓰지 마세요.

명령어 목록 조회

채널의 커스텀 명령어를 모두 가져옵니다. 대시보드 표 순서(cmd_index 오름차순)로 정렬되며 페이지 없이 한 번에 옵니다.

요청

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

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

응답

[
  {
    "id": 1,
    "cmd_index": 0,
    "command": "!출첵",
    "response": "<보낸사람>님 출석 완료! <출석횟수>번째 출석이에요.",
    "response_use_point_fail": "<보낸사람>님은 이미 출석을 진행하였습니다",
    "point": 0,
    "cooltime": 0,
    "user_cooltime": 0,
    "live_only": false,
    "notice_on_staff": false,
    "user_daily_limit": 0,
    "total_daily_limit": 0,
    "total_used_count": 352,
    "total_daily_used_count": 41,
    "is_attendance": true,
    "activate": true
  },
  {
    "id": 3,
    "cmd_index": 1,
    "command": "!디코",
    "response": "디스코드는 discord.gg/초대코드 로 들어오세요",
    "response_use_point_fail": "",
    "point": 0,
    "cooltime": 10,
    "user_cooltime": 0,
    "live_only": false,
    "notice_on_staff": false,
    "user_daily_limit": 0,
    "total_daily_limit": 0,
    "total_used_count": 128,
    "total_daily_used_count": 7,
    "is_attendance": false,
    "activate": true
  }
]

오류

명령어 추가

새 명령어를 만듭니다. 새 명령어는 목록 맨 뒤에 붙습니다.

요청

total_used_count, total_daily_used_count는 봇이 세는 값이라 보내도 무시됩니다.

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

{
  "command": "!선물",
  "response": "<보낸사람>님 100P 선물! 지금 <잔여포인트>P",
  "point": -100,
  "user_daily_limit": 1
}

응답

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

{
  "id": 4,
  "cmd_index": 2,
  "command": "!선물",
  "response": "<보낸사람>님 100P 선물! 지금 <잔여포인트>P",
  "response_use_point_fail": "",
  "point": -100,
  "cooltime": 0,
  "user_cooltime": 0,
  "live_only": false,
  "notice_on_staff": false,
  "user_daily_limit": 1,
  "total_daily_limit": 0,
  "total_used_count": 0,
  "total_daily_used_count": 0,
  "is_attendance": false,
  "activate": true
}

오류

명령어 수정

명령어 하나를 고칩니다. command와 response는 바꾸지 않더라도 항상 보내고, 나머지는 바꿀 필드만 보냅니다.

요청

필드를 빼면 유지되지만 null은 받지 않습니다(422). 값을 끄거나 비우려면 0, false, ""처럼 실제 값을 보내세요.

수정은 이름 중복을 검사하지 않습니다. 다른 명령어와 같은 이름으로 바꾸면 같은 이름이 둘이 되고, 채팅에는 목록에서 앞에 있는 명령어만 반응합니다. 이름을 바꾸기 전에 목록에서 확인하세요.

PUT /api/v1/developer/commands/3
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json

{
  "command": "!디코",
  "response": "새 디스코드 주소는 discord.gg/새코드 예요",
  "cooltime": 30
}

응답

{
  "id": 3,
  "cmd_index": 1,
  "command": "!디코",
  "response": "새 디스코드 주소는 discord.gg/새코드 예요",
  "response_use_point_fail": "",
  "point": 0,
  "cooltime": 30,
  "user_cooltime": 0,
  "live_only": false,
  "notice_on_staff": false,
  "user_daily_limit": 0,
  "total_daily_limit": 0,
  "total_used_count": 128,
  "total_daily_used_count": 7,
  "is_attendance": false,
  "activate": true
}

오류

명령어 삭제

명령어 하나를 지웁니다. 지운 명령어는 되돌릴 수 없습니다.

요청

이 명령어를 연결해 둔 룰렛의 command_id는 그대로 남습니다. 필요하면 룰렛 수정으로 연결을 바꾸세요.

DELETE /api/v1/developer/commands/3
Authorization: Bearer ACCESS_TOKEN

응답

{"ok": true}

오류