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 mailkeishicho2 メッセージのタイプ  
      msgid String 任意 メッセージ毎の一意な番号  
      sendid String 任意 メッセージの配信元情報  
      senddatetime String YYYY-MM-DD HH:mm:SS+HHmm形式 メッセージの送信時刻  
    details   Array データタイプ毎のパラメータを設定 メッセージの詳細情報設定セクション メールけいしちょう情報を設定します。
  • WebSocket APIからのメールけいしちょう通知メッセージ詳細

    • version区(セクション)
      • common_version:common区のバージョンが設定。(現在は"1"のみ利用)
      • details_version:details区(メールけいしちょう)のバージョンが設定。(現在は"1"のみ利用)
    • common区(セクション)
      • common_version: "1"は、以下のパラメータを含みます。
        • datatype:メールけいしちょうdatatype名:"mailkeishicho2"が設定されます。
        • msgid:メールけいしちょうの一意な値が設定されます。
        • sendid:メールけいしちょうの発信元情報などが設定されます。
        • senddatetime:メールけいしちょう通知メッセージの送信時刻が設定されます。(YYYY-MM-DD HH:mm:SS+HHmm形式)
    • 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
      <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 "mailkeishicho2":    // メールけいしちょう受信処理
              output.innerHTML = "メールけいしちょうからのお知らせ<br><br>" + parse.details[0].mailbody;
              break;
          }
        };
      
        // 切断イベント処理
        ws.onclose = function (e) {
          output.innerHTML += logStr('disconnect', e.code + ' - ' + e.type);
        };
      }());
      
      </script>
      </body>
      </html>