調(diào)用DescribePubUserListBySubUser根據(jù)訂閱端獲取通信中發(fā)布端用戶列表。
使用說明
本接口用于根據(jù)訂閱端獲取通信中發(fā)布端用戶列表。例如:您可以獲取訂閱端和發(fā)布端用戶詳情信息。
QPS限制
本接口的單用戶QPS限制為10次/秒。超過限制,API調(diào)用會(huì)被限流,這可能會(huì)影響您的業(yè)務(wù),請(qǐng)合理調(diào)用。更多信息,請(qǐng)參見QPS限制。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
請(qǐng)求頭
該接口使用公共請(qǐng)求頭,無特殊請(qǐng)求頭。請(qǐng)參見公共請(qǐng)求參數(shù)文檔。
請(qǐng)求語法
POST /api/call/describePubUserListBySubUser HTTP/1.1
請(qǐng)求參數(shù)
名稱 | 類型 | 位置 | 是否必選 | 示例值 | 描述 |
---|---|---|---|---|---|
AppId | String | Query | 是 | 9qb1**** |
App ID,可通過控制臺(tái)創(chuàng)建和查詢。 |
ChannelId | String | Query | 是 | 311 |
頻道ID。 |
CreatedTs | Long | Query | 是 | 1615887685 |
頻道創(chuàng)建時(shí)間,支持查詢最近30天的數(shù)據(jù)。使用UNIX時(shí)間戳表示,單位:秒。 |
DestroyedTs | Long | Query | 否 | 1615888615 |
頻道釋放時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。參數(shù)為空表示獲取當(dāng)前時(shí)間。 說明 如果傳入的頻道釋放時(shí)間超過真實(shí)的釋放時(shí)間,將返回從創(chuàng)建時(shí)間開始到真實(shí)釋放時(shí)間之間的數(shù)據(jù)。
|
SubUserId | String | Query | 是 | c906531af5f9**** |
訂閱端用戶ID。 |
返回?cái)?shù)據(jù)
名稱 | 類型 | 示例值 | 描述 |
---|---|---|---|
SubUserDetail | Object |
訂閱端用戶詳細(xì)信息。 |
|
UserId | String | c906531af5f9**** |
用戶ID。 |
UserIdAlias | String | 旁路轉(zhuǎn)推 |
用戶ID別稱 |
Roles | Array of String | SENDER |
用戶角色,取值:
|
Location | String | 浙江省-杭州市 |
地理位置信息,例如:浙江省-杭州市。 |
OnlinePeriods | Array of OnlinePeriod |
在線時(shí)段信息。 |
|
JoinTs | Long | 1614936817 |
加入通話時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
LeaveTs | Long | 1614936820 |
離開通話時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
CreatedTs | Long | 1614936817 |
第一次加入通話的時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
DestroyedTs | Long | 1614936820 |
最后一次離開通話的時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。通話未結(jié)束時(shí)值為0。 |
OnlineDuration | Long | 0 |
在線時(shí)長(zhǎng),單位:秒。 |
Duration | Long | 0 |
通話時(shí)長(zhǎng),首次進(jìn)入到最后離開,單位:秒。 |
SdkVersion | String | 1.0.0 |
SDK版本。 |
SdkVersionList | Array of String | ["1.0.0", "1.1.1"] |
SDK版本列表,例如:1.0.0、1.1.1等。 |
Os | String | iOS |
瀏覽器或操作系統(tǒng)類型,例如Chrome、iOS、Android等。 說明 如果客戶端為Web,返回瀏覽器類型;如果客戶端為本地Native端,返回操作系統(tǒng)類型。
|
OsList | Array of String | ["iOS", "Chrome"] |
瀏覽器或操作系統(tǒng)類型,例如Chrome、iOS、Android等。 |
Network | String | 4G |
網(wǎng)絡(luò)類型,例如WiFi、4G等。 |
NetworkList | Array of String | ["4G", "WiFi"] |
網(wǎng)絡(luò)類型,例如WiFi、4G等。 |
ClientType | String | WEB |
端類型,取值:
|
PubUserDetailList | Array of UserDetail |
發(fā)布端用戶詳情信息。 |
|
UserId | String | c906531af5f9**** |
用戶ID。 |
UserIdAlias | String | 旁路轉(zhuǎn)推 |
用戶ID別名。 |
Roles | Array of String | SENDER |
用戶角色,取值:
|
Location | String | 浙江省-杭州市 |
地理位置信息,例如:浙江省-杭州市。 |
OnlinePeriods | Array of OnlinePeriod |
在線時(shí)段信息。 |
|
JoinTs | Long | 1615887685 |
加入通話時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
LeaveTs | Long | 1614936820 |
離開通話時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
CreatedTs | Long | 1615887685 |
第一次加入通話的時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
DestroyedTs | Long | 1615888615 |
最后一次離開通話的時(shí)間,使用UNIX時(shí)間戳表示,單位:秒。 |
OnlineDuration | Long | 930 |
在線時(shí)長(zhǎng),單位:秒。 |
Duration | Long | 930 |
通話時(shí)長(zhǎng),首次進(jìn)入到最后離開,單位:秒。 |
SdkVersion | String | 1.14.7 |
SDK版本。 |
SdkVersionList | Array of String | ["1.0.0", "1.1.1"] |
SDK版本列表,例如1.0.0、1.1.1等。 |
Os | String | iOS |
瀏覽器或操作系統(tǒng)類型,例如Chrome、iOS、Android等。 說明 如果客戶端為Web,返回瀏覽器類型;如果客戶端為本地Native端,返回操作系統(tǒng)類型。
|
OsList | Array of String | ["iOS", "Chrome"] |
瀏覽器或操作系統(tǒng)類型,例如Chrome、iOS、Android等。 |
Network | String | 4G |
網(wǎng)絡(luò)類型,例如WiFi、4G等。 |
NetworkList | Array of String | ["4G", "WiFi"] |
網(wǎng)絡(luò)類型,例如WiFi、4G等。 |
ClientType | String | NATIVE |
端類型,取值:
|
CallIdList | Array of String | testcallid |
用戶通信流的Call ID。 說明 當(dāng)訂閱端有訂閱的下行數(shù)據(jù)并且對(duì)應(yīng)發(fā)布端的上行數(shù)據(jù)缺失時(shí)返回該字段,同時(shí),PubUserDetailList中對(duì)象的其他字段(例如UserId、Roles等)不會(huì)返回。
|
CallStatus | String | OUT |
通信狀態(tài)。取值:
|
RequestId | String | D27DB8B0-73F6-42D0-9AAA-AD77EE3A9B29 |
請(qǐng)求ID。 |
示例
請(qǐng)求示例
POST api/call/describePubUserListBySubUser?AppId=9qb1****&ChannelId=311&CreatedTs=1615887685&DestroyedTs=1615888615&SubUserId=c906531af5f9**** HTTP/1.1
Host: vdc.cn-shenzhen.aliyuncs.com
Date: GMT Date
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribePubUserListBySubUserResponse>
<code>200</code>
<data>
<RequestId>D27DB8B0-73F6-42D0-9AAA-AD77EE3A9B29</RequestId>
<SubUserDetail>
<DestroyedTs>1615888615</DestroyedTs>
<ClientType>WEB</ClientType>
<Os>Chrome</Os>
<UserId>c906531af5f92a78</UserId>
<SdkVersion>1.14.7</SdkVersion>
<Duration>930</Duration>
<Roles>SENDER</Roles>
<CreatedTs>1615887685</CreatedTs>
<OnlineDuration>930</OnlineDuration>
<OnlinePeriods>
<JoinTs>1615887685</JoinTs>
</OnlinePeriods>
<Location>浙江省-杭州市</Location>
</SubUserDetail>
<CallStatus>OUT</CallStatus>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>D27DB8B0-73F6-42D0-9AAA-AD77EE3A9B29</requestId>
<successResponse>true</successResponse>
</DescribePubUserListBySubUserResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"code" : "200",
"data" : {
"PubUserDetailList" : [ ],
"RequestId" : "D27DB8B0-73F6-42D0-9AAA-AD77EE3A9B29",
"SubUserDetail" : {
"DestroyedTs" : 1615888615,
"ClientType" : "WEB",
"Os" : "Chrome",
"UserId" : "c906531af5f92a78",
"SdkVersion" : "1.14.7",
"Duration" : 930,
"Roles" : [ "SENDER" ],
"CreatedTs" : 1615887685,
"OnlineDuration" : 930,
"OnlinePeriods" : [ {
"JoinTs" : 1615887685
} ],
"Location" : "浙江省-杭州市"
},
"CallStatus" : "OUT"
},
"httpStatusCode" : "200",
"requestId" : "D27DB8B0-73F6-42D0-9AAA-AD77EE3A9B29",
"successResponse" : true
}