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

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

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

【WebAPI】

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

【アクション】

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

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

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

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

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

コールアクションに任意の名称を付けます。

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

無効：設定したコールアクションを無効にします。
※ステータスを無効へ変更したタイミングでコールアクションの処理が存在する場合、
　該当の処理は最後まで実行されます。

BIZTEL内での処理実行の是非を判断する為に判定用コードを設定します。
※判定用コードのみ入力されていても実行されませんので、判定評価パターンも併せて入力ください。
• 例：{ISANSWERED}と設定し、その通話が応答されたものかどうかを判定して処理を切り分ける
• 例：{RESPONSE_CRM_ID}でデータが取れるかを見て CRM レコードが作成済かどうかで処理を切り分ける

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

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

※判定用コードの想定値と評価判定パターンが実際にマッチするかを、
事前に正規表現チェッカー等のサイトで確認してください。

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

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

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

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

外部CRMへのAPIリクエストを送るURLを入力します。APIサービス側にパラメータを指定されている場合適宜記載してください。
※変数展開文字列を使用することができます。
※URL内で変数展開を実施する場合、変数展開される文字列に自動でURLエンコードが実施されます。
上記のエンコードを回避する場合はRAW()のメソッドチェーンを使用します。

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

外部CRMへのAPIリクエストを送るリクエストヘッダを入力する。
外部CRMのWebAPIに指定された項目を記載してください。
※変数展開文字列を使用できます。

外部CRMへのAPIリクエストを送るボディを入力する。
外部CRMのWebAPIに指定された項目/方式にて記載してください。
※変数展開文字列を使用できます。

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

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

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

※変数抽出パターンの補足があります。
※BIZTELバージョン 3.8.12 まで、255文字以内での入力となります。
　BIZTELバージョン 3.8.20 以降、1,000文字以内での入力となります。
※BIZTELバージョン 3.9.0 以降、変数抽出パターンにおいて変数展開文字列の利用が可能です。

本項目は、BIZTELバージョン 3.9.0 以降で表示されます。
BIZTELサーバ内にコールアクションのレスポンス内容を保管するための設定です。

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

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

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

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

変数抽出パターンで抽出した内容を変数展開することで追加情報に表示する内容を指定します。
※100文字以上は切り捨てになりますのでご注意ください。
※「通話履歴の追加情報へ保存」を選択した場合、保存上限はありません。

解析結果が連携される各画面上に表示されるプロンプトの内容を入力します。
※保存時に1000文字で切り捨てられます。

リクエストを送信したAPIの結果からAI解析結果に表示する内容を指定します。
※保存時に2000文字で切り捨てられます。
※変数展開コードが利用可能です。
※AI解析結果は、10,000件が保存上限となります。保存上限を超えた場合、毎日夜間帯で保存上限以内となるよう古いデータから削除されますのでご注意ください。

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

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

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

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

外線着信後、通話が終了したタイミングで発生する。
※応答の有無は問わない。

外線発信に対して相手が応答したタイミングで発生する。

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

コールセンター初期ガイダンスの再生を開始したタイミングで発生する。
※コールセンター初期ガイダンスが設定されている場合のみ発生します。

コールセンター初期ガイダンスの再生が完了したタイミングで発生する。
※コールセンター初期ガイダンスが設定されている場合のみ発生します。

コールセンター初期ガイダンスの再生が完了する前に通話が切断された場合に
そのタイミングで発生する。
※コールセンター初期ガイダンスが設定されている場合のみ発生します。

コールセンターのエージェントへの呼び出しの段階に入ったタイミングで発生する。

コールセンターのエージェントへの呼び出しが発生するタイミング毎に発生する。

コールセンターのエージェントへの呼び出しに対してエージェントが拒否をした、
または呼び出しタイムアウトが発生したタイミングごとに発生する。

コールセンターのエージェント呼び出しに対してエージェントが応答した
タイミングで発生する。

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

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

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

コールセンターのエージェント応答待ち状態にて発信者が通話を終了した際に処理を実行する。

コールセンターのエージェント応答待ち状態にて全体のタイムアウト設定時間を
超え、通話を終了するタイミングで発生する。
※コールセンターに設定された外線番号への着信でのみ発生、発信では動作しません。

コールセンターの待ち呼状態にいる発信者が「#」を入力したタイミングで発生。
※本イベントはBIZTELバージョン 3.4.0以降で利用可能です。

ステレオ録音のファイル生成が完了したタイミング、もしくは音声認識履歴サービスの録音が完了したタイミングで発生。
※本イベントはBIZTELバージョン 3.4.0以降で利用可能です。
※BIZTELバージョン 3.4.X までは「ステレオ録音完了/音声認識サービス連携完了」と表示されます。

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

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

サブパターンにて(?P<サブパターン名>...※正規表現部...)といった入力をすることで、変数抽出データに指定した名称を設定することが可能です。
この方法で抽出された場合、{CODE*}に加えて、{RESPONSE_(指定サブパターン名)}の変数展開コードにて使用することができます。
※サブパターン名には半角の英大文字と数字、_アンダースコアのみ使用することができます。

格納データは一つの通話内であれば、以降のコールアクション処理時の変数展開時に使用することが可能です。
変数抽出がされるごとにデータ格納は実行され、{CODE*}などは最新の変数抽出結果に上書きされます。
格納データへの上書きを防ぎ、以降のコールアクション処理時に使用する場合は上記の名前付きサブパターンを使用する必要があります。
ただし、その場合でも同じ名前をサブパターン名に指定すると上書きしてしまうため、適切にサブパターン名を管理してください。

格納データは24時間保持され、その後削除されます。
その為、24時間以上の通話が行われた場合などのケースには注意が必要です。

{AGENTID}
{AGENT_ID}

変数展開の実行タイミングにて

通話が応答されている　：1
通話が応答されていない：0

現在日時を「YYYY-MM-DD HH:MI:SS」のフォーマットで返却する

コールバックAPIにて利用する request_code値

発着信履歴の最終着信番号に当たる電話番号

発着信履歴の最終着信者名にあたる電話端末名
※BIZTELバージョン3.4.10から利用可能です。

{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}は、自動補完機能で表示されません。

内線番号に紐づく外線番号の名称
※コールセンター名称や、電話端末の名称など

通話時間

通話開始時間または発着信履歴の時刻カラムの値

通話終了時間または発着信履歴の時刻と通話時間（応答までの時間を含む）を足した値

通話に対する音声テキスト化データの全文を出力します。
イベント実行時点でテキスト化が完了されているものしか出力されません。

※音声認識連携（Omnis）をご利用の場合、連携成功または失敗に関するメッセージのみ出力します。

通話に対する音声テキスト化データのお客様部分のみを出力します。
※BIZTELバージョン 3.9.0 以降で利用可能です。

話に対する音声テキスト化データのエージェント部分のみを出力します。
※BIZTELバージョン 3.9.0 以降で利用可能です。

* にはIVRの内線番号が入る。
同通話における経由した他のIVRでのダイヤル入力値を取得。

最初の * にはIVRの内線番号、最後の * には1〜9が入る。
同通話における経由したIVRでの外部API実行の変数抽出結果の抽出データが順番に{CODE1}〜{CODE9}から取得できる。

応答したエージェントのアカウント名を取得します。

応答したエージェントの名前を取得します。

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

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

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

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

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

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

通話が発着信のいずれかであるかを取得します。
返却値：0 = 発信通話
返却値：1 = 着信通話

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

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

※多段でIVRを構成している場合は、先頭のIVRでの値を引き渡します。

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

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

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

※多段でIVRを構成している場合は、先頭のIVRでの値を引き渡します。

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

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

BIZTEL内の「アカウント」に対して変数展開時に呼び出すためのデータを用意することができる

 * には「4.2APIカスタム項目」にてAPIカスタム項目に指定したKeyを設定する

BIZTEL内の「電話端末」に対して変数展開時に呼び出すためのデータを用意することができる

 * には「4.2APIカスタム項目」にてAPIカスタム項目に指定したKeyを設定する

BIZTEL内の「コールセンター」に対して変数展開時に呼び出すためのデータを用意することができる

 * には「4.2APIカスタム項目」にてAPIカスタム項目に指定したKeyを設定する

BIZTEL内の「着信グループ」に対して変数展開時に呼び出すためのデータを用意することができる

 * には「4.2APIカスタム項目」にてAPIカスタム項目に指定したKeyを設定する

BIZTEL内の「IVR」に対して変数展開時に呼び出すためのデータを用意することができる

 * には「4.2APIカスタム項目」にてAPIカスタム項目に指定したKeyを設定する

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 以降で利用可能です。
※正数のみ利用可能です。

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

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

※上記いずれの引数は半角英数字、半角スペース、以下の記号 / : . + - のみ使用することができる
上記参考リンク内で指定されている形式でも↑の文字以外のものは使用できません。

作成日時を条件にした検索を行います。
カレンダーアイコンから日付、時計アイコンから時間（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」の選択が可能です。

コールアクションのAPI連携タブで作成した設定のIDを条件にした検索を行います。
※IVR、Oauthの履歴を検索することはできません。

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

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

検索対象範囲とする集計対象日時を検索対象に指定します。
カレンダーアイコンから日付、時計アイコンから時間（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」の選択が可能です。

検索対象範囲とする集計対象日時を検索対象に指定します。
カレンダーアイコンから日付、時計アイコンから時間（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」の選択が可能です。

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

インポートファイルの拡張子が .json でない場合に表示されます。

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

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

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

● 各値の文字数超え
● 正規表現必須の項目が正規表現でない
● 必須項目が未入力
● 指定外の値の入力など