安否確認API

Overview

本APIは安否確認の集計の閲覧/開始/完了、ユーザの回答状況確認及び発信をすることができます。
-安否確認API(登録)
-安否確認API(集計一覧)
-安否確認API(状況確認)
-安否確認API(発信)
-安否確認API(完了)

 安否確認API(登録)

POST https://api.ntt.com/v1/anpi/register/safety/

安否確認を集計できる災害情報を登録します。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
title 表題 全半角 200
text 本文 全半角 5000
strdate 集計開始日時 半角数字 12 "YYYYMMDDHHMI"形式
endpldate 終了案内メール発信日時 半角数字 12 "YYYYMMDDHHMI"形式
[endmailList] 終了案内メールアドレス一覧 - - - 配列
-endmail 終了案内メールアドレス メール形式 100 登録数文設定する。(最大3件)
geolocationgetflg 位置情報区分 半角数字 1 "0:取得しない 1:取得する。指定がない場合は「1:取得する」として検索を行う。※ただし、基本管理情報マスタ.位置情報使用フラグが'1'(使用)の場合のみ有効。"

Example Request

POST https://api.ntt.com/v1/anpi/register/safety/
{
   "title": "APITEST",
   "text": "0123456789",
  "strdate": "201812311830"
 }

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
resultCount 処理結果件数 半角数字 6
tid スレッドID 半角数字 7
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "resultCount": 1,
  "tid": A000000,
  "useCount": 8,
  "contractCount": -1
}

戻る

 安否確認API(集計一覧)

GET https://api.ntt.com/v1/anpi/confirm/safety/

登録されている安否確認の集計一覧を取得します。
一度に取得できる情報は最大1,000件までとなります。

Request Parameters

URL Path Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

GET https://api.ntt.com/v1/anpi/confirm/safety/?offset=10&limit=10

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[thrdiList] スレッド情報一覧 - - - 検索結果数分、以下の情報を設定する
-tid スレッドID 半角数字 7
-title 表題 全半角 200
-text 本文 全半角 5000
-strdate 集計開始日時 半角数字 12 "YYYYMMDDHHMI"形式
-endflg ステータスコード 半角数字 1 0:受付け中、1:完了

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{   
  "searchTotal": 200000,    
  "searchCount": 10,    
  "nextOffset": 10, 
  "useCount": 4365762,  
  "contractCount": -1,  
  "thrdiList": [    
    {   
      "tid": "A000000", 
      "title": "災害発生",  
      "text": "地震が発生しました。速やかに安全を確保したのちに回答を願います。",   
      "strdate": "201904031409",    
      "endflg": "1" 
    },  
    {   
      "tid": "A000001", 
      "title": "災害発生",  
      "text": "昨日に続き地震が発生しました。昨日回答した人も改めて安全を確保したのちに回答を願います。",   
      "strdate": "201904031410",    
      "endflg": "0" 
    }   
 ]  
}

戻る

 安否確認API(状況確認)

POST https://api.ntt.com/v1/anpi/confirm/safety-status/

安否確認へのユーザ回答状況を確認できます。
一度に確認できる情報は最大5,000件までとなります。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
tid スレッドID 半角数字 7 無指定の場合は受付中のスレッドを選択する。
orgkbn 組織区分 半角数字 1 "0:組織、1:グループ。指定がない場合は「0:組織」として検索を行う"
[orgpathList] 組織パス一覧 - - - 配列
組織パス 半角英数字記号 331 検索条件数分設定する。
[grpidList] グループID一覧 - - - 配列
グループID 半角数字 7 検索条件数分設定する。
indpflg 所属組織区分 半角数字 1 "0:所属組織なしを含めない、1:所属組織なしを含める。組織パス一覧が指定されていて、所属組織区分に指定がない場合は「0:所属組織なしを含めない」として検索を行う。組織パス一覧が指定されていない場合、所属組織なしを含める。検索組織に、""組織所属なし""を含める場合、「1:所属組織なしを含める」を設定する。"
[usrcdList] 氏名コード一覧 - - - 配列
氏名コード 半角英数字 32 検索条件数分設定する。
sei 氏名(姓/セイ) 全半角 32
mei 氏名(名/メイ) 全半角 32
langcd 言語コード 半角英数字 2 "ja:日本語 、en:英語。指定がない場合は:全言語の検索を行う"
[lcncdList] ロケーションコード一覧 - - - 配列
ロケーションコード 半角英数字 32 検索条件数分設定する。
[ctmcdList] ユーザー設定コード一覧 - - - 配列
ユーザー設定コード 半角英数字 32 検索条件数分設定する。
adkbn 住所条件 半角数字 1 "0:全て、1:いずれか指定がない場合は「0:全て」として検索を行う"
[wktdfkcdList] 勤務先都道府県コード一覧 - - - 配列
勤務先都道府県コード 半角数字 2 検索条件数分設定する。
wkskcs 勤務先市区町村名 全半角 40 指定の場合、勤務先都道府県は1個まで
[ad1tdfkcdList] 住所1都道府県コード一覧 - - - 配列
住所1都道府県コード 半角数字 2 検索条件数分設定する。
ad1skcs 住所1市区町村名 全半角 40 指定の場合、住所1都道府県は1個まで
[ad2tdfkcdList] 住所2都道府県コード一覧 - - - 配列
住所2都道府県コード 半角数字 2 検索条件数分設定する。
ad2skcs 住所2市区町村名 全半角 40 指定の場合、住所2都道府県は1個まで
searchkbn 住所検索区分 半角数字 1 "0:組織/グループと住所の全て、1:組織/グループと住所のいずれか。指定がない場合は「0:組織/グループと住所の全て」として検索を行う"
ansstatus 回答状況 半角数字 1 "1:回答済み、2:未回答、3:未回答-既読、4:未回答-未読、5:未回答-既読・未読、6:対象外。指定がない場合は全回答状況の検索を行う"
regdatekbn 時間指定区分 半角数字 1 1:日付以降回答あり、2:日付以降回答なし
regdate 時間指定(日付) 半角数字 12 """YYYYMMDDHHMI""形式。時間指定区分=「1:日付以降回答あり」又は、時間指定区分=「2:日付以降回答なし」の場合、必須"
sendstatus 発信状況 半角数字 1 "1:発信中、2:発信中止、3:発信済み。指定がない場合、またはスレッドが完了している場合は全発信状況の検索を行う"
sendresult 発信状況(結果) 半角数字 1 "発信状況(結果)(1:OK、2:一部OK、3:NG、4:連絡先未登録)。発信状況が「3:発信済み」の場合のみ有効。指定がない場合、またはスレッドが完了している場合は全発信状況(結果)の検索を行う"
prodid 災害ID 半角英数字 33
prodkbn 災害区分 半角数字 1 "0:全てを対象とする、1:最新を対象とする。指定がない場合は「0:全てを対象とする」として検索を行う"
questkbn 質問一致条件 半角数字 1 "0:全て、1:いずれか。指定がない場合は「0:全て」として検索を行う"
[ansList1] 回答コード一覧1 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList2] 回答コード一覧2 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList3] 回答コード一覧3 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList4] 回答コード一覧4 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList5] 回答コード一覧5 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList6] 回答コード一覧6 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
[ansList7] 回答コード一覧7 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

POST https://api.ntt.com/v1/anpi/confirm/safety-status/
{
    "tid": A000001
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
tid スレッドID 半角数字 7 処理対象となったスレッドIDを設定する
title 表題 全半角 200
text 本文 全半角 5000
strdate 集計開始日時 半角数字 12 "YYYYMMDDHHMI"形式
[questList] 質問文一覧 - - - 検索結果数分、以下の情報を設定する
-questnum 質問NO 半角数字 2
-quest 質問文 全半角 200
-[ansList] 回答一覧 - - - 回答選択肢数分、以下の情報を設定する
--ans 回答コード 半角数字 2
--ansmsg 回答 全半角 200
[thrddList] 状況情報一覧 - - - 検索結果数分、以下の情報を設定する
-usrcd 氏名コード 半角英数字 32
-staffsei 全半角 32
-staffmei 全半角 32
-[orgList] 所属一覧 - - - 検索結果数分、以下の情報を設定する。配列(1:本務 2~:兼務)
--orgpath 組織パス 半角英数字記号 331
--orgpathnm 組織パス名 全半角 627
-sendstatus 発信状況 半角数字 1 1:OK、2:一部OK、3:NG、4:連絡先未登録、5:発信中、6:発信中止、7:未発信。スレッドが完了している場合はnullを設定
-ansstatus 回答状況 半角数字 1 1:回答あり、2:既読、3:未読、4:対象外
-ansdate 回答状況日時 半角数字 12 ""YYYYMMDDHHMI""形式。回答状況=""未読""の場合、""""(空文字)
-[ansList] 質問文の回答一覧 - - - 配列
質問文の回答コード 半角数字 2 | "検索結果数文設定する。質問が存在する場合、回答コード。存在しない場合又は、回答が開始日時より過去の場合、""""(空文字)"
-cmntkbn コメント区分 半角数字 1 "1:文字、2:音声、3:回答ありかつコメントなし、4:回答なし。回答なしまたはコメントが存在しない場合、null"
-cmnt コメント 全半角 1024 "コメントが存在し、文字の場合、コメント文言。コメントが存在し、音声の場合、null。回答なしまたはコメントが存在しない場合、null"
-reglat 位置情報_緯度 半角英数字 25 "位置情報が存在する場合、緯度。存在しない場合又は、回答が開始日時より過去の場合、""-""。基本管理情報マスタ.位置情報使用フラグが「0:未使用」、またはスレッド情報マスタ.位置情報取得フラグが「0:取得しない」の場合、""""(空文字)"
-reglon 位置情報_経度 半角英数字 25 "位置情報が存在する場合、経度。存在しない場合又は、回答が開始日時より過去の場合、""-""。基本管理情報マスタ.位置情報使用フラグが「0:未使用」、またはスレッド情報マスタ.位置情報取得フラグが「0:取得しない」の場合、""""(空文字)"
-regdevice 回答手段 半角数字 1 0:-(存在しない場合又は、回答が開始日時より過去の場合)1:PC、2:携帯Web、3:音声
-regdate 回答時間 半角英数字 12 "回答時間が存在する場合、回答時間 ""YYYYMMDDHHMI""形式。存在しない場合又は、回答が開始日時より過去の場合、""-"""
-regusrcd 回答者氏名コード 半角英数字 32 "存在する場合、回答者の氏名コード。存在しない場合又は、回答が開始日時より過去の場合、""""(空文字)"
-regusrnm 回答者氏名 全半角 64 "存在する場合、回答者の氏名。存在しない場合又は、回答が開始日時より過去の場合、""-"""
-readdate 既読日時 半角数字 12 |
-sendregdate 発信要求日時 半角英数字 12 "発信要求日時が存在しない場合、""-""で設定。発信要求日時が存在する場合、""YYYYMMDDHHMI""形式で設定。スレッドが完了している場合はnullを設定"

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "searchTotal": 200000,
  "searchCount": 10,
  "nextOffset": 10,
  "useCount": 4365765,
  "contractCount": -1,
  "tid": "0000019",
  "title": "DR TEST",
  "text": "TEST",
  "strdate": "201901251917",
  "questList": [
    {
      "questnum": 1,
      "quest": "本人の安否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "負傷"
        }
      ]
    },
    {
      "questnum": 2,
      "quest": "家族の安否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "負傷"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    },
    {
      "questnum": 3,
      "quest": "家屋の状況",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "無事"
        },
        {
          "ans": "02",
          "ansmsg": "損傷"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    },
    {
      "questnum": 4,
      "quest": "出社可否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "出社可能"
        },
        {
          "ans": "02",
          "ansmsg": "出社不可"
        },
        {
          "ans": "03",
          "ansmsg": "不明"
        }
      ]
    }
  ],
  "thrddList": [
    {
      "usrcd": "usr000001",
      "staffsei": "安否",
      "staffmei": "花子",
      "orgList": [
        {
          "orgpath": "/1stAAAA00001/",
          "orgpathnm": "1st組織00001"
        }
      ],
      "sendstatus": "1",
      "ansstatus": "1",
      "ansdate": "201901251928",
      "ansList": [
        "01",
        "01",
        "01",
        "01"
      ],
      "cmntkbn": null,
      "cmnt": null,
      "reglat": "35.6310162",
      "reglon": "139.7373535",
      "regdevice": "1",
      "regdate": "201901251928",
      "regusrcd": "usr000001",
      "regusrnm": "安否 花子",
      "readdate": "201901251928",
      "sendregdate": "201901251917"
    },
    {
      "usrcd": "usr000002",
      "staffsei": "安否",
      "staffmei": "太郎",
      "orgList": [
        {
          "orgpath": "/1stAAAA00001/",
          "orgpathnm": "1st組織00001"
        }
      ],
      "sendstatus": "7",
      "ansstatus": "4",
      "ansdate": null,
      "ansList": null,
      "cmntkbn": null,
      "cmnt": null,
      "reglat": null,
      "reglon": null,
      "regdevice": null,
      "regdate": null,
      "regusrcd": null,
      "regusrnm": null,
      "readdate": null,
      "sendregdate": "201901161810"
    }
  ]
}

戻る

 安否確認API(発信)

PUT https://api.ntt.com/v1/anpi/request/safety/

安否確認へのユーザへ発信処理を実行できます。
本APIは非同期処理になるので、発信結果は安否確認API(状況確認)でご確認ください。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
tid スレッドID 半角数字 7
sendkbn 発信区分 半角数字 1 0:発信、1:発信停止
allsendkbn 全件発信区分 半角数字 1 0:全件対象以外、1:全件対象
orgkbn 組織区分 半角数字 1 "0:組織、1:グループ。指定がない場合は「0:組織」として検索を行う"
[orgpathList] 組織パス一覧 - - - 配列
組織パス 半角英数字記号 331 検索条件数分設定する。
[grpidList] グループID一覧 - - - 配列
グループID 半角数字 7 検索条件数分設定する。
indpflg 所属組織区分 半角数字 1 "0:所属組織なしを含めない、1:所属組織なしを含める。組織パス一覧が指定されていて、所属組織区分に指定がない場合は「0:所属組織なしを含めない」として検索を行う。組織パス一覧が指定されていない場合、所属組織なしを含める。検索組織に、""組織所属なし""を含める場合、「1:所属組織なしを含める」を設定する。"
[usrcdList] 氏名コード一覧 - - - 配列
氏名コード 半角英数字 32 検索条件数分設定する。
sei 氏名(姓/セイ) 全半角 32
mei 氏名(名/メイ) 全半角 32
langcd 言語コード 半角英数字 2 "ja:日本語 、en:英語。指定がない場合は:全言語の検索を行う"
[lcncdList] ロケーションコード一覧 - - - 配列
ロケーションコード 半角英数字 32 検索条件数分設定する。
[ctmcdList] ユーザー設定コード一覧 - - - 配列
ユーザー設定コード 半角英数字 32 検索条件数分設定する。
adkbn 住所条件 半角数字 1 "0:全て、1:いずれか指定がない場合は「0:全て」として検索を行う"
[wktdfkcdList] 勤務先都道府県コード一覧 - - - 配列
勤務先都道府県コード 半角数字 2 検索条件数分設定する。
wkskcs 勤務先市区町村名 全半角 40 指定の場合、勤務先都道府県は1個まで
[ad1tdfkcdList] 住所1都道府県コード一覧 - - - 配列
住所1都道府県コード 半角数字 2 検索条件数分設定する。
ad1skcs 住所1市区町村名 全半角 40 指定の場合、住所1都道府県は1個まで
[ad2tdfkcdList] 住所2都道府県コード一覧 - - - 配列
住所2都道府県コード 半角数字 2 検索条件数分設定する。
ad2skcs 住所2市区町村名 全半角 40 指定の場合、住所2都道府県は1個まで
searchkbn 住所検索区分 半角数字 1 "0:組織/グループと住所の全て、1:組織/グループと住所のいずれか。指定がない場合は「0:組織/グループと住所の全て」として検索を行う"
ansstatus 回答状況 半角数字 1 "1:回答済み、2:未回答、3:未回答-既読、4:未回答-未読、5:未回答-既読・未読、6:対象外。指定がない場合は全回答状況の検索を行う"
regdatekbn 時間指定区分 半角数字 1 1:日付以降回答あり、2:日付以降回答なし
regdate 時間指定(日付) 半角数字 12 """YYYYMMDDHHMI""形式。時間指定区分=「1:日付以降回答あり」又は、時間指定区分=「2:日付以降回答なし」の場合、必須"
sendstatus 発信状況 半角数字 1 "1:発信中、2:発信中止、3:発信済み。指定がない場合、またはスレッドが完了している場合は全発信状況の検索を行う"
sendresult 発信状況(結果) 半角数字 1 "発信状況(結果)(1:OK、2:一部OK、3:NG、4:連絡先未登録)。発信状況が「3:発信済み」の場合のみ有効。"
prodid 災害ID 半角英数字 33
prodkbn 災害区分 半角数字 1 "0:全てを対象とする、1:最新を対象とする。指定がない場合は「0:全てを対象とする」として検索を行う"
questkbn 質問一致条件 半角数字 1 "0:全て、1:いずれか。指定がない場合は「0:全て」として検索を行う"
[questList] 質問NO一覧 - - - 検索条件数分、以下の情報を設定する
-questnum 質問NO 半角数字 2 回答コード一覧が指定された場合、必須
-[ansList] 回答コード一覧 - - - 配列
回答コード 半角数字 2 検索条件数分設定する。質問NOが指定された場合、必須

Example Request

PUT https://api.ntt.com/v1/anpi/request/safety/
{
    "tid": "A000001",
    "sendkbn": "1",
    "allsendkbn": "1"
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
targetCount 対象件数 半角数字 6 発信・発信停止の対象者の件数
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "targetCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る

 安否確認API(完了)

PUT https://api.ntt.com/v1/anpi/register/safety/

安否確認の集計を受付完了します。
本APIは非同期処理になるので、処理結果は安否確認API(集計一覧)でご確認ください。

Request Parameters

Body json Parameter

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
tid スレッドID 半角数字 7

Example Request

PUT https://api.ntt.com/v1/anpi/maintenance/organization/
{
    "tid": "0000019"
}

Response Parameters

正常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
targetCount 対象件数 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8

異常時

[]で囲まれた項目はList、-は階層を表す。
◎:必須、○:リクエストに項目が存在すれば必須、△:条件付必須(備考参照)、空白:任意

項目 名称 桁数 必須 備考
errorCode エラーコード 半角英数字 9
errorMessage エラーメッセージ 全半角 1024
moreInfo 追加情報 半角英数字 2000 null固定
errorDetails エラー内容 全半角 1024 配列

Example Result

{
  "targetCount": 1,
  "useCount": 8,
  "contractCount": -1
}

戻る