WebSocket API仕様(噴火速報受信者向け)


噴火速報について

  • 噴火速報は、気象庁から発表される情報を元に噴火の発生事実をお知らせするものです。
  • 本サービスは、気象庁発表の噴火速報を用いて火山名や発表対象地域をお知らせするものです。

注意事項

  • 本サービスは、噴火の発生を予知するものではありません。
  • 本サービスは、気象庁が発表する噴火速報に含まれる情報(火山情報、対象地域)を元に噴火の発生に関する情報をお知らせするものです。
  • 噴火速報は気象庁が常時観測している各火山を対象に発表しますが、以下のような場合には発表されませんのでご留意ください。
    • 普段から噴火している火山において、普段と同じ規模の噴火が発生した場合
    • 噴火の規模が小さく、噴火が発生した事実をすぐに確認できない場合
  • 噴火速報についての詳細は、 気象庁のwebサイト でご確認ください。
  • 気象庁が発表する噴火速報には、「通常報」と「訓練報」の2つのモードが存在しますが、本サービスではこの内「通常報」のみを取り扱い、「訓練報」は取り扱いません。
  • 噴火速報のデータには、「通常」「訓練」「試験」のモードが存在しており、データを利用する際にはこれらのモードに対して適切な処理を行ってください。
    • 例えば「訓練」「試験」モードのデータは利用しない、利用する場合は明らかに 訓練 や 試験 であることが分かるようにするなど、利用者の混乱を避けてください。
    • 「訓練」「試験」モードのデータを、「通常」データであるかのような処理は 行わない でください。
    • モードの誤用によるトラブルについては、弊社は一切の責任を負わないものとします。

噴火速報の通知について

  • 気象庁が噴火速報の発表時に、噴火が観測された火山をWebSocket API経由で通知します。
  • 本サービスでは、気象庁で定義された火山コード・運用種別・対象地域ごとの噴火情報を通知します。
    • 噴火速報の対象地域になっていない場合は通知されません。

WebSocket API 噴火速報通知メッセージ仕様

  • 噴火速報:WebSocket API通知メッセージ表

    セクション パラメータ タイプ 設定値 意味 備考
    version   Hash 以下の2パラメータを設定 メッセージのバージョン情報設定セクション  
      common_version String 任意 commonセクションのパラメータバージョン 現在は1のみ対応
      details_version String 任意 detailsセクションのパラメータバージョン 現在は1のみ対応
    common   Hash 以下の4パラメータを設定 メッセージの共通情報設定セクション 以下の4パラメータはバージョン1のもの
      datatype String jmaeruption_flash メッセージのタイプ  
      msgid String 任意 メッセージ毎の一意な番号  
      sendid String 任意 メッセージの配信元情報  
      senddatetime String YYYY-MM-DD HH:mm:SS+HH:mm形式 メッセージの送信時刻  
    details   Array データタイプ毎のパラメータを設定 メッセージの詳細情報設定セクション 噴火速報を設定します。
  • WebSocket APIからの噴火速報通知メッセージ詳細

    • version区(セクション)
      • common_version:common区のバージョンが設定。(現在は"1"のみ利用)
      • details_version:details区(噴火速報)のバージョンが設定。(現在は"1"のみ利用)
    • common区(セクション)
      • common_version: "1"は、以下のパラメータを含みます。
        • datatype:噴火速報のdatatype名:"jmaeruption_flash"が設定されます。
        • msgid:噴火速報毎の一意な値が設定されます。
        • sendid:噴火速報の発信元情報などが設定されます。(例:JMA など)
        • senddatetime:噴火速報通知メッセージの送信時刻が設定されます。(YYYY-MM-DD HH:mm:SS+HH:mm形式)
    • details区(セクション)

サンプルプログラム

  • html(javascript)

    • WebSocket APIへの接続と認証および噴火速報メッセージの受信表示処理

       1
       2
       3
       4
       5
       6
       7
       8
       9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
      91
      92
      93
      94
      95
      96
      97
      98
      99
      <html>
      <head>
      </head>
      <body>
      <div id="output"></div>
      
      <script>
      (function() {
        // websocketサーバアドレスおよびポートを指定
        var ws = new WebSocket("wss://localhost:443");
      
        var output = document.getElementById('output');
      
        function logStr(eventStr, msg) {
          return '<div>' + eventStr + ':' + msg + '</div>';
        }
      
        // websoket接続確立イベント処理
        ws.onopen = function() {
          output.innerHTML += logStr('connect', 'success');
      
          // websocket認証メッセージ
          var auth_message = {
            version: {
              common_version:   "1",                // commonセクションバージョン
              details_version:  "1"                 // detailsセクションバージョン
            },
            common: {
              datatype:     "authentication",       // データタイプ:認証(authenticaion指定)
              msgid:        "*",                    // *を設定(認証では利用しない)
              sendid:       "*",                    // *を設定(認証では利用しない)
              senddatetime: "*"                     // *を設定(認証では利用しない)
            },
            details:      {
              password:     "trialpass"             // ユーザパスワードを設定(利用申請時に発行)
            },
            sender: {
              version:      "1",                    // senderセクションバージョン
              userid:       "trialuser",            // ユーザIDを設定(利用申請時に発行)
              termid:       "000000001"             // 接続端末識別IDを設定(ユーザがユニークな値となるよう任意に採番)
            },
            receiver: {
              version:      "1",                    // receiverセクションバージョン
              userid:       "*",                    // *を設定(認証では利用しない)
              termid:       "*"                     // *を設定(認証では利用しない)
            }
          };
          // JSON形式に変換し、websocketサーバに送信
          ws.send(JSON.stringify(auth_message));
        };
      
        // メッセージ受信イベント処理
        ws.onmessage = function(e) {
          // JSON形式からオブジェクトに変換
          var parse = JSON.parse(e.data);
      
          switch( parse.common.datatype ) {
            case "authentication":    // 認証メッセージ受信処理
              output.innerHTML += logStr('recieved', 'authentication result');
              if( parse.details.resultcode === '200' ) {
                // 認証成功
                output.innerHTML += logStr('authentication', 'success');
              } else {
                // 認証失敗
                output.innerHTML += logStr('authentication', 'failed');
              }
              break;
            case "jmaeruption_flash":         // 噴火速報受信処理
              // 噴火速報メッセージ種別判別
              for( var i = 0, len = parse.details.length; i < len; i++ ) {
                var data = parse.details[i];
                // 噴火速報(例:対象地域・地点コード:東京都千代田区:1310300)
                if( data.areacode == "1310300" ) {
                  switch( data.controlstatuscode ) {
                    case "0":  // 通常報
                      break;
                    case "1":  // 訓練報
                      output.innerHTML += "<br><FONT color=\"#ff0000\">これは訓練報です。</FONT><br>";
                      break;
                    case "2":  // 試験報
                      output.innerHTML += "<br><FONT color=\"#ff0000\">これはテスト報です。</FONT><br>";
                      break;
                  }
                  output.innerHTML += "東京都千代田区に噴火速報( " + data.title + " )が発表されました。<br>";
                }
              }
              break;
          }
        };
      
        // 切断イベント処理
        ws.onclose = function (e) {
          output.innerHTML += logStr('disconnect', e.code + ' - ' + e.type);
        };
      }());
      
      </script>
      </body>
      </html>