調用DescribeCall查詢單次通信詳情。
使用說明
本接口用于查詢單次通信詳情。例如:您可以查詢通訊狀態、用戶詳情等信息。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見QPS限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求頭
該接口使用公共請求頭,無特殊請求頭。請參見公共請求參數文檔。
請求語法
POST /api/call/describeCall HTTP/1.1
請求參數
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
AppId | String | Query | 是 | pdtk**** |
App ID,可通過控制臺創建和查詢。 |
ChannelId | String | Query | 是 | 1230 |
頻道ID。 |
CreatedTs | Long | Query | 是 | 1616564129 |
創建頻道時間,支持查詢最近30天的數據。使用UNIX時間戳表示,單位:秒。 說明 創建頻道時間必須與實際創建時間完全一致(精確到秒)。您可以通過調用接口DescribeCallList查看創建頻道時間(返回的CreatedTS參數)。
|
DestroyedTs | Long | Query | 否 | 1616564304 |
釋放頻道時間,使用UNIX時間戳表示,單位:秒。參數為空表示獲取當前時間。 說明 如果傳入的頻道釋放時間超過真實的釋放時間,將返回從創建時間開始到真實釋放時間之間的數據。
|
ExtDataType | String | Query | 否 | USER_DURATION_STAT |
查詢的擴展。取值: USER_DURATION_STAT:用戶時長統計數據類型。 |
QueryExpInfo | Boolean | Query | 否 | false |
是否獲取通訊體驗,取值:
|
返回數據
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
CallInfo | Object |
通信基本信息。 |
|
AppId | String | pdtk**** |
App ID。 |
ChannelId | String | 1230 |
頻道ID。 |
CallStatus | String | OUT |
通信狀態。取值:
|
CreatedTs | Long | 1616564129 |
創建通信時間,使用UNIX時間戳表示,單位:秒。 |
DestroyedTs | Long | 1616564304 |
釋放通信時間,使用UNIX時間戳表示,單位:秒。 |
Duration | Long | 175 |
通信持續時長,單位:秒。 |
UserDetailList | Array of UserDetail |
用戶詳情列表。 |
|
UserId | String | 29ebdab59ba8**** |
用戶ID。 |
UserIdAlias | String | 旁路 |
用戶ID別名。 |
Roles | Array of String | SENDER |
用戶角色,取值:
|
Location | String | 浙江省-杭州市 |
地理位置信息,例如:浙江省-杭州市。 |
OnlinePeriods | Array of OnlinePeriod |
在線時段信息。 |
|
JoinTs | Long | 1616564129 |
加入通話時間,使用UNIX時間戳表示,單位:秒。 |
LeaveTs | Long | 1616564304 |
離開通話時間,使用UNIX時間戳表示,單位:秒。 |
CreatedTs | Long | 1616564129 |
第一次加入通話的時間,使用UNIX時間戳表示,單位:秒。 |
DestroyedTs | Long | 1616564304 |
最后一次離開通話的時間,使用UNIX時間戳表示,單位:秒。通話未結束時值為0。 |
OnlineDuration | Long | 175 |
在線時長,單位:秒。 |
Duration | Long | 0 |
通話時長,首次進入到最后離開,單位:秒。 |
SdkVersion | String | 2.1.2103191 |
SDK版本。 |
SdkVersionList | Array of String | ["1.0.0", "1.1.1"] |
SDK版本列表,例如1.0.0、1.1.1等。 |
Os | String | macOS |
瀏覽器或操作系統類型,例如Chrome、iOS、Android等。 說明 如果客戶端為Web,返回瀏覽器類型;如果客戶端為本地Native端,返回操作系統類型。
|
OsList | Array of String | ["iOS", "Chrome"] |
瀏覽器或操作系統類型,例如Chrome、iOS、Android等。 |
Network | String | WiFi |
網絡類型,例如WiFi,4G等。 |
NetworkList | Array of String | ["4G", "WiFi"] |
網絡類型,例如WiFi、4G等。 |
CallExp | String | GOOD |
通話體驗,取值:
|
DurMetricStatData | Object |
時長統計數據。 |
|
PubAudio | Long | 0 |
發布音頻時長,單位:秒。 |
SubAudio | Long | 0 |
訂閱音頻時長,單位:秒。 |
PubVideo360 | Long | 0 |
發布360P視頻時長,單位:秒。 |
SubVideo360 | Long | 0 |
訂閱360P視頻時長,單位:秒。 |
PubVideo720 | Long | 0 |
發布720P視頻時長,單位:秒。 |
SubVideo720 | Long | 0 |
訂閱720P視頻時長,單位:秒。 |
PubVideo1080 | Long | 0 |
發布1080P視頻時長,單位:秒。 |
SubVideo1080 | Long | 0 |
訂閱1080P視頻時長,單位:秒。 |
PubVideoScreenShare | Long | 0 |
發布屏幕共享時長,單位:秒。 |
SubVideoScreenShare | Long | 0 |
訂閱屏幕共享時長,單位:秒。 |
RequestId | String | EC4960AA-A407-4853-975E-D68F253E18FF |
請求ID。 |
示例
請求示例
POST api/call/describeCall?AppId=pdtk****&ChannelId=1230&CreatedTs=1616564129&DestroyedTs=1616564304 HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com
Date: GMT Date
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DscribeCallResponse>
<requestId>EC4960AA-A407-4853-975E-D68F253E18FF</requestId>
<code>200</code>
<message/>
<action/>
<apiName/>
<extendedCode/>
<bizCode/>
<httpStatusCode>200</httpStatusCode>
<data>
<RequestId>EC4960AA-A407-4853-975E-D68F253E18FF</RequestId>
<CallInfo>
<DestroyedTs>1616564304</DestroyedTs>
<AppId>pdtkb2qy</AppId>
<CallStatus>OUT</CallStatus>
<Duration>175</Duration>
<CreatedTs>1616564129</CreatedTs>
<ChannelId>1230</ChannelId>
</CallInfo>
<UserDetailList>
<Os>macOS</Os>
<SdkVersion>2.0.0.210324.dev--release/rtcsdk_v2.0</SdkVersion>
<Duration>175</Duration>
<OnlineDuration>175</OnlineDuration>
<DestroyedTs>1616564304</DestroyedTs>
<CallExp>GOOD</CallExp>
<UserId>29ebdab59ba891c3</UserId>
<Network>WiFi</Network>
<CreatedTs>1616564129</CreatedTs>
<OnlinePeriods>
<LeaveTs>1616564304</LeaveTs>
<JoinTs>1616564129</JoinTs>
</OnlinePeriods>
<Location>浙江省-杭州市</Location>
<DurMetricStatData/>
</UserDetailList>
<UserDetailList>
<Os>Android</Os>
<SdkVersion>2.1.2103191</SdkVersion>
<Duration>112</Duration>
<OnlineDuration>102</OnlineDuration>
<DestroyedTs>1616564253</DestroyedTs>
<CallExp>GOOD</CallExp>
<UserId>c31b32364ce1</UserId>
<Network>WiFi</Network>
<CreatedTs>1616564141</CreatedTs>
<OnlinePeriods>
<LeaveTs>1616564207</LeaveTs>
<JoinTs>1616564141</JoinTs>
</OnlinePeriods>
<OnlinePeriods>
<LeaveTs>1616564253</LeaveTs>
<JoinTs>1616564217</JoinTs>
</OnlinePeriods>
<Location>浙江省-杭州市</Location>
<DurMetricStatData/>
</UserDetailList>
</data>
<successResponse>true</successResponse>
</DscribeCallResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"requestId" : "EC4960AA-A407-4853-975E-D68F253E18FF",
"code" : "200",
"httpStatusCode" : "200",
"data" : {
"RequestId" : "EC4960AA-A407-4853-975E-D68F253E18FF",
"CallInfo" : {
"DestroyedTs" : 1616564304,
"AppId" : "pdtkb2qy",
"CallStatus" : "OUT",
"Duration" : 175,
"CreatedTs" : 1616564129,
"ChannelId" : "1230"
},
"UserDetailList" : [ {
"Os" : "macOS",
"SdkVersion" : "2.0.0.210324.dev--release/rtcsdk_v2.0",
"Duration" : 175,
"Roles" : [ ],
"OnlineDuration" : 175,
"DestroyedTs" : 1616564304,
"CallExp" : "GOOD",
"UserId" : "29ebdab59ba891c3",
"Network" : "WiFi",
"CreatedTs" : 1616564129,
"OnlinePeriods" : [ {
"LeaveTs" : 1616564304,
"JoinTs" : 1616564129
} ],
"Location" : "浙江省-杭州市",
"DurMetricStatData" : { }
}, {
"Os" : "Android",
"SdkVersion" : "2.1.2103191",
"Duration" : 112,
"Roles" : [ ],
"OnlineDuration" : 102,
"DestroyedTs" : 1616564253,
"CallExp" : "GOOD",
"UserId" : "c31b32364ce1",
"Network" : "WiFi",
"CreatedTs" : 1616564141,
"OnlinePeriods" : [ {
"LeaveTs" : 1616564207,
"JoinTs" : 1616564141
}, {
"LeaveTs" : 1616564253,
"JoinTs" : 1616564217
} ],
"Location" : "浙江省-杭州市",
"DurMetricStatData" : { }
} ]
},
"successResponse" : true
}