AgentSkillsCN

chatwork-api

Chatwork API 参考文档。提供 Chatwork 的 rooms、messages、tasks、files、members、contacts、invitations 的认证、端点及参数规范。

SKILL.md
--- frontmatter
name: chatwork-api
description: "Chatwork API リファレンス。チャットワークのrooms, messages, tasks, files, members, contacts, invitationsの認証・エンドポイント・パラメータ仕様を提供。"
user-invocable: false

Chatwork REST API v2 リファレンス

Chatwork REST API v2 の全エンドポイントに関する知識を提供するリファレンススキル。

基本情報

  • •Base URL: https://api.chatwork.com/v2
  • •プロトコル: HTTPS 必須
  • •レスポンス形式: JSON
  • •リクエストボディ: application/x-www-form-urlencoded（POST/PUT）

認証

API トークン

リクエストヘッダーに X-ChatWorkToken を設定する。

code
X-ChatWorkToken: YOUR_API_TOKEN
  • •トークンの取得: Chatwork画面 → ユーザー名クリック → サービス連携 → APIトークン
  • •トークンに有効期限はない
  • •クエリストリングではなく、必ずヘッダーで送信する

OAuth 2.0

各エンドポイントに必要なスコープが定義されている。詳細は各エンドポイントのリファレンスを参照。

レートリミット

制限種別上限期間
全般300リクエスト5分
メッセージ投稿・タスク追加（ルーム毎）10リクエスト10秒

レスポンスヘッダーで確認可能:

  • •x-ratelimit-limit: 最大リクエスト数
  • •x-ratelimit-remaining: 残りリクエスト数
  • •x-ratelimit-reset: リセット時刻（Unixタイムスタンプ）

超過時は HTTP 429 が返却される。

エラーレスポンス

エラー時は errors 配列を含むJSONが返却される。

json
{
  "errors": ["エラーメッセージ"]
}
ステータス説明
400リクエストパラメータ不正
401認証失敗
403権限不足
404リソース未検出
429レートリミット超過

エンドポイント一覧

ユーザー・アカウント

メソッドパス説明
GET/me自分自身の情報を取得
GET/my/status未読数・タスク数などのステータスを取得
GET/my/tasks自分のタスク一覧を取得（最大100件）

コンタクト

メソッドパス説明
GET/contactsコンタクト一覧を取得

チャットルーム

メソッドパス説明
GET/roomsチャット一覧を取得
POST/roomsグループチャットを作成
GET/rooms/{room_id}チャット情報を取得
PUT/rooms/{room_id}チャット情報を更新
DELETE/rooms/{room_id}グループチャットを退席/削除

メンバー

メソッドパス説明
GET/rooms/{room_id}/membersメンバー一覧を取得
PUT/rooms/{room_id}/membersメンバーを一括変更

メッセージ

メソッドパス説明
GET/rooms/{room_id}/messagesメッセージ一覧を取得（最大100件）
POST/rooms/{room_id}/messagesメッセージを投稿
GET/rooms/{room_id}/messages/{message_id}メッセージを取得
PUT/rooms/{room_id}/messages/{message_id}メッセージを更新
DELETE/rooms/{room_id}/messages/{message_id}メッセージを削除
PUT/rooms/{room_id}/messages/readメッセージを既読にする
PUT/rooms/{room_id}/messages/unreadメッセージを未読にする

タスク

メソッドパス説明
GET/rooms/{room_id}/tasksタスク一覧を取得（最大100件）
POST/rooms/{room_id}/tasksタスクを追加
GET/rooms/{room_id}/tasks/{task_id}タスク情報を取得
PUT/rooms/{room_id}/tasks/{task_id}/statusタスクの完了状態を変更

ファイル

メソッドパス説明
GET/rooms/{room_id}/filesファイル一覧を取得（最大100件）
POST/rooms/{room_id}/filesファイルをアップロード
GET/rooms/{room_id}/files/{file_id}ファイル情報を取得

招待リンク

メソッドパス説明
GET/rooms/{room_id}/link招待リンクを取得
POST/rooms/{room_id}/link招待リンクを作成
PUT/rooms/{room_id}/link招待リンクを変更
DELETE/rooms/{room_id}/link招待リンクを削除

コンタクト承認リクエスト

メソッドパス説明
GET/incoming_requests承認待ちリクエスト一覧を取得（最大100件）
PUT/incoming_requests/{request_id}リクエストを承認
DELETE/incoming_requests/{request_id}リクエストを拒否

詳細リファレンス

各エンドポイントの詳細なパラメータ、レスポンスフィールド、使用例については以下を参照。