Garoon APIドキュメント

メッセージを取得する

目次

1件のメッセージを取得する

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

メッセージIDを指定して、メッセージの内容を取得します。

URL

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

クラウド版

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

パスパラメーター
パラメーター名 説明
MESSAGE_ID 取得するメッセージのID

HTTPメソッド

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

GET

利用できるバージョン

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

  • クラウド版Garoon

リクエスト

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

パラメーター

なし

リクエストの例
ヘッダー
1
2
3

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

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

レスポンス

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

プロパティ
プロパティ名 型 説明
id 文字列 メッセージのID
title 文字列 メッセージの標題
acknowledgment 真偽値 閲覧状況を確認するかどうか
  • true：閲覧状況を確認する
  • false：閲覧状況を確認しない
creator[].id 文字列 作成者のGaroonユーザーID
creator[].code 文字列 作成者のログイン名
creator[].name 文字列 作成者の表示名
updater[].id 文字列 更新者のGaroonユーザーID
updater[].code 文字列 更新者のログイン名
updater[].name 文字列 更新者の表示名
recipients[].id 文字列 宛先のGaroonユーザーID
recipients[].name 文字列 宛先の表示名
recipients[].code 文字列 宛先のログイン名
recipients[].type 文字列 宛先のタイプ
  • USER：ユーザー
recipients[].isAcknowledged 文字列 閲覧状況を確認するかどうか
  • true：閲覧状況を確認する
  • false：閲覧状況を確認しない
isDraft 真偽値 下書きどうか
  • true：下書き
  • false：下書きではない
body 文字列 メッセージの本文
isHtmlBody 真偽値 本文を書式編集（HTML形式）で保存するかどうか
  • true：HTML形式
  • false：プレーンテキスト
folders[].id 文字列 フォルダーのID
folders[].name 文字列 フォルダーの表示名
folders[].type 文字列 フォルダーのタイプ
  • RECEIVED：受信箱
  • SENT：送信箱
  • DRAFT：下書き
  • TRASH：ごみ箱
  • ROOT：ルート
  • USER_FOLDER：ユーザーが作成したフォルダー
operatorType 文字列 変更/削除の許可
  • ONLY_SENDER：差出人のみ
  • SELECT_USERS：差出人が許可したユーザー
  • ALL_TO_RECIPIENTS：宛先のユーザー
operators[].id 文字列 メッセージの変更/削除を許可されているGaroonユーザーID
operators[].name 文字列 メッセージの変更/削除を許可されているユーザーの表示名
operators[].code 文字列 メッセージの変更/削除を許可されているユーザーのログイン名
operators[].type 文字列 メッセージの変更/削除を許可されているタイプ
  • USER：ユーザー
レスポンスの例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

{
    "id": "2",
    "title": "This is title of message",
    "acknowledgement": true,
    "creator": {
        "id": "1",
        "code": "Administrator",
        "name": "Administrator"
    },
    "updater": {
        "id": "1",
        "code": "Administrator",
        "name": "Administrator"
    },
    "createdAt": "2024-04-19T04:46:25Z",
    "updatedAt": null,
    "recipients": [
        {
            "id": "2",
            "name": "u1",
            "code": "u1",
            "type": "USER",
            "isAcknowledged": true,
        },
        {
            "id": "3",
            "name": "u2",
            "code": "u2",
            "type": "USER",
            "isAcknowledged": false,
        }
    ],
    "isDraft": false,
    "body": "This is body",
    "isHtmlBody": false,
    "folders": [
        {
            "id": "3",
            "name": "Sent items",
            "type": "SENT"
        },
    ],
    "operatorType": "ALL_TO_RECIPIENTS",
    "operators": [
        {
            "id": "2",
            "name": "u1",
            "code": "u1",
            "type": "USER"
        },
        {
            "id": "3",
            "name": "u2",
            "code": "u2",
            "type": "USER"
        }
    ]
}

サンプルコード

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

curlを使ったリクエスト
1
2

curl -X GET 'https://sample.cybozu.com/g/api/v1/message/messages/1' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
Garoon REST APIリクエストを送信するAPIを使ったリクエスト
1

await garoon.api('/api/v1/message/messages/1', 'GET', {});