1. 接口描述
接口请求域名： ses.tencentcloudapi.com 。
根据条件查询收件人列表，支持分页，模糊查询，状态查询
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ListReceivers。 |
| Version | 是 | String | 公共参数，本接口取值：2020-10-02。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表，本接口仅支持其中的: ap-guangzhou, ap-hongkong 。 |
| Offset | 是 | Integer | 偏移量，整型，从0开始 示例值：1 |
| Limit | 是 | Integer | 限制数目，整型，不超过100 示例值：10 |
| Status | 否 | Integer | 列表状态(1 待上传 2 上传中 3传完成)，若查询所有就不传这个字段 示例值：1 |
| KeyWord | 否 | String | 列表名称的关键字，模糊查询 示例值：列表名关键字 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 总数 示例值：123 |
| Data | Array of ReceiverData | 数据记录 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询收件人列表
输入示例
POST / HTTP/1.1
Host: ses.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListReceivers
<公共请求参数>
{
"Status": 1,
"Offset": 1,
"Limit": 1,
"KeyWord": "xx"
}输出示例
{
"Response": {
"TotalCount": 1,
"Data": [
{
"Count": 1,
"ReceiversStatus": 1,
"ReceiverId": 123,
"ReceiversName": "name",
"CreateTime": "2021-09-28 16:40:35",
"Desc": "描述"
}
],
"RequestId": "xx"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidLimit | 超过查询限制，Limit最大支持100。 |
| InternalError | 内部错误。 |