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

通話履歴取得API

開発中
POST
/general/{apiVersion}/{sourceUuid}/call/history
General

機能#

リクエストされた日時に終了した通話履歴(セッションID)のリストを返却します
日付のみ指定された場合、指定日の0:00:00~23:59:59に間に通話終了した通話リストを返却します
日付及び時間が指定された場合、指定日の指定時間の00:00~59:59に間に通話終了した通話リストを返却します
日付変更直後・時間変更直後に本APIをリクエストされた場合、直前に終了した通話がレスポンスに含まれない可能性があります。 日付変更、時間変更から、1分以上の間隔を開けて本APIをリクエストして下さい
例:20240915の通話履歴を取得する場合、2024/09/15 00:01:00以降にAPIリクエストをして下さい
一定期間に多数のリクエストを実施された場合、エラーを返却する可能性があります(概ねリクエスト間隔は、10分以上としてください)

エラー#

存在しないリクエストパラメータ
リクエストパラメータ不足
許可されていないテナントの情報要求
31日以上前の日付を指定
未来日を指定
存在しない日付を指定
時刻指定エラー: 0~23以外の数字を指定
現在及び未来時刻を指定(例:現在時刻が10:15の場合、10時は指定不可とする)

Requestパラメータ

Pathパラメータ
apiVersion
string 
必須
APIバージョンを示す文字列
サンプル値:
v1
sourceUuid
string 
必須
APIの利用者ごとに発行されるUUID形式の文字列
サンプル値:
d70c9bba-b71f-4021-b68c-0dccb2d99999
Headerパラメータ
Authorization
string 
必須
Bearer e0167b81201d415ab0d7ce9081849999 形式のAPIキーを設定する
APIキーは、事前共有する
Request Bodyパラメータapplication/json
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
date
string 
取得日
必須
通話履歴を取得する日付をJSTで指定する
指定形式はYYYYMMDDとする
現在日より31日以上前の日付指定は不可とする
hour
string 
取得時
可選
指定日付の特定時間の通話履歴を取得する場合に、JSTで指定する
例
{
  "tenantId": "05053698341",
  "date": "20240915",
  "hour": "10"
}

サンプルコード

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/general/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/call/history' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "05053698341",
  "date": "20240915",
  "hour": "10"
}'

Response

🟢200成功
application/json
Body
conversationList
object 
必須
status
string 
ステータス
必須
成功:complete 失敗:error
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
sessionList
array [object {4}] 
必須
例
{
	"conversationList": {
		"status": "complete",
		"tenantId": "05053698333",
		"sessionList": [
			{
				"sessionId": 942125,
				"connectTime": "2024-06-21T08:27:34.084Z",
				"disconnectTime": "2024-06-21T08:28:36.930Z",
				"recordList": [
					{
						"recordId": 1,
						"recognitionResultsFlag": "1"
											}
				]
			},
			{
				"sessionId": 942126,
				"connectTime": "2024-06-21T08:28:34.084Z",
				"disconnectTime": "2024-06-21T08:30:36.930Z",
				"recordList": [
					{
						"recordId": 1
						"recognitionResultsFlag": "1"
					},
					{
						"recordId": 2
						"recognitionResultsFlag": "0"
					}
				]
			}
		]
	}
}
🟢200失敗
前へ
通話ステータス通知API
次へ
待呼取得API
Built with