1. 接口描述
接口请求域名: gme.tencentcloudapi.com 。
获取房间内用户信息
默认接口请求频率限制:1000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeRoomInfo。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
SdkAppId | 是 | Integer | 应用ID,登录控制台 - 服务管理创建应用得到的AppID 示例值:123456 |
RoomIds.N | 否 | Array of Integer | 房间号列表,最大不能超过10个(RoomIds、StrRoomIds必须填一个) 示例值:[1234, 2345] |
StrRoomIds.N | 否 | Array of String | 字符串类型房间号列表,最大不能超过10个(RoomIds、StrRoomIds必须填一个) 示例值:["1234", "2345"] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | Integer | 操作结果, 0成功, 非0失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RoomUsers | Array of RoomUser | 房间用户信息 注意:此字段可能返回 null,表示取不到有效值。 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取房间内用户信息
获取房间内用户信息,RoomIds和StrRoomIds填一个即可,若都存在,则优先查询StrRoomIds。
输入示例
POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoomInfo
<公共请求参数>
{
"RoomIds": [
"88888"
],
"StrRoomIds": [
"aaaaa"
],
"SdkAppId": "1400000000"
}
输出示例
{
"Response": {
"Result": 1,
"RoomUsers": [
{
"RoomId": 0,
"Uins": [
1111
],
"StrRoomId": "aaaaa",
"StrUins": [
""
]
}
],
"RequestId": "50d01794-367f-4993-b4e3-cac5a4c1aaaa"
}
}
示例2 获取房间内用户信息1
获取房间内用户信息1
输入示例
POST / HTTP/1.1
Host: gme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeRoomInfo
<公共请求参数>
{
"RoomIds": [
"11"
],
"SdkAppId": "1400405451"
}
输出示例
{
"Response": {
"Result": 1,
"RoomUsers": [
{
"RoomId": 11,
"Uins": [
1111
],
"StrRoomId": "",
"StrUins": [
""
]
}
],
"RequestId": "50d01794-367f-4993-b4e3-cac5a4c1aaaa"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |