이런 때 써요
- 내 사이트 게시판에 새 글이 올라오면 채팅방에 알려요.
- 방송 후원·구독 알림을 채팅방에도 띄워요.
- 이벤트 시작 같은 소식을 원하는 때에 채팅방에 보내요.
외부 서버가 유챗 API로 이벤트를 보내면 이 플러그인이 채팅방에 띄워요. 플러그인을 켜고, 관리 페이지 API 메뉴에서 키를 발급받아 서버에 넣으면 돼요.
보내는 법
POST https://api.uchat.io/v2/rooms/{API 채팅방 아이디}/events에 Authorization: Bearer {API 키} 헤더와 JSON 본문을 보내요. 본문의 plugin은 alertBox이고, data의 첫 칸이 알림 종류예요.
curl -X POST https://api.uchat.io/v2/rooms/room_xxxxxxxxxxxxxxxx/events \
-H "Authorization: Bearer uchat_..." \
-H "Content-Type: application/json" \
-d '{"plugin":"alertBox","data":["donation","민지","10000","응원해요!"]}'
| 종류 | data 칸 순서 |
예 |
|---|---|---|
| 글 등록 | post, 작성자, 제목, 링크, 게시판 |
["post","하늘","오늘의 공지","https://example.com/1","공지"] |
| 후원 | donation, 닉네임, 금액, 메시지 |
["donation","민지","10000","응원해요!"] |
| 구독 | subscribe, 닉네임, 개월 수, 메시지 |
["subscribe","준호","3",""] |
| 직접 정의 | custom, 제목, 내용, 링크 |
["custom","이벤트 시작","지금 참여하세요",""] |
"to":"닉네임"을 넣으면 그 사람 화면에만 떠요.- 값은 글자로만 보여요. 링크는
https://로 시작할 때만 누를 수 있어요. - 채팅방 사람이 같은 이름으로 보낸 것은 무시하고, 서버 API로 온 것만 띄워요.
모양
대화 목록 안에 가로로 꽉 찬 색 칸으로 들어가요. 유튜브 슈퍼챗이나 치지직 후원처럼 대화 흐름에 남아서, 위로 올려 보면 지난 알림도 보여요. 첫 줄은 굵게, 둘째 줄(메시지·제목)은 그 아래에 보여요. 각자 화면에만 그리고 채팅 기록에는 남지 않아요.
설정
종류마다 켜기, 첫 줄·둘째 줄 문구, 배경색, 글자색을 정해요. 문구에는 {nick}·{title}·{amount}·{months}·{message} 같은 자리를 써요. 후원은 금액 단위와 최소 금액도 정할 수 있어요.