获取消息接收人列表

最近更新时间:2024-09-13 01:09:23

我的收藏

1. 接口描述

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

获取消息接收人列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ListReceiver。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,本接口不需要传递此参数。
Offset Integer 分页偏移量
示例值:0
Limit Integer 分页限制数目
示例值:12

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数目
示例值:12
Receivers Array of Receiver 联系人列表
示例值:[{"Uid":1001892,"Name":"nick","Remark":"","PhoneNumber":"+86 1863509","PhoneFlag":1,"Email":"2054@qq.com","EmailFlag":1,"IsReceiverOwner":1}]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取消息接收人列表

输入示例

https://cam.tencentcloudapi.com/?Action=ListReceiver
Offset=0&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Receivers": [
            {
                "Uid": 1001892,
                "Name": "nick",
                "Remark": "",
                "PhoneNumber": "+86 186****3509",
                "PhoneFlag": 1,
                "Email": "2054****@qq.com",
                "EmailFlag": 1,
                "IsReceiverOwner": 1
            }
        ],
        "RequestId": "9a9d4601-5f14-4293-b314-2319ab9f5450"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码