WebSocket API
ビュー
channels
登録済みのWebソケットチャンネルをすべて返します。
message
必須パラメーター：
- channelId: チャネルID
- messageId: メッセージID
指定されたメッセージの詳細な情報を返します。
「channelId」と「messageId」は、「messages」ビューを介して取得できます。
messages
オプションパラメーター：
- channelId: チャネルID
- start: メッセージの取得を開始するオフセット。値は0から始まります。
- count: 返すメッセージの数。
- payloadPreviewLength: ペイロードの最大バイト数。
指定された基準を満たすすべてのメッセージのリストを返します。デフォルトでは、すべてのメッセージが返されます。
「channelId」は「channels」ビューを介して取得できます。
「start」および「count」パラメーターは、メッセージのページ送りに使用できます。
「payloadPreviewLength」は、返されるデータのサイズを制限するために使用できます。
アクション
sendTextMessage
必須パラメーター：
- channelId: チャネルID
- outgoing: メッセージをサーバーに送信する場合は「True」、クライアントに送信する場合は「False」を指定します。
- message: 送信するメッセージ。
指定されたチャネルで指定されたメッセージを送信します。
「channelId」は「channels」ビューを介して取得できます。