WebSocket API仕様(Lアラート(XMLバージョン2対応版)受信者向け)¶
目次
Lアラート(XMLバージョン2対応版)について¶
- Lアラートは、災害などの住民の安心・安全にかかわる情報を迅速かつ効率的に伝達することを目的とした、新たな情報流通のための基盤です。
- 詳しくは、 マルチメディア振興センターのwebサイト をご参照ください。
Lアラート(XMLバージョン2対応版)のデータについて¶
- マルチメディア振興センターから発表された情報を元に、エリアごとの災害情報などをWebSocketで通知します。
- マルチメディア振興センターから発表される電文の仕様を確認したい場合は、マルチメディア振興センターのwebサイトの XML仕様書申込フォーム からお申込みください。
- 本サービスは、マルチメディア振興センターから配信される情報をお知らせするものです。
注意事項¶
- Lアラート(XMLバージョン2対応版)のデータが「取消」または「無効化」された場合、該当するデータの公開を終了してください。
- Lアラート(XMLバージョン2対応版)のデータを取り扱う場合、マルチメディア振興センターへLアラートの利用登録が必要となります。
取り扱い対象データについて¶
- 本サービスで取り扱うデータには、「通常報」「訓練報」「試験報」の3つのモード(運用種別)が存在しております。データを利用する際は、これらのモードに対して適切な処理を行ってください。
- 例えば「訓練報」「試験報」モードのデータは利用しない、利用する場合は明らかに 訓練 や 試験 であることが分かるようにするなど、利用者の混乱を避けてください。
- 「訓練報」「試験報」モードのデータを、「通常報」データであるかのような処理は 行わない でください。
- モードの誤用によるトラブルについては、弊社は一切の責任を負わないものとします。
取り扱うモードは利用するサーバによって異なります。各サーバで取り扱うモードは、以下の通りといたします。
本番系WebSocketサーバでのAPI利用の場合¶
- 本番系WebSocketサーバでは、「通常報」のみを取り扱い、それ以外のモードは取り扱いません。
WebSocket API Lアラート(XMLバージョン2対応版)通知メッセージ仕様¶
Lアラート(XMLバージョン2対応版):WebSocket API通知メッセージ表
セクション パラメータ タイプ 設定値 意味 備考 version Hash 以下の2パラメータを設定 メッセージのバージョン情報設定セクション common_version String 任意 commonセクションのパラメータバージョン 現在は1のみ対応 details_version String 任意 detailsセクションのパラメータバージョン 現在は1のみ対応 common Hash 以下の4パラメータを設定 メッセージの共通情報設定セクション 以下の4パラメータはバージョン1のもの datatype String lalert2 メッセージのタイプ msgid String 任意 メッセージ毎の一意な番号 sendid String 任意 メッセージの配信元情報 senddatetime String YYYY-MM-DD HH:mm:SS+HHmm形式 メッセージの送信時刻 details Array データタイプ毎のパラメータを設定 メッセージの詳細情報設定セクション 詳細は以下を参照してください。WebSocket APIからのLアラート(XMLバージョン2対応版)通知メッセージ詳細
- version区(セクション)
- common_version:common区のバージョンが設定。(現在は"1"のみ利用)
- details_version:details区(Lアラート(XMLバージョン2対応版))のバージョンが設定。(現在は"1"のみ利用)
- common区(セクション)
- common_version: "1"は、以下のパラメータを含みます。
- datatype:Lアラート(XMLバージョン2対応版)のdatatype名:"lalert2"が設定されます。
- msgid:Lアラート(XMLバージョン2対応版)の一意な値が設定されます。
- sendid:Lアラート(XMLバージョン2対応版)の発信元情報などが設定されます。
- senddatetime:Lアラート(XMLバージョン2対応版)の通知メッセージの送信時刻が設定されます。(YYYY-MM-DD HH:mm:SS+HHmm形式)
- common_version: "1"は、以下のパラメータを含みます。
- details区(セクション)
- details区は、バージョンによりパラメータが異なります。
- version区(セクション)