KARTE 公式の Microsoft Teams アプリを導入することで、エンドユーザーとのチャットを Teams 上で行うことができます。もちろん、Teams アプリをモバイル端末にインストールすることでモバイル端末からメッセージの返信なども可能となります。
※ご利用には KARTE Talk をご契約している必要があります。

null

実現できること

メッセージの受信

下記のセットアップ手順が済んでいれば、自動的にエンドユーザーからのメッセージが Teams アプリのチームに投稿されます。

メッセージの送信

対象ユーザーのスレッド内で KARTE アプリをメンションする(コマンドなし)ことで、エンドユーザーへのメッセージ送信が可能です。
例: @KARTE ${reply_message}

Teams アカウントと KARTE オペレーターの紐付け

エンドユーザーからのメッセージが送信されてきたときに、 Teams アカウントに対してメンションをつけることができます。
また、Teams からエンドユーザーに、オペレーターとしてメッセージを送信することができます。

チャットの担当者の変更

各エンドユーザーのチャットの担当者を、Teams でコマンドを実行することで変更することができます。

コマンドヘルプの表示

KARTE アプリをメンションして help コマンドを実行することで、実装されているコマンドの一覧を表示することができます。


セットアップ手順(全体)

事前準備

KARTE のサーバーサイド API v2 が必要となります。
KARTE の管理画面から「ストア」 -> 「API v2設定」で設定ページに遷移できます。
もしご不明点などあればサポート担当までお問い合わせください。

KARTE 連携用の App を追加

専用ページから以下の項目のように App を設定ください。

アプリ名称: 任意
アプリタイプ: bot
Scoped: talk.message.sendFromOperator , talk.message.get , track.event.write
Webhook URL: https://prod-teams-karte-talk.azurewebsites.net/api/teams/messages
Event Subscriptions: KARTE Talk: ユーザーからのメッセージ送信時
Bot名: 任意(エンドユーザーから見える名前になります)
Bot Icon: 任意(エンドユーザーから見えるアイコンになります)

設定参考画像
null
null
null

設定手順

TeamsアプリストアからKARTE公式アプリをインストール

Teams のアプリストアから「KARTE」を検索すると、KARTE 公式アプリが表示されます。
このアプリはチームに対してインストールを行うものなので、エンドユーザーと会話をするチームに対してインストールしてください。

null
null

インストールに成功すると以下のメッセージが表示されます。

null

setupコマンドを実行

インストールしただけでは、KARTE のどのプロジェクトと紐付いているか判断がつかないので、setup コマンドを使い KARTE の環境との紐付けを行います。

現状では複数チャネルとは紐付けができないため、エンドユーザーとのやり取りを行うチャネルで紐付けを行います。

@KARTE setup ${api_key} ${access_token} ${bot_id} ${client_secret}

null

各設定項目の取得場所は以下となります。
もしご不明点などあれば営業担当までお問い合わせください。

api_key: KARTEのプロジェクト設定画面からAPIキーを取得
access_token: 上記「KARTE連携用のAppを追加」設定完了後の基本設定タブのアクセストークン
bot_id: 上記「KARTE連携用のAppを追加」設定完了後のBot設定タブのBot ID
client_secret: 上記「KARTE連携用のAppを追加」設定完了後の基本設定タブのClient Secret

動作検証

以下の操作をすることで、正常にインストールおよび設定が完了しているか確認できます。

  • エンドユーザー側からチャットを送る
    • Teams 側にエンドユーザーのメッセージが送信されているか確認する
  • 対象のスレッドでエンドユーザーに返信してみる
    • エンドユーザー側の画面でメッセージが受信できているか確認する
  • KARTE のイベントを送信してみる
    • ユーザーストーリー画面などでイベントが送られているか確認する

セットアップ手順(個人)

Teams アカウントと KARTE オペレーターを紐付け

Teams アカウントと KARTE オペレーターを紐付けると以下のことが可能となります。

  1. エンドユーザーからのメッセージにメンションをつける
    エンドユーザーからメッセージが送られてきたときに、送られてきたメッセージに Teams アカウントへのメンションを付与することができます。

  2. KARTE オペレーターとしてメッセージを送信する
    通常、Teams からメッセージを送信した場合ボットとしてメッセージが送られますが、紐付けを行うと紐付けたオペレーターとしてメッセージの送信が可能となります。

「KARTE Talk のオペレーター」と「Teams アカウント」を紐付けるための設定については下記を参照してください。

KARTE 連携用の App の Scope 設定を変更

オペレーターの紐付けには以下の Scope の設定が必要となります。下記の設定手順に沿って設定してください。

必要な Scope: beta.talk.assignee.get, talk.operator.get

設定手順

  1. KARTE の管理画面で「API v2設定」を開く
    起動経路: グローバルメニュー > ストア > API v2 設定
  2. セットアップ時に作成した App を選択
  3. 右上の「編集」ボタンをクリック
  4. Scope に上記 Scope を追加
  5. 「保存」をクリックし内容を保存する

オペレーターリンク設定

KARTE Talk で紐付けをしたいオペレーターの ID を取得

  1. KARTE の管理画面で「オペレーター管理」を開く
    起動経路: グローバルメニュー > トーク設定 > オペレーター管理
  2. 紐付けをしたいオペレーターを選択し、オペレータの詳細を表示
  3. 表示されている「アサインID」 の値をコピー

Teams でオペレーターリンク設定を行う

  1. Teams にメンション設定をしたいアカウントでログインする
  2. KARTE アプリをインストールしたチームで以下のコマンドを実行
    コマンド: @KARTE operator link <アサインID>
     例: @KARTE operator link 123456789abcdef ※Teams 上では @ は省略されます

オペレーターリンク設定の削除

以下のコマンドを実行することでオペレーターリンク設定を削除することができます。
このコマンドを実行する場合、削除をしたい Teams のアカウントでログインをしてから行ってください。
 コマンド: @KARTE operator unlink

⚠️注意: 削除した内容は元には戻せません。内容をよくご確認のうえ行ってください。


チャットの担当者を変更する

エンドユーザーごとにチャットの担当者を設定することができます。担当者の変更は KARTE の画面を開くことなく、Teams でコマンドを実行することで変更ができます。
変更するには、先に担当者にする Teams アカウントと KARTE のオペレーターの紐付けが必要となります。上記の「エンドユーザーからのメッセージにメンションをつける」をご参考に、オペレーターリンク設定を行ってください。

KARTE 連携用の App の Scope 設定を変更

担当者を変更するには以下の Scope の設定が必要となります。下記の設定手順に沿って設定してください。

必要な Scope: talk.assignee.assign, talk.assignee.unassign

設定手順

  1. KARTE の管理画面で「API v2設定」を開く
    起動経路: グローバルメニュー > ストア > API v2 設定
  2. セットアップ時に作成した App を選択
  3. 右上の「編集」ボタンをクリック
  4. Scope に上記の Scope を追加
  5. 「保存」をクリックし内容を保存する

チャットの担当者を設定する

以下のコマンドを実行することでチャットの担当者の設定ができます。担当者を設定したいユーザーのスレッドでコマンドを実行してください。

自分を担当者に設定する場合
@KARTE operator assign

他の方を担当者に設定する場合
@KARTE operator assign @account

⚠️@account には担当者にしたい方の Teams アカウントをメンションしてください。
⚠️operator の打ち間違いにはご注意ください。打ち間違えた場合そのままユーザーにメッセージが送信されます。

チャットの担当者を外す

以下のコマンドを実行することでチャットの担当者を外すことができます。担当者を外したいユーザーのスレッドでコマンドを実行してください。

@KARTE operator unassign

⚠️operator の打ち間違いにはご注意ください。打ち間違えた場合そのままユーザーにメッセージが送信されます。


Teamsの連携先チャネルを変更する

通常エンドユーザーからのメッセージは一般のチャネルに投稿されます。
これを任意のチャネルに変更したい場合、チャットウィジェットの接客アクションに以下の設定を追加する必要があります。
こちらの機能はチャットウィジェットv3のみサポートされています。チャットウィジェットv3についてはこちらをご参照ください。

チャットウィジェットの設定

チャットウィジェット接客のScriptタブで以下のコードを貼り付け

chat.setMetadata("ms_teams", {channel:"{teams_channel_id}"});

{teams_channel_id} の部分は投稿先にしたいTeamsのchannel_idを指定します。

TeamsのChannel IDを取得する方法

null

TeamsのChannel IDは「チャネルへのリンクを取得」をクリックすると以下のようなリンクが生成されます。リンク中の{channel_id}の部分がTeamsのChannel IDとなります。

https://teams.microsoft.com/l/channel/{channel_id}/github-support?xxxxxxx
e.g. 19%3a330f212edf8349abad63fa36ea74d7ce%40thread.tacv2

連携の仕様

Teams連携では、ユーザー単位で投稿先のTeamsのチャネルが紐づく形となります。
また、紐づくタイミングは、ユーザーからメッセージをTeamsに初めて投稿した時です。
メンバーの場合はuser_id、ビジターの場合はvis_idにて投稿先のTeamsチャネルが紐づきます。
一度特定のチャネルへ紐付けられたユーザーからのチャットの会話は、以降同じチャネルへ投稿される仕様です。一度特定のチャネルへ紐付けられたユーザーについては、残念ながら現状管理画面から紐付けを解いて新たなチャネルへ紐付けしなおすことができないため、そのような操作をご希望の場合は対応方法を検討しますので、一度サポートにお問い合わせください。

なお、ビジター(vis_id)にてTeamsのチャネルへ紐付けられたユーザーが、その後user_idがKARTEで連携されてメンバーになった場合は、該当のuser_idの状態でメッセージを初めてTeamsに投稿した時に、新ためて紐付けがされます(ビジターで連携されていたチャネルはメンバーになったときに引き継がれません)。

設定例

null


FAQ

TeamsアプリストアでKARTE公式アプリが表示されない

こちらのKARTE公式アプリの紹介ページの「いますぐ入手」から、インストールをお試しください。

インストールに失敗する場合、Teams管理者によるアプリインストール許可が必要な場合がございます。

Microsoft Teams 管理センターでアプリを管理するをご参照いただき、社内でTeams管理者にお問合わせください。

お問い合わせ先

もしご不明点などがございましたら、お気軽にKARTE内のチャットサポートまでお問い合わせください。