Garoon APIドキュメント

メッセージを作成する

目次

1件のメッセージを作成する

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

メッセージを作成します。

URL

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

クラウド版

https://sample.cybozu.com/g/api/v1/message/messages

HTTPメソッド

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

POST

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

パラメーター
パラメーター名 型 必須 説明
title 文字列 必須 メッセージの標題
最大文字数は、100文字です。
recipients 配列 必須 宛先のリスト
recipients[].id 文字列 必須 宛先のGaroonユーザーID
recipients[].type 文字列 必須 宛先のタイプ
USERを指定します。
acknowledgment 真偽値 省略可 閲覧状況を確認するかどうか
  • true：閲覧状況を確認する
  • false：閲覧状況を確認しない
省略すると「false」が設定されます。
isDraft 真偽値 省略可 下書きとして保存するかどうか
  • true：下書きとして保存する
  • false：下書きとして保存せず、メッセージを送信する
省略すると「false」が設定されます。
body 文字列 省略可 メッセージの本文
isHtmlBody 真偽値 省略可 本文を書式編集（HTML形式）で保存するかどうか
  • true：HTML形式で保存する
  • false：プレーンテキストで保存する
省略すると「false」が設定されます。
リクエストの例
ヘッダー
1
2
3

{
  "X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}

リクエストヘッダーの詳細は Garoon REST APIの共通仕様を参照してください。

ボディ
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

{
  "title": "This is title of message",
  "recipients": [
    {
      "id": 1,
      "type": "USER"
    }
  ],
  "acknowledgement": false,
  "isDraft": false,
  "body": "This is body of the message.",
  "isHtmlBody": false
}

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 メッセージのID
title 文字列 メッセージの標題
creator[].id 文字列 作成者のGaroonユーザーID
creator[].code 文字列 作成者のログイン名
creator[].name 文字列 作成者の表示名
createdAt 文字列 作成日時
updater[].id 文字列 更新者のGaroonユーザーID
updater[].code 文字列 更新者のログイン名
updater[].name 文字列 更新者の表示名
recipients[].id 文字列 宛先のGaroonユーザーID
recipients[].name 文字列 宛先の表示名
recipients[].code 文字列 宛先のログイン名
recipients[].type 文字列 宛先のタイプ
  • USER：ユーザー
recipients[].isAcknowledged 文字列 閲覧状況を確認するかどうか
  • true：閲覧状況を確認する
  • false：閲覧状況を確認しない
acknowledgment 真偽値 閲覧状況を確認するかどうか
  • true：閲覧状況を確認する
  • false：閲覧状況を確認しない
isDraft 真偽値 下書きどうか
  • true：下書き
  • false：下書きではない
body 文字列 メッセージの本文
isHtmlBody 真偽値 本文を書式編集（HTML形式）で保存するかどうか
  • true：HTML形式
  • false：プレーンテキスト
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

{
  "id": "1",
  "title": "This is title of message",
  "creator": {
      "id": "1",
      "code": "Administrator",
      "name": "Administrator"
  },
  "createdAt": "2024-04-19T04:46:25Z",
  "recipients": [
    {
      "id": "2",
      "code": "Harry",
      "name": "h000912",
      "type": "USER",
      "isAcknowledged": false
    }
  ],
  "acknowledgement": false,
  "isDraft": false,
  "body": "This is body of the message.",
  "isHtmlBody": false
}

サンプルコード

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

curlを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

curl -X POST 'https://sample.cybozu.com/g/api/v1/message/messages' \      
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "This is title of message",
    "recipients": [
      {
        "id": 1,
        "type": "USER"
      }
    ],
    "acknowledgement": false,
    "isDraft": false,
    "body": "This is body of the message.",
    "isHtmlBody": false
  }'
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

const body = {
  title: 'This is title of message',
  recipients: [
    {
      id: 1,
      type: 'USER'
    }
  ],
  acknowledgement: false,
  isDraft: false,
  body: 'This is body of the message.',
  isHtmlBody: false
};

await garoon.api('/api/v1/message/messages', 'POST', body);