API経由でSlackへカスタム絵文字を追加できないか調査したときのメモ

✏️ 編集

やりたいこと

Slack API 経由で Slack へ絵文字を追加したい

調べたこと

方針 1: Slack API の admin.emoji.add を利用する

公式で用意されている絵文字追加用 API。

公式ドキュメント: https://api.slack.com/methods/admin.emoji.add

ただし、結局この API は使えなかった。理由はこの API を利用するには Slack App に admin.teams:write という権限を付与する必要があったから。

admin.teams:write についての公式ドキュメント: https://api.slack.com/scopes/admin.teams:write

これには次の問題があったので今回は方針を変更することにした:

Admin API は個々のワークスペースではなく組織全体に影響を与えることができ、ただ絵文字を追加するだけの用途で付与するには不適当なため
そもそも Enterprise 版でないと利用できないため

方針 2: 一般公開されていない API /api/emoji.add を利用する

どうやら Slack には一般公開されていない API がいくつかあるらしく、その中の一つである /api/emoji.add を利用すれば絵文字の追加が可能らしい:

参考: https://github.com/slackhq/slack-api-docs/issues/28#issuecomment-424195796

この API を利用しているプロダクトがいくつかあるようだったので、それらを参考に API を叩いてみた。 API を叩く手順は次の通り。

/api/emoji.add API を叩く手順

1. トークンを入手する

絵文字を追加したいワークスペースを開く
開発者ツールを開き、コンソールタブで次のコマンドを実行する

1
2
3
JSON.parse(localStorage.localConfig_v2).teams[
  document.location.pathname.match(/^\/client\/(T[A-Z0-9]+)/)[1]
].token;
引用: https://github.com/jackellenberger/emojme/blob/master/README.md#cookie-token-one-liner

xoxc-xxxxxxxxxx といった形式のトークンが返ってくるはず。

https://<TEAM_ID>.slack.com/customize/emoji を開く（ワークスペースを開いた状態で「以下をカスタマイズ」をクリックすると飛べる）
開発者ツールを開き、「ネットワーク」タブを開く
emoji というドキュメントを選択する
リクエストヘッダーの cookie: の値が入手したい Cookie （この値をコピーするとき、「右クリック > 『値をコピー』」だとコピー後の文字列に日本語が混じって後で困るので、範囲選択でコピーする必要がある）

3. API を叩く

API を叩くコード:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
import requests

TOKEN = "xoxc-xxxxxxxxxx"   # トークン
COOKIE = "xxxxxxxxxx"   # Cookie

team_name = "xxxxxxxxxx"    # ワークスペースのチーム名
emoji_name = "emoji"   # 絵文字の名前
emoji_img_filepath = "./emoji.png"   # 絵文字の画像ファイルへのパス

URL_ADD = "https://{team_name}.slack.com/api/emoji.add"
r = requests.post(
    URL_ADD.format(team_name=team_name),
    headers = {'Cookie': COOKIE},
    data = {
        'mode': 'data',
        'name': emoji_name,
        'token': TOKEN
    },
    files={'image': open(emoji_img_filepath, 'rb')}
)

次のレスポンスが返ってきていれば成功:

1
{"ok":true}

残る課題

トークンと Cookie の入手を自動でできないか？

余談

`/api/emoji.add` の xoxb トークンでの利用について

/api/emoji.add を xoxb トークンで利用できるよう求める Issue が 2019 年 1 月に建てられているが、2023 年 5 月現在、まだ Open なままである。

該当 Issue: https://github.com/slackhq/slack-api-docs/issues/95

xoxc トークンをスクレイピングで入手する

https://<TEAM_ID>.slack.com/customize/emoji ページをスクレイピングすることで xoxc トークンを入手している例を紹介している記事を見つけた。

該当コード: https://github.com/smashwilson/slack-emojinator/blob/fbcf759ebbda8bd37b77c91362edde9fd3e0c05a/upload.py#L81-L94

しかし、やってみたがうまくいかなかった（ api_token: の値が "" だった）。やってみた当時はまだトークンや Cookie の入手などが手探りの状態だったので、それが原因でうまくいかなかったのかも…？