本ドキュメントでは権限管理者を親IDと表記します。
親IDはビジネスポータルからお申込頂いたID、或いは当社担当者より払い出されたそれに相当するIDを指します。
本APIは親IDのアクセス可能なソースIPアドレスの設定を管理するAPIです。 親IDはビジネスポータルから申し込みの際、或いは当社担当者より払い出される際に必ずそのIDのソースIPアドレス初期登録を行ってます。 #1
#1 2025年8月以降新規に発行するIDの場合。2025年8月以前に発行のIDは初期値として一律0.0.0.0/0が設定されています。
下記のように登録のないIPアドレスからの親IDのアクセスはエラーとなります。
モバイルアクセス卸 APIは、ご契約されているSIMカードの制御、情報取得を可能とするAPIを提供します。
APIの詳細仕様につきましては、右側に表示されているモバイルアクセス卸 APIを参照ください。（要デベロッパーポータルログイン）
なお、下記[その他API]の内容やご契約に関する各種手続等については、弊社営業またはデベロッパーポータルのサポートからお問い合わせください。
[その他API]
回線グループ系
本APIでは、Arcstar Universal One フレキシブルイーサの帯域変更および経路変更のお申込が可能です。
本APIは、ご契約回線開通後にご利用可能となります。
「Arcstar Universal One フレキシブルイーサ」サービスについては、サービス紹介サイト(ギャランティアクセス、イーサネット専用線)をご参照ください。
Arcstar Universal Oneフレキシブルイーサは、以下のAPIを提供します。
本APIはArcstrar Universal Oneで発生中の回線アラームを取得するAPIです。
最大過去90日前から発生中のアラームを取得することができます。
グローバル共通ドメインの利用、または個別リージョンドメインをご利用ください。
グローバル共通ドメインを利用する場合、お客様のご利用箇所の状況に応じて、
一番近いAPIゲートウェイに接続します。
1.Base Path(Global Load Balance)
https://api.ntt.com/v1/circuitalarms
2.Base Path(Region)
本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は、OCN Mobile ONE for Business(以下、ForBiz(フォービズ)と略す)用となります。
本APIは、ご契約回線開通後にご利用可能となります。
ForBizのサービス内容につきましては、ForBizをご参照してください。
契約番号(1)配下の回線情報取得と変更および、回線を制御するAPI群です。 [同期API(2)]
(*1) 契約番号とは、N+9桁の 数字となります。(例:N999999123)
(*2) 同期APIとはAPIの応答にその結果が含まれるAPIです。
ForBizは、以下のAPIをご提供します。(2017/07/01時点)
本APIは一斉通報の集計の閲覧/開始、ユーザの回答状況確認及び発信をすることができます。
-一斉通報API（登録）
-一斉通報API（集計一覧）
-一斉通報API（状況確認）
-一斉通報API（発信）
POST https://api.ntt.com/v1/anpi/register/broadcast/
一斉通報の集計情報を登録します。
[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意
本APIは安否確認の集計の閲覧/開始/完了、ユーザの回答状況確認及び発信をすることができます。
-安否確認API（登録）
-安否確認API（集計一覧）
-安否確認API（状況確認）
-安否確認API（発信）
-安否確認API（完了）
POST https://api.ntt.com/v1/anpi/register/safety/
安否確認を集計できる災害情報を登録します。
[]で囲まれた項目はList、-は階層を表す。
◎：必須、○：リクエストに項目が存在すれば必須、△：条件付必須（備考参照）、空白：任意
本APIはユーザ設定コード、ユーザ設定コード名などのユーザ設定コードに紐づく情報を閲覧/登録/変更/削除することができます。
-ユーザ設定コード情報API（情報照会）
-ユーザ設定コード情報API（登録）
-ユーザ設定コード情報API（更新）
-ユーザ設定コード情報API（削除）
GET https://api.ntt.com/v1/anpi/maintenance/user-setting-code/
団体内に登録されているユーザ設定コード情報を取得します。
一度に取得できる情報は最大1,000件までとなります。