本接口用于根据订阅端获取通信中发布端用户列表。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| rtc:DescribePubUserListBySubUser |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| AppId | string | 是 | APP ID。 | testappid |
| ChannelId | string | 是 | 频道 ID。 | testid |
| CreatedTs | long | 是 | 频道创建时间，支持查询最近 30 天的数据。使用 UNIX 时间戳表示，单位：秒。 | 1614936817 |
| DestroyedTs | long | 否 | 频道释放时间，使用 UNIX 时间戳表示，单位：秒。参数为空表示获取当前时间。 说明
如果传入的频道释放时间超过真实的释放时间，将返回从创建时间开始到真实释放时间之间的数据。
| 1614936817 |
| SubUserId | string | 是 | 订阅端用户 ID。 | testuserid |
返回参数
示例
正常返回示例
JSON格式
{
"SubUserDetail": {
"UserId": "testuserid",
"UserIdAlias": "yi****",
"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"
],
"ClientType": "NATIVE"
},
"PubUserDetailList": [
{
"UserId": "testuserid2",
"UserIdAlias": "yi****",
"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"
],
"ClientType": "NATIVE",
"CallIdList": [
"testcallid"
]
}
],
"CallStatus": "IN",
"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. | 服务器内部错误 |
访问错误中心查看更多错误码。