kintone API

填寫記錄回覆

在記錄頁面填寫回覆。

目錄

HTTP 方法POST
URLhttps://sample.cybozu.com/k/v1/record/comment.json
URL(訪客空間)https://sample.cybozu.com/k/guest/GUEST_SPACE_ID/v1/record/comment.json
認證 密碼驗證 , API令牌認證 , 會話認證
Content-Typeapplication/json

請求參數

參數名稱 類型 必須 說明
app 數值或字串 必須 應用ID
record 數值或字串 必須 記錄ID
comment 物件 必須 回覆內容
comment.text 字串 必須 回覆內容
回覆的最大長度為 65,535 個字元。
comment.mentions 陣列 可省略 回覆的收件人資訊
comment.mentions[].code 字串 可省略 接收回覆的使用者/組織/群組代碼。
可以指定的最大接收人數為 10。
指定接收人時,接收人資訊將插入到正文之前。
如果要指定訪客作為接收人,則需要在代碼中指定「guest/登入電子郵件位址」。
comment.mentions[].type 字串 可省略 接收回覆的使用者/組織/群組的類型。
  • USER:使用者
  • GROUP:群組
  • ORGANIZATION:組織

應答屬性

屬性名稱 類型 說明
id 數值 您發佈的回覆的評回覆ID。

所需存取權限

  • 填寫回覆的應用的查看權限
  • 填寫回覆的記錄的查看權限

範例

1
2
3
4
{
  "X-Cybozu-API-Token": "API_TOKEN",
  "Content-Type": "application/json"
}

有關請求頭的詳細資訊,請參閱通用規格。
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
{
  "app": 12343,
  "record": 4,
  "comment": {
    "text": "這是來自系統的回覆。請確認。 ",
    "mentions": [
      {
        "code": "takahashi",
        "type": "USER"
      },
      {
        "code": "guest/yamada@test.jp",
        "type": "USER"
      },
      {
        "code": "営業本部_OZKQWZ",
        "type": "ORGANIZATION"
      },
      {
        "code": "管理部受付_zX6C6r",
        "type": "GROUP"
      }
    ]
  }
}

1
2
3
{
  "id": 3
}

有關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
const body = {
  app: kintone.app.getId(),
  record: 1001,
  comment: {
    text: '這是來自系統的回覆。 \n請確認。 ',
    mentions: [
      {
        code: 'takahashi',
        type: 'USER'
      },
      {
        code: 'guest/yamada@test.jp',
        type: 'USER'
      },
      {
        code: '営業本部_OZKQWZ',
        type: 'ORGANIZATION'
      },
      {
        code: '管理部受付_zX6C6r',
        type: 'GROUP'
      }
    ]
  }
};
await kintone.api(kintone.api.url('/k/v1/record/comment.json'), 'POST', body);

根據您的環境,curl的格式可能會有所不同。
有關說明,請參閱以下頁面。
使用curl命令執行kintone REST API中的3.執行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
curl -X POST 'https://sample.cybozu.com/k/v1/record/comment.json' \
  -H 'X-Cybozu-API-Token: API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "app": 1,
    "record": 1001,
    "comment": {
      "text": "這是來自系統的回覆。請確認。 ",
      "mentions": [
        {
          "code": "takahashi",
          "type": "USER"
        },
        {
          "code": "guest/yamada@test.jp",
          "type": "USER"
        },
        {
          "code": "営業本部_OZKQWZ",
          "type": "ORGANIZATION"
        },
        {
          "code": "管理部受付_zX6C6r",
          "type": "GROUP"
        }
      ]
    }
  }'

補充

  • 如果您使用 API 權杖,則發文者將是「Administrator」。
  • 回覆的接收人的名稱基於運行 API 的使用者的語言設置來顯示。
  • 暫停的使用者、已刪除的用戶、組織和組不會收到通知。
  • 對於訪客空間,退出空間的使用者與已刪除使用者的處理相同。
  • 如果將受邀的來賓使用者指定為目標,則會發生錯誤。
  • 如果您在禁用記錄回覆的應用程式中運行它,則會出現錯誤。