| 目的 | BIZTELとZendeskをQuickworkを利用して連携を行います。 |
|---|---|
| 対象プラン |
|
| 用語 |
Zendesk Quickwork ジャーニー |
| ポイント |
・本機能はBIZTELバージョン 3.9.11 から利用可能です。 ・Quickworkを利用する事で、BIZTELとZendesk間の連携を容易に実現します。 ・本機能をご利用いただく場合、お客様による外部契約が必要です。 |
目次
5.6 ChatGPTに対してのプロンプト（指示内容）について
1. Quickworkについて
1.1 Quickworkを用いた連携イメージ
Quickworkオプションは、BIZTELからQuickworkへ通話情報を送信することで、Quickwork上に設定された動作（録音URL連携、通話テキスト連携、テキスト要約連携）を実行し、Zendesk上に連携する機能です。
従来コールアクションオプションを用いて専門的な知識を要したZendeskとの連携設定は、本連携方法ではテンプレートを用いるため、お客様での設定操作は一部のみ実施いただきます。
※設定が必要な箇所は本マニュアル内で順を追ってご説明いたします。
1.2 必要ライセンス
連携する動作毎に必要なライセンスが異なりますので、お客様の想定動作に従った必要ライセンスをご確認ください。
①録音URL連携をご利用の場合
ご利用可能プラン・必要オプション
・コールセンタープラン
・コールアクション連携オプション
お客様に個別でご契約いただくサービス
・Zendesk（プラン問わず）
②テキスト連携をご利用の場合
ご利用可能プラン・必要オプション
・コールセンタープラン
・コールアクション連携オプション
・音声認識連携オプション
お客様に個別でご契約いただくサービス
・Zendesk（プラン問わず）
・AmiVoice API
③テキスト要約連携をご利用の場合
ご利用可能プラン・必要オプション
・コールセンタープラン
・コールアクション連携オプション
・音声認識連携オプション
お客様に個別でご契約いただくサービス
・Zendesk（プラン問わず）
・AmiVoice API
・OpenAI（ChatGPT 3.5 turboでの利用を想定しています）
1.3 注意事項
・本連携は、コールセンター着信時のみ動作する設定となります。
発信時及びビジネスフォンプランの場合、動作しませんのでご注意ください。
・本マニュアル以外の設定を行った場合、弊社によるサポートの対象外となりますのでご注意ください。
2. ご利用開始までの流れ
2.1 ご契約時に提供する情報
Quickworkオプションのご契約後、以下の情報を提供いたします。
- Quickworkのアカウント情報、アクセスURL
- コールアクション用の設定ファイル
2.2 全体の対応フロー
ご利用開始までにお客様で以下の設定を行っていただく必要がございます。
お客様がお申込みいただいた動作に沿った設定完了までのフローをご確認ください。
● ご利用開始までのフロー早見表
設定方法は、各手順を参照ください。
| 工程 | 対応手順 | 詳細 |
|---|---|---|
| 1 | 手順 3.1 | OpenAI上でお客様のクレジットカードの情報を登録します。 ※ChatGPTによるテキスト要約連携をご利用のお客様のみ必要な作業です。 |
| 2 | 手順 3.2 | OpenAI上で連携に利用する API KEY を発行します。 ※ChatGPTによるテキスト要約連携をご利用のお客様のみ必要な作業です。 |
| 3 | 手順 4 | ZendeskのアカウントIDを確認します。 |
| 4 | 手順 5.1 | Quickworkにログインします。 |
| 5 | 手順 5.2.1 | パスワード生成ツール等を用いて、Quickwork上で設定する API KEY を発行します。 |
| 6 | 手順 5.2.2 | 生成した API KEY をQuickworkに登録します。 |
| 7 | 手順 5.3 | Quickwork上で、BIZTEL、Zendesk、ChatGPTの認証を行います。 ※ChatGPTの認証は、テキスト要約連携をご利用のお客様のみ必要な作業です。 |
|
8 |
手順 5.4 |
Quickwork上で、BIZTELとの連携に必要な WebhookURL を取得します。 |
| 9 | 手順 5.5 | Quickworkのジャーニーを開始します。 |
| 10 | 手順 6.1 | BIZTEL上で、コールアクションのテンプレートをインポートします。 |
| 11 | 手順 6.2 | BIZTEL上で、インポートしたコールアクションの設定を行います。 |
| 12 | 手順 6.3 | BIZTEL上で、BIZTELとZendeskのアカウントの紐づけを行います。 |
| 13 | 手順 6.4 | BIZTEL上で、音声認識連携（AmivoiceAPI）の設定を行います。 ※テキスト連携、テキスト要約連携をご利用のお客様のみ必要な作業です。 |
| 14 | 手順 7 | 動作試験を行います。 |
3. OpenAI事前準備
本手順は、「テキスト要約連携」をお申込みのお客様のみ対応ください。
3.1 クレジットカード情報の登録
OpenAIのアカウント作成後は無料トライアル枠が付与されます。
無料トライアル枠を超えて利用した場合、OpenAI APIを利用できなくなるため、事前にクレジットカード情報を登録ください。
※2024年1月時点では、無料トライアル枠を作成後、3か月間で5ドル分の利用が可能です。
手順１．OpenAIの管理画面にログインします。
手順２．「Settings」>「Billing」をクリックします。
手順３．「Add payment details」をクリックします。
手順４．アカウント種別を選択します。
Individual：個人アカウントで登録する場合に選択します。
Company：法人アカウントで登録する場合に選択します。
手順５．クレジットカード情報を入力し、「Continue」をクリックします。
手順６．「Initial credit purchase」に初回購入額を入力し「Continue」をクリックします。
※購入額・オートチャージの設定はお客様の任意で設定ください。
「Yes.automatically recharge my card ～」のボタンを有効化することでオートチャージの設定が可能です。
以上で登録が完了です。
3.2 OpenAIの API KEY を発行する
手順１．OpenAIの管理画面にログインします。
手順２．設定アイコンから「API keys」をクリックします。
手順３．「Create new secret key」をクリックします。
手順４．名前を入力し「Create secret key」をクリックします。
手順５．「Create new secret key」と表示後、「sk-」から始める英数字をコピーし、「Done」をクリックします。
※コピーしたAPI KEYはテキスト等にメモし、保存ください。
※本画面でしかAPI KEYのコピーができませんので必ずコピーしてください。
万が一コピーを忘れてしまった場合は、同様の手順で再度 API KEY を作成ください。
4. ZendeskのアカウントIDを確認する
本工程は、「録音URL連携」「テキスト連携」「テキスト要約連携」いずれの場合でも必要な設定です。
BIZTELとZendeskを連携するためのアカウントIDを確認します。
手順１．アカウントIDは、Zendeskの管理画面より、「メンバー」>「チームメンバー」>「IDを確認するアカウント」をクリックします。
手順２．アカウントクリック後の URL に表示される数字の部分を確認します。
※URLに表示される数字は各アカウント毎に異なりますので、連携時に利用するアカウント単位でIDを控えてください。
「6.3 BIZTELとZendeskのアカウントを紐づける」にて利用します。
5. Quickworkの事前設定を行う
本工程は、「録音URL連携」「テキスト連携」「テキスト要約連携」いずれの場合でも必要な設定です。
5.1 Quickworkにログインする
Quickworkのアクセス先URLは、ご契約時にご案内いたします。
初回アクセス時はアカウントパスワードのリセットを実施いただきます。
※パスワードリセット用のURLにアクセスし、パスワードを変更ください。
※初回ログインのリセット以降にパスワードリセットを行う場合は弊社までお問い合わせください。
パスワード設定基準
・8文字以上
・1文字以上の英大文字
・1文字以上の英小文字
・1文字以上の数字
・1文字以上の特殊文字（記号）
パスワードを変更後、更新後のパスワードを用いてQuickworkへログインください。
5.2 API KEYを登録する
5.2.1 API KEYを発行する
パスワード生成ツール等を用いて、API KEYとなる文字列を作成ください。
・文字数制限はありません。
・英大文字、英小文字、数字、記号の利用に制限はありません。
お客様のセキュリティポリシーに沿った内容で生成ください。
5.2.2 API KEYを登録する
BIZTELとの連携を行うためにAPI KEYを登録します。
手順１．Quickworkの画面で「ツール」>「API管理」をクリックします。
手順２．「パスのプレフィックス」に値を入力し、「Save」をクリックします。
※「5.2.1 API KEYを発行する」で生成した値を入力ください。
手順３．「成功」と表示されると登録完了です。
以上で API KEY の発行は完了です。
続けて「5.3 アプリケーションの認証」を実施ください。
5.3 アプリケーションの認証
Quickwork上で、BIZTELとZendeskの認証設定を行います。
手順１．登録されているジャーニーをクリックします。
手順２．イベントに表示されている BIZTEL の項目をクリックします。
手順３．「アカウントをリンク」をクリックします。
手順４．以下の内容を入力し、「リンクアカウント」をクリックします。
| 接続名 | 任意の内容で入力ください。 |
|---|---|
| API Key | 「5.2 API KEYを発行する」で発行したパスのプレフィックスを入力します。 |
手順５．「成功」と表示されたら連携完了です。
手順６．続けて、手順欄に表示されている Zendesk アイコンが表示されている行をクリックします。
※Zendeskアイコンが表示されている行であれば、どの行でも問題ありません。
手順７．「アカウントをリンク」をクリックします。
手順８．以下の内容を入力し、「リンクアカウント」をクリックします。
| 接続名 | 任意の内容で入力ください。 |
|---|---|
| Zendesk Domain |
お客様のZendeskドメインを入力します。 例）******.zendesk.com |
手順９．「成功」と表示されたら連携完了です。
手順１０．「変更内容を保存」をクリックし設定内容を保存します。
※ChatGPTとの連携を行う場合は、同様に ChatGPT の認証を実施ください。
「3.2 OpenAIの API KEY を発行する」にて発行した API KEY を入力し、アプリケーションを認証してください。
続けて「5.4 WebhookURLを発行する」を実施ください。
5.4 WebhookURLを発行する
BIZTELとの連携を行うためにWebhookURLを発行します。
BIZTELの行をクリックし、Event name欄に表示されている名称を変更し、入力欄の枠外をクリックします。
※WebhookURLは、「6.2 コールアクションの設定を行う」にて利用するため、コピーしてテキスト等にメモしてください。
5.5 ジャーニーを開始する
「5.4 WebhookURLを発行する」まで設定が完了後、ジャーニーを開始します。
「ジャーニーを停止」と表示されたら開始完了です。
※ジャーニーはTOP画面からボタンで開始・終了を切り替えることも可能です。
緑色が見えているボタンは開始状態となり、赤色が見えているボタンは停止状態です。
5.6 ChatGPTに対してのプロンプト（指示内容）について
「テキスト要約連携」を行う場合、ChatGPTに対してのプロンプト（指示内容）はアプリケーション内で定義されています。
標準のプロンプトの内容は、"お客様との通話テキスト内の情報のみを 300字以内 で要約し、要約できない場合は、その旨を記載する"内容となります。
プロンプトの内容はお客様運用に沿った内容で適宜変更ください。
※標準のプロンプトの内容から変更し、正常に動作しない場合は、弊社でのサポート対象外となりますのでご注意ください。
6. BIZTELの設定を行う
本工程は、「録音URL連携」「テキスト連携」「テキスト要約連携」いずれの場合でも必要な設定です。
6.1 コールアクションのテンプレートをインポートする
コールアクションのテンプレートは納品時にデータを送付しますので、事前にダウンロードください。
手順１．「連携オプション」>「コールアクション連携」をクリックします。
手順２．「インポート」をクリックします。
手順３．「ファイル選択」をクリックし、テンプレートファイルを開きます。
手順４．インポートをクリックします。
手順５．「インポートが完了しました」と表示後、「OK」をクリックします。
以上でテンプレートファイルのインポートは完了です。
6.2 コールアクションの設定を行う
本手順では、録音URL連携用のテンプレートを例として修正方法を紹介します。
手順１．インポートした設定をクリックします。
手順２．「API連携」タブをクリックします。
手順３．設定行３つを以下の内容で編集します。
| URL |
・修正箇所
https://XXXXXXXX XXXXXXXX には、Quickworkで発行した WebhookURL を入力します。 ※XXXXXXXX の部分だけ選択して貼り付けすると、"https://https://"のように不要な文字が入る可能性がありますのでご注意ください。
|
|---|---|
| リクエストヘッダ |
・修正箇所
X-BIZTEL-APIKEY:XXXXXXXX
XXXXXXXX には、「5.2.2 API KEYを登録する」で登録したパスのプレフィックスを入力します。
|
| URL、リクエストヘッダ以外の項目 | URL、リクエストヘッダ以外の項目は、編集不要です。 |
手順４．「連携対象」タブをクリックします。
手順５．「編集」ボタンをクリックします。
手順６．Quickworkと連携を行う電話番号にチェックを入れ、「保存」をクリックします。
※連携するコールセンターの設定が完了していない場合は、設定後に本項目を操作ください。
手順７．「保存しますか？」の表示後、「OK」をクリックします。
手順８．「基本情報」タブをクリックします。
手順９．「編集」ボタンをクリックします。
手順１０．ステータスを「有効」にチェックを入れ、「保存」をクリックします。
手順１１．「保存しますか？」の表示後、「OK」をクリックします。
以上でコールアクションの設定は完了です。
6.3 BIZTELとZendeskのアカウントを紐づける
着信時にZendeskの画面上にチケットをポップアップさせるため、「4. ZendeskのアカウントIDを確認する」で確認したIDとBIZTELのアカウントを紐づけます。
※本項目は、連携が必要なアカウント分の設定が必要です。
手順１．管理画面より「アカウント」>「アカウント」をクリックします。
手順２．設定対象のアカウントをクリックします。
手順３．画面上部のタブから「APIカスタム項目」をクリックします。
手順４．「新規」をクリックします。
手順５．以下の項目を入力し、「保存」をクリックします。
| Key | 「ID」と入力します。 |
|---|---|
| Value | 「4. ZendeskのアカウントIDを確認する」で確認した値を入力します。 |
| メモ | 500字以内でご自由に入力ください。 |
手順６．「保存しますか？」と表示後、「OK」をクリックします。
以上でBIZTELとZendeskのアカウントの紐づけは完了です。
6.4 音声認識連携（AmivoiceAPI）の設定
本設定は「テキスト連携」「テキスト要約連携」をご利用の場合に必要な設定となります。
マニュアル「1.音声認識連携（AmiVoice API）」に従い設定ください。
7. 動作確認を行う
QuickworkとBIZTELの設定が正常に動作していることを確認します。
連携対象として設定した電話番号に着信を入れ通話し、正常に動作するかをご確認ください。
● 録音URL連携の正常動作時の画面
録音URL連携が正常に動作した場合、以下の動作が実行されます。
1. 着信時にZendesk上にチケットを作成します。
2. エージェント呼出し時にチケットをポップアップします。
3. 録音完了後に「通話情報」「録音URL」をチケットに連携します。
● テキスト連携の正常動作時の画面
テキスト連携が正常に動作した場合、以下の動作が実行されます。
1. 着信時にZendesk上にチケットを作成します
2. エージェント呼出し時にチケットをポップアップします。
3. 録音完了後に「通話情報」「録音URL」「通話テキスト」をチケットに連携します。
● テキスト要約連携の正常動作時の画面
テキスト要約連携が正常に動作した場合、以下の動作が実行されます。
1. 着信時にZendesk上にチケットを作成します。
2. エージェント呼出し時にチケットをポップアップします。
3. 録音完了後に「通話情報」「録音URL」「通話テキスト」「テキスト要約」をチケットに連携します。
チケットがポップアップしない等、想定動作とならない場合は、「8. 正常に連携が動作しない場合の切り分け」にて原因の切り分けを実施ください。
8. 正常に連携が動作しない場合の切り分け
設定後に正常に動作しない場合の切り分け方法を紹介します。
切り分けた結果、原因が特定できない場合は、弊社までお問い合わせください。
8.1 Quickworkの確認
8.1.1 連携が成功している場合
連携が正常に完了している場合、設定したジャーニーの履歴タブ内に「成功」ステータスの実行ログが記録されます。
8.1.2 連携が失敗している場合
連携が正常に完了している場合、設定したジャーニーの履歴タブ内に「失敗」ステータスの実行ログが記録されます。
「失敗」ステータスが記録されている行をクリックすると、エラーメッセージと実行に失敗した手順が表示されます。
「成功」「失敗」いずれの実行ログも表示されていない場合、BIZTELからの連携に失敗している可能性がございます。次項「8.2 BIZTELの確認」から連携に失敗している箇所をご確認ください。
8.2 BIZTELの確認
8.2.1 コールアクション履歴を確認する
コールアクション履歴は実行されたコールアクション単位で連携結果を表示します。
処理がエラーとなった時刻と一致する行をクリックすることで該当のコールアクションの実行結果を確認可能です。
※画面内では、コールアクションに設定されている処理分の結果が表示されます。
各履歴の参照ボタンをクリックすることで、該当のコールアクションの検索条件を指定した状態で「外部API連携履歴」を確認する事が可能です。
API実行結果の詳細は「8.2.2 外部API連携履歴」からご確認ください。
8.2.2 外部API連携履歴
外部API連携履歴は、BIZTELと外部連携システムとのAPI連携履歴を記録しています。
「履歴・状況」>「外部API連携履歴」から対象の通話を検索ください。
※外部API連携履歴の検索方法などは「1.外部API連携履歴」を参照ください。
以下のようにエラーが記録されている場合、該当行をクリックすることでエラー詳細が確認可能です。
また、コールアクション履歴内で「参照」ボタンをクリックして、画面遷移した場合は、検索条件が指定された状態で該当の処理に関する履歴のみが表示されます。
本エラーの場合、「接続に問題があります」と記録されている為、コールアクションに設定しているURLに誤りがあることが考えられます。
例）コールアクション内「API連携」の設定値であるURLに脱字など、誤りがないかをご確認ください。
8.3 その他の確認箇所
API連携部分に問題が見受けられない場合、以下の点をご確認ください。
※お客様の連携内容に応じた設定箇所をご確認ください。
● BIZTELのアカウントとZendeskのアカウントが紐づけされているか。
Zendesk上で着信時にチケットがポップアップしない場合、BIZTELのアカウントとZendeskのアカウントが紐づけされていない可能性がございます。
「アカウント」>「アカウント」> 設定対象のアカウントをクリック > 「APIカスタム連携」タブにZendeskアカウントのIDが設定されているかご確認ください。
設定が不足している場合、以下２つの手順に従い、アカウントの紐づけを行ってください。
● コールアクション連携メニュー内の連携対象の電話番号にチェックが入っているか。
連携対象の電話番号にチェックが入っていない場合、コールアクションが動作しませんので、連携対象とする電話番号にチェックを付けてください。
● 音声認識連携メニュー内の連携対象の電話番号にチェックが入っているか。
連携対象の電話番号にチェックが入っていない場合、音声認識連携（通話内容のテキスト化）が動作しませんので、連携対象とする電話番号にチェックを付けてください。
● コールセンターの初期ガイダンスが「設定なし」になっていないか。
コールセンターの初期ガイダンスが「設定なし」になっている場合、Quickworkとの連携が正常に動作しない場合がございます。
コールセンターの初期ガイダンスは、極力何らかのガイダンスは再生される設定とするようにしてください。
● 連携対象としたリソースが録音される設定になっているか。
Quickworkへ連携を行う場合、録音データが生成される必要がございます。
コールセンター通話録音の設定が「設定する」になっているかご確認ください。
※コールセンターの通話録音の設定箇所
コールセンター > コールセンター > 対象のコールセンター > 基本情報 > コールセンター通話録音
● 通話テキスト要約連携でエラーとなる場合
通話テキストの要約連携で、ChatGPTより送信される token が 4097 tokens を超えた場合、以下の様なエラーメッセージが表示されます。
本エラーは、tokenカウントが多い通話（主に長時間の通話）で発生する場合がございます。
頻発する場合は、コールアクションのイベント種別「録音完了／音声認識連携完了」となっている設定（赤枠内の設定）の以下項目を修正ください。
| 修正箇所 |
リクエストボディ内の以下設定を修正します。 変更前：{VOICE_LOG.LEFT(4000).JSON_ESCAPE()} 変更後：{VOICE_LOG.LEFT(3800).JSON_ESCAPE()} ※本設定は、通話テキストの先頭文字列を何文字、Quickworkに連携するかの設定値となります。 |
|---|
9. 制限事項
● BIZTELから外部APIに対しての制限はございません。
● Quickworkの制限事項として、リクエスト上限は 2回/1秒 となります。
※複数の着信が入った場合、保留中となり順次処理されます。