General_API
  1. コムデザインAPIドキュメント
General_API
  • コムデザインAPIドキュメント
    • サービス
    • 汎用API共通仕様
    • 汎用APIを利用開始までの流れ
    • 汎用APIドキュメント
      • 通話ステータス通知API
      • 通話履歴取得API
      • 待呼取得API
      • 音声認識結果一括取得API
      • 音声認識結果取得API
      • 音声認識結果一括送信API
      • 音声データ取得API
      • 使用回線数取得API
    • 変更履歴
  1. コムデザインAPIドキュメント

サービス

WebRTC接続用API#

CT-e1とWebRTCを用いて接続するためのAPI情報を提供します
本API の利用をご検討される場合、弊社担当者へご連絡下さい

汎用API#

CT-e1とシステム連携するためのAPIを提供します

通話ステータス通知API#

CT-e1の全エージェントに対して、通話ステータスが変更されたタイミングで通知を行います
音声認識を実施している場合、対象の全通話の音声認識が完了したタイミングにて、「音声認識完了」ステータスを通知します。音声認識結果一括取得API を利用される場合、本通知を受け取った後に音声認識結果一括取得APIリクエストをしてください
本APIによるステータス通知の遅延時間保証は行っておりません。厳密なステータス通知が必要な場合は、別途お問い合わせください
本APIを利用される場合、お客様で通知を受け取るためのAPIを作成していただく必要があります
なんらかの要因により、ステータス通知が行えなかった場合においても再送は行いません

取得系API#

弊社のAPI にアクセスし必要な情報を取得していただくAPIです
取得系API は、将来的に一定期間ごとのアクセス回数制限を行う予定です。
規定のリクエスト間隔未満の頻度でアクセスされている場合、弊社判断によりAPIを遮断させていただく場合がございます
取得系API 一覧
音声認識結果一括取得API(リクエスト間隔:5秒)
音声認識結果取得API(リクエスト間隔:5秒)
音声データ取得API(リクエスト間隔:5秒)
通話履歴取得API(リクエスト間隔:10分)
待呼取得API(リクエスト間隔:30秒)
使用回線数取得API(リクエスト間隔:30秒)
通話ステータス通知APIによる通話ステータスの通知直後に、取得系APIをリクエストされた場合、必要な情報の準備ができていない場合がございます。通知から概ね以下の時間経過後に、APIリクエストを実施してください。処理が集中している場合など、必ずしも必要な情報が準備できていない場合があります。
音声認識結果:通知から10秒後
音声データ:通知から10分後
画像2.png

送信系API#

送信系API とは、音声認識が完了したタイミングもしくは音声データが作成されたタイミングにて、これらデータを送信するAPIです
送信系API一覧
音声認識結果一括送信API
音声認識結果送信API
音声データ送信API
送信系API は、いずれか1つのみ利用可能です。利用されるAPIを汎用API利用申込書でご指定下さい
本APIを利用される場合、お客様で通知を受け取るためのAPIを作成していただく必要があります
なんらかの要因により、送信が行えなかった場合においても再送は行いません
画像3.png

リカバリ(通話履歴取得API)#

ネットワーク障害、システムの定期メンテナンス等により送信系APIで必要な情報が連携できない事象が発生することが想定されます
通話履歴取得APIで指定期間内の通話一覧を返却します。通話履歴に存在し、御社で未取得となっている通話は、取得系APIを用いて、必要なデータの再取得をお願いします
通話履歴取得APIで取得対象となる通話は、終了した通話のみとなります。このため、日変わり直後、時間変わり直後にAPIリクエストされた場合、日マタギしている通話、時間マタギしている通話は、取得対象となりません。
画像4.png
前へ
コムデザインAPIドキュメント
次へ
汎用API共通仕様
Built with