Telegram List v2
リクエスト
GET https://api.dmdata.jp/v2/telegram
リクエストに応じた電文リストを新しい順で返します。
クエリパラメータ
パラメータ名 | 必須 | デフォルト | 説明 |
---|---|---|---|
type | いいえ | String データ種類コードを指定。1つのみの場合は前方一致で検索する カンマで区切り、複数のデータ種類コードを指定できる。その場合は完全一致の必要があり最大5つまで | |
classification | いいえ | String 配信区分(API名)を指定 カンマで区切り、複数の配信区分を指定できる | |
xmlReport | いいえ | false | Boolean XML電文に出現する、/Report/Control及び/Report/Head情報を表示するか指定する |
test | いいえ | no | String 訓練、試験等のテスト等電文を表示するか指定する including: テスト等電文を含む、only: テスト等電文のみ 注意:XML電文以外のテスト配信は常に false 判定になります。本文中を参照するようにしてください |
formatMode | いいえ | raw | String データフォーマットの指定。 生電文: raw、JSON化データ: json |
datetime | いいえ | String 【実験】 日時による絞り込みを行う。 形式は、 2021-05-01T00:00:00~2021-06-01T00:00:00 のようにし、~ で日付の範囲を区切る 左辺を開始日時とし、右辺を終了日時(その時刻を含まない) 検索の対象は受信時刻となり、左辺または右辺どちらかがなくてもよい | |
cursorToken | いいえ | String 次のリソースを取得する。レスポンス内のnextTokenまたはnextPoolingの値を指定する 詳しくはこちら | |
limit | いいえ | 20 | Integer 返す電文数を指定する。最大は100 |
APIに必要な権限
- telegram.list
その他
レスポンスのnextPooling
をクエリパラメータcursorToken
に指定すると、前回レスポンスしたデータより新しい情報のみをレスポンスします。
ファイル形式データ、緊急地震速報関連の電文は表示されません。
お知らせ
2025年07月01日以降は、直近約180日分の電文データが利用できます(ただし、気象観測データ[telegram.observation]は直近約30日分)。
2020年11月18日以降に配信された電文・緊急地震速報関連データは、ArchiveAPIで取得できます。
レスポンス
APIは常にJSONを返答します。
status: ok
成功時に次のような内容を返答します。
{
"responseId": "8359288359fc5bb9",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "ok",
"items": [
{
"serial": 0,
"classification": "telegram.weather",
"id": "123456789abcdef...",
"head": {
"type": "VPWW54",
"author": "JPTD",
"time": "2020-01-01T00:00:00.000Z",
"test": false
},
"receivedTime": "2020-01-01T00:00:02.000Z",
"xmlReport": {
"control": {
"title": "気象警報・注意報(H27)",
"dateTime": "2020-02-27T00:00:00Z",
"status": "通常",
"editorialOffice": "気象庁本庁",
"publishingOffice": "気象庁予報部"
},
"head": {
"title": "東京都気象警報・注意報",
"reportDateTime": "2020-02-27T09:00:00+09:00",
"targetDateTime": "2020-02-27T09:00:00+09:00",
"eventId": null,
"serial": null,
"infoType": "発表",
"infoKind": "気象警報・注意報",
"infoKindVersion": "1.2_1",
"headline": "注意報を解除します。"
}
},
"format": "xml",
"url": "https://data.api.dmdata.jp/v1/123456789abcdef..."
}
],
"nextToken": "bmV4dCAgICAgICAgNTc0MzI",
"nextPooling": "cG9sbGluZyAgICAgNzM0MzE",
"nextPoolingInterval": 1600
}
フィールド | 出現 | 説明 |
---|---|---|
responseId | いつも | String API処理ID |
responseTime | いつも | String API処理時刻(ISO8601拡張形式) |
status | いつも | String 成功時は ok 、失敗時(エラー)は error |
items | いつも | Array<Object> 電文情報リスト |
items[].serial | いつも | Integer|String<Integer> 電文受信通番 |
items[].id | いつも | String 配信データを区別するユニーク384bitハッシュ |
items[].classification | いつも | String 配信区分により変化。 |
items[].head | いつも | Object ヘッダ情報 |
items[].head.type | いつも | String データ種類コード |
items[].head.author | いつも | String 発表英字官署名 |
items[].head.target | 内容による※1 | String 対象観測地点コード |
items[].head.time | いつも | ISO8601Time 基点時刻 |
items[].head.designation | いつも | String|Null 指定コード WMO全球通信システム(GTS)で定義されている符号で、遅延報・訂正報に付加する。通常は Null とする |
items[].head.test | いつも | Boolean 訓練、試験等のテスト等電文かどうかを示す 注意:XML電文以外のテスト配信は常に false になります。本文中を参照するようにしてください。 |
items[].receivedTime | いつも | ISO8601Time 受信時刻 |
items[].xmlReport | format=xml、 クリパラメータxmlReport=true時 | Object XML電文Control,Head情報 |
items[].schema | format=json | Object 加工データのスキーマ情報 |
items[].schema.type | いつも | String スキーマ名 |
items[].schema.version | いつも | String スキーマのバージョン |
items[].format | いつも | String|Null bodyフィールドの表現形式を示す。 xml 、a/n 、binary は気象庁が定めたフォーマット、 json は本サービスが独自に定めたフォーマット |
items[].url | いつも | String 電文本文URL |
nextToken | 場合による | String 次のリソースがある場合に出現。詳しくはこちら |
nextPooling | いつも | String PuLL時に使用する。詳しくはこちら |
nextPoolingInterval | いつも | Integer PuLL時、次にリクエストするまでの待機すべき最小時間(ミリ秒) |
status: error
APIは各種エラーを次の通り返答します。
{
"responseId": "66d23c0cede77d82",
"responseTime": "2021-04-01T00:00:00.000Z",
"status": "error",
"error": {
"message": "...",
"code": 400
}
}
フィールド | 出現 | 説明 |
---|---|---|
error | いつも | Object エラー情報。 |
error.message | いつも | String エラーメッセージ、標準エラーおよび別表参照。 |
error.code | いつも | Integer HTTPステータスコード。 |
標準エラー以外に以下のエラーを出力します。
ステータスコード | エラーメッセージ | 説明 |
---|---|---|
400 | You have entered a string that is not defined in `formatMode`. | formatModeにrawかjson以外が指定されている |