Slack APIでメッセージにリアクション(スタンプの付与)をしてみた(reactions.add)

2020.06.19

こんにちは、CX事業本部の若槻です。

今回は、とあるChrome拡張を作りたく、Slack APIによるメッセージへのリアクション(スタンプの付与)の検証を行ってみました。

なお、APIを叩くSlack Appは前回の記事で作成したものを使用します。

どのAPIを使えば良いか

まず、Slackでメッセージへのリアクションを行うのにどのAPIを使えば良いかを確認します。

[API Methods | slack api]ページを見てみると、メッセージにリアクションをするにはreactions.addメソッドを使えばよさそうです。 スクリーンショット 2020-06-19 20.54.04.png

また、[reactions.add]ページを見ると、作成するAppのスコープはreactions:writeを指定すれば良さそうです。 スクリーンショット 2020-06-19 20.55.38.png

Slack Appの設定

Slack APIを利用するにはSlack上にAppを作成する必要がありますが、記事冒頭で述べた通り今回は前回の記事で作成したAppを設定変更してメッセージへのリアクションも行えるようにします。

https://api.slack.com/apps にアクセスし、前回作成したApp(test-app)を選択します。 スクリーンショット 2020-06-19 20.59.54.png

[Basic Information]ページで画面左の[Features]欄より[OAuth & Permissions]を開きます。 スクリーンショット 2020-06-19 21.01.31.png

[OAuth & Permissions]ページの[Scopes] - [User Token Scopes]で[Add an OAuth Scope]をクリックします。 スクリーンショット 2020-06-19 21.02.59.png

プルダウンメニューで先ほど確認したスコープsearch:readを選択します。 スクリーンショット 2020-06-19 21.10.45.png

するとAppの再インストールを促されるので[reinstall your app]をクリックします。 スクリーンショット 2020-06-19 21.11.37.png

するとAppが追加先のワークスペースへのアクセス権限をリクエストするので、[許可する]をクリックします。 スクリーンショット 2020-06-19 21.13.01.png

Appを再インストールしても発行済みのOAuth Access Tokenは変更されないため同じ値を引き続き利用可能です。tokenの値は後ほど使用するので控えておきます。 スクリーンショット 2020-06-19 21.14.36.png

これでSlack Appの設定は完了です。

APIでリアクションしてみる

次に、設定変更したAppを使って実際にAPIでメッセージへのリアクションをしてみます。

必要な情報を確認する

APIでリアクションを行う場合は、事前に以下の情報を確認する必要があります。

  • channel:リアクションしたいメッセージがあるチャネルのID
  • name:リアクションで貼りたいスタンプの名前
  • timestamp:リアクションしたいメッセージのタイムスタンプ

チャネルのIDは、対象のチャネルをブラウザで開いてURL末尾のパスの値で確認できます。(今回はC0XXXXXXスクリーンショット 2020-06-19 21.26.36.png

スタンプの名前は、私の以前の記事[Slack APIでメッセージにスタンプ(絵文字)を付けて投稿したい]を参考に確認できます。(今回はrimokai

メッセージのタイムスタンプは、Slackで対象のメッセージのタイムスタンプのリンクURLをコピーし、 スクリーンショット 2020-06-19 21.29.22.png

取得したURL(今回はhttps://xxxxxxxx.slack.com/archives/C0XXXXXXX/p1592288435000900)の末尾のパスの値からpを省き、ミリ秒以下を.区切りした値(今回は1592288435.000900)となります。

これで必要な情報を確認できました。

SlackのTesterページの場合

SlackのTesterページからAPIを使ってみます。reactions.addAPIの場合は下記のページです。

ここまで取得した各種情報を指定し、[Test Method]によりAPIを実行すると、実際に叩かれたURLとレスポンス結果を確認できました。 スクリーンショット 2020-06-19 21.43.48.png

rimokaiスタンプも付与することができました。 スクリーンショット 2020-06-19 21.51.17.png

Node.jsの場合

以下のようなNode.jsで実行可能なスクリプトを作成しました。

var request = require('request');

var reaction_url = `https://slack.com/api/reactions.add?\
  token=xoxp-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&\
  channel=C0XXXXXXX&\
  name=rimokai&\
  timestamp=1592288435.000900`;

var reaction_options = {
  uri: reaction_url,
  headers: {
    "Content-type": "application/json",
  },
  json: {}
};
request.post(reaction_options, function(error, response, body){});

Node.jsでスクリプトを実行すると、先ほどと同様にメッセージにrimokaiスタンプを付与することができました。

おわりに

Slack APIでメッセージにリアクション(スタンプの付与)をしてみました。

前回のSlack APIでメッセージの検索をしてみた(search.messages)のAPIと組み合わせれば「指定のメッセージを検索して自動でスタンプ付与」という処理を実装できそうです。

参考

以上