現在の位置
FrontPage > MierukaApiSetRelayConfig
set_relay_config †
グループ内のユーザが使用する中継サーバの設定を変更する。
URL †
http://web-api.soba-project.com/webapi/1.4/set_relay_config
認証 †
グループ管理者アカウントでの認証が必要
パラメータ †
- enabled: 必須。中継サーバを使用する場合は1、使用しない場合は0を指定する。
- ip: オプション。中継サーバのIPアドレス。enabledが1のときにこのパラメータを指定しない場合はデフォルトの中継サーバを使用する。
- port: オプション。中継サーバのポート番号。enabledが1でipが指定されていて、このパラメータが未指定のときは443が割り当てられる。
レスポンス †
成功時:
<?xml version="1.0" encoding="utf-8" ?> <set-relay-config result="OK"> </set-relay-config>
失敗時:
<set-relay-config result="NG"> <error code="xxx" message="xxxxxxxxx" /> </set-relay-config>