| 目的 |
外部APIの連携オプションごとに、連携エラーに対する通知設定（通知先、通知頻度、および通知上限）を行います。
通知設定を行うことにより、外部APIの連携エラー発生時にメールで通知を受け取ることが可能です。
通知対象は「API連携IVR／音声認識サービス連携IVR」「コールアクション連携／Slack連携」となります。
|
| 対象プラン |
  
|
| 用語 |
【コールアクション】
BIZTELサーバと外部CRMとのサーバ連携を行う機能となります。
BIZTELサーバを経由した通話に関してはそれぞれの動作に対して通話イベントを記録しており、
通話イベント(着信イベントや応答イベント)を起点として、外部CRMのWebAPIを実行することが
可能になります。
【API連携IVR】
IVRの機能を利用して、BIZTELサーバと外部CRMとのサーバ連携を行う機能となります。
お客様からの着信がBIZTELサーバに入った際にIVR機能を用いて、音声認識もしくは、プッシュ操作後(プッシュ操作なし設定も可能)に外部CRMのWebAPIを実行し、APIの結果に基づき音声ガイダンスを流したり、会員専用コールセンターへ着信をさせたりすることが可能です。
|
| ポイント |
・あらかじめ、連携オプション>通知先設定で通知先を設定しておく必要があります。
通知先設定の詳細は「1.通知先設定」を参照ください。
・本機能をご利用頂くには、「コールアクション」もしくは「API連携IVR」のオプション契約が必要です。
※BIZTELバージョン 3.4.0以降で利用可能です。
※通知先設定は、システム管理者ロールのアカウントでのみ操作・編集が可能です。
※外部連携先の基本契約ライセンスの追加・変更等が必要な場合がございます。
お客様の契約状況によって異なりますので、詳しくはこちらのフォームよりお問い合わせください。
|
目次
1. エラー通知設定
2. 通知頻度について
2.1 通知頻度を「即時」と指定した場合
2.2 通知頻度を「毎時」と指定した場合
2.3 通知頻度を「毎日」と指定した場合
3. 注意事項
1. エラー通知設定
手順１．BIZTEL管理画面より、「連携オプション」>「エラー通知設定」をクリックします。
手順２．画面右上の「編集」をクリックします。
※コールアクションオプション契約のみの画面
※API連携IVR契約のみの画面
手順３．必要事項を入力し、「保存」をクリックします。
※「API連携IVR/音声認識サービス連携IVR」と「コールアクション連携/Slack連携」の連携対象ごとにエラー通知の設定が可能です。
| ステータス |
API連携IVR、コールアクション連携に対するエラー通知の有効／無効を設定します。
※ API連携IVR、コールアクション連携内の１つ１つの設定に対して細かい制御はできません。
設定する
詳細項目を表示し、外部APIの連携エラーに対する通知設定を行います。
設定しない
外部APIの連携エラーに対する通知設定を行いません。
|
| 通知先 |
外部APIの連携エラー発生時の通知先を指定します。
※事前に「1.通知先設定」にて、エラー発生時の通知先を登録する必要があります。
|
| エラー通知タイトル |
外部APIの連携エラー通知メールの件名を指定します。
API連携IVR/音声認識サービス連携IVR エラー通知
デフォルト（【{OEM_TITLE}】API連携IVRエラー通知）
コールアクション連携/Slack連携 エラー通知
デフォルト（【{OEM_TITLE}】コールアクション連携エラー通知）
※{OEM_TITLE}にはBIZTELと表記されます。
|
| 通知頻度 |
エラー通知の頻度を指定します。
詳細は以下「2. 通知頻度について」を参照ください。
|
2. 通知頻度について
通知頻度について説明します。
2.1 通知頻度を「即時」と指定した場合
| 通知頻度 |
即時
エラーが発生する都度、メールで通知します。
|
| 通知上限 |
時間当たりのエラー通知上限数となります。
デフォルト：1 ※変更不可
※エラー通知は時間当たり1通のみ送信され、通知以降にエラーが発生しても次の時間までエラー通知は送信されません。
例）「10:05」にエラーが発生し、エラー通知が送信された場合
通知されたエラー以降、「10:59:59」までに発生したエラー：通知されない
「11:00:00」以降に発生したエラー：最初の1件のみ通知される
|
| 現在の通知数 |
参照時点のエラー通知数を表示します。
※エラー通知上限が「1」に達している場合のみ、リセットボタンにてエラー通知上限をリセットすることが可能です。
※本機能はBIZTELバージョン 3.7.0 以降で利用可能です。
|
| 超過通知タイトル |
エラー通知の上限を超えた場合、上限超過をメールで通知します。
上限超過通知のタイトルを指定します。
API連携IVR/音声認識サービス連携IVR エラー通知
デフォルト：【{OEM_TITLE}】API連携IVRエラー通知（超過通知）
コールアクション連携/Slack連携 エラー通知
デフォルト：【{OEM_TITLE}】コールアクション連携エラー通知（超過通知）
※{OEM_TITLE}にはBIZTELと表記されます。
※超過通知の送付先はエラー通知と同じです。
※超過通知は時間当たり1通のみ送信されます。
|
●エラー通知メール例
|
件名：【BIZTEL】コールアクション連携エラー通知
----------------------------
※本メールはBIZTELサーバより自動で送信されております。
BIZTEL外のAPI実行でエラーが確認されました。
-------------------------------------------------------------------------
発生時刻 : 2021-05-26 16:41:33 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-------------------------------------------------------------------------
---------------------------------------------------------------
BIZTEL
サービスサイト ：https://biztel.jp/
お問い合わせ先 ：https://biztel.jp/support/
© 2019 LINK, Inc.
---------------------------------------------------------------
|
●超過通知メール例
|
件名：【BIZTEL】コールアクション連携エラー通知（超過通知）
----------------------------
※本メールはBIZTELサーバより自動で送信されております。
BIZTEL外のAPI実行でエラー通知の上限超過が確認されました。
17:00 までエラー通知を停止します。
-------------------------------------------------------------
BIZTEL
サービスサイト ：https://biztel.jp/
お問い合わせ先 ：https://biztel.jp/support/
© 2019 LINK, Inc.
-------------------------------------------------------------
|
2.2 通知頻度を「毎時」と指定した場合
| 通知頻度 |
毎時
毎時間の xx:00:00 に直近1時間のエラーをメールで通知します。
例）09:00:00～09:59:59までのエラーを10:00:00に通知
|
●エラー通知メール例
|
件名：【BIZTEL】コールアクション連携エラー通知
----------------------------
※本メールはBIZTELサーバより自動で送信されております。
BIZTEL外のAPI実行でエラーが確認されました。
-----------------------------------------------------------------------
発生時刻 : 2021-05-26 17:57:47 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:47 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:45 URL :お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:44 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:48:16 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-----------------------------------------------------------------------
-------------------------------------------------------------
BIZTEL
サービスサイト ：https://biztel.jp/
お問い合わせ先 ：https://biztel.jp/support/
© 2019 LINK, Inc.
-------------------------------------------------------------
|
2.3 通知頻度を「毎日」と指定した場合
| 通知頻度 |
毎日
指定時間に直近24時間のエラーをメールで通知します。
例）通知時間を「10:00」と指定した場合
前日10:00:00～当日09:59:59までのエラーを10:00:00に通知
|
| 通知時間 |
毎日のエラー通知時間を指定します。
|
●エラー通知メール例
|
件名：【BIZTEL】コールアクション連携エラー通知
----------------------------
※本メールはBIZTELサーバより自動で送信されております。
BIZTEL外のAPI実行でエラーが確認されました。
-------------------------------------------------------------------------
発生時刻 : 2021-05-26 17:57:47 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:47 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:45 URL :お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:57:44 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
発生時刻 : 2021-05-26 17:48:16 URL : お客様サーバホスト名:8000/ api_link_log?created_at_start=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-------------------------------------------------------------------------
---------------------------------------------------------------
BIZTEL
サービスサイト ：https://biztel.jp/
お問い合わせ先 ：https://biztel.jp/support/
© 2019 LINK, Inc.
---------------------------------------------------------------
|
通知メールに記載のURLにアクセスすると、外部API連携履歴画面に遷移し、発生した連携エラーの詳細を確認できます。詳細は、「1.外部API連携履歴」を参照ください。
3. 注意事項
エラー通知対象について
エラー通知対象はHTTPレスポンスコード 400 ～ 500 番台となります。
各連携オプションに「エラー時のリトライ設定」をしている場合
各連携オプションに「エラー時のリトライ設定」をしている場合、リトライによりAPI実行が成功となった場合はエラー通知対象外となり、リトライが全て失敗した場合にエラー通知対象となります。
「エラー時のリトライ設定」の詳細は「1.コールアクション」および「2.API連携IVR」を参照ください。
