Skip to main content

Telegram List v2

リクエスト#

GET https://api.dmdata.jp/v2/telegram

リクエストに応じた電文リストを新しい順で返します。

クエリパラメータ#

パラメータ名必須デフォルト説明
typeいいえString
データ種類コードを指定。1つのみの場合は前方一致で検索する
カンマで区切り、複数のデータ種類コード指定できる。その場合は完全一致の必要があり最大5つまで
xmlReportいいえfalseBoolean
XML電文に出現する、/Report/Control及び/Report/Head情報を表示するか指定する
testいいえnoString
訓練、試験等のテスト等電文を表示するか指定する
including: テスト等電文を含む、only: テスト等電文のみ
注意:XML電文以外のテスト配信は常にfalse判定になります。本文中を参照するようにしてください
cursorTokenいいえString
次のリソースを取得する。レスポンス内のnextTokenまたはnextPoolingの値を指定する
詳しくはこちら
formatModeいいえrawString
データフォーマットの指定。
生電文: raw、JSON化データ: json
limitいいえ20Integer
返す電文数を指定する。最大は100

APIに必要な権限#

  • telegram.list

その他#

APIアクセスキーの権限にかかわらず、契約している区分の電文がすべて表示されます。

レスポンスのnextPoolingをクエリパラメータcursorTokenに指定すると、前回レスポンスしたデータより新しい情報のみをレスポンスします。


レスポンス#

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
電文受信通番
items[].idいつもString
配信データを区別するユニーク384bitハッシュ
items[].classificationいつもString
配信区分により変化。取りうる値は telegram.earthquake, telegram.volcano, telegram.weather, telegram.scheduled
items[].headいつもObject
ヘッダ情報
items[].head.typeいつもString
データ種類コード
items[].head.authorいつもString
発表英字官署名
items[].head.target内容による※1String
対象観測地点コード
items[].head.timeいつもISO8601Time
基点時刻
items[].head.designationいつもString|Null
指示コード
items[].head.testいつもBoolean
訓練、試験等のテスト等電文かどうかを示す
注意:XML電文以外のテスト配信は常にfalseになります。本文中を参照するようにしてください。
items[].receivedTimeいつもISO8601Time
受信時刻
items[].xmlReportformat=xml、
クリパラメータxmlReport=true時
Object
XML電文Control,Head情報
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ステータスコード。

標準エラー以外に以下のエラーを出力します。

ステータスコードエラーメッセージ説明
400You have entered a string that is not defined in `formatMode`.formatModeにrawかjson以外が指定されている