kintone API文件

向空間中的話題貼文回覆

information

本頁面使用機器翻譯而成。
機器翻譯免責聲明 (External link)

目錄

向空間中的話題發佈回覆

連結已複製

通過指定空間ID和主題ID向主題發佈回覆。

  • 收件人的名稱使用執行API 的使用者的語言設置。
  • 暫停的使用者/已刪除的使用者/組織/群組不會收到通知。
  • 對於訪客空間，離開組的使用者將具有與已刪除使用者相同的行為。
  • 如果將受邀的訪客指定為收件人，則會發生錯誤。

URL

連結已複製

https://sample.cybozu.com/k/v1/space/thread/comment.json

HTTP 方法

連結已複製

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 字串 可省略 提及的使用者/組織/群組代碼
您最多可以指定 10 個接收方。
如果指定收件人，則目標將插入到內文之前。
如果要將訪客使用者指定為收件者使用者，請指定「guest/登入電子郵件地址」。
comment.mentions[].type 字串 可省略 目標使用者/組織/群組類型
  • USER：使用者
  • GROUP：群組
  • ORGANIZATION：組織
comment.files 陣列 條件必填項 附件的清單
您最多可以指定 5 個檔案。
comment.text 和 comment.files 是必需的。
comment.files[].fileKey 字串 可省略 要附加的檔案的檔鍵
您可以使用上傳檔案API獲取的檔鍵。
上傳檔案的 API
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。
示例回應
1
2
3

{
  "id": 410
}

示例代碼

連結已複製

使用 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
        }
      ]
    },
  }'
kintone.api()請求使用

有關詳細的kintone.api()，請參閱以下頁面。
發送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
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);