階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 必須/任意 補足説明・備考等
1 contracts 契約番号 必須
1-1 {contractId} ・N番 必須
2 lineNo 回線番号 必須
2-1 {lineNo} ・回線番号 必須
3 session 回線状態 必須
4 agreement 同意する 必須
4-1 {agreement} ・同意する 必須
DELETE /v2/*****/contracts/N123456789/lines/09012345678/session?
agreement=yes
階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 必須/任意 補足説明・備考等
― 無し ― ―
Copyright © NTT Communications Corporation. All right reserved.
2-1.機能概要
2-1-4.回線制御
2-1-4-2.回線切断要求 [session](2/4)
・接続中の契約回線に対して、Radiusから交換機へ切断要求するAPIです。(※切断を保証するものではありません。)
* JSON形式によるリクエスト例
*レスポンス
階層 フィールド名・属性名(英語) フィールド名・属性名(日本語) 必須/任意 補足説明・備考等
1 contractId 契約番号 必須
2 lineNo 回線番号 必須
3 resultCode 受付結果 必須
(1)APIのサンプル構文(API個別部)
無し
Copyright © NTT Communications Corporation. All right reserved.
2-1.機能概要
2-1-4.回線制御
2-1-4-2.回線切断要求 [session](3/4)
・接続中の契約回線に対して、Radiusから交換機へ切断要求するAPIです。(※切断を保証するものではありません。)
(1)APIのサンプル構文(API個別部)
*レスポンス例
{ "contractId": "N123456789",
"lineNo": "09012345678",
"resultCode": 0 }
Copyright © NTT Communications Corporation. All right reserved.
2-1.機能概要
ユーザー API-GW 備考
(※)エラーについては
『2-1-7. エラー応答』参照
【API項目(アウトプット) 】
・契約番号(N番)
・回線番号
・受付結果
2-1-4.回線制御
2-1-4-2.回線切断要求 [session](4/4)
・接続中の契約回線に対して、Radiusから交換機へ切断要求するAPIです。(※切断を保証するものではありません。)
(2)APIの動作フロー
【API項目(インプット) 】
・契約番号(N番)・回線番号 ・同意する
回線リスト確認APIレスポ ンスの中の「回線番号(リ スト)」にユーザーからき た 回線番号があるかを チェックします。
回線切断要求
(リクエスト)
契約者番号 (N番)確認
OK O Auth2
(レスポンス)エラー
(レスポンス)エラー NG(エラー①②③⑳(※))
入力値チェック
(レスポンス)エラー
回線切断要求 (リクエスト)API OK NG(エラー④(※)) OK
NG(エラー⑤⑧⑮⑯(※))
受付結果 回線切断要求
(レスポンス)
Copyright © NTT Communications Corporation. All right reserved.
2-1.機能概要
2-1-5.
オーダーキャンセル 系API概要
API-GWを経由して、
オーダーキャンセル 系のAPIを公開します。各APIの名称と使用目的を以下に示します。
連番
API名
英語名 日本語名 API種別 使用目的
(同期/非同期)
キャンセル 28 orders (DELETE) 申し込み取り消し 容量シェア以外の申し込みについて取り消しを行います。
29 dataShare-reserves(DELETE) 容量シェア予約取り消し 容量シェア申し込みについて取り消しを行います。
Copyright © NTT Communications Corporation. All right reserved.