GitHub Organizationの管理をしているのですが、運用が少し面倒なのでなんとかできないかといろいろ考えています。
今回はチャットボットでの運用を導入できないかと考えて検証してみたのでまとめました。
（いろいろな制約により残念ながら実用には至ってません。）
今回の記事ではSlackAppにおける機能としてSlach Commandを利用しています。
また、この記事では以下の要素を利用して、SlackAppを構築するための基本的な部分を実装していますが、
個々の要素の具体的な利用方法や言語の実装についてはあまり触れません。
- Amazon API Gateway
- AWS Lambda (Golang)
- CloudFormation (AWS SAM)
TL;DR
SlackとAWSを利用して対話型なインターフェイスを作成するサンプルを作りました。
以下のアニメーションにあるコマンドで呼び出し → 選択肢の応答 → ボタン押下による応答 → メッセージ書き換えによる応答の流れのうち、選択肢の応答までを説明しています。
以下のような動作をします。
前提条件
- Slackのワークスペースの管理権限を持っていること
- AWSの対象の各サービスの操作権限と基礎知識をもっていること
- (ソースコードを読むのであれば)Golangの基礎知識をもっていること
Amazon API Gatewayの構築
このコマンドを実行する事でAWS上に本記事で使うAPIを構築します。
また、最終行にそのAPIのURLが出力されます。SlackApp構築時に設定に利用するのでメモっておいてください。
なお、環境変数AWS_PROFILEについてはデフォルト以外のプロファイルを利用する場合に指定してください。
$ git clone https://github.com/ikeisuke/slack-app-example.git
$ cd slack-app-example
$ export AWS_PROFILE=xxx
$ make all
また、これ以外に各コマンドから利用するためにいくつか環境変数がありますが、必要に応じてアップデートをしますのでここでは未指定で進めてください。
Slack Appの作成
https://api.slack.com/apps にアクセスし「Create New App」ボタンをクリックして新しいアプリケーションを作成します。
クリックすると「App Name」と「Development Slack Workspace」の入力を求められるので、好きな名前と自分の管理しているワークスペースを選択します。
コマンドを作成する
アプリケーション作成完了後に表示されるページの左メニューからSlash Commandsを選んで「Create New Command」ボタンをクリックして新しいコマンドを追加します。
「Command」には作成したいコマンド（既存のコマンドに被らないもの）、「Request URL」にはAWSにデプロイした際に表示されたURLの後ろに「slash」（そのようなパスでAPIをデプロイしています）を追加したURLを設定します。画像にはないですがその下にある「Short Description」も入力しないと進めないので注意してください。
ボットを作成する
今回のコマンドでは、コマンド送信後Botがチャネルの一覧のボタンを送ってくるだけのプログラムになっています。送信のためにボットユーザーを用意します。
左のメニューから「Bot Users」を選択し「Add a Bot User」ボタンをクリックします。基本項目は入力されているので問題なければそのまま「Add Bot User」ボタンをクリックして完了です。
ワークスペースにアプリケーションをインストールする
ここまでの作業を完了させてたら、ワークスペースにアプリケーションをインストールするために左のメニューから「Install App」を選択し、「Install App to Workspace」ボタンをクリックしてインストールします。
インストールが完了するとアクセストークンが表示されていますので、「Bot User OAuth Access Token」をコピーして次の環境変数の設定で使います。
アプリケーションの環境変数を設定する
Slackから送られてくるメッセージの署名の確認用のシークレットキーとボットユーザーがメッセージを送信するためのトークンを環境変数に設定します。
左のメニュの「Basic Information」をクリックして、少し下にスクロールした位置にある「App Credentials」グループ内の「Signing Secret」の部分を「Show」ボタンを押すと表示できるので表示してコピーします。
本項でコピーしたシークレットキーと前項でコピーしたボット用トークンを以下のように環境変数に設定してデプロイコマンドを実行します。
$ export SLACK_SIGNING_SECRET=xxxx
$ export BOT_USER_ACCESS_TOKEN=xoxb-xxxxx
$ make deploy
動作確認
/[作成したコマンド] channel listとメッセージ欄に入力して送信した後に、ワークスペースの登録済みチャネルの一覧がボタンでボットユーザーにより投稿されればコマンドは完成です。
参考
- ソースコード ikeisuke/slack-app-example
- Slack API
- 動画をアニメーションGifに変換 （動画をQiitaに貼るのにやり方を参考にさせてもらいました。）
あとがき
botからのメッセージにあるボタンを押した後のインタラクションについてまでをかこうと思っていたのですが、
思ったより記事が長くなってしまったので、今回はここまでにします。
次回は続きとしてインタラクション周りについて書きたいと思います。