#chatworkapi

昨今流行りの IoT。 ものとインターネットをつなげて云々…

IoT とひとくちに言ってもいろいろあります。 その中でも自動車や家電とインターネットをつなげた、製品として開発されているものであれば、見たり耳にすることがよくあると思います。

また、最近では手頃に入手できて、簡単に取り扱えるセンサー類や、WiFi を搭載したマイコンボードなどもあるので、趣味の範囲でインターネットと何かをつなげたデバイスを作ることもできます。

そこで、この記事では、私、フロントエンドチームの西口が趣味として作ったガジェットの一例を、チャットワーク社のクリエイターズブログということで、そのガジェットとチャットワークをつなげてみた、というお話をご紹介していきます。

コミュニケーション効率化による生産性アップだけがチャットワークじゃない

チャットワーク の利用目的のメインは言わずもがなビジネスコミュニケーション。 社員同士や取引先などとのやり取りに使うことでコミュニケーションコストを抑え、生産効率を上げることです。

しかし、チャットワーク の活用方法はそれだけには留まりません。 先ほど言ったように、ものとチャットワークをつなげることで、チャットワーク 活用の幅をさらに広げることができるのです。

ものとチャットワークをつなげると言っても…

でも、実際にどういうものを作れば活用範囲を広げられるのか、なかなか見当がつかないと思います。

そういう時は、日常業務のなかで、そこで働くみんながどういったことで困っているのかを観察してみることです。そうすると何かヒントを見つけられることがあります。

例えば、弊社では社内の備品管理をチャットワークのグループチャットでおこなっています。

備品がなくなれば、最後に使った人がそのチャットで担当者に購入依頼のタスクを振る、といった具合です。

ですが、購入依頼をするところは人力のため、本来の業務が忙しかったりで、どうしても忘れてしまうことがあり、それは仕方がありません。

では、この依頼タスクを振る部分をどうにか自動化できないか？？ こういったきっかけがヒントになり、ガジェット開発につながっていきます。

備品購入依頼を自動化するガジェット

これで、どういうものを作れば良いかが見えてきました。 では、次にそれをどんな仕組みで実現していくのかを考えていきます。

今回は、備品が少なくなってきたら購入依頼をチャットワークに送信する、ということが処理できるものです。

タスクをチャットワークに送信するのは チャットワーク API でできそうなので、メインで考えることは、備品の在庫が減ってきたことをどう知るかと言う部分になります。

その方法は幾つかあると思いますが、今回は一番シンプルな備品の重さによる方法にしました。 重さを採用した理由には、購入依頼処理を実行する閾値を調整するだけで、あらゆる備品に対応できそうかな、という期待もありました。

技術とガジェットの構成を検討する

デジタル体重計をハック

仕組みのアイデアが揃ったので、次は重さをどういう技術で検出するかの検討が必要になります。

まずはじめに考えたのが重さ（圧力）センサーでした。

数百円で売られているのでコスト的には魅力ですが、検出できる重さの範囲が狭く、重量のある備品には向かなそうなので、諦めました。

次の候補はキッチンスケール。 ということで、ネットでいろいろ検索してみましたが、キッチンスケールも数Kg程度まで量れるものしかなく、備品の重さ検出には使えなさそうでした。

キッチンスケールよりも計測範囲の広いものということで、次に検討したのがデジタル体重計でした。

1,000円弱と重さセンサーよりは高価になりますが、手が出ない程でもなく問題のない範囲です。ということで、今回はデジタル体重計を使うことに決めました。

ESP-WROOM-02 安価のWiFiモジュール

重さ検出にデジタル体重計を使うことが決まりましたが、検出した重さをゴニョゴニョしてチャットワークとつなげる、ガジェット全体の構成を決めなくては、実際の開発に進むことができません。

大まかな構成としては、重さをはかるデジタル体重計と、その重さを入力として処理し、チャットワーク API と通信をおこなうマイコン部分のふたつになります。

この構成では、マイコン部分でチャットワーク API との通信が必要になり、ネット接続が要件として挙がってきます。

そこで候補になるのが、WiFi 内蔵、そして、個人的に以前から使っていた Arduino プログラムが書き込める ESP-WROOM-02 という Wifi モジュールです。

ESP-WROOM-02 というのは Espressif Systems 社から出ている WiFi チップ ESP8266EX をベースにした WiFiモジュールになります。特徴としては…

Arduino IDE で開発でき、Arduino プログラムを書き込める

GPIO や AD コンバータなどの多種のインターフェースを搭載している

コンパクトなサイズ

技適取得済みなので、日本でも問題なく使える

などなど。

Arduino UNO などのように USB ケーブルでパソコンと接続してすぐにプログラムを書き込む、ということができないので若干使いづらい点はありますが、プログラムの書き込み方法はネットで簡単に見つけられるので心配なしです。

そして、600円程と気軽に初められる価格のメリットもあり、このESP-WROOM-02 を使うことにしました。

実際に運用してみる

そんなこんなでできあがった備品管理ガジェット！（一気にスッ飛んだ感がありますが…）

実際にオフィスで運用してみます。 依頼漏れが比較的多かった、お客さまにお出しするペットボトルのお茶の在庫管理をすることにしました。

一時間に一回、計測したお茶ケースの重さをチャットに送信します。 業務時間中は、お茶を取り出したり、箱を整理したりで計測値の変動が考えられますので、購入依頼をかけるのは業務開始前の朝8時台に計測した時だけにしました。

また、一度購入依頼を出した後は、リセットボタンを押すまでは再度依頼しないように、依頼重複を防止する処理もいれました。

と言う動きを期待していますが、実はまだ運用開始より日が浅く、購入依頼はまだ出されていません…。

しばらく一時間に一度のメッセージをモニタして、きちんと計測できているか様子を見ようと思っています。 在庫が少なくなってきた時に無事に発注タスクがチャットワークに投稿されれば大成功！

まとめ

体重計をハックして備品の購入依頼を処理するガジェットを作ってみました。

それまで人力で処理していた備品の購入依頼を自動化することができました。

つまり言い換えると、備品発注依頼という雑務に割かれていた時間が必要なくなり、その分本来の業務に各自のリソースを集中させることが可能になったということです。

このように、ちょっとしたアイデアからチャットワークの活用範囲を広げられる結果につなげられました！

今回は、記事が長くなりそうだったので、ガジェットの作成やプログラミングといった開発部分の話を端折りましたが、それらはまた別の機会に開発編として記事を書こうと思います。（乞うご期待！）

1年ぶりに記事を書きます。Web開発部のチバです。

この記事は ChatWork Advent Calendar 2014 の 22 日目の記事です。 みんないろいろ為になる記事を書いてて、プレッシャーを感じつつ、そのプレッシャーに押し潰された形でこの記事を書いています。

総務部の早乙女さん

わたしが今日みなさんに紹介したいことは便利な情報やツールの事ではありません。総務部の早乙女さんのことです。

はい。誰なの。それをこれから説明します。

早乙女さんは総務部と言われている組織に所属している58歳のおじさんです。 チャットワークを使って色々と面倒なことをやってくれます。 最近パソコンを使い始めたばかりでまだ操作に慣れていないので今は出来ることは少ないですが、お願いした事をお願いした通りにやってくれます。(例外もあります)

何をしてくれるの

早乙女さんにお願いをすると、特定の誰かをを既存のグループチャットに一括で追加してくれます。 新入社員の入社時などにお願いをするといいと思います。 （最近やっとこの操作を覚えたところらしいので、残念ながら今のところこれしかできません）

どうやってお願いするの

早乙女さんは日本語がわかりません。なので専用のツールを使ってお願いをすることになります。

ライブラリのダウンロード

早乙女さんへのお願いをするための専用ツールは無いのですが、簡単にお願いをすることが出来るライブラリを早乙女さんが作ってくれています。 このライブラリを使ってツールは自分で作ってください。（もちろんこのライブラリを使わなくても早乙女さんへの依頼をすることは可能です） そして、どのような形でお願いをしたとしても早乙女さんへ届きます。

chatwork-saotome

使用上起きた問題についての責任は負いかねます。ご自身の責任でお使いください！！！

依頼者は誰なのか

早乙女さんは依頼者が誰なのかをとても気にします。 早乙女さんはAPIトークンを使って依頼者が誰なのかを判別します。これがわからないと早乙女さんはとても困ります。なので必ずAPIトークンを用意しておきましょう APIトークンの取得方法についてはChatWorkのAPIドキュメントをご参照ください

// 早乙女さんにAPIトークンを伝える $saotome = new Saotome('YOUR_API_TOKEN');

誰を追加するかを選ぶ

APIトークンを早乙女さんに伝えたら、次は誰を追加したいのかを早乙女さんに伝えなければいけません。 そこで、早乙女さんにお願いをして、コンタクト一覧を出してもらいましょう。（早乙女さんは日本語がわからないのでJSONという形式で一覧を返してくれます。）

コンタクト一覧全てを取得したい場合

$contact_list = $saotome->getContacts();

同じ組織に属しているコンタクトのみを取得したい場合

$contact_list = $saotome->getContacts(true);

コンタクト一覧が取得できたら追加したい人を選択しましょう。 ここで注意して欲しいのですが、早乙女さんは日本語がわかりませんので、account_idで伝えましょう。

// アカウントIDを伝えるためにメモをする $account_id = ACCOUNT_ID;

どこに追加するかを選ぶ

誰を追加するかを選んだ後は、どこに追加するかを選びます。 自分が「管理者」になっている「グループチャット」の一覧を用意してもらいましょう。（早乙女さんは日本語がわからないのでJSONという形式で一覧を返してくれます。）

// 早乙女さんにグループチャット一覧の作成をお願いする $room_list = $saotome->getRooms();

早乙女さんが用意してくれたグループチャット一覧から追加したいグループチャットと、追加する際にどの権限で追加するかを選びます。 選び終わったら、早乙女さんがわかりやすいようにグループチャットのIDと権限をこのような形にまとめておきます。

// 追加したいチャットのIDと権限をメモ $rooms = array( ROOM_ID => 'admin', ROOM_ID => 'member', ROOM_ID => 'readonly', : : ROOM_ID => 'admin or member or readonly', )

お願いする

誰をどこに追加するのかが決まれば後はお願いをするだけです。 心を込めてお願いしましょう。その想いはきっと早乙女さんに届きます。

先ほどメモをしたaccount_idとグループチャットを早乙女さんに伝えます。

// 誰をどこに追加するのかを伝える $results = $saotome->append($account_id, $rooms);

注意点

あなたが管理者として登録されているグループチャットにしか追加できません

既に登録されているチャットには登録できません

これらの場合、早乙女さんでは判断が難しいため処理してくれませんが、「なぜ私は処理しなかったのか」ということをこのような形で教えてくれます。

array( // 追加に成功 'success' => array( ROOM_ID => 'admin', ROOM_ID => 'member', ROOM_ID => 'readonly', ), // 追加に失敗 'failure' => array( ROOM_ID => 'admin', // 既に管理者として登録されている ROOM_ID => 'member', // 既にメンバーとして登録されている ROOM_ID => 'readonly', // 既に閲覧飲みのメンバーとして登録されている ), )

以上で早乙女さんについての説明は終わりです。

よくある質問

早乙女さんへの依頼とコツについて

記者 早乙女さんへの依頼が何回成功したのかと、依頼のコツについて何かあれば教えてください チバ まず早乙女さんへの依頼については私自身、すでに200回以上成功しています。コツは先ほどご説明した通りの手順を行うだけで特にありません。

早乙女さんは本当にいるのか？

記者 ここ一番大事なところですので、改めて聞かせてください。早乙女さんはいるんでしょうか、いないんでしょうか チバ 早乙女さんはいまぁす。 記者 今のご説明はソースコードにも書かれているのでしょうか チバ はい、第三者が見た時に充分な記載になっているかどうかはわかりませんが、私はトレース出来るレベルで書かれております。

ソースコードを公開する気は？

記者 先ほど質問がでましたけど、お持ちのソースコードというのを公開されるお考えがあるのかをイエスノーで言うとどうなのか。理由もあわせてお聞かせいただけますでしょうか？ チバ ソースコードにつきましては、私個人のアカウントで作成したGithubのリポジトリがございますので、こちらをご参照頂けたらと考えております。理由は特にありません。 記者 ソースコードのリポジトリのURLを教えて下さい チバ こちらになります。chatwork-saotome

最後に

こんにちは！Web開発部の渋谷です。

この記事は ChatWork Advent Calendar 2014 の 18 日目の記事です。

先日、待望されていたメッセージ取得APIがリリースされましたね！ メッセージ取得API ドキュメント

メッセージ取得APIが使えるとBotが作れたりと、夢が広がりますね 社内では、特定のBotアカウントへ「なに」と発言するとオフィスで流れている曲名を教えてくれるBotが作られたりと、おもしろいものが作られています

通知アプリ ChatWork Notifier

そこで今回は、チャットワークをブラウザで開いていなくても通知を受け取れる通知アプリ ChatWork Notifier を チャットワークAPIを利用して作成しました！

「チャットワークをブラウザで開くのを忘れて、メッセージに気付けなかった」などの声があったりしますので、解決の手助けになれば幸いです。

ちなみに、ChatWork NotifierはChromeアプリとして作成しました。

Chromeアプリとは？

Chromeアプリ は Chromeブラウザを開いていなくても起動することが出来るクラウドベースのアプリです。

Chromeを開かなくても使えることや、Mac,Windows,ChromeOS(!) でも使えるクロスプラットフォームなところなどがなかなかいけてますね

詳しくは Google、デスクトップアプリのように使える「Chromeアプリ」を発表 などを参照ください

使い方

インストール

Chromeブラウザで Chrome ウェブストアのアプリページへアクセス

https://chrome.google.com/webstore/detail/haedjkfbplpnlmlohhjhnhplcnljbnel ※ Chromeブラウザをインストールしていない人はインストールしてください

インストール

アプリランチャーから起動

通知設定

APIトークンを取得して、入力

APIトークンの取得方法はこちら

特定のチャットの通知だけ受け取りたい、そんな時

通知を受け取りたいチャットのIDをカンマ区切りで「通知対象のチャットID」へ入力してください チャットURLの末尾にある #!rid 以降の数字がそれです。（#rid90 だったら 90 を入力）

ログイン時に開く設定をしていくと便利かも

Chromeアプリはログイン時に開くなど設定が出来るみたいです。

・・・が、ログイン時に自動で開いてくれないみたい？(；´∀｀)

どんな感じに通知が来るか

こんな感じにデスクトップに通知がされます

動作保証について

使い方を説明してきましたが・・・このアプリの動作保証はできません。ごめんなさい！ 紹介したアプリは自己責任においてインストール、ご利用ください。

※下記環境において検証中、Chromeのデスクトップ通知が完全に沈黙する現象が確認されています

OS X Yosemite Chrome 39.0.2171.95

最後に

毎日チャットワークを開いてくれている方々にはあまりメリットないかもしれませんが、、 日頃、チャットワークを開くのを忘れがち、通知来てから開きたい という人にはきっと役立つと信じています！

こんにちは！アプリケーション開発部の安宅 (あたか) と申します。 ChatWork Advent Calendar 2014 の 2 日目を担当します。

お仕事はチャットワークの iOS アプリ開発です。現在、黙々と開発中です

さて、本日はチャットワークの API (現在プレビュー版を公開中！) を使ったクライアント・アプリを一つ紹介します。

ChatWork for Emacs

私が個人プロジェクトで作っている chatwork.el です。

github.com/ataka/chatwork

チャットワークにはタスクを管理したり、ファイル・ストレージとして活用したり、ビデオ・チャットができたりと、業務をスムーズに回すための仕組みがありますが、この Emacs 用チャットワーク・クライアントはまだメッセージの送信しかできません。

機能は限定的ですが、Emacs ユーザーに少しでも楽になってもらえれば幸いです。もちろん、私がこの機能が欲しかったのは言うまでもありません

簡単ですが、デモ・ムービーを作りました。40 秒の短いデモです。 まず画面下を見てください。ミニバッファから一行メッセージを送信しています。送信先 (ルーム) は補完入力が可能です。 動画の後半はリージョンを指定して、複数行のテキストを送信しています。送信先は「マイチャット」。他人と共有しないメモやタスクを置ける、自分専用のルームですね。

インストール

chatwork.el は MELPA に登録されています。Emacs 24 以降であれば Emacs 標準のパッケージ・システムを使ってインストールが可能です。

もし、Emacs のパッケージ・システムを使ったことがなければ、.emacs.d/init.el に次のコードを追記します。

M-x package-list-packages を実行すると、パッケージ一覧が表示されます。

i でインストール・マークを付け、x で実行してみましょう。パッケージのダウンロードからインストールまで、Emacs が全部やってくれます。

最後に設定です。.emacs.d/init.el に ChatWork API トークンを設定します。ChatWork API トークンの取得方法は過去記事「チャットワークAPIを限定プレビュー公開します！」及び認証方法をご覧ください。

これで chatwork.el を使う準備ができました

chatwork.el を使う

現在、chatwork.el には 2 つのメッセージ送信コマンドがあります。

chatwork-send-message

chatwork-send-message-in-region

好みに合わせて使い分けます。

chatwork-send-message

一行メッセージを送信するコマンドです。

M-x chatwork-send-message

実行すると、ミニバッファに Message: とメッセージの入力が促されます。

メッセージを入力したら、送信先 (ルーム) の指定です。Room: と出てくるので、ルーム名を入力します。この時、ルーム名の入力には補完入力が使えます。TAB キーを押してみましょう。 もし、前回と同じルームへメッセージを送りたいなら、ルーム入力時に M-p と打ちます。以前に入力されたルーム名が表示されます。

chatwork-send-message-in-region

予め範囲 (リージョン) で囲ったテキストをメッセージとして送信するコマンドです。

テキストをリージョンで囲んだ後、コマンドを実行します。

M-x chatwork-send-message-in-region

メッセージは選択済ですので、送信先 (ルーム) を指定するだけです。ルームの指定方法は chatwork-send-message と同じです。

メッセージを選択する時、M-x mark-paragraph コマンドを使うと段落を簡単にリージョンで囲えるので便利です。C-x C-x でカーソルの位置をリージョンの先頭から末尾へ、もしくはリージョンの末尾から先頭へ入れ替えられることも覚えておくと、リージョン指定の自由度が高まります

まとめ

以上、できたてほやほやの chatwork.el を紹介しました。

chatwork.el は外部プログラムに依存しないように作ってあります。ネットワーク接続には url.el を (Emacs 24.4 から導入された Emacs 上のウェブ・ブラウザー eww でも使われていますね！)、JSON の解析には json.el を使っています。 そのため、新しめの Emacs でないと動きません。Emacs 20 系をまだ使っていたら、ごめんなさい

その代わりと言ってはなんですが、Emacs 単体でチャットワークにメッセージを送れるというメリットがあります。

chatwork.el はまだまだ未熟なプログラムです。To の補完入力、タスクの作成、ファイルの送信などなど未実装な機能が数多くあります。

先月末、私たちはメッセージ取得 API を公開しました。

メッセージ取得 API を使えば、Emacs 上でメッセージ一覧を取得することも可能です。メッセージが取得できれば、返信や引用もできるようになるでしょう。chatwork.el の開発を温かい目で見守って頂きたく存じます。

みなさん、こんにちは。技術部の小崎です。 ついにChatWorkに待望されていたメッセージAPIが公開されました！！

ご意見・ご要望の公開フォーラム、メッセージ取得API、ChatWork広告 販売開始などアップデート情報！

この機能を待っていた方は多いのではないのでしょうか。 私もその一人で、このAPIが公開されたら必ずやろうと思っていたことがありました。

そう「伺か」です。

伺かがわからない方はこちらを参照してください。

伺か - wikipedia

準備

ChatWork Message APIと伺かをつなげるのに以下のものが必要になります。

ChatWorkのアカウント（API有効化済み）

伺か（SSP）

fluentd + fluent-plugin-sstp

curl

jq

Googleで「アプリケーション名　OS」で検索するとインストールの仕方を説明したページが、詳しいインストールの仕方はそちらを参考にしてください。

構成

伺かとAPIを繋ぐのにfluentdを中継クライアントとして使います。

これは伺か自体にはAPIを叩く機能がないため、fluentdでAPIを叩き、その結果を伺か専用プロトコルのSSTPに変換してメッセージを渡して上げる形になります。 一見難しそう・・・と思えるかもしれませんが、fluentd自体にAPIを叩く機能と、受け取った結果をSSTPに変換する機能があるので簡単に設定することができます。

fluentdは優秀な伺か中継クライアントなのです。

ChatWork Message APIとfluentdをつなげる

ChatWork Message APIをつなげるのにfluentdのexecインプットプラグインを使います。 execインプットプラグインでは好きなコマンドを定期実行して、fluentdに取り込むことができます。

<source> type exec command cmd arg arg format json tag k1 run_interval 10s </source>

上記のように指定するとcommandに指定したcmd arg argを10秒間隔で実行し、タグをk1としてfluentdに取り込みを行います。 つまり、commandにChatWork Message APIを実行するコマンドを指定すればfluentdにメッセージを取り込むことができます。 ChatWork Message APIの定義に合わせてHTTPリクエストを送るコマンドを作成します。

$ curl -X GET -H "X-ChatWorkToken: {自分のAPIトークン}" "https://api.chatwork.com/v1/rooms/{room_id}/messages"

上記のコマンドを実行するとChatWork Message APIからメッセージを取得することができます。（ヤッタ！！） ただ、これでは最大100件のメッセージが取れてしまうので、1件だけ取り込むようにフィルタリングをおこないます。

$ curl -X GET -H "X-ChatWorkToken: {自分のAPIトークン}" "https://api.chatwork.com/v1/rooms/{room_id}/messages" | jq -c -M ".[0]"

これで１件だけメッセージを取得することができました。 最終的にfluentdの設定は下記のようになります。

<source> type exec command curl -sS -X GET -H "X-ChatWorkToken: {自分のAPIトークン}" "https://api.chatwork.com/v1/rooms/{room_id}/messages" | jq -c -M ".[0]" format json tag chatwork.sakura run_interval 60s </source>

fluentdと伺かをつなげる

次にfluentdと伺かをつなげます。 bash0C7氏が作られたfluent-plugin-sstpを使うだけという簡単仕様です。

<match chatwork.sakura> type sstp sstp_server 127.0.0.1 sstp_port 9801 request_method NOTIFY request_version SSTP/1.1 sender fluentd script_template \0<%= record['account']['name'].force_encoding("utf-8") %> さんが\n「<%= record['body'].force_encoding("utf-8") %>」\nって言っているよ。\w9\w9\u\s[11]放置だな\e </match>

script_templateに伺かでのやりとりを書きます。 書式に関しては下記の2ページを参照してください。

伺か - SSTPプロトコル

伺か - SHIORI

ここまで出来たらあとはfluentdを再起動するだけです。

さくらさん超可愛い！！！！

おわりに