API 中心
有奖：语音产品征文挑战赛火热进行中> HOT
文档中心 > API 中心 > 邮件推送 > 邮件相关接口 > 查询某个收件人列表详情

查询某个收件人列表详情

最近更新时间：2024-03-12 01:46:31

我的收藏

本页目录：

1. 接口描述

接口请求域名： ses.tencentcloudapi.com 。

根据收件人列表id查询收件人列表中的所有收件人邮箱地址，分页查询，可以根据收件邮箱地址来过滤查询

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：ListReceiverDetails。
Version 是 String 公共参数，本接口取值：2020-10-02。
Region 是 String 公共参数，详见产品支持的 地域列表。
ReceiverId 是 Integer 收件人列表ID,CreateReceiver接口创建收件人列表时会返回该值
示例值：123
Offset 是 Integer 偏移量，整型，从0开始
示例值：1
Limit 是 Integer 限制数目，整型,不超过100
示例值：10
Email 否 String 收件人地址，长度0-50，示例：xxx@te.com，支持模糊查询
示例值：xxx@te.com

3. 输出参数

参数名称 类型 描述
TotalCount Integer 总数
示例值：123
Data Array of ReceiverDetail 数据记录
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询某个收件人列表详情

输入示例

POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListReceiverDetails
<公共请求参数>

{
    "ReceiverId": 123,
    "Email": "abc@ec.cm",
    "Offset": 1,
    "Limit": 10
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Data": [
            {
                "Email": "abc@cd.com",
                "CreateTime": "2021-09-28 16:40:35",
                "TemplateData": "{\"name\":\"1\"}"
            }
        ],
        "RequestId": "8979fc1e-9564-4fc9-bf7d-2958ce679b72"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.InvalidLimit 超过查询限制，Limit最大支持100。
InternalError 内部错误。
OperationDenied.ReceiverNotExist 收件人列表不存在。
中国站