Slack APIの使い方メモ

以前、Slack APIを使ったのですが、久しぶりに使おうとしたら完全に使い方を忘れていたので、また忘れた時用のSlack API使い方メモです。

ちなみにAPIでやりたかったことは下記のようなことです。

投稿（アプリとして）
投稿（ユーザーとして）
ファイルアップロード
ワークスペースのユーザー一覧取得

基本的な仕組み

基本的には、まずアプリを作成して、そのアプリをユーザーがワークスペースにインストールし、ユーザーがそのインストールされたアプリを介してAPIを使います。

Slackのデベロッパー向け機能には、Slackを操作するAPIだけでなく

ユニークなURLを発行して、トークン無しでURLコールだけで投稿する機能
指定したURLにWebhookでイベント通知を受け取る機能

など、色々な機能があります。そして、何をするにもまずアプリを作成し、そのアプリをハブにして各種機能を開発していくスタイルになります。

手順（準備）

アプリの作成

Slack APIページに移動

https://api.slack.com/

[Building Slack apps]-[Create a Slack app]ボタンでアプリを作成

Slack APIの使い方メモ

アプリはワークスペースにひも付きます。

アプリのインストール

上記でアプリが作成されるので、次に作成したアプリをユーザーがインストールして、APIを使えるようにします。

[Basic Information]-[Add features and functionality]-[Permissions] に移動

（「OAuth & Permissions」でも同じページに行けます）

Slack APIの使い方メモ

ちょっと分かりにくいのですが、移動先のページ（OAuth & Permissions）で「どのAPIを使うかの設定」と「アプリのインストール」を行います。

[Scopes]-[Select Permission Scopes]で使いたいAPIを選択

[Save Changes]ボタンで使いたいAPIを登録

例として下記のAPIを登録してみました。

投稿（アプリとして）
- chat:write:bot
投稿（ユーザーとして）
- chat:write:user
ファイルアップロード
- files:write:user
ユーザー一覧取得
- users:read

Slack APIの使い方メモ

[OAuth Token & Redirect URLs]-[Install App to Workspace]でユーザー（自分）にアプリをインストール

すると自分にアプリが登録され、アクセストークンが発行されるので、以後このトークンを使ってAPIを呼び出します。

Slack APIの使い方メモ

手順（APIを使う）

トークンはBearerトークンで、「Authorization」ヘッダーに「Bearer <トークン値>」を設定して使います。

他の設定はAPIによってまちまちなので、APIのリファレンスに合わせて設定します。

例）アプリとして投稿

import axios from 'axios';

(async () => {
    const token = `xoxp-XXXX`;
    const url = 'https://slack.com/api/chat.postMessage';

    const result = await axios.request({
        headers: {
            'authorization': `Bearer ${token}`
        },
        url,
        method: "POST",
        data: {
            channel: 'XXXX',
            text: 'Hello, World!',
        }
    });

    console.log(result.data);
})();

すると、こんな感じで投稿されます。

Slack APIの使い方メモ

手順（API・アプリの追加・変更・削除方法）

自分が作成したアプリ一覧はSlack APIページの右上の「Your Apps」から行けます。

Slack APIの使い方メモ

アプリ名をクリックすると、アプリの設定ページに移動します。

APIの追加・変更・削除

アプリ設定ページの[OAuth & Permissions]-[Scopes]で行います。
変更した後は、[OAuth & Permissions]-[OAuth Tokens & Redirect URLs]-[Reinstall App]でトークンを再発行します。
今まで発行したトークンを無効にするのは[OAuth & Permissions]-[Revoke All OAuth Tokens]-[Revoke Tokens]で行います。

アプリの削除

インストールしたアプリをアンインストールするには、ワークスペースの「App +」から行います。

アプリそのものを削除するには、アプリ設定ページの[Delete App]-[Delete App]で行います。

Slack APIの使い方メモ

手順（API情報収集）

API使用にあたり、どんなAPIがあって、どう使うかをリファレンスで調べる必要があります。リファレンスの参照方法は下記のとおりです。

どんなAPIがあるかを調べる

Slack APIページの[Reference]-[Methods]にAPI一覧があるので、そこから使いたいAPIを探します。

Slack APIの使い方メモ

APIの具体的な使い方を調べる

上記のAPI一覧からAPI名をクリックすると、URL・method・引数等の、API毎の使い方が載っています。

Slack APIの使い方メモ

API使用例

例）ユーザーとして投稿

import axios from 'axios';

(async () => {
    const token = `xoxp-XXXX`;
    const url = 'https://slack.com/api/chat.postMessage';

    const result = await axios.request({
        headers: {
            'authorization': `Bearer ${token}`
        },
        url,
        method: "POST",
        data: {
            channel: 'XXXX',
            text: 'Hello, World!',
            as_user: true,    // ユーザーとして投稿フラグ
        }
    });

    console.log(result.data);
})();

例）ファイルアップロード

import axios from 'axios';
import * as FormData from 'form-data';
import * as fs from 'fs';

(async () => {
    const token = `xoxp-XXXX`;
    const url = 'https://slack.com/api/files.upload';
    const form = new FormData();
    form.append('file', fs.createReadStream('./data/slack_logo.png'));
    form.append('filename', 'slack_logo.png');
    form.append('channels', 'XXXX');

    const result = await axios.request({
        headers: {
            'authorization': `Bearer ${token}`,
            ...form.getHeaders(),
        },
        url,
        method: "POST",
        data: form
    });

    console.log(result.data);
});

Slack APIの使い方メモ

補足説明

ファイルアップロードAPIのパラメータを自分で設定しようとするとハマりやすいです。

ファイルの中身を渡すだけではダメで、ファイルの種類を適切に設定しないとうまく行きません。

ファイルの種類を判定して設定するのはかなり手間なので、ライブラリがあるならそれに任せてしまった方がいいです。

ファイルアップロードは、いわゆるhtmlのファイルアップロード方法「multipart/form-data」が使えます。

サンプルでは、Node.jsで「multipart/form-data」を行うライブラリ「form-data」を使っていて、ライブラリがよしなにファイルの種類（content-type）を設定してくれています。

例）ワークスペースのユーザー一覧を取得

import axios from 'axios';
import * as qs from 'qs';

(async () => {
    const token = 'xoxp-XXXX';
    const url = 'https://slack.com/api/users.list';

    let cursor = '';

    do{
        const result:any = await axios.request({
            headers: {
                'authorization': `Bearer ${token}`,
                'Content-Type': 'application/x-www-form-urlencoded',
            },
            url,
            method: "POST",
            data: qs.stringify({
                cursor,
            })
        });

        console.log(result.data);
        cursor = result.data.response_metadata.next_cursor;

    }while(cursor);

})();