本接口用于查詢單次通信詳情。例如:您可以查詢通訊狀態、用戶詳情等信息。
接口說明
使用說明
本接口用于查詢單次通信詳情。例如:您可以查詢通訊狀態、用戶詳情等信息。
QPS 限制
本接口的單用戶 QPS 限制為 5 次/秒。超過限制,API 調用會被限流,這可能會影響您的業務,請合理調用。更多信息,請參見 QPS 限制。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
AppId | string | 是 | APP ID。 | testappid |
ChannelId | string | 是 | 頻道 ID。 | testid |
CreatedTs | long | 是 | 創建頻道時間,支持查詢最近 30 天的數據。使用 UNIX 時間戳表示,單位:秒。 說明
創建頻道時間必須與實際創建時間完全一致(精確到秒)。您可以通過調用接口 DescribeCallList 查看創建頻道時間(返回的 CreatedTS 參數)。
| 1614936817 |
DestroyedTs | long | 否 | 釋放頻道時間,使用 UNIX 時間戳表示,單位:秒。參數為空表示獲取當前時間。 說明
如果傳入的頻道釋放時間超過真實的釋放時間,將返回從創建時間開始到真實釋放時間之間的數據。
| 1614936817 |
ExtDataType | string | 否 | 查詢的擴展。取值:USER_DURATION_STAT:用戶時長統計數據類型。 | USER_DURATION_STAT |
QueryExpInfo | boolean | 否 | 是否查詢通信體驗信息,不傳默認是 true。 | false |
返回參數
示例
正常返回示例
JSON
格式
{
"CallInfo": {
"AppId": "testappid",
"ChannelId": "123456",
"CallStatus": "IN",
"CreatedTs": 1615860711,
"DestroyedTs": 1615860811,
"Duration": 100
},
"UserDetailList": [
{
"UserId": "testuserid",
"Roles": [
"SENDER"
],
"Location": "浙江省-杭州市",
"OnlinePeriods": [
{
"JoinTs": 1614936817,
"LeaveTs": 1614936817
}
],
"CreatedTs": 1614936817,
"DestroyedTs": 1614936817,
"OnlineDuration": 0,
"Duration": 0,
"SdkVersion": "1.0.0",
"SdkVersionList": [
"1.0.0"
],
"Os": "iOS",
"OsList": [
"iOS"
],
"Network": "4G",
"NetworkList": [
"4G"
],
"CallExp": "GOOD",
"DurMetricStatData": {
"PubAudio": 0,
"SubAudio": 0,
"PubVideo360": 0,
"SubVideo360": 0,
"PubVideo720": 0,
"SubVideo720": 0,
"PubVideo1080": 0,
"SubVideo1080": 0,
"PubVideoScreenShare": 0,
"SubVideoScreenShare": 0
}
}
],
"RequestId": "231470C1-ACFB-4C9F-844F-4CFE1E3804C5"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | ApiParamError | API %s. | Api參數錯誤 |
403 | BizCreatedTsError | A business CreatedTs error occurred. | 參數會議創建時間不準確。 |
403 | BizAppError | A business application permission error occurred. | 業務應用權限錯誤 |
403 | BizUidError | A business UID error occurred. | 業務主賬號錯誤 |
500 | ServerInternalError | An internal error occurred. | 服務器內部錯誤 |
訪問錯誤中心查看更多錯誤碼。