1. 接口描述
接口请求域名: lke.tencentcloudapi.com 。
获取发布渠道列表
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ListChannel。 |
Version | 是 | String | 公共参数,本接口取值:2023-11-30。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
AppBizId | 是 | String | 应用ID 示例值:1908652910168703294 |
PageNumber | 否 | Integer | 页码 示例值:1 |
PageSize | 否 | Integer | 分页数量 示例值:10 |
ChannelType.N | 否 | Array of Integer | 渠道类型, 10000: 微信订阅号,10001: 微信服务号,10002:企微应用,10004:微信客服,10005:小程序,10009:企微智能机器人 示例值:[10000,10001,10002] |
ChannelStatus.N | 否 | Array of Integer | 渠道状态 1未发布 2运行中 3已下线 示例值:[1,2,3] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Total | Integer | 返回总数 示例值:100 |
ListChannel | Array of ChannelListInfo | 渠道信息列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取发布渠道列表
输入示例
POST / HTTP/1.1
Host: lke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ListChannel
<公共请求参数>
{
"AppBizId": "1927296561029113536",
"PageNumber": 1,
"PageSize": 20
}
输出示例
{
"Response": {
"ListChannel": [
{
"ChannelId": "1932046222365083648",
"ChannelName": "微信服务号",
"ChannelStatus": 2,
"ChannelType": 10000,
"Comment": "",
"CreateTime": "1749470703",
"UpdateTime": "1749470703",
"UpdatedUser": "channel@qq.com",
"YuanQiInfo": {
"VisibleRange": "share"
}
}
],
"RequestId": "bf251d0d-0409-4849-98e7-81fd7dbcc994",
"Total": 1
}
}
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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |