エンドポイント: /rooms

グループチャット、ダイレクトチャット、マイチャットなどのチャット全体をあらわすエンドポイントです。チャットにひもづくメッセージ、タスク、ファイル、概要、メンバー情報などにアクセスできます。

GET/rooms

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms"

レスポンス

自分のチャット一覧の取得

POST/rooms

curl -X POST -H "X-ChatWorkToken: 自分のAPIトークン" -d "description=group+chat+description&icon_preset=meeting&members_admin_ids=123%2C542%2C1001&members_member_ids=21%2C344&members_readonly_ids=15%2C103&name=Website+renewal+project" "https://api.chatwork.com/v2/rooms"

レスポンス

グループチャットを新規作成

パラメータ

description
string

チャット概要

グループチャットの概要説明テキスト

入力例

group chat description

icon_preset
string 列挙

アイコン種類

グループチャットのアイコン種類

正しい値の一覧:

group, check, document, meeting, event, project, business, study, security, star, idea, heart, magcup, beer, music, sports, travel

入力例

meeting

members_admin_ids
integer リスト 必須

管理者権限のユーザー

作成したチャットに参加メンバーのうち、管理者権限にしたいユーザーのアカウントIDの配列。最低1人は指定する必要がある。

※リストはカンマ区切りで複数の値を指定してください

入力例

123,542,1001

members_member_ids
integer リスト

メンバー権限のユーザー

作成したチャットに参加メンバーのうち、メンバー権限にしたいユーザーのアカウントIDの配列。

※リストはカンマ区切りで複数の値を指定してください

入力例

21,344

members_readonly_ids
integer リスト

閲覧のみ権限のユーザー

作成したチャットに参加メンバーのうち、閲覧のみ権限にしたいユーザーのアカウントIDの配列。

※リストはカンマ区切りで複数の値を指定してください

入力例

15,103

name
string 必須

グループチャット名

作成したいグループチャットのチャット名

入力例

Website renewal project

GET/rooms/{room_id}

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}"

レスポンス

チャットの名前、アイコン、種類(my/direct/group)を取得

PUT/rooms/{room_id}

curl -X PUT -H "X-ChatWorkToken: 自分のAPIトークン" -d "description=group+chat+description&icon_preset=meeting&name=Website+renewal+project" "https://api.chatwork.com/v2/rooms/{room_id}"

レスポンス

チャットの名前、アイコンをアップデート

パラメータ

description
string

チャット概要

グループチャットの概要説明テキスト

入力例

group chat description

icon_preset
string 列挙

アイコン種類

グループチャットのアイコン種類

正しい値の一覧:

group, check, document, meeting, event, project, business, study, security, star, idea, heart, magcup, beer, music, sports, travel

入力例

meeting

name
string

グループチャット名

グループチャットのチャット名

入力例

Website renewal project

DELETE/rooms/{room_id}

curl -X DELETE -H "X-ChatWorkToken: 自分のAPIトークン" -d "action_type=leave" "https://api.chatwork.com/v2/rooms/{room_id}"

レスポンス

グループチャットを退席/削除する

パラメータ

action_type
string 列挙 必須

退席するか、削除するか

退席すると、このグループチャットにある自分が担当のタスク、および自分が送信したファイルは削除されます。 削除すると、このグループチャットに参加しているメンバー全員のメッセージ、タスク、ファイルはすべて削除されます。 ※一度削除すると元に戻せません!

正しい値の一覧:

leave, delete

入力例

leave

GET/rooms/{room_id}/members

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/members"

レスポンス

チャットのメンバー一覧を取得

PUT/rooms/{room_id}/members

curl -X PUT -H "X-ChatWorkToken: 自分のAPIトークン" -d "members_admin_ids=123%2C542%2C1001&members_member_ids=21%2C344&members_readonly_ids=15%2C103" "https://api.chatwork.com/v2/rooms/{room_id}/members"

レスポンス

チャットのメンバーを一括変更

パラメータ

members_admin_ids
integer リスト 必須

管理者権限のユーザー

作成したチャットに参加メンバーのうち、管理者権限にしたいユーザーのアカウントIDの配列。最低1人は指定する必要がある。

※リストはカンマ区切りで複数の値を指定してください

入力例

123,542,1001

members_member_ids
integer リスト

メンバー権限のユーザー

作成したチャットに参加メンバーのうち、メンバー権限にしたいユーザーのアカウントIDの配列。

※リストはカンマ区切りで複数の値を指定してください

入力例

21,344

members_readonly_ids
integer リスト

閲覧のみ権限のユーザー

作成したチャットに参加メンバーのうち、閲覧のみ権限にしたいユーザーのアカウントIDの配列。

※リストはカンマ区切りで複数の値を指定してください

入力例

15,103

GET/rooms/{room_id}/messages

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/messages?force=0"

レスポンス

チャットのメッセージ一覧を取得。パラメータ未指定だと前回取得分からの差分のみを返します。(最大100件まで取得)

パラメータ

force
boolean

未取得にかかわらず最新の100件を取得するか

1を指定すると未取得にかかわらず最新の100件を取得します(デフォルトは0)

入力例

0

POST/rooms/{room_id}/messages

curl -X POST -H "X-ChatWorkToken: 自分のAPIトークン" -d "body=Hello+ChatWork%21" "https://api.chatwork.com/v2/rooms/{room_id}/messages"

レスポンス

チャットに新しいメッセージを追加

パラメータ

body
string 必須

メッセージ本文

入力例

Hello ChatWork!

PUT/rooms/{room_id}/messages/read

curl -X PUT -H "X-ChatWorkToken: 自分のAPIトークン" -d "message_id=101" "https://api.chatwork.com/v2/rooms/{room_id}/messages/read"

レスポンス

メッセージを既読にする

パラメータ

message_id
string

ここで指定するIDのメッセージまでを既読にする。すでに既読済みの場合はエラー(400)

入力例

101

PUT/rooms/{room_id}/messages/unread

curl -X PUT -H "X-ChatWorkToken: 自分のAPIトークン" -d "message_id=101" "https://api.chatwork.com/v2/rooms/{room_id}/messages/unread"

レスポンス

メッセージを未読にする

パラメータ

message_id
string 必須

ここで指定するIDのメッセージ以降を未読にする

入力例

101

GET/rooms/{room_id}/messages/{message_id}

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

レスポンス

メッセージ情報を取得

PUT/rooms/{room_id}/messages/{message_id}

curl -X PUT -H "X-ChatWorkToken: 自分のAPIトークン" -d "body=Hello+ChatWork%21" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

レスポンス

チャットのメッセージを更新する。

パラメータ

body
string 必須

更新するメッセージ本文

入力例

Hello ChatWork!

DELETE/rooms/{room_id}/messages/{message_id}

curl -X DELETE -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

レスポンス

メッセージを削除

GET/rooms/{room_id}/tasks

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/tasks?account_id=101&assigned_by_account_id=78&status=done"

レスポンス

チャットのタスク一覧を取得 (※100件まで取得可能。今後、より多くのデータを取得する為のページネーションの仕組みを提供予定)

パラメータ

account_id
integer

タスクの担当者のアカウントID

入力例

101

assigned_by_account_id
integer

タスクの依頼者のアカウントID

入力例

78

status
string 列挙

タスクのステータス

正しい値の一覧:

open, done

入力例

done

POST/rooms/{room_id}/tasks

curl -X POST -H "X-ChatWorkToken: 自分のAPIトークン" -d "body=Buy+milk&limit=1385996399&to_ids=1%2C3%2C6" "https://api.chatwork.com/v2/rooms/{room_id}/tasks"

レスポンス

チャットに新しいタスクを追加

パラメータ

body
string 必須

タスクの内容

入力例

Buy milk

limit
integer

タスクの期限

Unix timeで入力してください

入力例

1385996399

to_ids
integer リスト 必須

担当者のアカウントID

担当者のアカウントIDをカンマ区切りで

※リストはカンマ区切りで複数の値を指定してください

入力例

1,3,6

GET/rooms/{room_id}/tasks/{task_id}

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/tasks/{task_id}"

レスポンス

タスク情報を取得

GET/rooms/{room_id}/files

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/files?account_id=101"

レスポンス

チャットのファイル一覧を取得 (※100件まで取得可能。今後、より多くのデータを取得する為のページネーションの仕組みを提供予定)

パラメータ

account_id
integer

アップロードしたユーザーのアカウントID

入力例

101

GET/rooms/{room_id}/files/{file_id}

curl -X GET -H "X-ChatWorkToken: 自分のAPIトークン" "https://api.chatwork.com/v2/rooms/{room_id}/files/{file_id}?create_download_url=1"

レスポンス

ファイル情報を取得

パラメータ

create_download_url
boolean

ダウンロードする為のURLを生成するか

30秒間だけダウンロード可能なURLを生成します

入力例

1