設定情報を取得または変更する
設定情報を取得する
メッセージの設定をレスポンスとして返すAPIです。個人設定だけを取得するか、システム設定を含めて取得するかを指定できます。
API名
MessageGetProfiles
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| include_system_profile | xsd:boolean | 0~1 | システム設定の取得
|
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| personal_profile | message:MessagePersonalProfileType | 1 | メッセージの個人設定 |
| system_profile | message:MessageSystemProfileType | 0~1 | メッセージのシステム設定 |
例
|
|
設定情報を変更する
個人設定をリクエストのパラメーターとして受け取り、個人設定を変更し、設定内容をレスポンスとして返すAPIです。
API名
MessageSetProfiles
使用可能なGaroonのバージョン
- クラウド版Garoon
- パッケージ版Garoon 3.0以降
リクエスト
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| personal_profile | message:MessagePersonalProfileType | 1 | 設定するメッセージの個人設定 |
例
|
|
レスポンス
| パラメーター名 | 型 | パラメーター数 | 説明 |
|---|---|---|---|
| personal_profile | message:MessagePersonalProfileType | 1 | 設定したメッセージの個人設定 |
例
|
|
