一斉通報API

Overview

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

 一斉通報API(登録)

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

一斉通報の集計情報を登録します。

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
ttype スレッド識別 半角英数字 1 "T:一斉通報、P:パンデミック指定がない場合は「T:一斉通報」として登録を行う"
title 表題 全半角 200
text 本文 全半角 5000
[questList] 質問一覧 - - - 登録数分、以下の情報を設定する(最大20件)
-quest 質問文 全半角 200 対応する回答文が入力されている場合、必須
-[ansList] 回答文一覧 - - - 配列
回答文 全半角 200 "登録数分設定する。(最大10件)質問が入力されている場合、回答文は必須"
senddeviceflg 送信先端末フラグ 半角数字 1 "0:連絡先(MAIL)+連絡先(TEL)、1:連絡先(MAIL) のみ指定がない場合は「0:連絡先(MAIL)+連絡先(TEL)」として登録を行う。基本管理情報マスタ.利用可能デバイスが、「メール+電話」の場合のみ有効"
noticesetflg 通知設定フラグ 半角数字 1 "0:同時発信しない 1:集計開始と同時に発信指定がない場合は「1:集計開始と同時に発信」として登録を行う"
geolocationgetflg 位置情報取得フラグ 半角数字 1 "0:取得しない 1:取得する指定がない場合は「1:取得する」として登録を行う。基本管理情報マスタ.位置情報使用フラグが'1'(使用)の場合のみ有効。"
endpldate 終了日時 半角数字 12 "YYYYMMDDHHMI"形式
sumflg 集計対象判別フラグ 半角数字 1 "0:全社員を対象としない 1:全社員を対象とする指定がない場合は「0:全社員を対象としない」として登録を行う"
[orgpathList] 組織パス一覧 - - - "配列。集計対象判別フラグが""0""の場合有効。※組織パス一覧、グループID一覧を両方指定した場合はOR条件"
組織パス 半角英数字記号 331 "検索条件数分設定する。集計対象判別フラグが""0""、または未設定の場合、組織パス又は、グループIDのいずれか必須"
[grpidList] グループID一覧 - - - "配列。集計対象判別フラグが""0""の場合有効。※組織パス一覧、グループID一覧を両方指定した場合はOR条件"
グループID 半角数字 7 "検索条件数分設定する。集計対象判別フラグが""0""、または未設定の場合、組織パス又は、グループIDのいずれか必須"
[langcdList] 言語コード一覧 - - - 配列
言語コード 半角英数字 2 "検索条件数分設定する。ja:日本語 、en:英語。指定がない場合は「ja:日本語 または、en:英語」として登録を行う"
lcncd ロケーションコード 半角英数字 32
ctmcd ユーザー設定コード 半角英数字 32
wktdfkcd 勤務先都道府県コード 半角数字 2
wkskcs 勤務先市区町村名 全半角 40
ad1tdfkcd 住所1都道府県コード 半角数字 2
ad1skcs 住所1市区町村名 全半角 40
ad2tdfkcd 住所2都道府県コード 半角数字 2
ad2skcs 住所2市区町村名 全半角 40

Example Request

POST https://api.ntt.com/v1/anpi/register/broadcast/
{
   "title": "APITEST",
   "text": "0123456789",
  "sumflg": "1"
 }

Response Parameters

正常時

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

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

異常時

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

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

Example Result

{
  "resultCount": 1,
  "ttype": T,
  "tid": 0001010,
  "useCount": 8,
  "contractCount": -1
}

戻る

 一斉通報API(集計一覧)

POST https://api.ntt.com/v1/anpi/confirm/broadcast/

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

Request Parameters

URL Path Parameter

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

項目 名称 桁数 必須 備考
ttype スレッド識別 半角英数字 1 T:一斉通報、P:パンデミック、未設定:両方
title 表題 全半角 200
strregdate 登録日_開始 半角数字 8 "YYYYMMDD"形式
endregdate 登録日_終了 半角数字 8 "YYYYMMDD"形式
regusrkbn 登録者検索選択 半角数字 1 1:氏名、2:組織、3:グループ
[regusrcdList] 登録者_氏名コード一覧 - - - 配列
登録者_氏名コード 半角英数字 32 "登録者検索選択=氏名の場合、検索条件数分設定する。"
regusrsei 登録者_氏名(姓/セイ) 全半角 32 登録者検索選択=氏名の場合
regusrmei 登録者_氏名(名/メイ) 全半角 32 登録者検索選択=氏名の場合
[regusrorgpathList] 登録者_組織パス一覧 - - - 配列
登録者_組織パス 半角英数字記号 331 "登録者検索選択=組織の場合、検索条件数分設定する。"
regusrindpflg 登録者_所属組織区分 半角数字 1 "0:所属組織なしを含めない、1:所属組織なしを含める。組織パス一覧が指定されていて、所属組織区分に指定がない場合は「0:所属組織なしを含めない」として検索を行う。組織パス一覧が指定されていない場合、所属組織なしを含める。検索組織に、""組織所属なし""を含める場合、「1:所属組織なしを含める」を設定する。"
[regusrgrpidList] 登録者_グループID一覧 - - - 配列
登録者_グループID 半角数字 7 "登録者検索選択=グループの場合、検索条件数分設定する。"
tgtusrkbn 対象者検索選択 半角数字 1 1:氏名、2:組織、3:グループ
[tgtusrcdList] 対象者_氏名コード一覧 - - - 配列
対象者_氏名コード 半角英数字 32 "対象者検索選択=氏名の場合、検索条件数分設定する。"
tgtusrsei 対象者_氏名(姓/セイ) 全半角 32 対象者検索選択=氏名の場合
tgtusrmei 対象者_氏名(名/メイ) 全半角 32 対象者検索選択=氏名の場合
[tgtusrorgpathList] 対象者_組織パス一覧 - - - 配列
-tgtusrorgpath 対象者_組織パス 半角英数字記号 331 "対象者検索選択=組織の場合、検索条件数分設定する。"
tgtusrindpflg 対象者_所属組織区分 半角数字 1 "0:所属組織なしを含めない、1:所属組織なしを含める。組織パス一覧が指定されていて、所属組織区分に指定がない場合は「0:所属組織なしを含めない」として検索を行う。組織パス一覧が指定されていない場合、所属組織なしを含める。検索組織に、""組織所属なし""を含める場合、「1:所属組織なしを含める」を設定する。"
[tgtusrgrpidList] 対象者_グループID一覧 - - - 配列
-tgtusrgrpid 対象者_グループID 半角数字 7 "対象者検索選択=グループの場合、検索条件数分設定する。"
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

POST https://api.ntt.com/v1/anpi/confirm/broadcast/
{
   "strregdate": "20170401",
   "endregdate": "20180331"
 }

Response Parameters

正常時

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

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
[thrdiList] スレッド情報一覧 - - - 検索結果数分、以下の情報を設定する
-ttype スレッド識別 半角英数字 1 T:一斉通報、P:パンデミック
-tid スレッドID 半角数字 7
-title 表題 全半角 200
-text 本文 全半角 5000
-regusrcd 登録者_氏名コード 半角英数字 32
-regusrsei 登録者_姓 全半角 32
-regusrmei 登録者_名 全半角 32
-[orgList] 登録者_所属一覧 - - - "検索結果数分、以下の情報を設定する。配列(1:本務 2~:兼務)"
--orgpath 登録者_組織パス 半角英数字記号 331
--orgpathnm 登録者_組織パス名 全半角 627
-upfilflg 添付ファイル 半角数字 1 0:なし、1:あり
-upfilsize 添付ファイルサイズ 半角数字 10 "単位:Byte単位未回答の場合、""""(空文字)"
-regdate 集計開始日時 半角数字 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": [    
    {   
     "ttype": "T",   
     "tid": "1000000",  
      "title": "GWの過ごし方に関して",   
      "text": "今年度のGWは長期にわたりますが、皆さん節度を持って過ごしましょう。",
      "regusrcd": "0001",
      "regusrsei": "安否",
      "regusrmei": "太郎",
      "orgList": [
        {
         "orgpath": "/A001/",
         "orgpathnm": "A組織",
        }
      ],                
      "upfilflg": "0",  
      "upfilsize": "",      
      "regdate": "201904031409",    
      "endflg": "0",    
    },  
    {   
     "ttype": "T",   
     "tid": "1000001",  
      "title": "上期キックオフのお知らせ",  
      "text": "今年度上期のキックオフの案内が総括経由で連絡が入っていますので、皆さん回答をお願いします。",
      "regusrcd": "0001",
      "regusrsei": "安否",
      "regusrmei": "太郎",
      "orgList": [
        {
         "orgpath": "/A001/",
         "orgpathnm": "A組織",
        }
      ],                
      "upfilflg": "0",  
      "upfilsize": "",      
      "regdate": "201904031411",    
      "endflg": "0",    
    }
 ]  
}

戻る

 一斉通報API(状況確認)

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

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

Request Parameters

Body json Parameter

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

項目 名称 桁数 必須 備考
ttype スレッド識別 半角英数字 1 "T:一斉通報、P:パンデミック。指定がない場合は「T:一斉通報」として検索を行う"
tid スレッドID 半角数字 7 無指定の場合は最新のスレッド
[orgpathList] 組織パス一覧 - - - 配列
組織パス 半角英数字記号 331 検索条件数分設定する。
indpflg 所属組織区分 半角数字 1 "0:所属組織なしを含めない、1:所属組織なしを含める。組織パス一覧が指定されていて、所属組織区分に指定がない場合は「0:所属組織なしを含めない」として検索を行う。組織パス一覧が指定されていない場合、所属組織なしを含める。検索組織に、""組織所属なし""を含める場合、「1:所属組織なしを含める」を設定する。"
[grpidList] グループID一覧 - - - 配列
グループID 半角数字 7 検索条件数分設定する。
[usrcdList] 氏名コード一覧 - - - 配列
氏名コード 半角英数字 32 検索条件数分設定する。
sei 氏名(姓/セイ) 全半角 32
mei 氏名(名/メイ) 全半角 32
langcd 言語コード 半角英数字 2 "ja:日本語 、en:英語。指定がない場合は:全言語の検索を行う"
[lcncdList] ロケーションコード一覧 - - - 配列
ロケーションコード 半角英数字 32 検索条件数分設定する。
[ctmcdList] ユーザー設定コード一覧 - - - 配列
ユーザー設定コード 半角英数字 32 検索条件数分設定する。
adkbn 住所条件 半角数字 1 "0:全て、1:いずれか。指定がない場合は「0:全て」として検索を行う"
[wktdfkcdList] 勤務先都道府県コード一覧 - - - 配列
勤務先都道府県コード 半角数字 2 検索条件数分設定する。
wkskcs 勤務先市区町村名 全半角 40 勤務先都道府県コードが複数指定の場合、条件から除外する
[ad1tdfkcdList] 住所1都道府県コード一覧 - - - 配列
住所1都道府県コード 半角数字 2 検索条件数分設定する。
ad1skcs 住所1市区町村名 全半角 40 住所1都道府県コードが複数指定の場合、条件から除外する
[ad2tdfkcdList] 住所2都道府県コード一覧 - - - 配列
住所2都道府県コード 半角数字 2 検索条件数分設定する。
ad2skcs 住所2市区町村名 全半角 40 住所2都道府県コードが複数指定の場合、条件から除外する
searchkbn 住所検索区分 半角数字 1 "0:組織・グループと住所の全て、1:組織・グループと住所のいずれか。指定がない場合は「0:組織・グループと住所の全て」として検索を行う"
ansstatus 回答状況 半角数字 1 "1:回答済み、2:未回答、3:未回答-既読、4:未回答-未読、5:未回答-既読・未読。指定がない場合は全回答状況の検索を行う"
sendstatus 発信状況 半角数字 1 "1:発信中、2:発信中止、3:発信済み。指定がない場合、またはスレッドが完了している場合は全発信状況の検索を行う"
sendresult 発信状況(結果) 半角数字 1 "発信状況(結果)(1:OK、2:一部OK、3:NG、4:連絡先未登録)。発信状況が「3:発信済み」の場合のみ有効。指定がない場合、またはスレッドが完了している場合は全発信状況(結果)の検索を行う"
questkbn "質問一致条件" 半角数字 1 "0:全て、1:いずれか。指定がない場合は「0:全て」として検索を行う"
[ansList1] 回答コード一覧1 - - - 配列。質問1に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList2] 回答コード一覧2 - - - 配列。質問2に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList3] 回答コード一覧3 - - - 配列。質問3に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList4] 回答コード一覧4 - - - 配列。質問4に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList5] 回答コード一覧5 - - - 配列。質問5に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList6] 回答コード一覧6 - - - 配列。質問6に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList7] 回答コード一覧7 - - - 配列。質問7に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList8] 回答コード一覧8 - - - 配列。質問8に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList9] 回答コード一覧9 - - - 配列。質問9に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList10] 回答コード一覧10 - - - 配列。質問10に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList11] 回答コード一覧11 - - - 配列。質問11に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList12] 回答コード一覧12 - - - 配列。質問12に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList13] 回答コード一覧13 - - - 配列。質問13に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList14] 回答コード一覧14 - - - 配列。質問14に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList15] 回答コード一覧15 - - - 配列。質問15に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList16] 回答コード一覧16 - - - 配列。質問16に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList17] 回答コード一覧17 - - - 配列。質問17に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList18] 回答コード一覧18 - - - 配列。質問18に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList19] 回答コード一覧19 - - - 配列。質問19に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
[ansList20] 回答コード一覧20 - - - 配列。質問20に対する回答コード一覧"
回答コード 半角数字 2 検索条件数分設定する。
offset 検索開始位置 半角数字 7 省略された場合は、先頭(0)とする
limit 要求件数 半角数字 4 省略された場合は、設定値から上限を取得する

Example Request

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

Response Parameters

正常時

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

項目 名称 桁数 必須 備考
searchTotal 検索総件数 半角数字 6
searchCount 検索件数 半角数字 4
nextOffset 次回検索開始位置 半角数字 6
useCount 利用回数 半角数字 8
contractCount 契約回数 半角数字 8
tid スレッドID 半角数字 7 処理対象となったスレッドIDを設定する
title 表題 全半角 200
text 本文 全半角 5000
regusrcd 登録者氏名コード 半角数字 32
regusrsei 登録者_姓 全半角 32
regusrmei 登録者_名 全半角 32
[orgList] 登録者_所属一覧 - - - "検索結果数分、以下の情報を設定する。配列(1:本務 2~:兼務)"
-orgpath 登録者_組織パス 半角英数字記号 331
-orgpathnm 登録者_組織パス名 全半角 627
senddevicekbn 発信連絡先 半角数字 1 1:連絡先(MAIL)+連絡先(TEL)、2:連絡先(MAIL)のみ、3:連絡先(MAIL)+連絡先(TEL)/アプリ、4:連絡先(MAIL)/アプリのみ
targettype 対象者種別 半角数字 1 0:全社員、1:組織、2:グループ、3:組織+グループ
[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:未読
-ansdate 回答状況日時 半角数字 12 "回答状況が「0:未発信」の場合、""-""で設定。回答状況が「1:回答あり」の場合、スレッド設備回答テーブル.登録日時を""YYYYMMDDHHMI""形式で設定。回答状況が「2:既読」の場合、スレッド設備詳細テーブル.既読日時を""YYYYMMDDHHMI""形式で設定。回答状況が「3:未読」の場合、""""(空文字)で設定"
-[ansList] 質問文の回答一覧 - - - 配列
質問文の回答コード 半角数字 2 "検索結果数分設定する。質問が存在する場合、回答コード。存在しない場合、""""(空文字)"
-cmntkbn コメント区分 半角数字 1 "コメント区分(1:文字、2:音声。回答なしまたはコメントが存在しない場合、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": "上期キックオフのお知らせ",
  "text": "今年度上期のキックオフの参加可否を、皆さん回答をお願いします。",
  "regusrcd": "0001",
  "regusrsei": "安否",
  "regusrmei": "太郎",
  "orgList": [
    {
     "orgpath": "/A001/",
     "orgpathnm": "A組織",
    }
  ],                
  "senddevicekbn": "1",
  "targettype": "0",
  "questList": [
    {
      "questnum": 1,
      "quest": "一次会の参加可否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "参加"
        },
        {
          "ans": "02",
          "ansmsg": "不参加"
        }
      ]
    },
    {
      "questnum": 2,
      "quest": "二次会の参加可否",
      "ansList": [
        {
          "ans": "01",
          "ansmsg": "参加"
        },
        {
          "ans": "02",
          "ansmsg": "不参加"
        }
      ]
    }
  ],
  "thrddList": [
    {
      "usrcd": "usr000001",
      "staffsei": "安否",
      "staffmei": "花子",
      "orgList": [
        {
          "orgpath": "/1stAAAA00001/",
          "orgpathnm": "1st組織00001"
        }
      ],
      "sendstatus": "1",
      "ansstatus": "1",
      "ansdate": "201901251928",
      "ansList": [
        "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/broadcast/

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

Request Parameters

Body json Parameter

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

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

Example Request

PUT https://api.ntt.com/v1/anpi/request/broadcast/
{
    "tid": "1000001",
    "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
}

戻る