ChatworkのAPIを使ってメンバーに自動で通知する
チャットワーク
より効率的な意思伝達を可能にしてくれるChatworkのAPI。
Chatworkを社内や社外との連絡で活用するために、Chatwork内に用意されているAPIの機能を利用することができます。
この記事では、どんな業務で役立てることができるか、どんな環境が必要かを解説します。
チャットワークAPIが使えるシーン
投稿監視通知
オウンドメディアなどを持っていると、投稿されたコメントのメンテナンスに時間を取られてしまいがちです。
たとえば、NGワードなどを登録しておいて、自動で通知が来るように設定しているというケースが考えられます。
その場合メーリングリストのメンバーに一斉に送信して、そのメンバーのうちの対応可能な人がコメントのメンテナンス対応に取りかかる、というフローが一般的です。
ただこれだと、だれが対応しようとしているか、いつ頃対応可能か、対応が完了したかなど、連携したい情報をすべてのメンバーで瞬時に共有することができません。
ChatworkのチャットルームにAPIでNGワード通知メッセージを自動で投稿するようにすると、そのチャットルームのメンバーすべてに通知が瞬時に送信されます。
そしてその通知メッセージが投稿されたチャットルームに、メンテナンス対応するメンバーが対応を開始する旨の投稿を送ることができます。
投稿によって、すでに誰かが対応を開始しているということを他のメンバーが知ることができます。
これにより、複数のメンバーがメンテナンス対応のために手を止めてしまうといった事態を防ぐことができます。
また、どのような対応をしたのかも同じチャットルームに記録するようにしておくと、複数の担当者で同じような対応が可能となります。
障害監視
サーバーの障害監視やWEBサイトの稼働確認など、監視業務を複数人のチームで対応するというケースでも、ChatworkのAPIを導入すれば効率アップが可能です。
投稿監視の場合と同じようなフローを持たせて、メーリングリストで通知していたものをChatworkのメンバーに一斉に伝えればOKです。
定型文管理
Chatworkを使ってチームを管理する際に、同じ文章を何度も送らないといけないということも多いことでしょう。
メモ帳アプリなどに定型文を記録しておいて、コピーアンドペーストをしてメッセージをつくっているという方も多いのではないでしょうか。
しかしそうすると、宛先の名前を書き足すなど修正の必要があり、間違ったメッセージを送ってしまう原因にもなりかねません。
Chatworkのメッセージの定型文をつくるプログラムとAPIを使って連携させると、文章の組み合わせを状況に合わせてプログラムでつくれるようになります。
たとえば、進捗を確認したいというメッセージを送りたい場合は、宛先の名前と進捗確認の定型文の2点を選択すればOK。
生成後は、APIを通してChatworkのチャットルームにメッセージが投稿されます。
チャットワークのAPIの準備
API使用を申請する
では、どうすればChatworkのAPIを利用することができるのでしょうか。
まずAPIでやり取りをするアカウントで、API使用を申請する必要があります。申請すると、数日で使用OKのメールが送られてきます。
トークンを取得する
ChatworkのアプリのAPI設定の中に、APIトークンを確認するページがあります。
APIのプログラムを正しく動作させるためには、ここで確認できたAPIトークンの情報を常に通信に含める必要があります。
APIトークンの情報だけでChatworkのAPIが自由に使用可能となるので、絶対に第三者に知らせないようにしましょう。
なおトークンは再発行することができます。もし、第三者に知られてしまった可能性があるなら、再発行をしましょう。
その際は、すでに構築されたプログラムに登録されているトークンも、すべて新しいトークンに変更する必要があります。
エンドポイントと記法を理解する
APIのエンドポイントへの通信によって、情報を受け取ったり送ったりすることが可能です。
たとえば、チャットルームにメッセージを投稿する場合、「https://api.chatwork.com/(バージョン)/rooms/(投稿するチャットルームのID)/messages」にPOST通信を送ります。
なお、「バージョン」は、Chatworkの都合によって都度変更される可能性があります。都度確認しておきましょう。
また、通信のヘッダー情報の内容に先ほど取得したトークンの情報を含めることも忘れずに。
チャットワークのAPIの開発環境
PHPとサーバーの定時実行プログラム
APIを送信するプログラムの開発のための環境について解説します。
PHPプログラマがいるならPHPプログラムをWEBサーバーに設置、CRONなどのサーバーの定期実行プログラムを通して、自動的に実行されるように設定できます。
ほんの数十行のPHPプラグラムだけで自動的にメッセージを送信することが可能となります。
GASを使って開発する
最近注目されているのが、サーバー構築などの手間を省けるGoogleのGAS(Google Apps Script)です。
これを利用することで、Googleドキュメントやスプレッドシートの中にプログラムを仕込んでおくことができます。
JavaScriptがベースになっている言語なので、プログラマーでなくてもコードを書くことができます。
ある程度自由に定期実行を設定することも可能で、自動でAPIを通してメッセージを送ることもできます。
使用の際はGoogleドライブから、新規作成でGASプログラムを作成します。
なお事前準備として、GASをアプリとしてGoogleドライブに登録する必要があるかもしれません。
GASファイルをつくったら、PHPと同じようにエンドポイントに通信を送るコードを書くだけで、APIプログラムが完成します。
まとめ
プログラムをコーディングするのは、最近ではだいぶ身近になってきています。
Chatworkをより効率的に利用するには、APIプログラムを用いた高度な使い方が求められるでしょう。
良好なコミュニケーション環境により業務成果を向上すれば、ライフワークバランスを向上させることができ、生活全体もより充実したものにすることができるでしょう。
Chatwork連携でオフィスDXを進めましょう!
・リモートワーク環境が整わず、出社しなければいけない従業員がいる
・社内をフリーアドレスにしたいけど移行できずにいる
・来客対応がアナログなまま効率化できてない
・経団連が発表した「来訪者履歴」が自動で取れていない
・Chatworkをベースに効率化をしていきたい
などの課題があれば、RECEPTIONISTで即解決しましょう!