お問い合わせは https://biztel.jp/support/ から
ご依頼ください

こちらに「ソフトフォン設定」等、調べたいワードをご入力ください。

このセクションの記事

1. コールアクション

BIZTEL Servicedesk
  • 更新
目的

BIZTELサーバと外部CRMとのサーバ連携を行う機能となります。

BIZTELサーバを経由した通話に関してはそれぞれの動作に対して通話イベントを記録しており、
通話イベント(着信イベントや応答イベント)を起点として、外部CRMのWebAPIを実行可能になります。

対象プラン
用語

【外部CRM】
外部CRMとは顧客管理のためのシステムとなり、各CRMベンダーより提供されているサービスとしてSalesforce、Kintoneなどがあります。

※BIZTELサービスとして外部CRMは提供しておりませんので、BIZTELサービスと外部CRMを連携してご利用いただくためには、別途外部CRMをご契約頂く必要がございます。

【WebAPI】

インターネットを経由した標準的なWeb技術を利用した各サービス(BIZTELでは外部CRM)と連携するためのCRM側のインターフェースとなります。
各CRMごとにWebAPIで用いるパラメータは異なっており、それぞれのCRMサービスで仕様を公開しています。

【アクション】

通話イベント(着信イベントや応答イベント)を起点として、外部CRMのWebAPIを実行する一連の処理を意味しています。

ポイント

・本機能をご利用頂く場合、「コールアクション連携」のオプション契約が必須です。
※外部連携先の基本契約ライセンスの追加・変更等が必要な場合がございます。
　お客様の契約状況によって異なりますので、詳しくはこちらのフォームよりお問い合わせください。

・OAuth認証を用いてWebAPIへ連携する場合は、オプション > OAuthアカウントの事前登録が必要となります。

・コールアクションをSalesforceで利用するにはOAuth認証が必須となります。

※オプション > Salesforceアカウント設定はSalesforce履歴連携メニュー用となり、コールアクションには対応しておりません。

・本マニュアルはHTML/PHP(PCRE正規表現等)/WebAPIの基礎的な技術知識がある、WEB系開発者様やCRMベンダー様を対象にしております。

目次

1. コールアクションの基本機能

2. コールアクションが動作する通話パターンと発動イベント

3. コールアクションの登録・編集

3.1 コールアクションの新規登録

3.2 連携対象タブの設定

3.3 API連携設定

4. 変数展開コード

4.1 変数展開文字列

4.2 APIカスタム項目

4.2.1 KeyとValue登録

4.2.2 メソッドチェーン

5. コールアクション動作確認

5.1 外部API連携履歴

5.2 コールアクション履歴

5.2.1 「コールアクション」メニューから確認する

5.2.2 「履歴・状況」メニューから確認する

5.3 コールアクション履歴の検索結果を確認する

5.4 うまく動作しない場合の切り分け

6. コールアクションのエクスポート・インポート

6.1 コールアクションのエクスポート

6.2 コールアクションのインポート

1. コールアクションの基本機能

ひとつの通話には、「着信」「応答」「切断」など、複数のイベントが存在します。
コールアクションでは、通話の開始から終了までの各イベントごとにアクション（API連携設定）を指定・実行可能です。

 【動作イメージ図】

・通話の流れ

mceclip1.png

・コールアクションの流れ

mceclip2.png

 

● 通話イベントごとにそれぞれアクションを行うことにより、通話イベント単位で外部CRMのWebAPIを実行可能です。 
また、実行順を設定することで、1つの通話イベントに対して複数のアクションを設定することも可能です。

● 同一通話イベント内でのアクションは同期処理されますが、別通話イベントのアクションは非同期で実行されます。
同期とは、1つのアクションを確認してから次のアクション（API連携設定）を実行することを指します。 

● 外部CRMのWebAPI実行結果から指定したデータを変数に格納し、以降のアクションで使用可能です。

● 各アカウント・電話端末などにコールアクション機能で使用するためのデータを変数で格納し、アクションに使用可能です。

例：CRM連携などで必要となるAPI認証データ（IDやパスワードなど、オペレータごとに異なるデータ)）を、アカウントごとに紐付けて保持することで認証処理に使用可能です。
アカウント以外にもコールセンター、電話端末、IVRにもデータを保持可能です。

注意事項

通話イベントの発生間隔が極端に短い場合、想定通りの動作が行われない場合があります。

2. コールアクションが動作する通話パターンと発動イベント

コールアクションを動作させることが可能な通話パターン（通話内における処理のタイミング）と、設定時に選択するイベント種別は以下のとおりです。
イベント種別の選択や詳細は「3.3 API連携設定」で行います。

外線発信時

通話パターン

 「API連携」タブで選択するイベント種別
発信を開始したとき
（転送で外線発信したときを含む） 		発信
発信先が通話に応答したとき 発信応答
発信先が通話に応答する前に切断したとき 発信切断
発信先が通話に応答し切断したとき 発信切断
外線転送が完了したとき 発信切断
録音ファイルが生成されたとき 録音完了／音声認識連携完了
音声認識連携が完了したとき 録音完了／音声認識連携完了

※以下の場合は「転送元からの外線発信通話」として処理されるため、「外線発信」としてコールアクションが動作します。

・自動/手動問わず、着信を外線転送する場合

外線着信時（コールセンター以外への着信）

ダイヤルイン設定箇所 通話パターン 「API連携」タブで選択するイベント種別
電話端末 着信が鳴動したとき 着信
着信に応答したとき 着信応答
着信応答前に切断されたとき 着信切断
着信応答後に切断した・されたとき 着信切断
録音ファイルが生成されたとき 録音完了／音声認識連携完了
音声認識連携が完了したとき 録音完了／音声認識連携完了
ダイヤルイン設定箇所 通話パターン 「API連携」タブで選択するイベント種別
IVR 着信し、発信者に
ガイダンス再生が開始されたとき 		着信
ダイヤルプッシュが行われる前に
着信が切断されたとき（※） 		着信切断
ダイヤルプッシュ後、転送先が
通話に応答しなかったとき（※） 		着信切断
ダイヤルプッシュ後、転送先で
通話に応答したとき（※） 		着信応答
ダイヤルプッシュ後、転送先で
応答後に切断した・されたとき（※） 		着信切断
録音ファイルが生成されたとき 録音完了／音声認識連携完了
音声認識連携が完了したとき 録音完了／音声認識連携完了

※ IVRの転送先が外線番号の場合、ダイヤルプッシュ後の通話処理は「転送元からの外線発信通話」として処理されます。
そのため、「外線発信」としてコールアクションが動作します。

※ IVRの転送先がコールセンターの場合、ダイヤルプッシュ後のイベントは「着信切断」「着信応答」「録音完了／音声認識連携完了」のみ設定可能です。
その他、「外線着信時（コールセンター着信）」に記載のイベントは設定できません。

ダイヤルイン設定箇所 動作させるタイミング 「API連携」タブで選択するイベント種別
着信グループ 着信が鳴動したとき 着信
着信に応答したとき 着信応答（※）
着信応答前に切断されたとき 着信切断
着信応答後に切断した・されたとき 着信切断
録音ファイルが生成されたとき 録音完了／音声認識連携完了
音声認識連携が完了したとき 録音完了／音声認識連携完了

※ 同じ着信に対し複数端末が同時に応答した場合など、「着信応答」イベントの連携処理が重複する場合があります。

外線着信時（コールセンター着信）

ダイヤルイン設定箇所 動作させるタイミング 「API連携」タブで選択するイベント種別
コールセンター 初期ガイダンスの再生が開始されたとき コールセンター初期ガイダンス開始
初期ガイダンスの再生が終了したとき コールセンター初期ガイダンス終了
初期ガイダンス再生中に
発信者が通話を切断したとき 		コールセンター初期ガイダンス中の切断
着信が待ち呼状態となったとき（※１） コールセンターキュー
エージェントの端末を鳴動したとき コールセンターエージェント呼び出し
エージェントが着信に応答したとき（※２） コールセンター応答
エージェントが通話を保留したとき コールセンター保留開始
エージェントが通話を保留解除したとき コールセンター保留終了
着信応答後に切断した・されたとき コールセンター切断
他のエージェントへの転送が完了したとき コールセンター切断
エージェントが着信に応答できなかった時 コールセンターエージェント応答不能
待ち呼状態になってから
着信応答前に切断されたとき 		コールセンター放棄呼
不在応答設定により着信が切断されたとき コールセンタータイムアウト
録音ファイルが生成されたとき 録音完了／音声認識連携完了
音声認識連携が完了したとき 録音完了／音声認識連携完了
折り返し呼が登録されたとき 折り返し呼登録完了（※３）
折り返し呼の録音が生成されたとき 折り返し呼登録完了（※３）
折り返し呼の音声認識連携が完了したとき 折り返し呼登録完了（※３）

※１ 初期ガイダンスが設定されている場合は、「初期ガイダンスの再生終了後」が動作タイミングです。

※２ エージェント向けガイダンスが設定されている場合は、「エージェントガイダンスの再生終了後」が動作タイミングです。

※３ 「折り返し呼登録完了」イベントは、BIZTELバージョン 3.13.10 以降から選択可能です。

3. コールアクションの登録・編集

コールアクションの登録や編集は、システム管理者以上のロールアカウントで操作します。

3.1 コールアクションの新規登録

本手順ではコールアクションの基本設定を解説します。

手順１．管理画面より、「オプション」 > 「コールアクション」をクリックします。
※BIZTELバージョン 3.3.X 以降、「連携オプション」>「コールアクション連携」となります。

mceclip0.png

手順２．コールアクションの画面表示後、右上の「新規」をクリックします。

mceclip0.png

手順３．必要事項を入力し、「保存」をクリックします。
※BIZTELバージョン 3.2.X までのお客様は「登録」と表示されます。

mceclip1.png

コールアクション名
※必須 		コールアクションに任意の名称を付けます。
ステータス

有効：設定したコールアクションを有効にします。

無効：設定したコールアクションを無効にします。
※ステータスを無効へ変更したタイミングでコールアクションの処理が存在する場合、
該当の処理は最後まで実行されます。
メモ ご自由に記入ください。※500文字まで。

 手順４．「保存しますか？」と表示後、「OK」をクリックします。
※BIZTELバージョン 3.2.X までは「登録しますか？」と表示されます。

mceclip2.png

以上で設定完了です。続けて「3.2 連携対象タブの設定」を実施ください。

3.2 連携対象タブの設定

手順１．一覧から設定するコールアクションをクリックします。

mceclip4.png

手順２．「連携対象」タブをクリックし、「編集」ボタンをクリックします。

mceclip3.png

手順３．外部システムとの連携対象とする電話番号にチェックを入れ、保存します。
※BIZTELバージョン 3.2.X までのお客様は「登録」と表示されます。

mceclip5.png

※この際、既に別のコールアクションにて利用中の電話番号を選択する事はできませんのでご注意ください。

 手順４．「保存しますか？」と表示後、「OK」をクリックします。
※BIZTELバージョン 3.2.X までは「登録しますか？」と表示されます。

mceclip2.png

BIZTELバージョン3.4.10 以降、連携対象タブにて設定箇所の情報を参照可能です。

mceclip0.png

3.3 API連携設定

手順１．「API連携」タブをクリックし、右上の「新規」をクリックします。

mceclip6.png

手順２．設定入力画面が表示後、必要事項を入力し、「保存」をクリックします。

※BIZTELバージョンごとに内容が異なります。

● BIZTELバージョン 3.10.X まで

基本情報

イベント種別

外部CRMのWebAPIを実行する種別を選択します。
各イベントの詳細は、「イベント種別の詳細」をご参照ください。

実行順

同じ通話イベント種別に対して複数の処理設定を行う場合の実行順を設定します。

メモ

500字以内でご自由にご入力ください。

API実行条件

判定用コード

BIZTEL内での処理実行の是非を判断するための判定用コードを設定します。

※判定評価パターンもあわせて入力してください。
判定用コードのみ入力されていても実行されません。

•例：{ISANSWERED}と設定し、その通話が応答されたものかどうかを判定して処理を切り分ける
• 例：{RESPONSE_CRM_ID}でデータが取れるかを見て、CRMレコードが作成済かどうかで処理を切り分ける

※詳細は「4. 変数展開コード」をご参照ください。

判定評価パターン

BIZTEL内での処理実行の是非を判断するために、PHPのPCRE正規表現形式で判定評価パターンを設定します。
判定用コードに対象パターンがマッチしない場合はモーダル内の処理実行を中止しますが、以降の実行順の処理や別通話イベントの処理には関与しません。

※判定用コードの想定値と評価判定パターンが実際にマッチするかを確認してください。
BIZTELにはチェックツールがないため、弊社外の正規表現のチェッカーなどをご活用ください。

API情報

API連携種別

マニュアル、OAuthを選択します。

マニュアル

認証が不要な場合や、外部CRMへのAPIリクエスト情報内に手動で認証情報を埋めこむ場合に選択します。

OAuth

外部CRMのWebAPIへの処理実行時に、OAuth認証が必要な場合に選択します。
※別途、OAuthアカウント設定が必要です。

OAuthアカウント

上記API連携種別にてOAuthを選択している場合、利用するOAuthアカウントを選択します。
URL

外部CRM等へのAPIリクエストを送るURLを入力します。
APIサービス側にパラメータを指定されている場合、適宜記載してください。

※変数展開文字列を使用可能です。
※URL内で変数展開を実施する場合、変数展開される文字列に自動でURLエンコードが実施されます。

上記のエンコードを回避する場合は、RAW()のメソッドチェーンを使用します。
メソッド

GET,POST,PUTなど、処理に使用するメソッドを選択します。
使用メソッドについては使用する外部CRMのWebAPIにて指定されている為、WebAPIに合わせて選択してください。
リクエストヘッダ

外部CRMへのAPIリクエストを送るリクエストヘッダを入力します。
外部CRMのWebAPIに指定された項目を記載してください。

※変数展開文字列を使用可能です。
リクエストボディ

外部CRMへのAPIリクエストを送るボディを入力します。
外部CRMのWebAPIに指定された項目/方式にて記載してください。

※変数展開文字列を使用可能です。
タイムアウト判定(秒)

外部CRMのWebAPIへのリクエスト送信後、設定秒数内にレスポンスが得られない場合にBIZTELでの処理を中止する時間を設定します。

※BIZTELバージョン 3.11.10 前後で、設定可能な秒数の範囲が異なります。
BIZTELバージョン 3.11.10未満：3 ～ 60 秒
BIZTELバージョン 3.11.10以降：10 ～ 60 秒

※タイムアウト判定を10秒未満で設定していたBIZTELサーバをバージョン 3.11.10 以降にバージョンアップした場合、設定値が10秒に変更されます。
変数抽出パターン

リクエストを送ったWebAPIの結果から、必要なデータを抽出するための正規表現パターンを設定します。
正規表現パターン内のサブパターン（正規表現内で()で囲まれた箇所、グループ）箇所を順次抽出し、データベースに格納します。

データベースに格納されたデータは同一の通話内であれば、以降の処理実行時に変数展開箇所にて使用可能です。

例）顧客情報レコードIDを取得する処理を実施し、顧客情報レコードIDを取得、以降のコールアクションの処理でその顧客情報レコードIDを使用し顧客情報レコードを更新する

※変数抽出パターンの補足があります。

※BIZTELバージョン 3.8.20 前後で、入力可能な文字数の上限が異なります。

BIZTELバージョン 3.8.20 未満：最大255文字
BIZTELバージョン 3.8.20 以降：最大1000文字

※BIZTELバージョン 3.9.0 以降、変数抽出パターンにおいて変数展開文字列が使用可能です。

処理種別

抽出したレスポンス結果に対する処理を指定します。
※本項目は、BIZTELバージョン 3.9.0 以降で表示されます。

処理なし

レスポンス結果をBIZTELサーバ内に保持しません。

通話履歴の追加情報へ保存

通話情報を外部システムへ連携し、レスポンス結果をBIZTEL内に保持する場合に選択します。
例）コールアクションでSalesforce上にケースを作成し、ケースIDをBIZTEL内に保存する など

通話履歴のAI解析へ保存

通話内容をChatGPT等の生成AIへ連携し、AI解析した結果をBIZTEL内に保存する場合に選択します。

以下の2項目は処理種別「通話履歴の追加情報へ保存」の選択時に表示されます

項目名

レスポンスが反映される各画面に表示される項目名を指定します。

保存内容

変数抽出パターンで抽出した内容を変数展開することで追加情報に表示する内容を指定します。

※変数展開後、展開された文字列が100文字（BIZTELバージョン 3.13.10 以降は1,000文字）を超過した場合、超過分は切り捨てとなります。

※「通話履歴の追加情報へ保存」を選択した場合、保存上限はありません。

以下の2項目は処理種別「通話履歴のAI解析へ保存」の選択時に表示されます
※設定イメージは「1.OpenAI連携設定例（コールアクション）」をご参照ください。

保存内容（プロンプト）

解析結果が連携される各画面上に表示されるプロンプトの内容を入力します。

※保存内容が1,000文字を超過した場合、超過分は保存時に切り捨てられます。

保存内容（AI解析）

リクエストを送信したAPIの結果からAI解析結果に表示する内容を指定します。

※保存内容が,2000文字を超過した場合、超過分は保存時に切り捨てられます。

※変数展開コードが使用可能です。

※AI解析結果は、10,000件が保存上限です。
保存上限を超えた場合、毎日夜間帯で保存上限以内となるよう古いデータから削除されます。

以下の３項目は処理種別「SMS送信」を選択時に表示されます

SMSテンプレート名

送信するSMSテンプレートを指定します。

※管理画面「オプション」＞「SMSテンプレート」 で登録した一覧が表示されます。

SMS送信番号

「SMSテンプレート名」で指定したSMSテンプレートに紐づくSMS送信番号を表示します。

本文

「SMSテンプレート名」で指定したSMSテンプレートに紐づくSMSの本文を表示します。

エラー時のリトライ設定　※本項目はBIZTELバージョン 3.4.0 以降で表示されます。

エラー判定パターン

API実行後、返却されたレスポンスコードに対して、エラー判定する正規表現を設定します。

※未入力の場合、400 ～ 599 のレスポンスコードをエラー判定します。

リトライ回数

リトライ回数の上限を 0 ～ 5 回で設定します。

リトライ間隔（秒）

リトライの実施間隔を 1 ～ 10 回で設定します。

● BIZTELバージョン 3.11.0 以降

基本情報
イベント種別  外部CRMのWebAPIを実行する通話イベントの種別を選択します。
 各イベントの詳細は、「イベント種別の詳細」をご参照ください。
実行順 同じ通話イベント種別に対し、複数の処理設定を行う場合の実行順を設定します。
当処理の実行判定
判定用コード

BIZTEL内での処理実行の是非を判断する為に判定用コードを設定します。

※判定用コードのみ入力されていても実行されませんので、判定評価パターンもあわせて入力してください。

 例：{ISANSWERED}と設定し、その通話が応答されたものかどうかを判定して処理を切り分ける
 例：{RESPONSE_CRM_ID}でデータが取れるかを見て CRM レコードが作成済かどうかで処理を切り分ける

※詳細は「4. 変数展開コード」をご参照ください。
判定評価パターン

BIZTEL内での処理実行の是非を判断するために、PHPのPCRE正規表現形式で判定評価パターンを設定します。
判定用コードに対象パターンがマッチしない場合はモーダル内の処理実行を中止しますが、以降の実行順の処理や別通話イベントの処理には関与しません。

※判定用コードの想定値と評価判定パターンが実際にマッチするかを確認してください。
BIZTELにはチェックツールがないため、弊社外の正規表現のチェッカーなどをご活用ください。
APIリクエスト情報
API連携種別

マニュアル、OAuthを選択します。

マニュアル

認証が不要な場合、または外部CRMへのAPIリクエスト情報内に手動で認証情報を埋めこむ場合に選択します。

OAuth

外部CRMのWebAPIへの処理実行時にOAuth認証が必要な場合に選択します。
※別途、OAuthアカウント設定が必要です。
OAuth
アカウント		 上記API連携種別にてOAuthを選択している場合、利用するOAuthアカウントを選択します。
URL

外部CRM等へのAPIリクエストを送るURLを入力します。
APIサービス側にパラメータを指定されている場合は適宜記載してください。

※変数展開文字列を使用可能です。
※URL内で変数展開を実施する場合、変数展開される文字列に自動でURLエンコードが実施されます。
上記のエンコードを回避する場合はRAW()のメソッドチェーンを使用します。
メソッド GET,POST,PUTなど、処理に使用するメソッドを選択します。
使用する外部CRMのWebAPI仕様に応じて選択してください。
リクエストヘッダ

外部CRMへのAPIリクエストを送るリクエストヘッダを入力します。
外部CRMのWebAPIに指定された項目を記載してください。

※変数展開文字列を使用可能です。
リクエストボディ

外部CRMへのAPIリクエストを送るボディを入力します。
外部CRMのWebAPIに指定された項目/方式にて記載してください。

※変数展開文字列を使用可能です。
※BIZTELバージョン 3.12.10 前後で、入力可能な文字数の上限が異なります。

BIZTELバージョン 3.12.10 未満：最大 2000 文字
BIZTELバージョン 3.12.10 以降：最大 5000 文字
タイムアウト判定(秒)

外部CRMのWebAPIへのリクエスト送信後、設定秒数内にレスポンスが得られない場合にBIZTELでの処理を中止する時間を設定します。

※BIZTELバージョン 3.11.10 前後で、設定可能な秒数の範囲が異なります。

BIZTELバージョン 3.11.10未満：3 ～ 60 秒
BIZTELバージョン 3.11.10以降：10 ～ 60 秒

※タイムアウト判定を10秒未満で設定していたBIZTELサーバをバージョン 3.11.10 以降にバージョンアップした場合、設定値が10秒に変更されます。
エラー時のリトライ設定　
エラー判定パターン

API実行後、返却されたレスポンスコードに対して、エラー判定する正規表現を設定します。

※未入力の場合、400 ～ 599 のレスポンスコードをエラー判定します。
リトライ回数

リトライ回数の上限を 0 ～ 5 回で設定します。

※BIZTELバージョン 3.13.10 以降、リトライ回数の上限は「0回」または「1回」のみとなります。
リトライ間隔（秒） リトライの実施間隔を 1 ～ 10 回で設定します。
変数抽出
変数抽出パターン

リクエストを送ったWebAPIの結果から、必要なデータを抽出するための正規表現パターンを設定してください。
正規表現パターン内のサブパターン（正規表現内で()で囲まれた箇所、グループ）箇所を順次抽出し、データベースに格納します。データベースに格納されたデータは同一の通話内であれば、以降の処理実行時に変数展開箇所にて使用可能です。

例）顧客情報レコードIDを取得する処理を実施し、顧客情報レコードIDを取得、以降のコールアクションの処理でその顧客情報レコードIDを使用し顧客情報レコードを更新する

※変数抽出パターンの補足があります。
※1,000文字以内でご入力ください。
※変数抽出パターンにおいて変数展開文字列が利用可能です。
抽出後の処理
処理種別

BIZTELサーバ内にコールアクションのレスポンス内容を保管するための設定です。

処理なし

API連携設定の内容をBIZTELサーバ内に保管しません。

通話履歴の追加情報へ保存

通話情報を外部システムへ連携し、レスポンス結果をBIZTEL内に保存する動作を設定する際に選択します。
例）コールアクションでSalesforce上にケースを作成し、ケースIDをBIZTEL内に保存する など

通話履歴のAI解析へ保存

通話内容をChatGPT等の生成AIへ連携し、AI解析した結果をBIZTEL内に保存する動作を設定する際に選択します。

SMS送信

指定したテンプレートのSMSを自動送信する際に選択します。
※BIZTELバージョン 3.12.0 以降、「SMS送信」オプションをご契約の場合に表示されます。

通話履歴にタグを付与⁠

通話履歴に任意のタグを付与する場合に選択します。
※BIZTELバージョン 3.13.0 以降に表示されます。
以下の2項目は処理種別「通話履歴の追加情報へ保存」を選択時に表示されます
項目名 レスポンスが反映される各画面に表示される項目名を指定します。
保存内容

変数抽出パターンで抽出した内容を変数展開することで追加情報に表示する内容を指定します。

※100文字以上（BIZTELバージョン 3.13.10 以降は1,000文字以上）は切り捨てとなります。
※「通話履歴の追加情報へ保存」を選択した場合、保存上限はありません。

※（BIZTELバージョン 3.13.10 以上、かつ「DTMF入力ログマスク化」オプションをご契約の場合のみ）
本設定で特定条件に合致した番号情報が展開された場合、通話履歴上は入力内容がマスクされます。
以下の2項目は処理種別「通話履歴のAI解析へ保存」を選択時に表示されます
※設定イメージは「1.OpenAI連携設定例（コールアクション）」をご参照ください。
保存内容（プロンプト）

解析結果が連携される各画面上に表示されるプロンプトの内容を入力します。

※保存時に1000文字で切り捨てられます。

※（BIZTELバージョン 3.13.10 以上、かつ「DTMF入力ログマスク化」オプションをご契約の場合のみ）
本設定で特定条件に合致した番号情報が展開された場合、通話履歴上は入力内容がマスクされます。
保存内容（AI解析）

リクエストを送信したAPIの結果からAI解析結果に表示する内容を指定します。

※保存時に2000文字で切り捨てられます。
※変数展開コードが使用可能です。

※AI解析結果は、10,000件が保存上限となります。
保存上限を超えた場合、毎日夜間帯で保存上限以内となるよう古いデータから削除されます。

※（BIZTELバージョン 3.13.10 以上、かつ「DTMF入力ログマスク化」オプションをご契約の場合のみ）
本設定で特定条件に合致した番号情報が展開された場合、通話履歴上は入力内容がマスクされます。
以下の３項目は処理種別「SMS送信」を選択時に表示されます
SMSテンプレート名

送信するSMSテンプレートを指定します。

※オプション＞SMSテンプレート で登録した一覧が表示されます。
SMS送信番号 「SMSテンプレート名」で指定したSMSテンプレートに紐づくSMS送信番号を表示します。
本文 「SMSテンプレート名」で指定したSMSテンプレートに紐づくSMSの本文を表示します。
以下の３項目は処理種別「通話履歴にタグを付与」を選択時に表示されます
登録対象タグ

通話履歴へ付与するタグを指定します。

※タグの詳細は「1.タグ」をご参照ください。
タグ判定用コード

タグを付与するか判定するために、評価対象となる文字列データを指定します。
タグ判定用コードに対して、タグ判定評価パターンがヒットした場合に、通話履歴へタグが付与されます。
タグの判定評価の詳細は、「タグの判定評価について」をご参照ください。

※変数展開コードを使用可能です。
詳細は「4. 変数展開コード」をご参照ください。
タグ判定評価パターン タグを付与するか判定するために、タグ判定用コードの評価条件となる文字列データを正規表現で指定します。
メモ
メモ 500字以内でご自由に入力ください。

イベント種別の詳細

「イベント種別」で選択可能な項目および具体的な通話時のタイミングは以下をご参照ください。

項目名

説明 （具体的な発生タイミング）

着信

外線着信したタイミングで動作します。

着信応答

外線着信に対して相手が応答したタイミングで動作します。

着信切断

着信に対する応答の有無にかかわらず、外線着信が終了したタイミングで動作します。

発信

発信先の応答がなかった場合や発信先番号が存在しない場合も含め、外線発信を行ったタイミングで動作します。

発信応答

外線発信に対し、相手が応答したタイミングで動作します。

発信切断

外線発信後、応答の有無を問わず、通話が終了したタイミングで動作します。

以下は、コールセンターライセンスをご契約の場合のみ表示対象
かつ、「コールセンター宛の外線着信」に対してのみ動作します。

コールセンター初期ガイダンス開始

コールセンター初期ガイダンスの再生が開始されたタイミングで動作します。

コールセンター初期ガイダンス終了

コールセンター初期ガイダンスの再生が終了したタイミングで動作します。

コールセンター初期ガイダンス中の切断

コールセンター初期ガイダンスの再生が完了する前に、通話が切断された場合に動作します。

コールセンターキュー

コールセンター着信に対し、エージェントへの呼び出しを開始した入ったタイミングで動作します。

コールセンターエージェント呼び出し

コールセンターのエージェントへの呼び出しが発生したタイミングで動作します。
前回呼び出された人が通話に応答せず次のエージェントが呼び出された場合は、次の人が呼び出されるたびに都度動作します。

コールセンターエージェント応答不能

コールセンターのエージェント呼び出しに対し、エージェントが拒否をした、またはコールセンター設定「タイムアウト」で設定した呼び出しタイムアウト秒数が発生したタイミングで動作します。

コールセンター応答

コールセンターのエージェント呼び出しに対し、エージェントが応答したタイミングで動作します。

コールセンター保留開始

コールセンター通話に応答中のエージェントが通話を保留状態にしたタイミングで動作します。

コールセンター保留終了

コールセンター通話を保留状態にしていたエージェントが保留状態を解除したタイミングで動作します。

コールセンター切断

コールセンター通話に対してエージェントが応答後、通話が終了したタイミングで動作します。

コールセンター放棄呼

エージェントがコールセンター通話に応答する前に、発信者が通話を終了したタイミングで動作します。

コールセンタータイムアウト

コールセンターの着信設定で「不在判定時ルール」が設定されている場合、設定した不在判定秒が経過したタイミングで動作します。

コールセンターキューダイヤル受付

コールセンターの待ち呼状態にいる発信者が「#」を入力したタイミングで動作します。

※BIZTELバージョン 3.4.0以降で利用可能です。

折り返し呼登録完了

コールセンター着信に対し、折り返し呼の登録が完了したタイミングで動作します。

折り返し呼の「録音」および「音声テキスト化」が有効化されている場合は、以下のタイミングで動作します。

録音が有効の場合

折り返し呼の録音ファイルが生成されたタイミングで動作します。

録音と音声テキスト化が有効の場合

折り返し呼録音の音声テキスト化が完了したタイミングで動作します。

※BIZTELバージョン 3.13.10 以降で利用可能です。
※折り返し呼の詳細については「1.折り返し呼管理について」をご参照ください。

録音完了/音声認識サービス連携完了

録音ファイルの生成が完了したタイミング、もしくは音声認識履歴サービスによる音声テキスト化が完了したタイミングで発生します。

※BIZTELバージョン 3.4.0 以降で利用可能です。
※BIZTELバージョン 3.4.X までは「ステレオ録音完了/ 音声認識サービス連携完了」と表示されます。

イベント種別を選択するときの注意事項

※不在転送（秒数問わず）や IVR等 からの外線転送時は、転送者（内線端末、IVR等）からの発信扱いとなります。

※1コール目の着信側チャネル終了時に転送完了のイベントが発動します。

※グループ着信の場合は、同タイミングで応答する可能性があり、2つ応答処理が発生する可能性があります。

変数抽出パターンの補足

項目名 説明 
サブパターンについて

正規表現内において、()で囲まれたパターンの箇所のことを指します。
また、グループとも呼ばれます。

例）
文字列「"testkey":"Name","testValue":"TestValue"」に対して/"testkey":"([0-9A-Za-z]*)","testValue":"([0-9A-Za-z]*)"/
を抽出パターンとすると、２箇所のサブパターン部分のName,TestValueを抽出しデータベースに格納します。
格納データの取り出し方について

格納データはサブパターンの順番に９個までデータが格納され、以降のコールアクションの処理における変数展開時に{CODE1}〜{CODE9}の文字列を指定すると使用可能です。

上記例の場合、{CODE1}に"Name"が、{CODE2}に"TestValue"が格納されます。
変数抽出パターンの動作テストについて

変数抽出パターンを作成するためには、外部CRMのWebAPIから得られる実際のレスポンスボディデータを確認する必要があります。

PostmanなどのAPI実行ソフトウェアでWebAPIを実行すると、レスポンスボディ内容を取得可能です。

取得したレスポンスボディ内容に対して、事前に正規表現チェッカなどの外部ツールで動作確認しながら、変数抽出パターンを作成してください。
名前付きサブパターンについて

サブパターンにて(?P<サブパターン名>...※正規表現部...)といった入力をすることで、変数抽出データに指定した名称を設定可能です。

この方法で抽出された場合、{CODE*}に加えて、{RESPONSE_(指定サブパターン名)}の変数展開コードにて使用可能です。

※サブパターン名には半角の英大文字と数字、_アンダースコアのみ使用可能です。
格納データの上書きについて

格納データは一つの通話内であれば、以降のコールアクション処理時の変数展開時に使用可能です。

変数抽出の都度データ格納は実行され、{CODE*}などは最新の変数抽出結果に上書きされます。

格納データへの上書きを防ぎ、以降のコールアクション処理時に使用する場合は上記の名前付きサブパターンを使用する必要があります。

ただし、その場合でも同じ名前をサブパターン名に指定すると上書きしてしまうため、適切にサブパターン名を管理してください。
格納データについて

格納データは24時間保持され、その後削除されます。

その為、24時間以上の通話が行われた場合などのケースには注意が必要です。

タグの判定評価について

「タグ判定用コード」と「タグ判定評価パターン」の入力状態により、以下の動作となります。

タグ判定用コードの
入力状態		 タグ判定評価パターンの
入力状態		 動作
〇 〇

判定評価を実施します。

・ヒットすれば、タグが付与される
・ヒットしなければ、タグは付与されない
〇 × 判定評価を実施しませんが、タグは付与されます。
× 〇

ブランクを判定対象として判定評価を実施します。

・ヒットすれば（タグ判定評価パターンにブランクが含まれていれば）、タグが付与されます。
・ヒットしなければ（タグ判定評価パターンにブランクが含まれていなければ）、タグは付与されません。
× × 判定評価を実施しませんが、タグは付与されます。

「XXXXXXXX」表示について

※BIZTELバージョン 3.7.0 以降、判定用コード、URL、リクエストヘッダ、リクエストボディの各項目内でXXXXXXXX（半角大文字エックス8つ）を入力した場合、参照画面・編集画面ともに赤太字で表示されます。

mceclip0.png

また、変数の動的な箇所にXXXXXXXXが含まれている場合は、変数全体が赤太字となります。

例）{XXXX_DIGITS}　→　{XXXX_DIGITS}
{XXXXXXXX_DIGITS}　→　{XXXXXXXX_DIGITS}

手順３．「保存しますか？」と表示後、「OK」をクリックします。
※BIZTELバージョン 3.2.X までは「登録しますか？」と表示されます。

mceclip2.png

以上でコールアクションの連携対象タブの設定は完了です。

4. 変数展開コード

外部CRMのWebAPI実行のリクエストデータ作成や、コールアクションの実行判定の際に変数展開文字列を指定することで、
下記の通話情報やBIZTEL内データ、コールアクションの1つ前の処理結果データなどを使用可能です。

4.1 変数展開文字列

変数展開文字列は{RESPONSE_KEY}のように中括弧 {　} 内に半角英大文字、数字、アンダースコアの
文字列が設定されている場合に認識されます。

利用可能な変数は以下をご確認ください。

種類 変数名 説明
固定系 {SVID} BIZTELサーバ単位で割り振られた一意のIDを展開します。
{HOST} 「システム設定」 > 「ライセンス設定」 > 「システム」 > 「サーバホスト名」に記載されているサーバホスト名を展開します。
{ID} 通話ごとに割り振られた一意のIDを展開します。
{TEL} 発信側の電話番号 （BIZTEL側/相手側いずれも外線番号）を展開します。
{CALLED} 着信側の電話番号（BIZTEL側/相手側いずれも外線番号）を展開します。
{EXTEN_NO} BIZTELの内線番号を展開します。
{AGENTID}
{AGENT_ID}		 コールセンターの着信に応答したエージェントのアカウントIDを展開します。
{QUEUEID}
{QUEUE_ID}		 コールセンターのIDを展開します。
{ISANSWERED}
{IS_ANSWERED}		 変数展開を実行するタイミングにおいて、通話が応答されている場合は「1」、通話が応答されていない場合は「0」を返却します。
{DATE} 現在日時を「YYYY-MM-DD HH:MI:SS」のフォーマットで返却します。
{REQUEST_CODE} コールバックAPIにて利用するrequest_code値を展開します。
{ANSWER_NO} 発着信履歴の最終着信番号に当たる電話番号を展開します。
{ANSWER_NAME}

発着信履歴の最終着信者名にあたる電話端末名を展開します。

※BIZTELバージョン3.4.10から利用可能です。
{ANSWER_TIME} 着信時の応答時刻を展開します。

{AGENT_EXTEN_NO}

{AGENT_CALLBACK_NO}

BIZTELバージョンにより動作、利用可能範囲が異なります。

BIZTELバージョン 3.7.11 まで

{AGENT_EXTEN_NO}のみ利用可能です。
コールセンターの着信に応答したエージェントの内線番号を取得します。

BIZTELバージョン 3.7.20 以降

{AGENT_EXTEN_NO} 及び {AGENT_CALLBACK_NO}のいずれも利用可能です。
コールセンターの着信に応答したエージェントのサインイン端末の番号（内線・外線）を取得します。

※{AGENT_EXTEN_NO}は、自動補完機能で表示されません。
{EXTEN_NAME} 内線番号に紐づく名称を展開します。
{CALLSEC}
{CALL_SEC}		 通話時間を展開します。
{STARTTIME}
{START_TIME}		 通話開始時間または発着信履歴の時刻カラムの値を展開します。
{ENDTIME}
{END_TIME}		 通話終了時間または発着信履歴の時刻と通話時間（応答までの時間を含む）を合計した値を展開します。
{VOICE_LOG}

通話に対する音声テキスト化データの全文を出力します。

※イベント実行時点でテキスト化が完了されているもののみ出力します。
※音声認識連携（Omnis）をご利用の場合、連携成功または失敗に関するメッセージのみ出力します。
{CU_VOICE_LOG}

通話に対する音声テキスト化データのお客様部分のみ出力します。

※BIZTELバージョン 3.9.0 以降で利用可能です。
{OP_VOICE_LOG}

通話に対する音声テキスト化データのエージェント部分のみ出力します。

※BIZTELバージョン 3.9.0 以降で利用可能です。 
{VOICE_LOG_SAVING}

通話に対する音声テキスト化データの全文を出力します。

※イベント実行時点でテキスト化が完了されているもののみ出力します。
※本パラメータでは、発話者の情報が以下のように省略表示されます。
お客様：C
オペレータ：O
{CU_VOICE_LOG_SAVING}

通話に対する音声テキスト化データのお客様部分のみを出力します。

※本パラメータでは、お客様を「C」と省略表示します。
{OP_VOICE_LOG_SAVING}

通話に対する音声テキスト化データのエージェント部分のみを出力します。

※本パラメータでは、オペレータを「O」と省略表示します。 
{****_DIGITS}

同通話における経由した他のIVRでのダイヤル入力値を取得します。

※「****」にはIVRの内線番号が入ります。
{****_CODE*}

同じ通話内で経由したIVRにおける、外部API実行の変数抽出結果の抽出データを順番に{CODE1}〜{CODE9}から取得します。

※冒頭「****」にはIVRの内線番号、末尾「*」には1〜9が入ります。
{AGENT_ACCOUNT} 応答したエージェントのアカウント名を取得します。
{AGENT_NAME} 応答したエージェントの名前を取得します。
{BUSINESS}

着信した業務ラベルを取得します。

※業務ラベルの詳細は「1.業務ラベル」をご参照ください。

※BIZTELバージョン 3.4.0から利用可能です。
{CALL_FLOW}

着信した呼の経路情報を取得します。

※経路情報の詳細は「2.CTI設定-その他CRM連携（BIZTELバージョン 3.2以降）」をご参照ください。

※BIZTELバージョン 3.4.0から利用可能です。
{IS_INCOMING}

通話が発着信どちらなのかを、以下の数値で取得します。

返却値：0 = 発信通話
返却値：1 = 着信通話

※BIZTELバージョン 3.7.0 から利用可能です。
{CALLBACK_VOICE_LOG}

通話のリクエストIDに対し、折り返し呼の音声認識結果が紐づいていた場合、音声認識のテキストデータ全文を取得します。

※折り返し呼の詳細は「1.折り返し呼管理について」をご参照ください。

※BIZTELバージョン 3.13.10 から利用可能です。
前APIレスポンスデータ系 {CODE*}

同じ通話における、前の処理結果の変数抽出結果のデータを順番に{CODE1}〜{CODE9}から取得します。

※末尾の「*」には任意の値「1」〜「9」が入ります。
※抽出データ数が9個以上の場合、9個までしか格納されなません。
※同通話における変数抽出が複数された場合、CODE1〜のデータは最新値に上書きされます。
{RESPONSE_*}

同じ通話における前の処理結果の変数抽出にてサブパターン名を指定した場合、{RESPONSE_(サブパターン名)}の形式で取得します。

※末尾の「*」には変数抽出時に指定したサブパターン名が入ります。
※同じサブパターン名を指定した場合、最新のものに上書きされます。
{VOICE}

API連携IVRの処理で音声入力値（録音した音声データ）をバイナリとして引き渡します。

※IVRを複数階層で構成している場合は、先頭のIVRでの値を引き渡します。
{内線番号_VOICE}

API連携IVRの処理で音声入力値（録音した音声データ）をバイナリとして引き渡します。

※多段でIVRを構成している場合でも内線番号を指定する事で、指定のIVRの音声入力結果を引き渡します。
{VOICE_BASE64}

API連携IVRの処理で音声入力値（録音した音声データ）をBASE64エンコードした文字列として引き渡します。

※多段でIVRを構成している場合は、先頭のIVRでの値を引き渡します。
{内線番号_VOICE_BASE64}

API連携IVRの処理で音声入力値（録音した音声データ）をバイナリとして引き渡します。

※多段でIVRを構成している場合でも内線番号を指定する事で、指定のIVRの音声入力結果を引き渡します。
BIZTEL内用意データ系 {ACCOUNTVALUE_*}
{ACCOUNT_VALUE_*}

BIZTEL内の「アカウント」に対し、変数展開時に呼び出すためのデータを用意します。

※末尾「*」には、「4.2APIカスタム項目」でAPIカスタム項目に指定したKeyを設定します。
{SIPUSERVALUE_*}
{SIPUSER_VALUE_*}

BIZTEL内の「電話端末」に対し、変数展開時に呼び出すためのデータを用意します。

※末尾「*」には、「4.2APIカスタム項目」でAPIカスタム項目に指定したKeyを設定します。
{QUEUEVALUE_*}
{QUEUE_VALUE_*}

BIZTEL内の「コールセンター」に対し、変数展開時に呼び出すためのデータを用意します。

※末尾「*」には、「4.2APIカスタム項目」でAPIカスタム項目に指定したKeyを設定します。
{CALLGROUPVALUE_*}
{CALLGROUP_VALUE_*}
 

BIZTEL内の「着信グループ」に対し、変数展開時に呼び出すためのデータを用意します。

※末尾「*」には、「4.2APIカスタム項目」でAPIカスタム項目に指定したKeyを設定します。
{IVRVALUE_*}
{IVR_VALUE_*}

BIZTEL内の「IVR」に対し、変数展開時に呼び出すためのデータを用意します。

※末尾「*」には、「4.2APIカスタム項目」でAPIカスタム項目に指定したKeyを設定します。

変数展開文字列の自動補完について

BIZTELバージョン 3.7.0 以降、以下の項目に変数展開文字列を入力する場合、「 { 」を入力することで自動補完機能が有効になります。

・判定用コード
・URL
・リクエストヘッダ
・リクエストボディ
・変数抽出パターン

mceclip7.png

※{ACCOUNT_VALUE_x} の x は任意の値に修正ください。

入力した変数展開コードの整合性について

BIZTELバージョン 3.7.20 以降、入力した変数展開コードに誤りがある場合、青字の強調表示がされません。

4.2 APIカスタム項目

管理画面の各アカウントや、各コールセンターなどに、APIカスタム項目タブにて使用データを登録します。
例えば、アカウントごとに紐づく外部CRM用WebAPI認証情報などを登録しておき、通話を受けたアカウントごとの
外部CRMに対してWebAPIを実行するといった運用が可能です。

4.2.1 KeyとValue登録

{ACCOUNTVALUE_(指定したKey)}と変数展開時に記述するとValueに設定した項目に置き換えられます。

※Keyは変数展開ルールから、半角の英大文字、数字、_アンダースコアのみ使用可能です。

手順１．管理画面より「アカウント」 > 「アカウント」をクリックします。

mceclip1.png

手順２．更新対象のアカウントをクリックします。

mceclip2.png

手順３．「APIカスタム項目」を選択し、「新規」をクリックします。

mceclip3.png

手順４．「Key」及び「Value」を入力し、「登録」をクリックします。

※BIZTELバージョン3.3.X以降のお客様は「保存」と表示されます。

mceclip0.png

項目 説明
Key

{ACCOUNTVALUE_KEY名}のKey名となります。

※変数展開ルールから半角英大文字、数字、アンダーバーのみ使用可能。
Value {ACCOUNTVALUE_KEY名}を変数展開した結果の値です。
メモ ご自由にご記入ください。

手順５．「登録しますか？」と表示される為、「OK」をクリックします。
※BIZTELバージョン3.3.X以降のお客様は「保存しますか？」と表示されます。

mceclip3.png

以上で登録完了です。

 

注意事項

各データに紐付けたAPIカスタム項目が使える状況について外線番号の紐付け先により以下のように使用可否が異なりますので、ご注意ください。

外線番号の紐付け 変数展開コード
アカウント 電話端末 コールセンター 着信グループ IVR
コールセンター 使用可能（※１） 使用不可 使用可能 使用不可 使用不可
電話端末 使用可能（※２）（※３） 使用可能 使用不可（※３） 使用不可 使用不可
着信グループ 使用不可（※３） 使用不可 使用不可（※３） 使用可能 使用不可
IVR 使用不可（※３） 使用不可 使用不可（※３） 使用不可 使用可能

※１．着信呼分配以降の呼び出しや応答など、エージェントが特定できる以下のイベントが使用可能です。

・コールセンターエージェント呼び出し
・コールセンターエージェント応答不能
・コールセンター応答
・コールセンター保留開始
・コールセンター保留解除
・コールセンター切断
・録音完了／音声認識連携完了

※２．電話端末にログインしているアカウントを対象として使用可能です。

※３．紐付け先からコールセンターへ「#転送」または「着信ルールでの転送」を行なった場合、以下のイベントを指定すれば使用可能です。
アカウント：※１に記載のイベント
コールセンター：コールセンターイベント、および録音完了／音声認識連携完了

4.2.2 メソッドチェーン

 各変数展開文字列に対し{(変数展開文字列).(メソッドチェーン部)}といった形式の入力をすることによって、変数展開した文字列に対して用意されたメソッドを適用可能です。

 メソッドチェーン用のメソッドは以下のメソッドが用意されています。

外線番号の紐付け 使用可否
START(引数)

変数展開結果の文字列に対して、引数の開始位置から開始するように前部分を切り落とします。

例）
{CALLED.START(3)}と入力した場合、CALLEDの値が 09012341234 とすると、「12341234」が得られる

※BIZTELバージョン 3.7.20 以降、正数のみ利用可能です。
END(引数)

変数展開結果の文字列に対して、文末から引数の文字数の文字を削除します。

例）
{CALLED.END(4)}と入力した場合、CALLEDの値が 09012341234 とすると、「0901234」が得られる
 

※BIZTELバージョン 3.7.20 以降で利用可能です。
※正数のみ利用可能です。
LEFT(引数)

変数展開結果の文字列に対して、左から引数の値の文字を抽出します。

例）{CALLED.LEFT(3)}と入力した場合、CALLEDの値が 09012341234 とすると、「090」が得られる

※BIZTELバージョン 3.7.20 以降で利用可能です。
※正数のみ利用可能です。
RIGHT(引数)

変数展開結果の文字列に対して、右から引数の値の文字を抽出します。

例）{CALLED.RIGHT(3)}と入力した場合、CALLEDの値が 09012341234 とすると、「234」が得られる

※BIZTELバージョン 3.7.20 以降で利用可能です。
※正数のみ利用可能です。
DATE_FORMAT(format, modify)
または
DATE_FORMAT(format)

日付形式の文字列に対して日付形式の変更や、日付の変更を実施します。

PHPのdate_format()と、2個めの引数が設定されていればmodify()を適用します。

・formatの入力形式は下記とする
https://www.php.net/manual/ja/function.date.php

・modifyの入力形式は下記を参考にすること
https://www.php.net/manual/ja/function.strtotime.php

※上記いずれの引数は半角英数字、半角スペース、記号 / : . + - のみ使用可能絵です。
上記参考リンク内で指定されている形式でも↑の文字以外のものは使用できません。
RAW() URLにおける変数展開時のURLエンコードが、自動で実施されるのを回避する場合に使用します。
JSON_ESCAPE() 変数展開時の内容をエスケープ処理済みの文字列にすることが可能です。

メソッドチェーンの自動補完について

BIZTELバージョン 3.7.20 以降、以下の項目にメソッドチェーンを入力する場合、「 . 」を入力することで自動補完機能が有効になります。

・判定用コード
・URL
・リクエストヘッダ
・リクエストボディ

※メソッドチェーン(x) の x は任意の値に修正してください。

5. コールアクション動作確認

5.1 外部API連携履歴

実際に外部CRMのWebAPIへどういったAPIリクエストを送ったか、またレスポンス内容についてのログを確認可能です。

● コールアクションにて設定したURL、リクエストヘッダ、リクエストボディの変数展開後の結果を確認可能です。

●レスポンスコード(成功/失敗の判定)や素のままのレスポンス内容を確認可能です。

外部API連携履歴の参照方法

手順１．管理画面より「履歴・状況」 > 「外部API連携履歴」をクリックします。

mceclip0.png

手順２．検索条件を設定し、検索をクリックします。

mceclip2.png

項目 説明
期間

作成日時を条件にした検索を行います。
カレンダーアイコンから日付、時計アイコンから時間（10分単位）を選択可能です。

※開始、終了いずれかの日時は必須となります。

※BIZTELバージョン 3.6.X まで通話終了時刻にて「24:00」の選択ができません。
10/01 00:00 ～ 10/31 24:00 としたい場合は、10/01 00:00 ～ 11/01 00:00 にて検索ください。

※BIZTELバージョン 3.7.0 以降、通話終了時刻にて「24:00」の選択が可能です。
リクエストID リクエストIDを条件にした検索を行います。
API連携種別  API連携を利用した機能の種別を条件にした検索を行います。
エンティティID IVR、コールアクション、Oauthアカウント作成時に付与されたIDを条件にした検索を行います。
ノードID

コールアクションのAPI連携タブで作成した設定のIDを条件にした検索を行います。

※IVR、Oauthの履歴を検索することはできません。
名称 IVRまたはコールアクションの名称を条件にした検索を行います。
リクエストURL API連携時に送信したHTTPリクエストの送信先URLを条件とした検索を行います。
リクエストメソッド API連携時に送信したHTTPリクエストのリクエストメソッドを条件とした検索を行います。
リクエストヘッダ API連携時に送信したHTTPリクエストのリクエストヘッダを条件とした検索を行います。
リクエストボディ API連携時に送信したHTTPリクエストのリクエストボディを条件とした検索を行います。
ステータスコード API連携時に受信したHTTPレスポンスのステータスコードを条件とした検索を行います。
レスポンスボディ API連携時に受信したHTTPレスポンスのレスポンスボディを条件とした検索を行います。
エラーコード API連携中にエラーが発生した場合に記録されるエラーコードの値を条件とした検索を行います。
エラータイプ API連携中にエラーが発生した場合に記録されるエラーの種別を条件とした検索を行います。
エラーメッセージ API連携中にエラーが発生した場合に記録されるメッセージを条件とした検索を行います。
エラー詳細 API連携中にエラーが発生した場合に記録されるエラータイプに応じた詳細情報を条件とした検索を行います。

手順３．検索対象に一致する結果が表示されます。確認したい行をクリックする事で詳細表示が可能です。

mceclip5.png

基本情報
API連携種別 連携元の種別です。
種別：IVR、コールアクション、OAuth
名称 IVRまたはコールアクションで設定した名称が表示されます。
・IVR > 基本情報 > IVR名称
・コールアクション > 基本情報 > コールアクション名
リクエストID API連携を行った通話のリクエストIDです。
エンティティID 連携を行った設定のID（主キー）の値です。
※IVRやコールアクションを登録し、詳細画面を表示した際のURL部分に表示されるIDです
・IVRの場合の例
　https://sXXXXXXXXXXXX.u.biztel.jp:8000/ivr/10001　の『10001』の部分が該当
・コールアクションの場合の例
　https://sXXXXXXXXXXXX.u.biztel.jp:8000/call_action/10004　の『10004』の部分が該当します
ノードID

エンティティIDが配下に持つ子の設定のIDです。
・IVRの場合
　設定なし
・コールアクションの場合
　API連携タブの各設定に対応する
『コールアクション > API設定タブ』のIDカラムに表示される内容が該当します

リクエスト情報
URL API連携時に送信したHTTPリクエストの送信先URLです。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
メソッド API連携時に送信したHTTPリクエストのリクエストメソッドです。
GET、POST、PUT、DELETE、PATCHのいずれかが表示されます。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
ヘッダ API連携時に送信したHTTPリクエストのリクエストヘッダです。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
ボディ API連携時に送信したHTTPリクエストのリクエストボディです。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
レスポンス情報
ステータスコード API連携時に受信したHTTPレスポンスのステータスコードです。
※HTTTPレスポンスを受信した場合、必ず記録されます。
ヘッダ API連携時に送信したHTTPリクエストのリクエストヘッダです。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
ボディ API連携時に送信したHTTPリクエストのリクエストボディです。
※HTTPリクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
エラー情報
エラーコード エラーコードの値を表示します。
※API連携にて例外が発生したタイミングで記録されます。
エラータイプ エラーの種別を表示します。
※API連携にて例外が発生したタイミングで記録されます。
エラーメッセージ

エラータイプに応じたメッセージを表示します。
※API連携にて例外が発生したタイミングで記録されます。

エラー詳細 エラータイプに応じたエラーの詳細情報を表示します。
※API連携にて例外が発生したタイミングで記録されます。

●エラー発生時の情報一覧

概要 エラーコード エラータイプ エラーメッセージ
HTTP通信起因の例外
Http Client Request Exception 503 CONNECTION_ERROR 接続に問題があります
TOO_MANY_REQUEST_ERROR 過大なリダイレクトが発生しています
OAuth起因の例外
Oauth Exception 500 BASE64_ENCODE_ERROR stateのデコードに失敗しました
STATE_DECRYPT_ERROR stateの復号に失敗しました
RESPONSE_CODE_NOT_SET codeが取得できませんでした
RESPONSE_STATE_NOT_SET stateが取得できませんでした
RESPONSE_STATE_EXPIRE stateの有効期限が切れました
RESPONSE_ACCESS_TOKEN_NOT_SET アクセストークンが取得できませんでした
RESPONSE_REFRESH_TOKEN_NOT_SET リフレッシュトークンが取得できませんでした
REFRESH_TOKEN_NOT_HAVE リフレッシュトークンが未取得です
TOKEN_RESPONSE_JSON_DECODE_FAIL トークンレスポンスの読み込みに失敗しました
TOKEN_RESPONSE_ERROR トークン・リクエストに対してエラーが応答されています

5.2 コールアクション履歴

外部CRMのWebAPIへの実行判定の内容と結果、APIリクエストの作成、リクエストからのデータ抽出の結果についてのログを確認可能です。

● コールアクションの処理実行判定に用いる判定用コードの変数展開後の文字列の確認

● コールアクションの処理実行判定により処理を中止した場合の確認

● 変数展開の際に何らかのエラーが発生し、正しく変数展開が出来なかった場合の確認

● 変数抽出パターンによりAPIレスポンスからデータを抽出し、一時保存場所に格納する場合の確認
※格納できた場合にのみログ登録されるため、格納を想定しているキーに対してログが登録されない場合は変数抽出パターンによるデータ抽出が失敗しています。

コールアクション履歴の確認方法

コールアクション履歴は 2つのメニューから確認が可能です。

5.2.1 「コールアクション」メニューから確認する

作成したコールアクション単位で履歴検索が可能です。

手順１．管理画面「連携オプション」>「コールアクション連携」をクリックします。

手順２．検索対象のコールアクションをクリックします。

mceclip3.png

手順３．「履歴」タブをクリックします。

mceclip2.png

手順４．検索条件を指定し、「検索」をクリックします。

mceclip4.png

期間
時刻

検索対象範囲とする集計対象日時を検索対象に指定します。
カレンダーアイコンから日付、時計アイコンから時間（10分単位）を選択可能です。

※BIZTELバージョン 3.6.X までは「期間」、BIZTELバージョン 3.7.0 以降は「時刻」と表示されます。

※BIZTELバージョン 3.6.X まで通話終了時刻にて「24:00」の選択ができません。
10/01 00:00 ～ 10/31 24:00 としたい場合は、10/01 00:00 ～ 11/01 00:00 にて検索ください。

※BIZTELバージョン 3.7.0 以降、通話終了時刻にて「24:00」の選択が可能です。
リクエストID 通話に紐づくリクエストIDを検索対象に指定します。
メッセージ

コールアクションのAPI連携処理結果のメッセージを検索対象に指定します。

※BIZTELバージョン 3.6.X まで、検索条件として利用可能です。

検索結果の確認方法は「5.3 コールアクション履歴の検索結果を確認する」をご参照ください。

5.2.2 「履歴・状況」メニューから確認する

コールアクション全体から詳細な検索条件を設定し、履歴検索が可能です。

 手順１．管理画面より「履歴・状況」>「コールアクション履歴」をクリックします。

手順２．検索条件を指定し、「検索」をクリックします。

● BIZTELバージョン 3.6.X までの検索画面

mceclip1.png

● BIZTELバージョン 3.7.X までの検索画面

mceclip0.png

期間
時刻

検索対象範囲とする集計対象日時を検索対象に指定します。
カレンダーアイコンから日付、時計アイコンから時間（10分単位）を選択可能です。

※BIZTELバージョン 3.6.X までは「期間」、BIZTELバージョン 3.7.0 以降は「時刻」と表示されます。

※BIZTELバージョン 3.6.X まで通話終了時刻にて「24:00」の選択ができません。
10/01 00:00 ～ 10/31 24:00 としたい場合は、10/01 00:00 ～ 11/01 00:00 にて検索ください。

※BIZTELバージョン 3.7.0 以降、通話終了時刻にて「24:00」の選択が可能です。
リクエストID 通話に紐づくリクエストIDを検索対象に指定します。
コールアクションID コールアクション毎に付与されるIDを検索対象に指定します。
※BIZTELバージョン 3.6.X まで、検索条件として利用可能です。
API連携ID コールアクション内のAPI連携毎に付与されるIDを検索条件に指定します。
コールアクション名 コールアクション名を検索対象に指定します。
※BIZTELバージョン 3.7.X 以降、コールアクションIDに変わり表示されます。
種別 コールアクション時の区分（コールアクション、WEBサービス連携）を検索条件として指定します。
メッセージ コールアクションのAPI連携処理結果のメッセージを検索対象に指定します。
※BIZTELバージョン 3.6.X まで、検索条件として利用可能です。

検索結果の確認方法は「5.3 コールアクション履歴の検索結果を確認する」をご参照ください。

5.3 コールアクション履歴の検索結果を確認する

コールアクション履歴は、ご利用のBIZTELバージョンにより表示方法が異なります。

ご利用のBIZTELバージョンに沿った内容をご確認ください。

● BIZTELバージョン 3.6.X までの表示方法

検索結果と一致する処理が一覧として表示されます。
検索結果をクリックすると該当の処理の詳細画面を確認可能です。

※詳細画面内の「関連API連携履歴を参照」をクリックすることで外部API連携履歴へ遷移します。

mceclip0.png

● BIZTELバージョン 3.6.X までの表示項目詳細

一覧表示
時刻 API連携処理が実行された時刻を表示します。
リクエストID 通話単位で付与される一意なIDを表示します。
コールアクションID コールアクションで付与される一意のIDを表示します。
API連携ID コールアクション内のAPI連携単位で付与された一意のIDを表示します。
メッセージ

コールアクション実行時ののAPI連携処理結果の内容が表示されます。
※メッセージ詳細は下記「コールアクション履歴のメッセージ例」をご参照ください。

詳細表示
時刻 該当する通話が開始された時刻を表示します。
発信番号 該当する通話の発信者番号を表示します。
着信番号 該当する通話の着信番号を表示します。
通話時間 該当する通話の通話時間を表示します。
リクエストID 通話単位で付与される
関連API連携履歴を参照 関連する外部API連携履歴に遷移します

● BIZTELバージョン 3.7.X 以降の表示方法

検索結果と一致する処理がリクエストID単位（１つのコールアクションの処理単位）で表示されます。
検索結果をクリックすると、詳細画面から該当のAPI連携IDに関わる処理を確認可能です。

mceclip2.png

● BIZTELバージョン 3.7.X  以降の表示項目詳細

検索結果をクリックすることで、履歴に紐づくコールアクションの動作状況を確認可能です。

mceclip8.png

時刻 API連携処理が実行された時刻が表示されます。
リクエストID 通話単位で付与される一意のIDが表示されます。
コールアクションID コールアクション単位で付与されるIDが表示されます。
種別 コールアクション実行時の区分（コールアクション、WEBサービス連携）が表示されます。
メッセージ履歴 コールアクション実行時の各イベント毎のメッセージが表示されます。
「関連外部API連携履歴を参照」欄の「参照」ボタンをクリックすると外部API連携履歴の画面に遷移します。
関連通話一覧 該当の通話に関連する通話情報を表示します。

※BIZTELバージョン 3.11.0以降、「履歴を参照」項目の「外部API連携履歴」をクリックすることで外部API連携履歴へ遷移します。

※BIZTELバージョン 3.12.0以降、自動SMS送信機能に関する履歴は「履歴を参照」項目の「SMS送信履歴」をクリックすることでSMS送信履歴へ遷移します。

● コールアクション履歴のメッセージ例（各バージョン共通）

概要 表示条件 内容 
API連携の処理タイミング 処理開始
(リクエスト作成〜レスポンス格納)		  “コールアクション処理を開始します (コールアクション名/イベント種別/実行順)”
処理終了
(エラーが発生せずに処理終了まで到達)		  “コールアクション処理を終了します (コールアクション名/イベント種別/実行順)”
API実行条件による判定処理 変数展開後のコールアクションの処理実行判定用コードと処理実行条件パターン内容の表示(コールアクションの処理実行条件パターンが入力されている場合)  “API実行判定コード:0312345678”
“API実行判定パターン:/^0312345678$/”
上記の実行判定で結果がNGだった場合 “API実行判定が満たされなかったためAPI実行を中止します”
変数展開の処理結果 汎用KeyValueのエンティティが見つからない “指定されたエンティティが見つかりません:{ACCOUNTVALUE_ID}”
汎用KeyValueのKeyに当たるデータがない “APIカスタム項目データが見つかりません:{ACCOUNTVALUE_ID}”
{CODE}、{RESPONSE}指定時にRedisにデータがない “抽出データが見つかりません:{RESPONSE_PASSWORD}”
メソッドチェーンのスタイル不備 “メソッドチェーン部が不正です:{ID.STRAT(1)}”
変数展開後にURLがブランクになった場合(中止にする) “変数展開に後のURLがブランクとなったためAPIの実行を中止します”
リクエスト作成に失敗し、処理を中止する場合 “変数展開に失敗したためAPI実行を中止します”
レスポンス格納時(CODE) “APIレスポンス結果が格納されます:CODE1 => (value)”
レスポンス格納時(RESPONSE) “APIレスポンス結果が格納されます:RESPONSE_NAME => (value)”

※「絞り込み」から検索表示されたデータから更にデータを絞り込むことが可能です。BIZTELバージョン 3.8.0 以降、絞り込みのAND検索が可能です。
「キーワード（スペース）キーワード」の形式で入力ください。（複数キーワードの指定が可能です。）

5.4 うまく動作しない場合の切り分け

 上記の履歴を確認し、問題の箇所を特定してください。

①API連携履歴を確認し、外部CRMのWebAPIへの処理が実行されているかを確認します。
● 処理が実行されている場合
API連携ログ内容の確認　→　②へ進んでください。

● 処理が実行されていない場合
コールアクション履歴にてコールアクションの処理が中止されている原因を確認する

②リクエスト内容が想定通りか、処理がエラーになっていないかを確認する
● リクエスト内容が想定通りの場合
外部CRMのWebAPIの現在のサービス状態や使い方が正しいかを確認します。
また、想定した結果を得られることをAPI実行アプリなどで確認します。

● リクエスト内容が誤っている場合
変数展開が想定通りに動作していない場合コールアクション履歴にて変数展開エラーが発生していないか、
または変数展開で使用するデータが正しく格納されているか確認します。

6. コールアクションのエクスポート・インポート

BIZTELバージョン 3.7.0 以降より、設定したコールアクションをjsonファイル形式でエクスポート・インポート可能です。
既存の設定をエクスポートしバックアップとして保管したり、複数のBIZTEL環境をご利用の場合に同じコールアクション設定を各環境にインポート可能です。

※出力したファイルは編集せず、そのまま取り込みを行ってください。
動作異常に繋がる場合があります。

6.1 コールアクションのエクスポート

設定したコールアクションのエクスポート手順を紹介します。

手順１．管理画面「連携オプション」 > 「コールアクション連携」をクリックします。

mceclip1.png

手順２．一覧から設定をエクスポートするコールアクションをクリックします。

mceclip2.png

手順３．コールアクションの画面表示後、右上の「エクスポート」をクリックします。

mceclip3.png

手順４．エクスポートに関する注意事項が表示されるため、内容を確認のうえ「エクスポート」をクリックします。
※エクスポート時、連携するCRMへのアクセスは行いません。

mceclip4.png

エクスポート対象のコールアクション設定データがjsonファイルとして出力されます。

mceclip5.png

注意事項

● エクスポートしたjsonファイルに出力されるのは、「基本情報」タブと「API連携タブ」の各項目です。
※「OAuthアカウント」はBIZTELバージョン 3.12.0以降よりエクスポート対象です。

● エクスポート時のファイル命名規則は「 {コールアクション名}_YYYY-MM-DD.json 」です。

6.2 コールアクションのインポート

本手順では「6.1 コールアクションのエクスポート」で出力したファイルのインポート方法を解説します。

手順１．管理画面「連携オプション」 > 「コールアクション連携」をクリックします。

mceclip1.png

手順２．画面右上の「インポート」をクリックします。
※登録できるコールアクションの上限数に達している場合、「インポート」はクリックできません。

mceclip7.png

手順３．インポート画面表示後、「ファイル選択」をクリックし、インポートしたいjsonファイルを選択します。

mceclip8.png

手順４．選択したファイル名が「インポートファイル」の横に表示されるため、確認し「インポート」をクリックします。
※インポート時、連携するCRMへのアクセスは行いません。

mceclip9.png

手順５．インポート完了のメッセージが表示されるため、確認し「OK」をクリックします。

mceclip10.png

インポートしたコールアクションが一覧に表示されます。

mceclip11.png

注意事項

● エクスポートしたファイルを同じBIZTELサーバにインポートした場合、既存の設定とは別に新規登録されます。
既存の設定は上書きされません。

● インポート後のコールアクションはステータスが「無効」となります。
設定内容の確認・編集後にステータスを「有効」に変更してください。

mceclip12.png

● インポート対象は 、「基本情報」タブと「API連携タブ」の各項目となります。インポート後、「連携対象」タブより連携対象となる電話番号の設定を行ってください。
※「OAuthアカウント」はBIZTELバージョン 3.12.0 以降よりインポート対象です。

● 特定のコールアクション設定をインポートした場合、バージョンごとに動作が異なります。

BIZTELバージョン 3.11.X まで

OAuth認証を指定したコールアクションをインポートした場合、「API連携」タブの「OAuthアカウント」が空欄となります。
該当のイベント種別行に「！」マークが表示され、ステータスを「有効」にできません。

mceclip13.png

対象行をクリックし、OAuthアカウントを設定してください。

mceclip14.png

BIZTELバージョン 3.12.0 以降 

「OAuth認証」または処理種別に「SMS送信」を指定したコールアクションをインポートし、jsonファイル内のOAuthアカウントおよびSMSテンプレートのIDに一致する設定がインポート先の管理画面に存在する場合は、その設定が反映されます。

● OAuthアカウントの表示例

※以下のいずれかに該当する場合、OAuthアカウント／SMSテンプレート／登録対象タグは空欄で登録されます。

・jsonファイル内のOAuthアカウント／SMSテンプレート／登録対象タグのIDに一致する設定が管理画面側で削除されている場合

・OAuth認証、または処理種別に「SMS送信」を指定しているが、OAuthアカウント／SMSテンプレート／登録対象タグが空欄のコールアクションをインポートする場合

・別のサーバからエクスポートしたjsonファイルをインポートする場合

インポート時のエラーについて

インポート時に表示されるエラーの一例となります。

エラーメッセージ エラー発生理由
インポートファイルがjsonファイルではありません インポートファイルの拡張子が .json でない場合に表示されます。
インポートファイルがjson形式ではありません

拡張子は .json でも、中身がJSON構文になっていない場合に表示されます。

● ファイルの中身が空の場合
● ファイル編集後、文字列が""で囲まれていない
● 閉じカッコ}が無い　など
不正な値が入力されています

JSONファイルを直接修正し、以下に該当する場合に表示されます。

● 各値の文字数超え
● 正規表現必須の項目が正規表現でない
● 必須項目が未入力
● 指定外の値の入力など
所属可能な上限数を超えています ライセンス設定＞連携オプション＞コールアクション数上限（件）の上限数を超えてアップロードした場合に表示されます。
イベント種別ごとの登録可能な上限数を超えています ライセンス設定＞連携オプション＞コールアクションAPI連携数上限（件）の上限数を超えてアップロードした場合に表示されます。

 

セクションページに戻る

関連記事