Overview
本APIは、Arcstar Universal One モバイルのオプション用となります。
本APIは、ご契約回線開通後にご利用可能となります。
サービス詳細につきましては、Arcstar Universal One モバイルを参照してください。
契約番号(1)配下の回線情報取得と変更および、回線を制御するAPI群です。 [同期API(2)]
(*1) 契約番号とは、N+9桁の 数字となります。(例:N999999123)
(*2) 同期APIとはAPIの応答にその結果が含まれるAPIです。
Arcstar Universal One モバイルは、以下のAPIをご提供します。(2017/07/01時点)
情報参照系API
| No | API | Description |
|---|---|---|
| 001 | traffic | 回線毎の運用状況(データ利用量等)を取得します。 |
| 002 | group-traffic | グループ単位の運用状況(容量シェア等)を取得します。 |
Resource URL
グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。(*3)
*3) 2014/12現在、DNSラウンドロビンを運用中です。準備出来次第、お客さまの地理的に近いAPIゲートウェイに自動接続する予定です。別途アナウンスします。
1.Base Path(Global Load Balance)
https://api.ntt.com/v1/unom
2.Base Path(Region)
https://{region}.api.ntt.com/v1/unom
- region is jp|us|uk
- e.g. https://jp.api.ntt.com/v1/unom
- 指定できるregionは、将来拡充予定
Resource Information
| Key | Value |
|---|---|
| レスポンス フォーマット | JSON |
| 認証(oAuth2)APIゲートウェイ用 | Yes |
| 帯域制御(*4) | Yes |
(*4) お客さま接続単位で適切な流量制限を実施
001:回線運用情報取得(traffic)
Request Parameters[Query Parameters]
| Name | Description | Mandatory |
|---|---|---|
| contractId | 契約番号 | Yes |
| lineNo | 回線番号 | Yes |
1)traffic
ご契約番号、回線番号を指定して情報を取得します。
GET /v1/unom/contracts/{contractId}/lines/{lineNo}/traffic
Example Request
GET /v1/unom/contracts/N*********/lines/0**********/traffic
Response Parameters
| Name | Description | Mandatory | Remarks |
|---|---|---|---|
| contractId | 契約番号 | Yes | |
| lineNo | 回線番号 | Yes | |
| limitStatus1 | 規制状態1 | Yes | #1.参照 |
| monthlyLimitStartTime | 月次規制開始日時 | Yes | |
| dailyLimitStartTime | 日次規制開始日時 | Yes | |
| limitCause | 規制理由 | Yes | |
| limitStatus2 | 規制状態2 | Yes | #1.参照 |
| trafficThisMonth | 利用通信量 当月(月単位/Byte) | Yes | |
| traffic1monthAgo | 利用通信量 前月(月単位/Byte) | Yes | |
| traffic2monthAgo | 利用通信量 前前月(月単位/Byte) | Yes | |
| trafficToday | 利用通信量 当日(日単位/Byte) | Yes | |
| traffic1dayAgo | 利用通信量 1日前(日単位/Byte) | Yes | |
| traffic2daysAgo | 利用通信量 2日前(日単位/Byte) | Yes | |
| traffic3daysAgo | 利用通信量 3日前(日単位/Byte) | Yes | |
| traffic4daysAgo | 利用通信量 4日前(日単位/Byte) | Yes | |
| traffic5daysAgo | 利用通信量 5日前(日単位/Byte) | Yes | |
| traffic6daysAgo | 利用通信量 6日前(日単位/Byte) | Yes | |
| traffic7daysAgo | 利用通信量 7日前(日単位/Byte) | Yes | |
| traffic8daysAgo | 利用通信量 8日前(日単位/Byte) | Yes | |
| traffic9daysAgo | 利用通信量 9日前(日単位/Byte) | Yes | |
| traffic10daysAgo | 利用通信量10日前(日単位/Byte) | Yes | |
| traffic11daysAgo | 利用通信量11日前(日単位/Byte) | Yes | |
| traffic12daysAgo | 利用通信量12日前(日単位/Byte) | Yes | |
| traffic13daysAgo | 利用通信量13日前(日単位/Byte) | Yes | |
| traffic14daysAgo | 利用通信量14日前(日単位/Byte) | Yes | |
| traffic15daysAgo | 利用通信量15日前(日単位/Byte) | Yes | |
| traffic16daysAgo | 利用通信量16日前(日単位/Byte) | Yes | |
| traffic17daysAgo | 利用通信量17日前(日単位/Byte) | Yes | |
| traffic18daysAgo | 利用通信量18日前(日単位/Byte) | Yes | |
| traffic19daysAgo | 利用通信量19日前(日単位/Byte) | Yes | |
| traffic20daysAgo | 利用通信量20日前(日単位/Byte) | Yes | |
| traffic21daysAgo | 利用通信量21日前(日単位/Byte) | Yes | |
| traffic22daysAgo | 利用通信量22日前(日単位/Byte) | Yes | |
| traffic23daysAgo | 利用通信量23日前(日単位/Byte) | Yes | |
| traffic24daysAgo | 利用通信量24日前(日単位/Byte) | Yes | |
| traffic25daysAgo | 利用通信量25日前(日単位/Byte) | Yes | |
| traffic26daysAgo | 利用通信量26日前(日単位/Byte) | Yes | |
| traffic27daysAgo | 利用通信量27日前(日単位/Byte) | Yes | |
| traffic28daysAgo | 利用通信量28日前(日単位/Byte) | Yes | |
| traffic29daysAgo | 利用通信量29日前(日単位/Byte) | Yes | |
| traffic30daysAgo | 利用通信量30日前(日単位/Byte) | Yes | |
| dataVolumeRemains | 残容量(今月) | Yes |
1.容量シェアグループ設定がされていない回線ごとの規制状態は、下記の表にあるそれぞれの応答値をもとに判定してください。
| 容量シェアのグループ設定 | 回線グループ | 問い合わせ単位 | 規制状態 | 規制状態1(limitStatus1) | 規制状態2(limitStatus2) |
|---|---|---|---|---|---|
| グル―プ設定なし | 「-」ハイフン | 回線単位 | 00：規制なし | 0またはNULL | 0 |
| 01：月間規制中 | 0またはNULL | 1 | |||
| 2 | - | ||||
| 02：直近規制中 | 1 | 0 | |||
| 03：直近/月間両方で規制中 | 1 | 1 | |||
| 3 | - |
Example Result
{
"contractId": "N********",
"lineNo": "0**********",
"limitStatus1": "0",
"monthlyLimitStartTime": "",
"dailyLimitStartTime": "",
"limitCause": "",
"limitStatus2": "0",
"trafficThisMonth": "611327130",
"traffic1monthAgo": "447574716",
"traffic2monthAgo": "394867798",
"trafficToday": "21012758",
"traffic1dayAgo": "77233",
"traffic2daysAgo": "1274590",
"traffic3daysAgo": "8830612",
"traffic4daysAgo": "93786215",
"traffic5daysAgo": "31778021",
"traffic6daysAgo": "205158511",
"traffic7daysAgo": "119091473",
"traffic8daysAgo": "81011",
"traffic9daysAgo": "89517",
"traffic10daysAgo": "10318704",
"traffic11daysAgo": "67939699",
"traffic12daysAgo": "5089542",
"traffic13daysAgo": "46102141",
"traffic14daysAgo": "83811",
"traffic15daysAgo": "78267",
"traffic16daysAgo": "92428",
"traffic17daysAgo": "84739",
"traffic18daysAgo": "104513",
"traffic19daysAgo": "78422",
"traffic20daysAgo": "87029",
"traffic21daysAgo": "87894",
"traffic22daysAgo": "91079",
"traffic23daysAgo": "98533",
"traffic24daysAgo": "9454806",
"traffic25daysAgo": "558619",
"traffic26daysAgo": "19802261",
"traffic27daysAgo": "13818036",
"traffic28daysAgo": "25134199",
"traffic29daysAgo": "82504",
"traffic30daysAgo": "94714",
"dataVolumeRemains": "7521435648"
}
002:容量シェア運用情報取得(group-traffic)
Request Parameters[Query Parameters]
| Name | Description | Mandatory |
|---|---|---|
| contractId | 契約番号 | Yes |
| lineNo | 回線番号 | Yes |
1)group-traffic
ご契約番号、回線番号を指定して情報を取得します。
GET /v1/unom/contracts/{contractId}/lines/{lineNo}/group-traffic
Example Request
GET /v1/unom/contracts/N*********/lines/0**********/group-traffic
Response Parameters
| Name | Description | Mandatory | Remarks |
|---|---|---|---|
| contractId | 契約番号 | Yes | |
| lineNo | 回線番号 | Yes | |
| limitStatus1 | 通信規制状態 | Yes | #1.参照 |
| monthlyLimitStartTime | 月次規制開始日時 | Yes | |
| dailyLimitStartTime | 日次規制開始日時 | Yes | |
| limitCause | 適用サービス状態(規制理由) | Yes | |
| limitStatus2 | 総量規制状態 | Yes | #1.参照 |
| trafficThisMonth | 利用通信量 当月(月単位/Byte) | Yes | |
| traffic1monthAgo | 利用通信量 前月(月単位/Byte) | Yes | |
| traffic2monthAgo | 利用通信量 前前月(月単位/Byte) | Yes | |
| trafficToday | 利用通信量 当日(日単位/Byte) | Yes | |
| traffic1dayAgo | 利用通信量 1日前(日単位/Byte) | Yes | |
| traffic2daysAgo | 利用通信量 2日前(日単位/Byte) | Yes | |
| traffic3daysAgo | 利用通信量 3日前(日単位/Byte) | Yes | |
| traffic4daysAgo | 利用通信量 4日前(日単位/Byte) | Yes | |
| traffic5daysAgo | 利用通信量 5日前(日単位/Byte) | Yes | |
| traffic6daysAgo | 利用通信量 6日前(日単位/Byte) | Yes | |
| traffic7daysAgo | 利用通信量 7日前(日単位/Byte) | Yes | |
| traffic8daysAgo | 利用通信量 8日前(日単位/Byte) | Yes | |
| traffic9daysAgo | 利用通信量 9日前(日単位/Byte) | Yes | |
| traffic10daysAgo | 利用通信量10日前(日単位/Byte) | Yes | |
| traffic11daysAgo | 利用通信量11日前(日単位/Byte) | Yes | |
| traffic12daysAgo | 利用通信量12日前(日単位/Byte) | Yes | |
| traffic13daysAgo | 利用通信量13日前(日単位/Byte) | Yes | |
| traffic14daysAgo | 利用通信量14日前(日単位/Byte) | Yes | |
| traffic15daysAgo | 利用通信量15日前(日単位/Byte) | Yes | |
| traffic16daysAgo | 利用通信量16日前(日単位/Byte) | Yes | |
| traffic17daysAgo | 利用通信量17日前(日単位/Byte) | Yes | |
| traffic18daysAgo | 利用通信量18日前(日単位/Byte) | Yes | |
| traffic19daysAgo | 利用通信量19日前(日単位/Byte) | Yes | |
| traffic20daysAgo | 利用通信量20日前(日単位/Byte) | Yes | |
| traffic21daysAgo | 利用通信量21日前(日単位/Byte) | Yes | |
| traffic22daysAgo | 利用通信量22日前(日単位/Byte) | Yes | |
| traffic23daysAgo | 利用通信量23日前(日単位/Byte) | Yes | |
| traffic24daysAgo | 利用通信量24日前(日単位/Byte) | Yes | |
| traffic25daysAgo | 利用通信量25日前(日単位/Byte) | Yes | |
| traffic26daysAgo | 利用通信量26日前(日単位/Byte) | Yes | |
| traffic27daysAgo | 利用通信量27日前(日単位/Byte) | Yes | |
| traffic28daysAgo | 利用通信量28日前(日単位/Byte) | Yes | |
| traffic29daysAgo | 利用通信量29日前(日単位/Byte) | Yes | |
| traffic30daysAgo | 利用通信量30日前(日単位/Byte) | Yes | |
| dataVolumeRemains | 残容量(今月) | Yes |
1.容量シェアグループ単位における規制状態は、下記の表にあるそれぞれの応答値をもとに判定してください。
| 容量シェアのグループ設定 | 回線グループ | 問い合わせ単位 | 規制状態 | 規制状態1(limitStatus1) | 規制状態2(limitStatus2) |
|---|---|---|---|---|---|
| グル―プ設定あり | 「-」ハイフン、NULL以外の値 | 容量シェアグループ単位 | 00：規制なし | 0またはNULL | 0 |
| 01：月間規制中 | 0またはNULL | 1 | |||
| 2 | - | ||||
| 02：直近規制中 | 1 | 0 | |||
| 03：直近/月間両方で規制中 | 1 | 1 | |||
| 3 | - |
Example Result
{
"contractId": "N*********",
"lineNo": "0**********",
"limitStatus1z: "",
"monthlyLimitStartTime": "",
"dailyLimitStartTime": "",
"limitCause": "",
"limitStatus2": "0",
"trafficThisMonth": "637545361",
"traffic1monthAgo": "447574716",
"traffic2monthAgo": "394867798",
"trafficToday": "47230989",
"traffic1dayAgo": "77233",
"traffic2daysAgo": "1274590",
"traffic3daysAgo": "8830612",
"traffic4daysAgo": "93786215",
"traffic5daysAgo": "31778021",
"traffic6daysAgo": "205158511",
"traffic7daysAgo": "119091473",
"traffic8daysAgo": "81011",
"traffic9daysAgo": "89517",
"traffic10daysAgo": "10318704",
"traffic11daysAgo": "67939699",
"traffic12daysAgo": "5089542",
"traffic13daysAgo": "46102141",
"traffic14daysAgo": "83811",
"traffic15daysAgo": "78267",
"traffic16daysAgo": "92428",
"traffic17daysAgo": "84739",
"traffic18daysAgo": "104513",
"traffic19daysAgo": "78422",
"traffic20daysAgo": "87029",
"traffic21daysAgo": "87894",
"traffic22daysAgo": "91079",
"traffic23daysAgo": "98533",
"traffic24daysAgo": "9454806",
"traffic25daysAgo": "558619",
"traffic26daysAgo": "19802261",
"traffic27daysAgo": "13818036",
"traffic28daysAgo": "25134199",
"traffic29daysAgo": "82504",
"traffic30daysAgo": "94714",
"dataVolumeRemains": "7521435648"
}