サポートされているアクション

ウェブソケットセッションの維持とリプレイに利用可能なアクションの詳細。

このページでは、Benzinga WebSocket API と連携するために使用できるサポートされているアクションを一覧で示します。これらのアクションにより、セッションの健全性を維持し、直近のメッセージ履歴にアクセスできます。

list アクションで返されるメッセージ数を制御することはできません。実際の件数は、指定したキーに対して現在キャッシュされているメッセージ数に依存します。

​

利用可能なアクション

Action	説明	例
replay	直近最大100件のメッセージを再送します。返されるメッセージ数は、そのキーに対するキャッシュの利用状況によって変動します。	replay
ping	ハートビート信号を送信してウェブソケットセッションを維持します。	ping

​

使用例

ウェブソケットクライアントを使用して、以下の形式でアクションを送信します。 ping の使用例:

ping

レスポンス：

pong

リプレイ機能の使用例：

replay

レスポンス:

{
  "id": "unique-uuid-for-response",
  "api_version": "websocket/v1",
  "kind": "stream_type",
  "data": {
    "action": "created/updated/deleted",
    "id": "insight-id",
    "content": {
      ...  
    },
    "timestamp": "2024-10-08T10:00:00Z"
  }
}