2015年10月29日 星期四

ChatWork API 的 Endpoints 項目

  • このエントリーをはてなブックマークに追加
  • シェア

Endpoint:/me


           可以查看自己的個人資訊
  • GET/me查看個人情報

GET/me

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/me"
Response   
可以查看自己的個人情報



Endpoint:/me


　　　可以查看自己的工作狀態資料
  • GET/my/status查看自己的未讀訊息數量、未讀To訊息數量
  • GET/my/tasks        查看自己的工作總覽

GET/my/status

curl -X GET -H "X-ChatWorkToken: 您のAPI Token" "https://api.chatwork.com/v1/my/status"
Response 
查看自己的未讀訊息數量、未讀To訊息數量、未完成的工作數量

GET/my/tasks

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/my/tasks?assigned_by_account_id=78&status=done"
Response 
查看自己的工作總覽（※目前最多可讀取100件工作資料。未來預計推出分頁功能讓使用者讀取更多的資料）


參數
assigned_by_account_id

integer
工作交辦人的帳號ID
範例
78
status

string 列挙
工作狀態
有效的值一覽：
open, done
範例
done


endpoint:/contacts


可以查看自己的聯絡人總覽。
  • GET/contacts取得自己的聯絡人總覽

GET/contacts

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/contacts"
Response 
查看自己的聯絡人總覽

endpoint:/rooms


可以查看所有交談（包括群組交談、一對一交談、我的交談）的資訊。可讀取交談的任何訊息、工作、檔案、描述、成員等等資訊。
  • 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查看交談訊息總覽。
  • POST/rooms/{room_id}/messages於交談新增新訊息
  • GET/rooms/{room_id}/messages/{message_id}查看訊息資料
  • GET/rooms/{room_id}/tasks查看交談內工作總覽
  • POST/rooms/{room_id}/tasks於交談新增工作
  • GET/rooms/{room_id}/tasks/{task_id}查看工作資訊
  • GET/rooms/{room_id}/files查看交談內的檔案總覽
  • GET/rooms/{room_id}/files/{file_id}查看檔案資訊

GET/rooms

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms"
Response 
查看自己的交談總覽

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/v1/rooms"
Response 
建立群組交談
參數

description

string
交談描述
群組交談的描述說明文字
範例
group chat description
icon_preset

string 列舉
icon種類
群組交談的頭像種類
有效的值一覽：
group, check, document, meeting, event, project, business, study, security, star, idea, heart, magcup, beer, music, sports, travel
範例
meeting
members_admin_ids

integer 清單 必要
管理者權限的使用者
在參加交談的成員內，指定一位以上使用者賦予管理員權限，並排列其使用者帳號ID。
※若為多人請用逗號分隔。
範例
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 Token" "https://api.chatwork.com/v1/rooms/{room_id}"
Response 
查看交談的姓名、大頭照、種類(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/v1/rooms/{room_id}"
Response 
更新交談的姓名、大頭照
參數
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 Token" -d "action_type=leave" "https://api.chatwork.com/v1/rooms/{room_id}"
Response 
退出／刪除群組交談
參數
action_type

string 列舉 必要
退出或是刪除
若退出群組交談，於該群組交談內該員負責的工作以及上傳的檔案將會消失。
若刪除群組交談，該群組交談內所有訊息、工作、檔案將全部消失。
※一旦刪除將無法恢復。
有效的值一覽：
leave, delete
範例
leave

GET/rooms/{room_id}/members

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/members"
Response 
查看交談成員總覽

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/v1/rooms/{room_id}/members"
Response 
一次變更交談成員
參數
members_admin_ids

integer 清單 必要
管理者権限的使用者
作在參加交談的成員內，指定一位以上使用者賦予管理員權限，並排列其使用者帳號ID。
※若為多人請用逗號分隔。
範例
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 Token" "https://api.chatwork.com/v1/rooms/{room_id}/messages?force=0"
Response 
查看交談訊息總覽。若未指定參數將僅回應與上次呼叫取得資料的差異之處。(最多可查看100件資料)
參數
force

boolean
是否查看最新的100件資訊
若參數指定為1，將不論已存取與否查看最新的100件資訊（預設值為0）
範例
0

POST/rooms/{room_id}/messages

curl -X POST -H "X-ChatWorkToken: 您的API Token" -d "body=Hello+ChatWork%21" "https://api.chatwork.com/v1/rooms/{room_id}/messages"
Response 
於交談新增新訊息
參數
body

string 必要
訊息內容
範例
Hello ChatWork!

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

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/messages/{message_id}"
Response 
メッ

GET/rooms/{room_id}/tasks

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/tasks?account_id=101&assigned_by_account_id=78&status=done"
Response 
查看交談內工作總覽（※目前最多可讀取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 Token" -d "body=Buy+milk&limit=1385996399&to_ids=1%2C3%2C6" "https://api.chatwork.com/v1/rooms/{room_id}/tasks"
Response 
於交談新增工作
參數
body

string 必要
工作內容
範例
Buy milk
limit

integer
工作期限
請以Unix的時間格式輸入
範例
1385996399
to_ids

integer 清單 必要
負責人的帳號ID
請使用逗號分隔負責人的帳號ID
※若為多人請用逗號分隔。
範例
1,3,6

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

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/tasks/{task_id}"
Response 
查看工作資訊

GET/rooms/{room_id}/files

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/files?account_id=101"
Response 
查看交談內的檔案總覽（※目前最多可讀取100件工作資料。未來預計推出分頁功能讓使用者讀取更多的資料）
參數
account_id

integer
上傳者的帳號ID
範例
101

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

curl -X GET -H "X-ChatWorkToken: 您的API Token" "https://api.chatwork.com/v1/rooms/{room_id}/files/{file_id}?create_download_url=1"
Response 
查看檔案資訊
參數
create_download_url

boolean
是否產生下載檔案專用URL
產生下載檔案的專用URL，該URL僅保留30秒
範例
1

【相關資料】
ChatWork使用導引
API認證方法
Endpoints (資料傳輸接點)
ChatWork表示法
RAML

カテゴリー:

  • このエントリーをはてなブックマークに追加
  • シェア