スペースIDとスレッドIDを指定してスレッドのコメントを投稿できます。
- メンションの名前は投稿ユーザーの言語設定が利用されます。
- 停止ユーザー、削除ユーザー・組織・グループには通知されません。
- ゲストスペースの場合、退会したユーザーは削除ユーザーと同じ動作になります。
- 招待中のゲストユーザーにメンションを指定するとエラーになります。
HTTP メソッド
POST
URI
https://{subdomain}.cybozu.com/k/v1/space/thread/comment.json
ゲストスペースの場合
https://{subdomain}.cybozu.com/k/guest/{spaceId}/v1/space/thread/comment.json
必要なアクセス権
スペースの閲覧権限
※非公開スペース・ゲストスペースの場合、スペース参加者のみ実行可能です。
リクエストパラメータ
パラメータ名 | 指定する値 | 必須 | 説明 |
---|---|---|---|
space | 数値又は文字列 | 必須 | スペースのIDを指定します。 |
thread | 数値又は文字列 | 必須 | スレッドIDを指定します。 |
comment | オブジェクト | 必須 | コメントの情報です。投稿時の内容は下記の順で構成されます。
|
comment.text | 文字列 | 条件必須 | コメントの内容です。改行はLFで指定できます。コメントの最大文字数は65535文字です。 comment.text と comment.files いずれかが必須になります。 |
comment.mentions | 配列 | メンションの宛先情報です。 | |
comment.mentions[].code | 文字列 |
メンション先のユーザー・組織・グループコードです。指定できるメンション数の上限値は10です。 ※メンション先のユーザーにゲストユーザーを指定する場合、 |
|
comment.mentions[].type | 文字列 |
メンション先のユーザー・組織・グループの種類です。
|
|
comment.files | 配列 | 条件必須 |
添付ファイルの配列です。最大5つまでです。 |
comment.files[].fileKey | 文字列 |
添付するファイルのキーです。ファイルアップロードのキーを利用できます。 |
|
comment.files[].width | 数値又は文字列 |
添付ファイルが画像の場合に画像が表示される幅を指定できます。最小100、最大750です。 |
※各IDはブラウザのアドレスをご確認ください。
https://{subdomain}.cybozu.com/k/#/space/250/thread/1026 の場合、スペースIDは「250」、スレッドIDは「1026」です。
リクエストの例
リクエストヘッダを含んだ文字列
POST /k/v1/space/thread/comment.json HTTP/1.1 Host: example.cybozu.com:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU= Content-Type: application/json
Content-Type に application/json を指定して下さい。 指定しない場合は JSON が解釈できないため、実行時エラーとなります。
ボディ
レスポンス
投稿したコメントのIDが返されます。
投稿した画面例
JavaScriptサンプル
XMLHttpRequest
制限事項
制限事項 をご確認ください。
お世話になります。
こちらの API で、書式付きコメント(HTML コメント)は投稿できないのでしょうか。
comment.text に HTML タグの入ったテキストを指定してもそのまま(プレーンテキストで)出力されてしまう仕様のようですが、
HTML で記述できれば利便性が上がるかと思います。
(kintone のスレッドで markdown 表記が使えるようになればそれでも良いのですが)
新貝博幸 様
お世話になっております。cybozu developer network 運営チームです。
>こちらの API で、書式付きコメント(HTML コメント)は投稿できないのでしょうか。
現状、リクエストパラメータのcomment.textの値の形式は文字列であるため、
仕様上、HTML タグでの投稿はできません。ご不便をおかけして申し訳ありません。
>HTML で記述できれば利便性が上がるかと思います。
>(kintone のスレッドで markdown 表記が使えるようになればそれでも良いのですが)
ご要望頂きありがとうございます。
頂きましたご要望は、開発元に共有させていただきます。
今後ともよろしくお願いいたします。