Telegram List v1

リクエスト

GET https://api.dmdata.jp/telegram/v1/list

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

クエリパラメータ

パラメータ名必須デフォルト説明
keyはいString
APIアクセスキー。
typeいいえString
電文ヘッダを指定。前方一致で検索する。
xmlいいえfalseBoolean
XML電文に出現する、/Report/Control及び/Report/Head情報を表示するか指定する。
testいいえfalseBoolean|String
訓練、試験等のテスト等電文を表示するか指定する。
true: テスト等電文を含む。
only: テスト等電文のみ。
newCatchいいえ0Int
レスポンス内に存在するnewCatchの値をそのまま指定することにより、それ以降の新しい電文を受け取る。
nextTokenいいえString
レスポンス内に存在するnextTokenの値をそのまま指定することにより、それ以前の古い電文を受け取る。
limitいいえ100Int
返す電文数を指定する。1~100までの整数を受け取る。

APIアクセスキーに必要な権限

  • telegram.list

その他

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


レスポンス

APIは常にJSONを返答します。

status: ok

成功時に次のような内容を返答します。

{
"responseId": "71604ee6-8210-414a-ac87-078562ed6142",
"responseTime": "2020-01-01T09:00:00.000+09:00",
"status": "ok",
"items": [
{
"key": "123456789abcdef...",
"classification": "telegram.weather",
"data": {
"type": "VPWW54",
"author": "JPTD",
"time": "2020-01-01T00:00:00.000Z",
"test": false,
"xml": true,
"createTime": "2020-02-27T00:00:00.000Z",
"sendNumber": 0
},
"url": "https://data.api.dmdata.jp/v1/123456789abcdef...",
"xmlData": {
"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": "注意報を解除します。"
}
}
}
],
"newCatch": 254689
}
プロパティ名出現説明
responseIdいつもString
API処理ID。
responseTimeいつもString
API処理時刻(ISO8601拡張形式)。
statusいつもString
成功時は "ok"、失敗時(エラー)は "error"。
itemsいつもArray[ Object ]
電文情報リスト。
items[].classificationいつもString
配信区分により変化。取りうる値は "telegram.earthquake", "telegram.volcano", "telegram.weather", "telegram.scheduled"。
items[].keyいつもString
配信データを区別するユニーク384bitハッシュ。
items[].dataいつもObject
電文ヘッダ情報。
items[].data.typeいつもString
データ種類コード。
items[].data.authorいつもString
発表英字官署名。
items[].data.timeいつもString
基点時刻(ISO8601拡張形式)。
items[].data.testいつもBoolean
訓練、試験等のテスト等電文かどうかを示す。
items[].data.xmlいつもBoolean
XML電文かどうかを示す。
items[].data.createTimeいつもString
気象業務支援センター電文生成時刻(ISO8601拡張形式)。
items[].data.sendNumberいつもInt
気象業務支援センター付与通過番号。
items[].urlいつもString
電文本文があるURL。別途参照。
items[].xmlDataitems[].data.xml=true時および、クエリパラメータxml=trueの時Object
XML電文Control,Head情報。
items[].xmlData.controlいつもObject
XML電文Control情報。
items[].xmlData.control.titleいつもString
情報名称。
items[].xmlData.control.dateTimeいつもString
発表時刻(ISO8601拡張形式、世界協定時)。
items[].xmlData.control.statusいつもString
運用種別を示し、"通常"以外は利用してはならない。取りうる値は "通常", "試験", "訓練"。
items[].xmlData.control.editorialOfficeいつもString
編集官署名。
items[].xmlData.control.publishingOfficeいつもString
発表官署名。
items[].xmlData.headいつもObject
XML電文Head情報。
items[].xmlData.head.titleいつもString
情報表題。
items[].xmlData.head.reportDateTimeいつもString
公式な発表時刻(ISO8601拡張形式)。
items[].xmlData.head.targetDateTimeいつもString
基点時刻(ISO8601拡張形式)。
items[].xmlData.head.targetDateTimeDubious電文によるString
基点時刻のあいまいさ(頃、など)。
items[].xmlData.head.targetDuration電文によるString
予報期間(ISO8601継続時間形式)。
items[].xmlData.head.validDateTime電文によるString
本情報の失効時刻(ISO8601拡張形式)。
items[].xmlData.head.eventIdいつもString|Null
電文識別情報。
items[].xmlData.head.serialいつもString|Null
電文情報番号。
items[].xmlData.head.infoTypeいつもString
電文発表形態を示し、取りうる値は "発表", "訂正", "遅延", "取消"。
items[].xmlData.head.infoKindいつもString
XML電文スキーマの運用種別情報。
items[].xmlData.head.infoKindVersionいつもString
XML電文スキーマの運用種別情報のバージョン。
items[].xmlData.head.headlineいつもString|Null
見出し文。
newCatchいつもInt
クエリパラメーターにこの値を入れると取得した情報より新しい情報を表示。

status: error

APIは各種エラーを次の通り返答します。

{
"responseId": "aa5f6aa2-c308-442f-be8c-9c59cbfa3414",
"responseTime": "2020-01-01T09:00:00.000+09:00",
"status": "error",
"error": {
"message": "Parameter is incorrect.",
"code": 400
}
}
プロパティ名出現説明
errorいつもArray[ Object ]
エラー情報。
error.messageいつもString
エラーメッセージ、標準エラー参照。
error.codeいつもString
HTTPステータスコード。