外部システムからの自動発信やハードフォン利用時にパソコンのCRM側から発信操作を行いたい場合などに利用します。

【コールバック】

BIZTELにおけるコールバックとは、システムからの電話が自動で掛かってくることを指しています。

内線宛にシステムから着信後にお客様へシステムから発信といった動作が可能になります。

(詳細はコールバックAPI機能概要を参照ください。)

【BIZTEL API】

BIZTELとして公開しているAPIとなり、外部システムからBIZTELに対して実行処理や履歴などの取得を行うことができるパラメーターが用意されています。

・コールバックAPIに関しては、URLを実行して動作させるタイプと、BIZTELとして公開しているAPI(BIZTEL API)を実行するパターンがあります。

・BIZTEL APIの実行にはAPIリクエスト数の上限と、連続実行に関する制限があります。
　(詳細はBIZTEL 管理画面 > システム設定 > ライセンス設定をご参照ください)

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

BIZTELサーバから1stコール先に対して、発信を行います。

(例：内線xxxx宛に着信)

1stコール先が応答します。

(例：内線xxxxがソフトフォンで応答)

BIZTELサーバから2ndコール先に対して、発信を行います。

(例：外線番号xxxxxxxxxxのお客様へ発信)

2ndコール先が応答します。

(例：外線番号xxxxxxxxxxのお客様が応答)

外部システムからBIZTEL APIを実行する仕組みになります。

認証のため、APIトークンが必要となります。
詳細は「API認証トークン」を参照ください。
リクエストヘッダに「Authorization: Token トークン文字列」を指定して使用します。

■実行例

プラウザのアドレスバーにURLを入力する。

https:// ご契約BIZTELサーバURL :8000/callback?リクエストパラメータ

■入力サンプル

https://sxxxxxxxxxxxx.u.biztel.jp:8000/callback?first_call_number=2001&second_call_number=03xxxxxxxx&async_flg=0

※内線2001宛に着信・応答後、外線03xxxxxxxx宛に発信されます。

また、「async_flg=0」の定義を行っているため、発信が完了したことがブラウザ上で表示されます。

（失敗時には失敗した旨の表示がされます。詳細は下記、4.3 レスポンスボディを参照してください。)

■実行例

macOSのターミナルにて下記コマンドを入力し、実行する

※本コマンドはcurlコマンドでの一例を記載しています。実行する外部システムにより実行内容は変更してください。

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'Authorization: Token ★事前に払い出したAPIトークン★' -d '★リクエストパラメータ★' 'https://★

ご契約BIZTELサーバURL ★:8000/public/api/v1/callback'

■入力サンプル

curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' --header 'Authorization: Token cc673fea2227201182aa9261626e08a39cfbb96e7d952bcccb79d31e4f76310e0cf5cd3276f942b9' -d 'first_call_number=2001&second_call_number=03xxxxxxxx

&async_flg=0' 'https://sxxxxxxxxxxxx.u.biztel.jp:8000/public/api/v1/callback

※内線2001宛に着信・応答後、外線03xxxxxxxx宛に発信されます。

また、「async_flg=0」の定義を行っているため、発信が完了したことがレスポンスボディに表示されます。

（失敗時には失敗した旨の表示がされます。詳細は下記、4.3 レスポンスボディを参照してください。)

{
  "access-control-allow-credentials": "true",
  "access-control-allow-headers": "Origin, Content-Type, Authorization, X-Auth-Token, x-xsrf-token",
  "access-control-allow-methods": "GET, POST, PUT, DELETE",
  "access-control-allow-origin": "*",
  "access-control-expose-headers": "Content-Disposition",
  "cache-control": "no-cache, private",
  "connection": "keep-alive",
  "content-encoding": "gzip",
  "content-type": "application/json",
  "date": "Mon, 06 Apr 2020 03:34:15 GMT",
  "referrer-policy": "same-origin",
  "server": "nginx",
  "strict-transport-security": "max-age=31536000; includeSubDomains",
  "transfer-encoding": "chunked",
  "vary": "Accept-Encoding",
  "x-account-id": "10011",
  "x-content-type-options": "nosniff",
  "x-frame-options": "SAMEORIGIN",
  "x-ratelimit-limit": "3",
  "x-ratelimit-remaining": "3",
  "x-robots-tag": "noindex",
  "x-xss-protection": "1; mode=block"
｝

コールバック発信の際は1stコールと2ndコールで2件の履歴が記録される
外線同士の通話に関しては、同時通話数は２消費する。（同時通話数の仕様に準じる）

※1通話あたり、同時通話数を2消費しますのでご注意ください。

1stおよび2ndに外線番号を指定した場合、それぞれの番号に対し発信を行いますので、それぞれで通話料が発生します。（課金明細の仕様に準じる）
またその場合、内線は0000で表示される。

※課金明細ではシステムからの発信となるため、ソフトフォンやハードフォンの内線が表示されませんのでご注意ください。

・累積APIリクエスト数、累積APレスポンスオブジェクト数ともに１づつ消費する。
・呼が成立しない場合(※)もサーバがリクエストを受け取った時点でライセンスを消費する。
　※1stコールが応答しない、2ndコールが応答しないなど