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/audio_data
General

機能#

リクエストされたタイミングで、指定された通話の音声データを返却します
一定期間に多数のリクエストを実施された場合、エラーを返却する可能性があります(概ねリクエスト間隔は、5秒以上としてください)

エラー#

存在しないリクエストパラメータ
リクエストパラメータ不足
許可されていないテナントの情報要求
31日以上前の音声データを要求
未完了の通話に対する取得要求

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。テナントを一意に特定する
sessionId
integer 
セッションID
必須
CTe-1で生成されるテナント単位で通話を識別するID。 転送時も変化しない。複数テナントの情報を扱う場合、重複することがある。
recordId
integer 
レコードID
必須
保留・転送等で通話が分かれた場合に発番されるID 同一sessionId内で1からシーケンシャルに付与される
例
{
	"tenantId": "05053698341",
	"sessionId": 942125,
	"recordId": 1
}

サンプルコード

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/audio_data' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
	"tenantId": "05053698341",
	"sessionId": 942125,
	"recordId": 1
}'

Response

🟢200成功
multipart/form-data
Body
status
string 
ステータス
必須
成功:complete 失敗:error
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
sessionId
integer 
セッションID
必須
CTe-1で生成されるテナント単位で通話を識別するID。 転送時も変化しない。複数テナントの情報を扱う場合、重複することがある。
recordId
integer 
レコードID
必須
保留・転送等で通話が分かれた場合に発番されるID 同一sessionId内で1からシーケンシャルに付与される
direction
integer 
方向
必須
0:着信, 1:発信
ani
string 
発信者番号
必須
着信:発信者番号(非通知の場合は、anonymous)
発信:発信先番号
dnis
string 
着信番号
必須
着信:着信番号
発信:発信元番号
agentId
string 
エージェントID
必須
CT-e1のエージェントID
agentName
string 
エージェント名
必須
CT-e1のエージェント名
connectTime
string 
通話開始時刻
必須
SO8601 形式(GMT)
disconnectTime
string 
通話終了時刻
必須
SO8601 形式(GMT)
skillId
string 
着信スキルID
必須
CT-e1の着信スキルID
skillName
string 
着信スキル名
必須
CT-e1の着信スキル名
groupId
string 
局番スキルID
必須
CT-e1の局番スキルID
groupName
string 
局番スキル名
必須
CT-e1の局番スキル名
discription
string 
説明
可選
失敗の場合、失敗原因を表す任意のメッセージ
例
{
    "status": "complete",
    "tenantId": "05058085500",
    "sessionId": 35087858,
    "recordId": 1,
    "direction": 0,
    "ani": "08075082398",
    "dnis": "05053698333",
    "agentId": "F99971353",
    "agentName": "コムデザイン一郎",
    "skillName": "着信スキル名1",
    "groupId": "0368509999@0368939999",
    "groupName": "局番スキル名1",
    "connectTime": "2023-01-04T11:22:33.123Z",
    "disconnectTime": "2023-01-04T11:27:13.570Z"
}
🟢200失敗
前へ
音声認識結果一括送信API
次へ
使用回線数取得API
Built with