Overview

These APIs are used in "OCN Mobile ONE for Business (hereinafter abbreviated as ForBiz)".
The APIs allow the customer to change the bandwidth and the route of their line.

For ForBiz service content, please refer to ForBiz

It is an API group that acquires and changes line information under contract number(*1) and controls lines. [Sync API (*2)]

(*1) The contract number is N + 9 digit number. (E.g. N999999123)

(*2) Sync API is an API that contains the result in API response.

ForBiz provides the following APIs. (As of July 1, 2017)

Information reference API

Resource URL

Please use of global common domain, or the individual region domain.
If you want to use the global common domain, depending on the circumstances of your available points , and then connect to the nearest API gateway. [*3]

(*3) Dec. 2014 currently, DNS round robin operation is working. In the future, API request will automatically connect to geographically close API gateway.

1.Base Path(Global Load Balance)

https://api.ntt.com/v1/bocnm

2.Base Path(Region)

https://{region}.api.ntt.com/v1/bocnm

• region is jp|us|uk
• e.g. https://jp.api.ntt.com/v1/bocnm
• Specifiable regions will be expanded in the future

Resource Information

(*4) Appropriate flow restriction is implemented for each customer connection unit

001:Acquire Line traffic infomation (traffic)

Request Parameters[Query Parameters]

1)traffic

Specify your contract number and line number to obtain the information.

GET  /v1/bocnm/contracts/{contractId}/lines/{lineNo}/traffic

Example Request

GET  /v1/bocnm/contracts/N*********/lines/0**********/traffic

Response Parameters

1.Please judge the regulation state for each line for which capacity sharing group is not set based on each response value shown in the following table.

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": "1234567"
}

002:Capacity share Group traffic acquisition (group-traffic)

Request Parameters[Query Parameters]

1)group-traffic

Specify your contract number and line number to obtain the information.

GET /v1/bocnm/contracts/{contractId}/lines/{lineNo}/group-traffic

Example Request

GET  /v1/bocnm/contracts/N*********/lines/0**********/group-traffic

Response Parameters

1. Please judge the regulation state in capacity sharing group unit based on each response value shown in the following table.

Example Result

{
  "contractId": "N*********",
  "lineNo": "0**********",
  "limitStatus1": "",
  "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": "1234567"
}