| 目的 |
外部システムからBIZTEL APIを実行する際に認証を行う必要があります。 その認証を行う際にAPIトークンの発行が必要となります。 BIZTELではアカウント毎にAPIトークンの発行が可能です。 |
|---|---|
| 対象プラン |
|
| 用語 |
【BIZTEL API】 BIZTELとして公開しているAPIとなり、外部システムからBIZTELに対して実行処理や履歴などの取得を行うことができるパラメーターが用意されています。 |
| ポイント |
・本機能をご利用頂く場合、「コールバックAPI」「履歴取得API」「録音ファイル取得API」のいずれかのオプション契約が必須です。 |
目次
※項目名をクリックいただく事で項目が展開され、参照したい手順へ移動できます。
1. 前提条件
アカウント設定（APIトークン、変数設定）が可能なアカウントは次の権限設定が必要です。
・システム管理者ロール所属のアカウント
2. APIトークンの設定
本項では、外部システムからBIZTEL APIを実行する際に利用するAPIトークンの設定方法を紹介します。
※本項を登録・編集するには、「コールバックAPI」「履歴取得API」「録音ファイル取得API」いずれかのオプション契約が必要です。
※取得したAPIトークンを各オプションで利用する方法は「1.コールバックAPI」「2.履歴取得API」「2.ステレオ録音API」の項目をご参照ください。
手順１．BIZTEL管理画面より、「アカウント > アカウント」をクリックします。
手順２．外部システムからBIZTEL APIを実行する対象のアカウントをクリックします。
発行例：管理者用アカウントで実行する、外部システム用アカウントを発行し、そのアカウントで実行する等
手順３．画面上部の「APIトークン」をクリックし、「発行する」をクリックします。
手順４．必要項目を入力し、「登録」をクリックします。
| 項目 | 説明 |
|---|---|
| APIトークン | APIトークンは登録完了後に表示されます。 |
| 有効期限 | 設定する：有効期限を設ける場合に選択します。 無期限 ：有効期限を設けない場合に選択します。 |
| 有効期限期日 |
有効期限を「設定する」にしている場合に設定します。 発行済みのAPIトークンを一時的に無効化する場合は、「当日より過去の日付」を指定することで可能です。 |
| 作成日時 | APIトークンは登録完了後に表示されます。 |
手順５．「APIトークンを発行します。よろしいですか？」と表示される為、「OK」をクリックします。
発行が完了すると、APIトークンが表示され、クリップボードへコピーする事が可能です。
以上で、APIトークンの設定は完了です。
補足
● 発行したAPIトークンは有効期限を過ぎるまで利用可能です。期日を過ぎた時点で利用不可となりますのでご注意ください。
● １アカウントにつき、APIトークンは１つまで発行可能です。
● 編集画面では「有効期限」「有効期限期日」のみ変更可能です。
● アカウントを削除した場合、APIトークンも自動削除されます。