有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: cme.tencentcloudapi.com 。

获取平台中所有的已注册账号。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAccounts。
Version String 公共参数,本接口取值:2019-10-29。
Region String 公共参数,本接口不需要传递此参数。
Platform String 平台 Id,指定访问的平台。关于平台概念,请参见文档 平台
示例值:test
Phone String 手机号码。指定手机号获取账号信息,目前仅支持国内手机号,且号码不加地区码 +86 等。
示例值:15515555055
Offset Integer 分页返回的起始偏移量,默认值:0。
示例值:0
Limit Integer 分页返回的记录条数,默认值:10,最大值:20。
示例值:10

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合搜索条件的记录总数。
示例值:10
AccountInfoSet Array of AccountInfo 账号信息列表。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 指定手机号获取用户信息

输入示例

https://cme.tencentcloudapi.com/?Action=DescribeAccounts
&Platform=test
&Phone=15517177077
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "AccountInfoSet": [
            {
                "UserId": "72392ca4-2c79-44f3-ad5a-63cbfa72367c",
                "Phone": "15515555055",
                "Nick": "Nick",
                "Status": "Normal"
            }
        ],
        "RequestId": "946c2480-a14f-4d18-8a09-31a45cbd21af"
    }
}

示例2 分布获取平台所有账号信息

输入示例

https://cme.tencentcloudapi.com/?Action=DescribeAccounts
&Platform=test
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "AccountInfoSet": [
            {
                "UserId": "32392ca4-2c79-44f3-ad5a-63cbfa72367c",
                "Phone": "15515555056",
                "Nick": "小李",
                "Status": "Normal"
            },
            {
                "UserId": "62392ca4-2c79-44f3-ad5a-63cbfa72365d",
                "Phone": "13415555056",
                "Nick": "小张",
                "Status": "Normal"
            }
        ],
        "RequestId": "946c2480-a14f-4d18-8a09-31a45cbd21ad"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameter.Platform 平台参数非法。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.Offset 分页偏移不合法。
InvalidParameterValue.Platform 平台参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.PermissionDeny 权限不足,请检查对应操作者的权限。
ResourceNotFound.Platform 平台不存在。
ResourceNotFound.PlatformNotFound 平台不存在。
UnauthorizedOperation 未授权操作。