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

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

このセクションの記事

1.外部API連携履歴

BIZTEL Servicedesk
  • 更新
目的

BIZTELサーバと外部CRMとのサーバ連携(WebAPI実行等)を行った際の動作結果を表示します。

対象オプションは、OAuthアカウント設定、コールアクション、API連携IVRとなります。

本項目を確認することにより、システム連携時のエラーなどを確認することができます。
対象プラン ビジネスフォン コールセンター 　　　　　　　 オプション
用語

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

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

【WebAPI】

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

・外部CRMとのサーバ連携時に処理が正常に動作しているか、異常時の切り分けに使用します。

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

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

目次

1. 基本機能

2. 前提条件

3. 外部API連携履歴の参照

4. CSVダウンロード

5. 非同期検索

本手順では、BIZTELサーバと外部CRMとのサーバ連携(WebAPI実行等)に関連する動作結果を参照する方法を紹介します。

1. 基本機能

外部API連携履歴では、正常・異常の処理結果を以下のタイミングで表示します。

正常

・OAuth認可コードフロー時、トークンリクエストを受信した場合
・コールアクション、API連携IVRでの処理実行時に発生した全てのHTTPレスポンスを受信した場合

異常

・OAuth認可コードフロー時、トークンリクエストの受信中に異常（例外）が発生した場合
・コールアクション、API連携IVRでの処理実行時に異常（例外）が発生した場合

※OAuth認可コードフローについては「1.OAuthアカウントの設定」をご参照ください。

※コールアクション、API連携IVRについては「1.コールアクション」「2.API連携IVR」をご参照ください。

2. 前提条件

外部API連携履歴の参照は次のアカウントで参照可能です。

・システム管理者ロールのアカウント

※スーパバイザ、ユーザロールでの参照はできません。

3. 外部API連携履歴の参照

外部API連携履歴では、実際にどういった API リクエストを送ったか、またレスポンス内容についての動作結果を確認することが可能です。

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

●レスポンスコードやレスポンス内容を確認可能です。
レスポンスボディは json 形式の場合はフォーマットして出力されるため、変数抽出パターンなどの想定結果にはそのまま使えない場合があるので注意が必要です。

※BIZTELサーバと外部CRMとのサーバ連携(WebAPI実行等)を行った際の動作結果を表示する機能となりますので、外部システムからBIZTEL API(コールバックAPI、履歴取得API)を実行した際の動作結果は表示されません。

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

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

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

項目 説明
期間

作成日時を条件に検索を行います。
※開始、終了いずれかの日時は必須となります。
リクエストID リクエストIDを条件に検索を行います。
サービス実行ID 外部サービス実行時のユニークIDを条件に検索を行います。
例）SMS送信サービスの送信時に付与されるメッセージIDなど
※BIZTELバージョン 3.8.0 から表示されます。
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レスポンスのレスポンスボディを条件に検索を行います。
JSON加工 レスポンスボディを加工するために利用したjqコマンドを条件に検索を行います。
※BIZTELバージョン 3.8.0 から表示されます。
JSON加工結果 レスポンスボディの内容をjqコマンドで加工した結果を条件に検索を行います。
※BIZTELバージョン 3.8.0 から表示されます。
エラーコード API連携中にエラーが発生した場合に記録されるエラーコードの値を条件に検索を行います。
エラータイプ API連携中にエラーが発生した場合に記録されるエラーの種別を条件に検索を行います。
エラーメッセージ API連携中にエラーが発生した場合に記録されるメッセージを条件に検索を行います。
エラー詳細 API連携中にエラーが発生した場合に記録されるエラータイプに応じた詳細情報を条件に検索を行います。

手順３．検索対象に一致する結果が表示されます。

※確認したい行をクリックする事で詳細表示が可能です。

● 詳細情報

基本情報
リクエストID API連携を行った通話のリクエストIDが表示されます
サービス実行ID 外部サービス実行時のユニークIDが表示されます
例）SMS送信サービスの送信時に付与されるメッセージIDなど
※BIZTELバージョン 3.8.0 以降で表示されます。
API連携種別 連携元の種別が表示されます
種別：IVR、コールアクション、OAuth
エンティティID 連携を行った設定のID（主キー）が表示されます
※IVRやコールアクションを登録し、詳細画面を表示した際のURL部分に表示されるIDです
・IVRの場合の例
　https://test.u.biztel.jp:8000/ivr/10001　の『10001』の部分が該当
・コールアクションの場合の例
　https://test.u.biztel.jp:8000/call_action/10004　の『10004』の部分が該当
ノードID

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

IVRまたはコールアクションで設定した名称が表示されます
・IVR > 基本情報 > IVR名称
・コールアクション > 基本情報 > コールアクション名
リクエスト情報
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リクエストの送信が行われた場合は成否にかかわらず必ず記録されます。
※リクエスト送信前に例外が発生した場合は記録されません。
JSON加工情報
JSON加工 レスポンスボディを加工するために利用したjqコマンドを表示します。
※BIZTELバージョン 3.8.0 から表示されます。
JSON加工結果 レスポンスボディの内容をjqコマンドで加工した結果を表示します。
※BIZTELバージョン 3.8.0 から表示されます。
エラー情報
エラーコード エラーコードの値を表示します。
※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 トークン・リクエストに対してエラーが応答されています

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

4. CSVダウンロード

検索結果は画面右上の「CSVダウンロード」にてダウンロードが可能です。

検索件数の上限を超える件数をダウンロードしたい場合、「」に従いダウンロード可能です。

mceclip0.png

5. 非同期検索

履歴検索時に検索上限を超えた場合は、以下のようなエラーが表示します。

エラーが表示された場合は、非同期検索にて、検索結果をダウンロードが可能です。

mceclip0.png

※エラー件数は、ご利用バージョンにより異なります。

BIZTELバージョン 3.3.21 まで：検索上限 1,000件

BIZTELバージョン 3.4.0 以降：検索上限 10,000件

 

手順１．画面右側の「非同期検索」をクリックします。

mceclip0.png

手順２．検索条件を入力し、画面中央の「非同期検索」をクリックします。
※検索メモはご自由に入力ください。

mceclip1.png

手順３．「保存しますか？」と表示後、「OK」をクリックします。

mceclip23.png

非同期検索後は、ボタン下に検索日時が表示されます。

mceclip19.png

作成直後の状況は「未処理」となりますが、「処理中」→「正常終了」と遷移しますので、
「正常終了が」表示されたらダウンロード可能となります。

※状況の遷移

mceclip16.png

画面は自動で更新されませんので、更新ボタンをクリックするか、ブラウザのリロードください。

手順４．CSVデータのダウンロードは正常終了となった処理のダウンロードアイコンをクリックします。

mceclip18.png

非同期検索結果をメールで受信する

非同期検索の処理結果はメール受信も可能です。

尚、検索するアカウントにメールアドレスの登録が必要となりますので、未登録の場合は、アカウントメニューからメールアドレスを登録ください。

※CSVデータは添付されませんので、管理画面よりダウンロードください。

※通知メール例

件名：BIZTEL：非同期履歴検索通知

------------------------------------------------------------

本文

※本メールはBIZTELサーバより自動で送信されております。

非同期検索処理が完了しました

登録日時: 2020-11-05 13:39:51

[履歴画面]

履歴画面 を押すことが出来ない場合は以下のURLをコピーしてブラウザのアドレスバーに貼り付けてください
お客様サーバホスト名/api_link_log

※[履歴画面]はHTML形式の場合、BIZTELサーバへ接続可能なボタンが表示されます。
※通知メールの件名、内容は変更できません。

非同期検索の注意事項

● 非同期検索は10件まで検索条件を保存する事が可能です。不要になった検索条件はゴミ箱アイコンから削除ください。

● 非同期検索の作成処理が失敗した場合は、「異常終了」と表示されます。
　異常終了と表示された場合は、再度非同期検索を実施ください。

セクションページに戻る

関連記事