トークBot APIの概要
トークBot APIを利用すると、トークBotとメンバーでメッセージを送受信できます。例えば、自社で用意したメッセージ送受信サーバーとメンバー間で対話型コミュニケーションを行なったり、メンバーが送信したトークに対して自動で返信することも可能です。
トークBot APIでは、以下のようにトークBotの登録と照会、メッセージ送受信機能を提供しています。
- トークBotの登録: 自社のトークBotを登録、修正、照会します。
- メッセージ送信: 自社のメッセージ送信サーバーからトークBotを通じてメンバーにメッセージを送信します。
- メッセージ受信: メンバーがトークBotに返信すると、設定したメッセージ受信サーバーにメッセージを転送します。
トークBot
トークBotを利用するとメンバーへのメッセージ送信や対話型コミュニケーションを行うことができます。例えば、メンバーへの一斉通知をBotからのメッセージとして伝えることができます。また、メンバーが送信したメッセージにあわせて自動的に回答するシステムを作り、対話型コミュニケーションを行うような活用方法も考えられます。
参考
- Botは最大300個まで登録可能。
トークBot API
トークBot APIを利用するとトークBotの登録、修正、照会、およびメンバーとの対話が可能になります。
トークBotの登録とメッセージ送信は、以下のステップで行われます。
- 「トークBotの登録API」でトークBot情報をテナントに登録
- 「トークBotのドメイン登録API」でトークBotをテナント内の各ドメインに登録
- 「メッセージ送信API」を利用してメッセージ送信
- （必要な場合）Botのcallback URLにメッセージ受信サーバーを登録してメンバーからのメッセージを受信
Bot利用までのプロセスを図であらわすと下記のようになります。
図1 トークBot利用プロセス
トークBotの登録と照会
トークBot APIを利用するには、テナントとドメインの関係について理解する必要があります。1つのテナントは1つもしくは複数のドメインから構成されます。テナントは企業グループ、ドメインは個別企業をイメージしてください。
トークBotはまず最初にテナントに登録されます。登録されたトークBotを使用するためには、合わせて利用ドメインにもトークBotの登録を行う必要があります。
参考
- トークBotを登録すると「botId」が作成されます。Bot IdはAPI 1.0における「bot No」と同様です。
トークBotの登録からドメイン登録までの作業はDevelopers Consoleでも可能です。
利用ドメインを登録したトークBotはメッセージの送受信が可能になります。
メッセージの送信
トークBotは特定のメンバーにメッセージを送信することができます。
参考
- 参加者が500 名以上のトークルームでは、Botからメッセージを送信してもメンバーへのプッシュ通知が行われません。
メッセージの受信
メンバーとトークBotの間での対話型インターフェースを提供します。メンバーからトークBotにメッセージが送信されると、LINE WORKSのメッセージサーバーを通じて、登録されたメッセージ受信サーバーへポストします。メッセージ受信サーバーに渡した値について改ざんの有無を確認するため、チェック値をX-WORKS-Signatureヘッダーに含めて送信し、Bot Secretをキーとして確認することができます。
参考
- メッセージを受信するcallback URLは1件のみ登録できます。
- callbackの形式を、API 1.0形式とAPI 2.0形式から選択することができます。詳細は「Developers Console > Bot」を参照してください。
トークBotの状態
トークBotには以下の状態があります。
| 状態 | 説明 |
|---|---|
| 準備中 | テナント登録のみ行なった状態です。 トークBotを使用する場合は、トークBotのドメイン登録APIでトークBotのドメインを登録を行う必要があります。 |
| サービス中 | 各ドメインに登録された状態です。 権限ON状態でメッセージ送信APIを使って各メンバーにメッセージを送信できます。 |
| > 使用権限ON | Botをトークルームに招待可。 |
| >> 公開 | アドレス帳のBotリストに表示。 |
| >> 非公開 | アドレス帳のBotリストに非表示。 |
| > 使用権限OFF | Botをトークルームに招待不可。 |
Botの状態を変更すると、以下のサービス通知が送信されます。
| サービス通知タイプ | 状態 | 送信先 |
|---|---|---|
| Botリストに追加 | ● 権限ON & 公開 | メンバー |
| Botリストから削除 | ● 権限ON & 非公開 ● 権限OFF ● 権限ONのBotをドメインから削除 ● 権限ONのBotに対してドメイン利用範囲を限定 ● 権限ONのBotを削除 |
メンバー |
| 公開中のBotを登録ドメインから削除 | ● 公開中のBotを削除 ● 公開中のBotに対してドメインの利用範囲を制限 |
管理者 |
| 公開中のBotに'複数人のトークルームに招待可' を設定 | ● '複数人のトークルームに招待可' 設定 | 管理者 |
| 公開中のBotから'複数人のトークルームに招待可' 設定を解除 | ● '複数人のトークルームに招待可' 解除 | 管理者 |
管理者は、最高管理者、副管理者、IT管理者を意味します。
'複数人のトークルームに招待可' に設定されると、公開範囲は全メンバーに固定されます。
削除されたBotは復元できません。
図であらわすと下記のようになります。
図2 トークBotの状態遷移
トークBot API利用前の準備
トークBot APIを利用するには、botまたはbot.read Scopeを利用するアプリを作成する必要があります。詳細は「Developer Console」を参照してください。