はじめに

この記事は「Zoomライセンスの切り替えをSlackでやってみた」の一環で投稿した記事です。

SlackAPPの作成から、APPからのメッセージ送信、スラッシュコマンドの利用、Interactiveメッセージを使ったAppの対話と、SlackAPPで使う上での基本的な部分を説明します。

この記事で知れること

SlackAPPの作成方法
SlackAppからのメッセージ送信方法
スラッシュコマンドど実装方法
Interactiveメッセージ（Blockメッセージ）の実装方法
Interactiveメッセージを使ったAPPとの対話方法

１．Slack APPの作成

ワークスペースにAppを追加

にアクセスし、Create New App からAPPを登録します。

AppName：任意
WorkSpace：Appを登録したいワークスペース

APPに権限の追加

APPの設定ページよりAPPの権限を設定します。

「OAuth & Permissions」を選択
「Scopes － Bot Token Scopes　－　Add an OAuth Scope」より以下の権限を追加
- chat:write
- commands
- im:history
- im:write

Interactivity & Shortcuts の設定

Interactiveメッセージを使用するための初期設定をします。

「Interactivity & Shortcuts」を選択。InteractivityをONにする
「Request URL」にはInteractiveityイベントを受信する用のURLを設定する。
ここではFQDN ＋/slack/interactive とする
（例）https://******.herokuapp.com/slack/interactive

Slash Commands の設定

スラッシュコマンドを使用するための初期設定をします。

Slash Commandsを選択する
「Create New Command」をクリックし、コマンドの情報を入力後Saveする
- Command：スラッシュコマンド名（/zoomなど）
- Request URL：スラッシュコマンドが実行された際にPOSTイベントを受信する用のURLを設定
- Short Description：任意
- Usage Hint：任意

APPのインストール

各種設定が完了したらワークスペースにAPPをインストールします。

「OAuth & Permissions」を選択し、「Install to Workspace」をクリックしてAPPをインストールする
「＊＊＊権限をリクエストしています」の画面がでたら「許可する」をクリック
Bot User OAuth Tokenが表示されればOk

２．channelにメッセージを送信してみる

APPのインストールが完了したら、試しにAPPからチャネルにメッセージを送信してみます。

インストールしたAPPをSlackの任意のチャネル参加させる
Slcakのチャネル設定－インテグレーション－アプリの追加より追加する
SlackAPPを使うのに必要なライブラリ（slack_sdk）をインストール

pip install slack_sdk

以下のようにchat_postMessageAPIを使ってチャネルにメッセージを送信する
- SLACK_TOKEN：APPのインストール時に「OAuth & Permissions」に表示されたBot User OAuth Token
- CHANNELID：APPを追加したChannelのID

slack_mdule.py

from slack_sdk import WebClient

SLACK_TOKEN = "xoxb-xxxxxxxxxxxxx-xxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"
CHANNELID = "Cxxxxxxxxxx"

#SLACK にメッセージ送信
def dm_send( send_message):
    client = WebClient(SLACK_TOKEN)

    # DMを送信する
    client.chat_postMessage(channel=CHANNELID, text=send_message)

dm_send("テストメッセージ")

※チャネルIDはチャネル情報から確認できます

３．スラッシュコマンドを使ってみる

スラッシュコマンドの使用イメージは以下です。

スラッシュコマンドを実行したらSlackAPPから「Slash Commands の設定」で設定したRequest URLにPOSTメッセージが送信されます。

今回は、スラッシュコマンドである「/zoom」を実行したらチャネルにテストメッセージを送信するコードを実装してみます。

スラッシュコマンド受信部分

webservice.py

from bottle import debug, route, run, request ,Response
import slack_module as slackm

##############################
# スラッシュコマンド受信route
##############################
@route("/slashcommand", method=['POST'])
def slash_zoom():
    print("slash")
    print(vars(request.params))

    channel_id = request.params["channel_id"]
    slackm.dm_send("スラッシュコマンド受信しました", channel_id)
    return Response(message="Ok")

##############################
# 初期起動処理：Webサービス起動
##############################
if __name__ == "__main__":
    print('starting  webdyno')
    debug(True)
    run(host="0.0.0.0", port=int(os.environ.get("PORT", 5000)),)

メッセージ送信モジュール部分

slack_mdule.py

from slack_sdk import WebClient

SLACK_TOKEN = "xoxb-xxxxxxxxxxxxx-xxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"

#SLACK にメッセージ送信
def dm_send( send_message, channel_id):
    client = WebClient(SLACK_TOKEN)

    # DMを送信する
    client.chat_postMessage(channel=channel_id, text=send_message)

これをHerokuにデプロイし、APPを追加したチャネルで/zoomを実行してAPPから「スラッシュコマンド受信しました」が返信されればOKです。

４．インタラクティブメッセージを送信してみる

Interactive Messageは、SlackAPPと対話形式でやり取りできるようにボタンやプルダウンメニューなどを含んだメッセージのことです。

Interactive Messageを使うにはBlockKitという仕組みを使い、APPの送信メッセージ内にボタンやプルダウンメニューメッセージを含めることで、Slack上でボタンやプルダウンUIを表現することができます。
ボタンやメニュー以外にも結構色々なことを表現できるので、BlockKitを使うことでSlackでできることが広がると思います。

詳細については、以下の公式ドキュメントを参照してください。とても細かく記載してれています。

ここでは、サンプルとしてプルダウンメニューをAPPからチャネルに送ってみます。

Block メッセージJson

BlockメッセージはJson形式で作成します。

どんなjson形式を送ればいいか？はSlackさんが「Block Kitビルダー」という素晴らしいツールを用意してくれているので、自身で送りたいイメージを作ってjsonイメージを確認してみてください。

以下はブルダウンメニューのjsonです。

pulldown.json

{
    "type": "section",
    "text": {
        "type": "mrkdwn",
        "text": "■プルダウンから選んでね"
    },
    "accessory": {
        "type": "static_select",
        "placeholder": {
            "type": "plain_text",
            "text": "＜メニューを選択＞",
            "emoji": true
        },
        "options": [
            {
                "text": {
                    "type": "plain_text",
                    "text": "●朝ごはん",
                    "emoji": true
                },
                "value": "breakfast"
            },
            {
                "text": {
                    "type": "plain_text",
                    "text": "●昼ごはん",
                    "emoji": true
                },
                "value": "lunch"
            },
            {
                "text": {
                    "type": "plain_text",
                    "text": "●晩ごはん",
                    "emoji": true
                },
                "value": "dinner"
            }
        ],
        "action_id": "eatmenu"
    }
}

メッセージ送信API部分

slack_module.py

from slack_sdk import WebClient
import json

SLACK_TOKEN = "xoxb-xxxxxxxxxxxxx-xxxxxxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx"
CHANNELID = "Cxxxxxxxxxx"

with open('./pulldown.json' ,encoding="utf-8_sig") as f:
    pulldownmenu = json.load(f)

#SLACK にメッセージ送信(blockメッセージ送信)
def dm_send_block ( send_message, channel_id, block_template ):
    print(send_message)
    print(json.dumps(block_template))
    client = WebClient(SLACK_TOKEN)

    # DMを送信する
    client.chat_postMessage(channel=channel_id, text=send_message, blocks=block_template)


dm_send_block("スラッシュコマンド受信しました", CHANNELID, pulldownmenu)

blockメッセージを送信する場合はchat_postMessageAPIのblocksにjsonを渡してあげます。
なお、textパラメータに文字列を設定してもチャットメッセージとしては表示されません（Slackでメッセージ通知される際のnotificationにはtextに設定した文字列が表示されるようです）。
　
Slackにメッセージが送信されると以下のように表示されます。

５．対話形式でインタラクティブメッセージを使ってみる

先程、Blockメッセージを使用しプルダウンメニューを送信しましたが、ユーザがプルダウンメニューを選択した際に決められたアクションを起こすことができれば、対話形式で会話することが可能になります。

例えば

ユーザ：スラッシュコマンドを実行
APP：ユーザにプルダウンメニューメッセージを送信
ユーザ：プルダウンメニューから項目を選択
APP：項目に応じた処理を実行しユーザに通知

といった感じでメッセージのやり取りができます。

ここではサンプルとして、上記のやり取りを実施するAPPを作ってみます。

＜必要な処理＞

プルダウンメニュー用Block メッセージJsonの作成
インタラクティブイベント受信ルート＆イベント受信処理の作成

プルダウンメニュー用Block メッセージJsonの作成

これは「４．インタラクティブメッセージを使ってみる」で作ったjsonをそのまま使います。

インタラクティブイベント受信ルート＆イベント受信処理の作成