Endpoint: /rooms

Là Endpoint hiển thị toàn bộ chat như Group Chat, Direct Chat, My Chat. Có thể access vào Chat message, task, file, member information, Chat description.

GET/rooms

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms"

Response

Lấy list chat của mình

POST/rooms

curl -X POST -H "X-ChatWorkToken: API token" -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"

Response

Tạo Group Chat mới

Parameter

description
string

Chat description

Text giải thích description của Group Chat

Input Ex:

group chat description

icon_preset
string List

Icon types

Các loại icon trong các Group Chat

list giá trị đúng:

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

Input Ex:

meeting

members_admin_ids
integer List Required

Admin user

Mảng acount ID các user muốn set quyền Admin trong các member tham gia vào Chat đã tạo. Cần chỉ định ít nhất 1 người.

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

123,542,1001

members_member_ids
integer List

Member user

Mảng acount ID các user muốn set quyền Member trong các member tham gia vào Chat đã tạo

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

21,344

members_readonly_ids
integer リスト

Readonly user

Mảng acount ID các user muốn set quyền Readonly trong các member tham gia vào Chat đã tạo

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

15,103

name
string Required

Tên Group Chat

Tên Group Chat muốn tạo

Input Ex:

Website renewal project

GET/rooms/{room_id}

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}"

Response

Lấy thông tin Chat name, icon, Chat type (my/direct/group)

PUT/rooms/{room_id}

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

Response

Update icon, Chat name

Parameter

List
description
string

Chat description

Nội dung giải thích description của Group Chat

Input Ex:

group chat description

icon_preset
string 列挙

Icon type

Các loại icon trong Group Chat

List giá trị đúng:

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

Input Ex:

meeting

name
string

Tên Group Chat

Tên Chatcủa Group Chat

Input Ex:

Website renewal project

DELETE/rooms/{room_id}

curl -X DELETE -H "X-ChatWorkToken: API token" -d "action_type=leave" "https://api.chatwork.com/v2/rooms/{room_id}"

Response

Leave/Delete Group Chat

Parameter

action_type
string List Required

Rời nhóm? Xóa nhóm?

Nếu rời nhóm, tất cả các task do mình phụ trách và các file mình đã gửi sẽ bị xóa hết. Nếu xóa nhóm, tất cả các message, task, file của các member tham gia vào nhóm đều bị xóa hết. *Một khi đã xóa sẽ không khôi phục lại được!

list giá trị đúng:

leave, delete

Input Ex:

leave

GET/rooms/{room_id}/members

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/members"

Response

Lấy list member trong Chat

PUT/rooms/{room_id}/members

curl -X PUT -H "X-ChatWorkToken: API token" -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"

Response

Thay đổi đồng loạt các member

Parameter

members_admin_ids
integer List Required

Admin user

Mảng acount ID các user muốn set quyền Admin trong các member tham gia vào Chat đã tạo. Cần chỉ định ít nhất 1 người.

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

123,542,1001

members_member_ids
integer List

Member user

Mảng acount ID các user muốn set quyền Member trong các member tham gia vào Chat đã tạo.

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

21,344

members_readonly_ids
integer List

Readonly user

Mảng acount ID các user muốn set quyền Readonly trong các member tham gia vào Chat đã tạo.

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

15,103

GET/rooms/{room_id}/messages

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/messages?force=0"

Response

Lấy list mesage trong Chat. Nếu chưa chỉ định parameter thì kết quả sẽ chỉ trả về phần khác biệt với phần đã lấy trước đó.(Có thể lấy tối đa 100 mess)

Parameter

force
boolean

Không quan tâm đến việc chưa lấy, sẽ lấy 100 messages mới nhất?

Nếu set là 1 thì không quan tâm việc việc chưa lấy, sẽ lấy 100 messages mới nhất (Default là 0)

Input Ex:

0

POST/rooms/{room_id}/messages

curl -X POST -H "X-ChatWorkToken: API token" -d "body=Hello+ChatWork%21" "https://api.chatwork.com/v2/rooms/{room_id}/messages"

Response

Thêm tin nhắn mới vào Chat

Parameter

body
string Required

Message body

Input Ex:

Hello ChatWork!

PUT/rooms/{room_id}/messages/read

curl -X PUT -H "X-ChatWorkToken: API token" -d "message_id=101" "https://api.chatwork.com/v2/rooms/{room_id}/messages/read"

Response

Đánh dấu tin nhắn đã đọc

Parameter

message_id
string

Đánh dấu Read cho đến message của ID được chỉ định ở đây. Nếu tin nhắn đó đã đọc rồi sẽ báo lỗi(400).

Input Ex:

101

PUT/rooms/{room_id}/messages/unread

curl -X PUT -H "X-ChatWorkToken: API token" -d "message_id=101" "https://api.chatwork.com/v2/rooms/{room_id}/messages/unread"

Response

Đánh dấu tin nhắn chưa đọc

Parameter

message_id
string Required

Đánh dấu Unread kể từ messege của ID được chỉ định ở đây.

Input Ex:

101

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

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

Response

Lấy thông tin tin nhắn

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

curl -X PUT -H "X-ChatWorkToken: API token" -d "body=Hello+ChatWork%21" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

Response

Update message trong Chat

Parameter

body
string Required

Nội dung tin nhắn update

Input Ex:

Hello ChatWork!

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

curl -X DELETE -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/messages/{message_id}"

Response

Xóa tin nhắn

GET/rooms/{room_id}/tasks

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/tasks?account_id=101&assigned_by_account_id=78&status=done"

Response

Lấy list task trong Chat(*Có thể lấy tối đa 100 task. Dự định sau này sẽ cung cấp cơ chế Pagination để lấy nhiều data hơn)

Parameter

account_id
integer

Acount ID của người phụ trách task

Input Ex:

101

assigned_by_account_id
integer

Acount ID của người yêu cầu task

Input Ex:

78

status
string List

Status của task

list giá trị đúng:

open, done

Input Ex:

done

POST/rooms/{room_id}/tasks

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

Response

Thêm task mới vào Chat

Parameter

body
string Required

Nội dung task

Input Ex:

Buy milk

limit
integer

Kỳ hạn của task

Hãy nhập bằng Unix time.

Input Ex:

1385996399

to_ids
integer List Required

Acount ID của người phụ trách

phân cách các acount ID người phụ trách ra bằng dấu phẩy

*Hãy phân cách các giá trị trong list bằng dấu phẩy.

Input Ex:

1,3,6

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

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/tasks/{task_id}"

Response

Lấy thông tin task

GET/rooms/{room_id}/files

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/files?account_id=101"

Response

Lấy list các file trong Chat(*Có thể lấy tối đa 100 file. Dự định sau này sẽ cung cấp cơ chế Pagination để lấy nhiều data hơn)

Parameter

account_id
integer

Acount ID của user đã upload

Input Ex:

101

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

curl -X GET -H "X-ChatWorkToken: API token" "https://api.chatwork.com/v2/rooms/{room_id}/files/{file_id}?create_download_url=1"

Response

Lấy thông tin file

Parameter

create_download_url
boolean

Tạo URL để download ?

Tạo URL có thể doawnload chỉ trong 30 giây.

Input Ex:

1