FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-24. NGN-SIP設定(ngn-sip)

 処理概要

NGN-SIP設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
NGN-SIP v2 /api/v2/ngn-sip
/api/v2/ngn-sip/server
/api/v2/ngn-sip/server/{INDEX}
/api/v2/ngn-sip/client
/api/v2/ngn-sip/client/{INDEX}

凡例:

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

- : 未対応

 

実行例

NGN-SIPサーバ設定の作成

メソッド URI
POST /api/v2/ngn-sip/server
JSON
リクエスト

POST /api/v2/ngn-sip/server
Content-Type: application/json

 

{
"server": {
"index": 1,
"from": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.101",
"port": 10000
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/ngn-sip/server
Content-Type: application/xml

 

<ngn-sip>
<server>
<index>1</index>
<from>03AAAABBBB</from>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.101</ip>
<port>10000</port>
</tcp>
</server>
</ngn-sip>

 

レスポンス

201 Created

 

全NGN-SIPサーバ設定の取得

メソッド URI
GET /api/v2/ngn-sip/server
JSON
リクエスト

GET /api/v2/ngn-sip/server
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": [
{
"index": 1,
"from": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.101",
"port": 10000
}
},
{
"index": 2,
"from": "03AAAACCCC",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.102",
"port": 10000
}
}
]
}

 

XML
リクエスト

GET /api/v2/ngn-sip/server
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ngn-sip>
<server>
<index>1</index>
<from>03AAAABBBB</from>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.101</ip>
<port>10000</port>
</tcp>
</server>
<server>
<index>2</index>
<from>03AAAACCCC</from>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.102</ip>
<port>10000</port>
</tcp>
</server>
</ngn-sip>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ngn-sip/server
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ngn-sip server 1
tel from 03AAAABBBB
mode tcp ip 192.168.0.101 port 10000
ngn-sip server 2
tel from 03AAAACCCC
mode tcp ip 192.168.0.102 port 10000

 

NGN-SIPサーバ設定の更新

メソッド URI
PUT /api/v2/ngn-sip/server/{INDEX}
JSON
リクエスト

PUT /api/v2/ngn-sip/server/1
Content-Type: application/json

 

{
"index": 1,
"from": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.101",
"port": 20000
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ngn-sip/server/1
Content-Type: application/xml

 

<server>
<index>1</index>
<from>03AAAABBBB</from>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.101</ip>
<port>20000</port>
</tcp>
</server>

 

レスポンス

204 No content

 

NGN-SIPサーバ設定の取得

メソッド URI
GET /api/v2/ngn-sip/server/{INDEX}
JSON
リクエスト

GET /api/v2/ngn-sip/server/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"index": 1,
"from": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.101",
"port": 20000
}
}

 

XML
リクエスト

GET /api/v2/ngn-sip/server/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<server>
<index>1</index>
<from>03AAAABBBB</from>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.101</ip>
<port>20000</port>
</tcp>
</server>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ngn-sip/server/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ngn-sip server 1
tel from 03AAAABBBB
mode tcp ip 192.168.0.101 port 20000

 

NGN-SIPサーバ設定の削除

メソッド URI
DELETE /api/v2/ngn-sip/server/{INDEX}
リクエスト

DELETE /api/v2/ngn-sip/server/1

 

レスポンス

204 No content

 

NGN-SIPクライアント設定の作成

メソッド URI
POST /api/v2/ngn-sip/client
JSON
リクエスト

POST /api/v2/ngn-sip/client
Content-Type: application/json

 

{
"client": {
"index": 1,
"to": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.1",
"port": 10000
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/ngn-sip/client
Content-Type: application/xml

 

<ngn-sip>
<client>
<index>1</index>
<to>03AAAABBBB</to>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.1</ip>
<port>10000</port>
</tcp>
</client>
</ngn-sip>

 

レスポンス

201 Created

 

全NGN-SIPクライアント設定の取得

メソッド URI
GET /api/v2/ngn-sip/client
JSON
リクエスト

GET /api/v2/ngn-sip/client
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"client": [
{
"index": 1,
"to": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.1",
"port": 10000
}
},
{
"index": 2,
"to": "03AAAACCCC",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.1",
"port": 20000
}
}
]
}

 

XML
リクエスト

GET /api/v2/ngn-sip/client
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<ngn-sip>
<client>
<index>1</index>
<to>03AAAABBBB</to>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.1</ip>
<port>10000</port>
</tcp>
</client>
<client>
<index>2</index>
<to>03AAAACCCC</to>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.1</ip>
<port>20000</port>
</tcp>
</client>
</ngn-sip>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ngn-sip/client
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ngn-sip client 1
tel to 03AAAABBBB
mode tcp ip 192.168.0.1 port 10000
ngn-sip client 2
tel to 03AAAACCCC
mode tcp ip 192.168.0.1 port 20000

 

NGN-SIPクライアント設定の更新

メソッド URI
PUT /api/v2/ngn-sip/client/{INDEX}
JSON
リクエスト

PUT /api/v2/ngn-sip/client/1
Content-Type: application/json

 

{
"index": 1,
"to": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.1",
"port": 10001
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/ngn-sip/client/1
Content-Type: application/xml

 

<client>
<index>1</index>
<to>03AAAABBBB</to>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.1</ip>
<port>10001</port>
</tcp>
</client>

 

レスポンス

204 No content

 

NGN-SIPクライアント設定の取得

メソッド URI
GET /api/v2/ngn-sip/client/{INDEX}
JSON
リクエスト

GET /api/v2/ngn-sip/client/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"index": 1,
"to": "03AAAABBBB",
"mode": "tcp",
"tcp": {
"ip": "192.168.0.1",
"port": 10001
}
}

 

XML
リクエスト

GET /api/v2/ngn-sip/client/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<client>
<index>1</index>
<to>03AAAABBBB</to>
<mode>tcp</mode>
<tcp>
<ip>192.168.0.1</ip>
<port>10001</port>
</tcp>
</client>

 

TEXT/PLAIN
リクエスト

GET /api/v2/ngn-sip/client/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ngn-sip client 1
tel to 03AAAABBBB
mode tcp ip 192.168.0.1 port 10001

 

NGN-SIPクライアント設定の削除

メソッド URI
DELETE /api/v2/ngn-sip/client/{INDEX}
リクエスト

DELETE /api/v2/ngn-sip/client/1

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。

なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド(CLI版)も合わせてご参照ください。

  • パラメータ表の説明文中の記号について
    < > … 括弧内の値の範囲から選択することを示しています。
    数字,文字列 … 初期値
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
ngn-sip client index SIPクライアント設定番号
to 着信側の電話番号
mode 通信モード … tcp
idle-timeout 無通信監視タイマ … <10-3600(60)>(sec)
tcp ip IPアドレス … A.B.C.D
port ポート番号 … <1-65535>
server index SIPサーバ設定番号
from 発信側の電話番号
mode 通信モード … tcp
idle-timeout 無通信監視タイマ … <10-3600(60)>(sec)
tcp ip IPアドレス … A.B.C.D
port ポート番号 … <1-65535>