みなさん、こんにちは！
現役エンジニアの”ます”です。
今回はチャットワークが提供するChatwork APIで何ができるのかを紹介していきます。
この記事を読んでいるみなさんは業務でチャットワークをご活用の方でしょうか？
また、その業務を効率化、自動化したいと思われているのではないでしょうか？
Chatwork APIではそれらの効率化/自動化を容易に行える機能が揃っております。
本記事ではそのChatwork APIの機能の一覧をご紹介し、何ができるのかをご紹介いたします。
APIとは
APIとはApplication Programming Interfaceの略で、サービスの提供側と利用者とであらかじめ決まった「型」のやりとりをするで細かなプログラムを書かずとも便利な機能を活用することができるサービスのことです。
これまで手動で実行していたあらゆる操作を自動で実行できるようになります。
APIはサービスによって特徴が大きく異るため、各サービス提供元のドキュメントを読み解く必要があります。
今回紹介するChatworkでもこのAPIが用意されており、こちらのサイトに公式が詳しく掲載しています。
では、Chatwork APIでは何ができて何ができないのかを細かくみていきましょう。
Chatwork APIでできること
APIの中には使える機能に制限がかかっていたり、有料でないと使えないものも多く存在します。
その中でChatwork APIは非常に良心的かつ使える機能も多いです。
まずはChatwork APIでできることの一覧です。
- 自分自身のアカウント情報を取得
- 自分の未読数、未読To数、未完了タスク数を返す
- 自分のタスク一覧を取得する
- 自分のコンタクト一覧を取得
- 自分のチャット一覧の取得
- グループチャットを新規作成
- チャットの名前、アイコン、種類(マイチャット、個別チャット、グループチャット)を取得
- チャットの名前、アイコンをアップデート
- グループチャットを退席/削除する
- チャットのメンバー一覧を取得
- チャットのメンバーを一括変更
- チャットのメッセージ一覧を取得
- チャットに新しいメッセージを追加
- メッセージを既読にする
- メッセージを未読にする
- メッセージ情報を取得
- チャットのメッセージを更新する
- メッセージを削除
- チャットのタスク一覧を取得
- チャットに新しいタスクを追加
- タスク情報を取得
- タスク完了状態を変更する
- チャットのファイル一覧を取得
- チャットに新しいファイルをアップロード
- ファイル情報を取得
- 招待リンクを取得する
- 招待リンクを作成する
- 招待リンクの情報を変更する
- 招待リンクを削除する
- 自分に対するコンタクト承認依頼一覧を取得する
- 自分に対するコンタクト承認依頼を承認する
- 自分に対するコンタクト承認依頼を拒否する
多くの機能が実装されていることがわかります。
それぞれの機能にエンドポイントが用意されており、どのようなパラメーターを渡すべきかも公式ドキュメントに記載されているため、簡単に利用することができます。
エンドポイントとは？
APIにおけるエンドポイントとは末尾のURLのことです。
APIを利用する際はネットワーク通信を行っていきます。API側で利用したい機能に対してそれぞれのエンドポイント、つまり、URLが指定されております。
API利用に対するベースURLを用いて末尾のURLを調整することでどのような機能を使いたいか選ぶことができます。
例えばChatwork APIのベースURLはhttps://api.chatwork.com/v2/ですが「me」を足してhttps://api.chatwork.com/v2/meといったURLにパラメーターを付与してアクセスすることで自分自身のアカウント情報を取得の機能を使うことができるのです。
オススメの活用法
チャットワークを業務や副業で活用している方も多いでしょう。
定型文での連絡や繰り返し作業が発生する場合はChatwork APIを活用した自動化/効率化がおすすめです。
本サイトではChatwork APIを活用した便利機能の開発を解説しております。
下記の記事ではGoogle Apps Scriptを用いた無料で簡単なChatwork APIの利用方法を記載しておりますので、ぜひご参考にしてみてください。
また、ライブラリを使わない方法も紹介しております。
「チャットワークに自動送信予約をしたい」、「Googleフォームの回答内容をチャットワークに通知したい」といった機能に興味があれば一度除いてみてください。
筆者もチャットワークとGoogle Apps Scriptをかけ合わせて収益化しております。
ぜひコチラの記事もご参照ください。
Chatwork APIでできないこと
現時点でChatwork APIでできないこともございます。
例えば、有料プランで組織のグループを操作したい場合です。
こちらはChatwork APIの中には含まれておらず、グループを自動で管理することができません。
また、リアクションの管理もAPIに含まれておらず自動化することはできません。
リアクション機能は非常に便利ではありますが、Chatwork APIにリアクションの処理は存在しないため、手動での実行となります。今後に期待ですね！
まとめ
今回はChatwork APIでできることの解説を行ってまいりました。
チャットワークを業務で使っている方はどのようなことができるのか知っていただけたのではないでしょうか。
それぞれの機能の具体的な実行方法に関してはこれから記事にしていきますので、
ぜひ当サイトの他の記事もご参照いただけましたら幸いです。
以上、最後までお読みいただきありがとうございました。