一斉通報API

Overview

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

　一斉通報API（登録）

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

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

Request Parameters

Body json Parameter

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

Example Request

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

Response Parameters

正常時

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

異常時

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

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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

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、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意

Example Request

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

Response Parameters

正常時

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

異常時

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

Example Result

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

戻る