| 目的 |
BIZTELとSlackを連携する事で、Slackの特定チャンネルに対し着信や録音URLを表示することが可能です。 |
|---|---|
| 対象プラン |
|
| 用語 |
【Slack】 Slack Technologies, Inc.が提供するチャンネルベースのメッセージプラットフォームです。 |
| ポイント |
・BIZTELをSlackに連携する事で、着信情報などを素早く確認する事が可能です。 ・本機能をご利用頂く為には「コールアクション連携」のオプション契約が必要です。 ・BIZTELバージョン 3.3.0以降 で「Slack連携」をご利用頂くにあたり、別途お客様でSlackのご契約が必要です。 |
目次
※項目名をクリックいただく事で項目が展開され、参照したい手順へ移動できます。
1. 利用シーン・制限事項
Slack連携の利用シーン
● 離席中や外出中の間に着信があったことをSlackアプリから参照したい。
● 電話機以外で不在着信を通知させたい。
制限事項
Slackの投稿APIの仕様により、１秒につき１メッセージの通知となります。
着信数が多いコールセンター等と連携を行った場合、正しく通知されない可能性がございますので、ご注意ください。
例：BIZTELへ同時に2本、3本と着信した場合などはSlackの仕様により連携されない可能性があります。
2. 利用可能変数、メソッド
2.1 利用可能な変数展開コード
Slack連携における利用可能な変数展開コードは「1.コールアクション（4.1 変数展開文字列）」に記載の内容に従います。
変数展開コードの自動補完について
BIZTELバージョン 3.7.0 以降、以下の項目に変数展開文字列を入力する場合、「 { 」を入力することで自動補完機能が有効になります。
・イベント：着信通知のメッセージ
・イベント：不在着信通知のメッセージ
・イベント：通知録音URL連携のメッセージ（着信時）及び、メッセージ（発信時）
※{ACCOUNT_VALUE_x} の x は任意の値に修正ください。
入力した変数展開コードの整合性について
BIZTELバージョン 3.7.20 以降、入力した変数展開コードに誤りがある場合、青字の強調表示がされません。
2.2 利用可能なメソッドチェーン
Slack連携における利用可能な変数展開コードは「1.コールアクション（4.2.2 メソッドチェーン）」に記載の内容に従います。
メソッドチェーンの自動補完について
BIZTELバージョン 3.7.20 以降、以下の項目に変数展開文字列を入力する場合、「 . 」を入力することで自動補完機能が有効になります。
・イベント：着信通知のメッセージ
・イベント：不在着信通知のメッセージ
・イベント：通知録音URL連携のメッセージ（着信時）及び、メッセージ（発信時）
3. Slack Webhook URLの取得
BIZTELとSlackを連携させる為には、SlackでWebhook URLを取得する必要があります。
お客様にて契約頂いているSlackアカウントでのご対応をお願い致します。
※Webhook URLはこちらより取得ください。
※Slackのサービス仕様変更により取得方法が変更になる場合があります。
手順１．「チャンネル選択」にて連携対象のチャンネルを選択します。
手順２．チャンネル選択後、「Incoming Webhookインテグレーションの追加」をクリックします。
手順３．Webhook URLが表示されます。
以上で、Webhook URLの取得は完了です。
表示されたWebhook URLはBIZTELの設定で使用しますので、テキストなどに控えてください。
4. Slack連携の設定方法
BIZTELとSlackを連携する為の設定方法を紹介します。
手順１．BIZTEL管理画面にて、「連携オプション」>「Slack連携」をクリックします。
手順２．「新規」をクリックします。
手順３．下記表を基に設定内容を入力します。
※各項目の詳細
| 基本情報 | |
|---|---|
| 設定名 | 任意登録です。 |
| ステータス | Slack連携の有効・無効を切り替えます。 |
|
Webhook URL
|
取得したWebhook URLを入力します。 |
|
メモ
|
ご自由にご記入ください。 |
● Slackに着信通知を残したい場合は以下の項目を入力ください。
|
イベント：着信通知（有効を選択するとメニューが展開されます）
|
|
|---|---|
|
着信通知設定
|
外線着信に対して、Slackで通知を行うかを設定します。 |
|
対象チャンネル
|
通知を行うチャンネル名を入力します。 ※「#」の入力は不要です。 |
|
メッセージ
|
着信時の通知内容を入力します。 デフォルト内容の場合、 デフォルト内容：{TEL}から{EXTEN_NAME}へ着信しています。 |
● Slackに不在着信通知を残したい場合は以下の項目を入力ください。
|
イベント：不在着信通知（有効を選択するとメニューが展開されます）
|
|
|---|---|
|
不在着信通知設定
|
外線着信に対して、応答できなかった場合の通知を行うかを設定します。 |
|
対象チャンネル
|
通知を行うチャンネル名を入力します。 ※「#」の入力は不要です。 |
|
メッセージ
|
不在着信時の通知内容を入力します。 デフォルト内容の場合、 デフォルト内容：{TEL}から{EXTEN_NAME}への通話に応答できませんでした。 |
● Slackに通話録音URLを残したい場合は以下の項目を入力ください。
|
イベント：通話録音URL連携（有効を選択するとメニューが展開されます）
|
|
|---|---|
|
通話録音URL連携設定
|
外線通話終了後、対象通話の録音URLをメッセージに付与するかを設定します。 |
|
対象チャンネル
|
通知を行うチャンネル名を入力します。 ※「#」の入力は不要です。 |
|
メッセージ（着信時）
|
外線着信通話終了後の通知内容を入力します。 デフォルト内容の場合、 デフォルト内容：{TEL}から{EXTEN_NAME}への通話が終了しました。{BASE_URL}/monitor_link/{ID} |
|
メッセージ（発信時）
|
外線発信通話終了後の通知内容を入力します。 デフォルト内容の場合、 デフォルト内容：{EXTEN_NAME}から{CALLED}への通話が終了しました。{BASE_URL}/monitor_link/{ID} |
※録音が無効になっている場合、通話終了後にURLの発行はされますが、録音の再生はできませんのでご注意ください。
利用可能変数について
着信通知・不在着信通知・通話録音URL連携は、それぞれ表示させる値の変更が可能です。
利用可能な変数は「1.コールアクション」をご確認ください。
手順４．入力完了後、「保存」をクリックします。
手順５．「保存しますか？」と表示されたら「OK」をクリックします。
設定が反映されていれば登録完了です。
5. 連携対象電話番号の設定
「4. Slack連携の設定方法」が完了後、連携対象となる電話番号を設定します。
手順１．「連携対象」をクリックします。
手順２．「編集」をクリックします。
手順３．連携対象の電話番号にチェックを入れ、「保存」をクリックします。
※この際、既に別のSlack連携設定にて利用中の電話番号を選択する事はできませんのでご注意ください。
手順４．「保存しますか？」と表示後、「OK」をクリックします。
保存内容が反映されていれば設定完了です。
BIZTELバージョン3.4.10 以降、連携対象タブにて設定箇所の情報を参照可能です。
6. Slack連携履歴
BIZTELとSlackの連携に関する履歴を確認する事が可能です。
※コールアクション履歴からの抜粋となります。
※API実行結果は「1.外部API連携履歴」にてご確認ください。
手順１．「履歴」をクリックします。
手順２．検索条件を指定し、「検索」をクリックします。
| 期間 | 連携された開始・終了時間を指定して検索します。 |
|---|---|
| リクエストID | 通話毎に発行される一意のIDを検索条件に指定します。 |
| メッセージ | 履歴に出力されるメッセージを検索条件に指定します。 |
検索結果が表示される事をご確認ください。
| ID | コールアクション毎に付与される一意のIDです。 ※通常は非表示になっています。 |
|---|---|
| 期間 | コールアクションが実施された時間が表示されます。 |
| リクエストID | 通話毎に発行される一意のIDです。 |
| コールアクションID | コールアクション毎に付与される一意のIDです。 |
| API連携ID | コールアクション内のAPI連携毎に付与される一意のIDです。 |
| メッセージ | コールアクションのAPI連携処理結果の内容が表示されます。 |
対象行をクリックする事で、詳細表示が可能です。
7. Slack連携の表示例
Slack連携時のBIZTELからの通知例を紹介します。
着信通知
不在着信通知
通話録音URL連携時（外線着信通話終了時）
通話録音URL連携時（外線発信通話終了時）
Slackからのデスクトップ通知
Slackのデスクトップ通知を有効にしている場合は、以下のように表示されます。
8. うまく動作しない場合
Slack連携がうまく動作していない場合の切り分け
以下を参考にエラーとなっている箇所を特定ください。
手順１．Slack連携の履歴から検索ボタンをクリックします。
●「登録がありません」と表示される。 → 手順２ へ
● 履歴が表示される。 → 手順３ へ
手順２．API の実行自体がされていない可能性があります。以下の内容をご確認ください。
● 連携対象タブにて、連携対象の電話番号にチェックが付いているか。
● Slack連携のステータスや連携させたいイベントが有効になっているか。
手順３．API の実行はされていますが、エラーが発生している可能性があります。
外部API連携履歴を参照し、対象のAPI実行の詳細からレスポンスをご確認ください。
以下の様なケースが想定されます。
・Webhook URLに誤りがある。
・連携対象のチャンネル名に誤りがある。
・メッセージにて変数展開実施後、「"(ダブルクォート)」が混入している。
→コールセンターの名称に「"」の記号が利用されている場合、かつSlackへの展開に{EXTEN_NAME}を
利用すると、json形式が崩れる為、API連携が失敗しますのでごご注意ください。
コールアクションのマニュアル内に切り分け方法を記載しておりますので、そちらも参照ください。