手っ取り早く LINE WORKS のトーク Bot API を実行してみる
この記事では、LINE WORKS のトーク Bot API をとにかく実行して、LINE WORKS の利用者に Bot からチャットを送信してみる方法を説明します。
Postman の入手とインストール
ここでは Postman というツールを利用します。Postman は Web API を試してみたいといったときに、便利なクライアント アプリです。
TITLE: Postman | The Collaboration Platform for API Development
URL: https://www.getpostman.com/
Windows, macOS, Linux それぞれに対応しています。ダウンロード ページからインストーラーを入手して、インストールしましょう。
TITLE: Download the App
URL: https://www.getpostman.com/downloads/
インストールが完了すると、Postman が起動します。サインインを求める表示が出る場合もありますが、これはスキップすることでサインインせずに使うこともできます。
スクリーンショットは Windows 版です。その他のプラットフォームもほぼ同様です。
LINE WORKS の API を利用する準備
LINE WORKS の API を利用するために、LINE WORKS の Developer Console で、いくつかの事前準備を行います。
Developer Console の説明はこちらにあります。
TITLE: LINE WORKS Developers
URL: https://developers.worksmobile.com/jp/document/13?lang=ja
Developers の権限が付与されたアカウントで次の URL から Developer Console にアクセスしましょう。LINE WORKS のサインアップ時に作成したアカウントは最高管理者の権限が付与されており、Developer の権限も含まれます。
最初のアクセスでは、利用規約の同意を求められます。
"同意" して [利用する] をクリックすると、コンソールが開きます。
Postman から トーク Bot API を使うために以下の発行と追加を行います。
- API ID
- Server API Consumer Key
- Server List (固定IPタイプ)
-
API ID
[発行] ボタンをクリックすると生成されます。
-
Server API Consumer Key
[発行] ボタンをクリックすると、Server API Consumer Key 権限設定のサブ ウィンドウが開きます。
"トークBotすべて" をチェックし [次へ] をクリックします。
"有効期限" と "自動延長" の設定を適宜行い、[保存] をクリックします。
Server API Consumer Key が生成されます。
- Server List (固定IPタイプ)
Postman を実行するコンピューターの利用しているグローバル IP アドレスを調べます。
アクセスすることで利用中のグローバル IP アドレスを表示する Web サービスがあるのでそれらを利用しましょう。
例: http://www.cman.jp/network/support/go_access.cgi
確認したグローバル IP アドレスはメモしておきましょう。
LINE WORKS Developer Console で Server List (固定IPタイプ) の [追加] ボタンをクリックします。
新しいウィンドウが開きます。次のように入力します。
サーバー名: 任意の名前
Keyの選択: プルダウンから先ほど作成した Server API Consumer Key を選択
IP: 先ほど調べたグローバル IP アドレス
[発行] ボタンをクリックします。
Token が生成されます。[同意して利用する] をクリック。
LINE WORKS に Bot を登録する
LINE WORKS の Developer Console から Bot を登録します。
Developer Console の Bot メニューで [登録] ボタンをクリックします。
Bot登録の画面で必要な項目をそれぞれ入力します。
Bot名: 任意の名前
「説明」: 任意の説明
管理者/主担当: 任意のメンバーを主担当に指定
その他の項目は今回は不要です。[保存] ボタンをクリックします。
Bot No. が生成されます。Bot No. はメモしておきましょう。
登録した Bot の利用設定
こちらの URL から LINE WORKS の管理者画面の Bot の利用設定ページにアクセスし、[+追加] ボタンをクリックします。
https://bot-admin.worksmobile.com/
先ほど登録した Bot を選択し、[追加] ボタンをクリックします。
Postman で LINE WORKS トーク Bot API を実行
トーク Bot API でテキスト メッセージを送信します。API の説明はこちらのページを参照してください。
TITLE: メッセージ送信 (text)
URL: https://developers.worksmobile.com/jp/document/100500801?lang=ja
こちらのドキュメントに記載のとおり Request URL は以下です。
https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push
{API ID} と {botNo} は、前の作業で生成された値に置き換えます。
例えば次のようになります。
https://apis.worksmobile.com/r/jp1iDZPxBenMo/message/v1/bot/101578/message/push
HTTP Method は POST です。
ここまでの内容を Postman に設定します。
さらに Postman の Authorization タブを開いて、次の設定を行います。
TYPE をプルダウンから "Bearer Token" を選択。
Token に Server List(固定IPタイプ) で生成した Token を入力。
次に Headers タブを開いて、以下の内容を入力します。
Key: Content-Type Value: application/json; charset=UTF-8
Key: consumerKey Value: <前の手順で生成された Server API Consumer Key の値>
引き続き、Body タブを開いてドキュメントの Request Example の内容を基に、次のとおり入力します。入力形式は [raw] を指定します。"accountId" は書き換えてください。
以上で準備が整いました。
Bot からのメッセージを確認するために LINE WORKS のトーク画面を開きましょう。
ブラウザで確認する場合はこちらの URL です。
Https://talk.worksmobile.com/
またはモバイル アプリや PC/Mac のアプリでログインしてもよいです。
Postman の [Send] ボタンをクリックします。
200 OK の Status が返れば正常にメッセージが送られています。
ブラウザで Bot からのトークを受信した様子です。
ありがちなエラーと対処
Postman で [Send] ボタンをクリックしても、メッセージが届かず 200 OK のレスポンスも返らない場合は、Postman の Http Response の Body の内容を確認しましょう。
存在しない API ID を記述しているケース。API ID を修正しましょう。
Server API Consumer Key または Server List(固定IPタイプ) の Token の相違。正しく key や Token の Value を記述しましょう。
accountId の相違。存在しないメンバー宛に送ってしまっているなど。
Server List(固定IPタイプ) で登録したのとは異なる Global IP Address から実行している。