Garoon API ドキュメント

メッセージオブジェクト

目次

メッセージオブジェクト

固定リンクがコピーされました

メッセージオブジェクトでは、次の内容を取得できます。
プロパティの詳細は、別表を参照してください。

メッセージオブジェクトの例を表示する 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "body": {
    "draft": true,
    "recipients": [
      {
        "id": "1",
        "name": "Noboru SATO",
        "code": "sato-noboru",
        "type": "USER"
      }
    ]
  }
}

基本プロパティ

固定リンクがコピーされました

プロパティ名 型 例 説明
draft 真偽値 
"draft": true
 下書きかどうか *1
  • true：表示中の画面が「下書きの編集/送信」画面
  • false：それ以外の画面
recipients 配列 
"recipients": [
  {
    "id": "1",
    "name": "Noboru SATO",
    "code": "sato-noboru",
    "type": "USER"
  }
]
 メッセージ宛先のリスト
詳細は 宛先に関するプロパティ を参照してください。

*1 クラウド版、パッケージ版バージョン 5.9 以降 ^

宛先に関するプロパティ

固定リンクがコピーされました

プロパティ名 型 例 説明
recipients 配列 
"recipients": [
  {
    "id": "1",
    "name": "Noboru SATO",
    "code": "sato-noboru",
    "type": "USER"
  }
]
 宛先
recipients[].id 文字列 宛先のユーザーID
recipients[].type 文字列 宛先のタイプ
  • USER：ユーザー
recipients[].code 文字列 宛先のログイン名
パッケージ版 Garoon の場合、ログイン名を公開する設定が必要です。
詳細は ユーザー情報の項目を変更する (External link) を参照してください。
recipients[].name 文字列 宛先の表示名