API共通仕様

エンドポイント

取得系API(コムデザインのAPIを利用する場合)

具体的なエンドポイントは、API申込書にてご連絡します。
基本的に、下記形式となります。

https://ドメイン/サービス名_前半/{APIバージョン名}/{アクセス元UUID}/サービス名_後半

APIバージョン：APIのバージョンを示す文字列

アクセス元UUID：APIのアクセス元毎に決定されるUUID形式のランダム値

通知系API（コムデザインから情報を通知する場合）

情報を受け取るお客様にてAPIをご用意いただく必要があります
エンドポイントは、API申込書にてご連絡下さい

API認証

HTTP Header に「Authorization: SECRET_API_KEY」を指定する事により認証します

送信系APIを利用する際のSECRET_API_KEYは、API利用申込書にてご連絡します

SECRET_API_KEYは、全APIで共通となります

(例）　Authorization:Bearer e0167b81201d415ab0d7ce9081849999

共通エラー

下記エラーは、HTTPステータスでエラーを返却します

許可されていないIPアドレスからのアクセス：404

認証エラー：401-403

リクエスト数超過（将来機能）：429

IPアドレス制限

取得系APIを利用される場合、汎用API利用申込書にてお客様のIPアドレスをご連絡ください。アクセス元IPドレス制限を実施します。

API毎に個別のアクセス元IPアドレスを指定することはできません。全APIで共通となります

汎用API用とCT-e1ツールのアクセス元IPアドレス制限は、個別設定となります

通知系APIを利用される場合、弊社のアクセス元IPアドレスによりアクセス制限を実施することが可能です。弊社のIPアドレスは、汎用API利用申込書にてご連絡します

取得系APIのリクエスト数制限

取得系API は、将来的に一定期間ごとのアクセス回数制限を行う予定です。

規定のリクエスト間隔未満の頻度でアクセスされている場合、弊社判断によりAPIを遮断させていただく場合がございます

取得系API 一覧

音声認識結果一括取得API（リクエスト間隔：5秒）

音声認識結果取得API（リクエスト間隔：5秒）

音声データ取得API（リクエスト間隔：5秒）

通話履歴取得API（リクエスト間隔：10分）

上記以外のAPI（リクエスト間隔：30秒）

音声データについて

CT-e1で管理している音声データは、エージェントとカスタマーが通話しているデータのみとなります。
このため、エージェント間の通話、IVR音声、留守電の音声等は、音声認識の対象となりません。また、音声データとしても保存されません

CT-e1では、通話内で保留・転送が実施された場合、それまでを個別通話として管理します。このため、カスタマーとの通話内で保留・転送が実施された場合、通話開始から通話終了までに複数の個別通話が含まれます。

個別通話の音声認識結果が必要な場合、音声認識結果取得API、音声認識結果送信APIを利用してください。通話全体の音声認識結果を取得する場合、音声認識結果一括取得API、音声認識結果一括送信APIを利用してください。

音声データは、音声データ取得APIもしくは音声データ送信APIで個別通話のみ取得できます。

音声認識処理

音声認識処理は、音声認識処理対象となっているエージェントとカスタマーが通話した内容のみ音声認識処理を実施します

音声認識対象のエージェントから音声認識対象外のエージェントへ転送された場合、全通話内の一部のみが音声認識されます

音声データの形式

音声データ送信APIで送信する音声データのフォーマットは以下となります。

音声形式：μRaw

サンプリング周波数：8000Hz

ビット長：8bit

チャンネル数：2チャンネル（Ｌがカスタマ、Rがオペレーター）
※音声の並びは LRLRLRLR となります

エンドポイント#

取得系API(コムデザインのAPIを利用する場合)#

通知系API（コムデザインから情報を通知する場合）#

API認証#

共通エラー#

IPアドレス制限#

取得系APIのリクエスト数制限#

音声データについて#

音声認識処理#

音声データの形式#