スペース ID とスレッド ID を指定してスレッドにコメントを投稿します。
- 宛先の名前には、API を実行したユーザーの言語設定が使用されます。
- 停止ユーザー／削除ユーザー／組織／グループには通知されません。
- ゲストスペースの場合、退会したユーザーは削除ユーザーと同じ動作になります。
- 招待中のゲストユーザーを宛先に指定するとエラーが発生します。
URL
https://sample.cybozu.com/k/v1/space/thread/comment.json
HTTP メソッド
POST
ゲストスペースの場合
https://sample.cybozu.com/k/guest/ゲストスペース ID/v1/space/thread/comment.json
必要なアクセス権
- スペースの閲覧権限
非公開スペース／ゲストスペースの場合、スペース参加者のみ実行可能です。
リクエスト
パラメーター
スペース ID やスレッド ID は、URL から確認できます。
たとえば、URL が「https://sample.cybozu.com/k/#/space/250/thread/1026」の場合、スペース ID は「250」、スレッド ID は「1026」です。
| パラメーター名 |
型 |
必須 |
説明 |
| space |
数値または文字列 |
必須 |
スペース ID |
| thread |
数値または文字列 |
必須 |
スレッド ID |
| comment |
オブジェクト |
必須 |
コメントの情報
投稿時の内容は次の順で構成されます。comment.mentions で指定される宛先情報comment.text で指定されるコメント内容comment.files で指定される添付ファイル
|
| comment.text |
文字列 |
条件必須 |
コメントの内容
改行は「LF」で指定します。
コメントの最大文字数は 65,535文字です。
comment.text と comment.files のいずれかが必須です。 |
| comment.mentions |
配列 |
省略可 |
宛先情報 |
| comment.mentions[].code |
文字列 |
省略可 |
宛先のユーザー／組織／グループコード
指定できる宛先の数は、10 個までです。
宛先を指定すると、本文の前に宛先が挿入されます。
宛先のユーザーにゲストユーザーを指定する場合、「guest/ログインメールアドレス」を指定してください。
|
| comment.mentions[].type |
文字列 |
省略可 |
宛先のユーザー／組織／グループの種類USER：ユーザーGROUP：グループORGANIZATION：組織
|
| comment.files |
配列 |
条件必須 |
添付ファイルの一覧
5 ファイルまで指定できます。
comment.text と comment.files のいずれかが必須です。 |
| comment.files[].fileKey |
文字列 |
省略可 |
添付するファイルのファイルキー
ファイルをアップロードする で取得したファイルキーを利用できます。
|
| comment.files[].width |
数値または文字列 |
省略可 |
添付ファイルが画像の場合に画像が表示される幅
100 から 750 までの数値を指定できます。
省略すると、画面から投稿時に「元のサイズ」を選択したときと同じ幅で表示されます。
画像以外を指定した場合、無視されます。 |
リクエストの例
ヘッダー
1
2
3
|
{
"X-Cybozu-Authorization": "QWRtaW5pc3RyYXRvcjpjeWJvenU="
}
|
リクエストヘッダーの詳細は
kintone REST API の共通仕様 を参照してください。
ボディ
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
|
{
"space": 250,
"thread": 1026,
"comment": {
"text": "本日のオススメ弁当です。\n弁当注文アプリの登録をお待ちしております。",
"mentions": [
{
"code": "takahashi",
"type": "USER"
},
{
// 宛先のユーザーにゲストユーザーを指定する場合
"code": "guest/yamada@test.jp",
"type": "USER"
},
{
"code": "営業本部_OZKQWZ",
"type": "ORGANIZATION"
},
{
"code": "管理部受付_zX6C6r",
"type": "GROUP"
}
],
"files": [
{
"fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",
"width": 500
}
]
}
}
|
レスポンス
プロパティ
| プロパティ名 |
型 |
説明 |
| id |
数値 |
投稿したコメントのコメント ID |
レスポンスの例
サンプルコード
curl を使ったリクエスト
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
|
curl -X POST 'https://sample.cybozu.com/k/v1/space/thread/comment.json' \
-H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
-H 'Content-Type: application/json' \
-d '{
"space": 1,
"thread": 1,
"comment": {
"text": "本日のオススメ弁当です。\n弁当注文アプリの登録をお待ちしております。",
"mentions": [
{
"code": "takahashi",
"type": "USER"
},
{
"code": "guest/yamada@test.jp",
"type": "USER"
},
{
"code": "営業本部_OZKQWZ",
"type": "ORGANIZATION"
},
{
"code": "管理部受付_zX6C6r",
"type": "GROUP"
}
],
"files": [
{
"fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6",
"width": 500
}
]
},
}'
|
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
|
const body = {
space: 1,
thread: 1,
comment: {
text: '本日のオススメ弁当です。\n弁当注文アプリの登録をお待ちしております。',
mentions: [
{
code: 'takahashi',
type: 'USER'
},
{
code: 'guest/yamada@test.jp',
type: 'USER'
},
{
code: '営業本部_OZKQWZ',
type: 'ORGANIZATION'
},
{
code: '管理部受付_zX6C6r',
type: 'GROUP'
}
],
files: [
{
fileKey: 'c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6',
width: 500
}
]
}
};
await kintone.api(kintone.api.url('/k/v1/space/thread/comment.json', true), 'POST', body);
|
