WebSocket API仕様(J-ALERT受信者向け)

申込の受注停止について

  • J-ALERT（データタイプ名：jalert1）は 2023年3月31日 をもちまして受注停止いたします。
    • 受注停止日
      • 2023年3月31日
        • ※新規契約、及び既存契約への追加・変更申込の受付も終了いたします。
    • 後継データタイプについて
      • 今後のお申込みでは、後継のJ-ALERT(XMLバージョン2対応版) (データタイプ：jalert2)をご利用ください。
    • 今後の当該データの配信について
      • 現在契約中のお客様への配信は、情報提供元の一般財団法人マルチメディア振興センターからのXMLバージョン1系のLアラート配信が終了するまで継続する予定です。
      • 配信するデータタイプの切替または並行配信を希望する場合は、下記問い合わせ先までご連絡いただけますようお願い申し上げます。
    • 本件に関するお問合せ

J-ALERTについて


注意事項

  • J-ALERTのデータを取り扱う場合、マルチメディア振興センターへLアラートの利用登録が必要となります。
    • J-ALERTはLアラートの付加サービスとして提供する情報であるため、J-ALERTのみでの利用はできません。

取り扱い対象データについて

  • 本サービスで取り扱うデータには、「通常報」「訓練報」「試験報」の3つのモード(運用種別)が存在しております。
    データを利用する際は、これらのモードに対して適切な処理を行ってください。
    • 例えば「訓練報」「試験報」モードのデータは利用しない、利用する場合は明らかに 訓練 や 試験 であることが分かるようにするなど、利用者の混乱を避けてください。
    • 「訓練報」「試験報」モードのデータを、「通常報」データであるかのような処理は 行わない でください。
    • モードの誤用によるトラブルについては、弊社は一切の責任を負わないものとします。

  • 取り扱うモードは利用するサーバによって異なります。各サーバで取り扱うモードは、以下の通りといたします。

本番系WebSocketサーバでのAPI利用の場合

  • 本番系WebSocketサーバでは、「通常報」のみを取り扱い、それ以外のモードは取り扱いません。

トライアル/開発系WebSocketサーバでのAPI利用の場合

  • トライアル/開発系WebSocketサーバでは、「通常報」「訓練報」「試験報」の3つのモードを取り扱います。

WebSocket API J-ALERT通知メッセージ仕様

  • J-ALERT:WebSocket API通知メッセージ表

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

  • WebSocket APIからのJ-ALERT通知メッセージ詳細

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

サンプルプログラム

  • html(javascript)

    • WebSocket APIへの接続と認証およびJ-ALERTメッセージの受信表示処理

       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
      <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",                // ユーザＩＤを設定(利用申請時に発行)
        termid: "000000001"                // 接続端末識別ＩＤを設定(ユーザがユニークな値となるよう任意に採番)
      },
      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 "jalert1":    // J-ALERT受信処理
        output.innerHTML = parse.details[0].cityname + "に" + parse.details[0].subject + "が発表されました。<br><br>";
        output.innerHTML += parse.details[0].info_summary;
        break;
    }
  };

  // 切断イベント処理
  ws.onclose = function (e) {
    output.innerHTML += logStr('disconnect', e.code + ' - ' + e.type);
  };
}());

</script>
</body>
</html>