設定情報を取得または変更する

目次

設定情報を取得する

メッセージの設定をレスポンスとして返すAPIです。個人設定だけを取得するか、システム設定を含めて取得するかを指定できます。

API名

MessageGetProfiles

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
include_system_profile xsd:boolean 0~1 システム設定の取得
  • true:取得する
  • false:取得しない
1
<parameters include_system_profile="true"></parameters>

レスポンス

パラメーター名 パラメーター数 説明
personal_profile message:MessagePersonalProfileType 1 メッセージの個人設定
system_profile message:MessageSystemProfileType 0~1 メッセージのシステム設定
1
2
3
4
<returns xmlns=""> 
  <personal_profile use_trash="true" trash_duration="5" /> 
  <system_profile check_send_confirm="false" confirm_action="Manual" /> 
</returns>

設定情報を変更する

個人設定をリクエストのパラメーターとして受け取り、個人設定を変更し、設定内容をレスポンスとして返すAPIです。

API名

MessageSetProfiles

使用可能なGaroonのバージョン

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

リクエスト

パラメーター名 パラメーター数 説明
personal_profile message:MessagePersonalProfileType 1 設定するメッセージの個人設定
1
2
3
<parameters> 
  <personal_profile use_trash="true" trash_duration="10"></personal_profile> 
</parameters>

レスポンス

パラメーター名 パラメーター数 説明
personal_profile message:MessagePersonalProfileType 1 設定したメッセージの個人設定
1
2
3
<returns xmlns=""> 
  <personal_profile use_trash="true" trash_duration="10" /> 
</returns>