外部サービスとの連携などにご利用いただける「Chatwork API」をバージョンアップいたしました。
今回のバージョンから新規に追加された機能や、仕様変更点についてお知らせいたします。
【目次】
コンタクト承認依頼APIを追加しました
今回のバージョンアップで、「コンタクト承認依頼」の情報へアクセスできるエンドポイントを追加いたしました。
「コンタクト承認依頼」に関する以下の機能をご利用いただけます。
- 自分に対するコンタクト承認依頼一覧を取得する
- 自分に対するコンタクト承認依頼を承認する
-
自分に対するコンタクト承認依頼をキャンセルする
コンタクトを自動承認するbotの作成などに便利ですので、ぜひご活用ください。
エンドポイントの仕様については「Chatwork APIドキュメント」をご確認ください。
バージョン更新と今後のサポートについて
今回のバージョンアップにともない、Chatwork APIのバージョンがv1からv2に変わります。
v2では以下の仕様変更点がありますので、どうぞご注意ください。
■バージョンアップにともなう変更点
・エンドポイントのベースURIの変更
エンドポイントのベースURIが変わります。
https://api.chatwork.com/v1 → https://api.chatwork.com/v2
・message_idのデータ形式の変更
各エンドポイントのレスポンスに含まれるmessage_idのデータ形式が、数字型から文字列型に変わります。
取り扱うメッセージデータの増加にともない、今後、message_idの桁数がInt型の限界である2147483647を超えることが予想されるため、
v2では、より大量のデータを扱えるよう、message_idのレスポンスを64bitの整数となる文字列型に変更いたしました。
レスポンスの内容が変わりますので、各言語やデータベースでの取り扱いにどうぞご注意ください。
【レスポンス例】
v1
v2
【レスポンスにmessage_idを含むエンドポイント】
- GET /my/tasks
- GET /rooms/{room_id}/messages
- POST /rooms/{room_id}/messages
- GET /rooms/{room_id}/messages/{message_id}
- GET /rooms/{room_id}/tasks
- GET /rooms/{room_id}/tasks/{task_id}
- GET /rooms/{room_id}/files
- GET /rooms/{room_id}/files/{file_id}
バージョン移行期間について
v1からv2への移行期間として、下記の停止日まではv1を引き続きご利用いただけます。
上記の停止日以降は、v1でのアクセスはできなくなりますので、
Chatwork APIをご利用中のお客様は、お早めにv2へ移行いただきますよう、お願いいたします。
本件についてご不明点などがありましたら、下記お問い合わせページよりお問い合わせください。