こんなときに使います
- 自分のサイトの掲示板に新しい投稿があったら、チャットルームに知らせます。
- 配信の投げ銭・サブスクの通知をチャットルームにも表示します。
- イベント開始などのお知らせを、好きなときにチャットルームに送ります。
外部サーバーがuchat APIでイベントを送ると、このプラグインがチャットルームに表示します。プラグインをオンにして、管理ページのAPIメニューでキーを発行し、サーバーに設定すれば完了です。
送り方
POST https://api.uchat.io/v2/rooms/{APIチャットルームID}/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から届いたものだけを表示します。
見た目
メッセージ一覧の中に、横幅いっぱいの色付きの枠として入ります。YouTubeのスーパーチャットやCHZZKの投げ銭のように会話の流れに残るので、上にスクロールすると過去の通知も見られます。1行目は太字で、2行目(メッセージ・タイトル)はその下に表示されます。各自の画面にだけ描かれ、チャットログには残りません。
設定
種類ごとに、オン・1行目と2行目の文言・背景色・文字色を決めます。文言には {nick}・{title}・{amount}・{months}・{message} などの差し込みを使えます。投げ銭は金額の単位と最低金額も設定できます。