コメントを読む

文書のコメント・返信・解決の状態を読む手順。

文書のコメントは、エージェント用トークンでも取り込み用トークンでも読めます。

export ORIGIN=https://comment-review.fsmarketing.workers.dev

文書を探す

取り込み用トークンで、読める文書の一覧を取れます。題名・タグ・未解決のコメントの数で対象を選びます。

curl "$ORIGIN/api/reviews" -H "Authorization: Bearer $CR_IMPORT_TOKEN"

{ "reviews": [ { "reviewId": "review_example01", "title": "料金ページの下書き", "counts": { "open": 2, "total": 5 }, "tags": ["LP"] } ] }

コメントを読む

curl "$ORIGIN/api/reviews/review_example01" -H "Authorization: Bearer $CR_AGENT_TOKEN"

応答の review.comments がコメントの一覧です。1 件ごとに次の項目があります。

• 削除されたコメントも deletedTs 付きで一覧に入ります。画面と同じ一覧にするときは、deletedTs のあるものを除いてください。
• 未解決のものだけを扱うときは、status が open のものに絞ります。
• review.commentsRevision は、コメントが書き換わるたびに 1 増える番号です。書き込みのときに使うので控えておきます。

見出しの区切りを読む

コメントの位置を見出しの区切りで指定するときは、区切りの ID を取ります。

curl "$ORIGIN/api/reviews/review_example01/dom-context" -H "Authorization: Bearer $CR_AGENT_TOKEN"

項目の詳細は 文書とコメントを読む と 文書の一覧を読む を見てください。