通過指定空間ID和線程ID向線程發佈註釋。
- 目標的名稱使用運行 API 的使用者的語言設置。
- 暫停的使用者/已刪除的使用者/組織/組將不會收到通知。
- 對於訪客空間,離開組的使用者將具有與已刪除使用者相同的行為。
- 如果將受邀的來賓使用者指定為目標,則會發生錯誤。
https://sample.cybozu.com/k/v1/space/thread/comment.json
POST
建立訪客空間
https://sample.cybozu.com/k/guest/GUEST_SPACE_ID
/v1/space/thread/comment.json
- 查看空間的許可權
在私人空間/訪客空間的情況下,只有空間參與者才能這樣做。
參數
您可以從 URL 中找到空間 ID 和線程 ID。
例如,如果 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 |
字串 |
自選 |
目標使用者/組織/組代碼 函數中最多可指定個參數。 如果指定目標,則目標將插入到正文之前。 如果要將訪客使用者指定為收件者使用者,請指定「訪客/登錄電子郵件位址」。
|
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);
|