阅读(942)
赞(19)
微信小程序 订阅消息·getPubTemplateTitleList
2020-07-29 10:03:51 更新
subscribeMessage.getPubTemplateTitleList
本接口应在服务器端调用，详细说明参见服务端API。
本接口支持云调用。需开发者工具版本 >= 1.02.1904090（最新稳定版下载）
wx-server-sdk >= 0.4.0
获取帐号所属类目下的公共模板标题
调用方式：
- HTTPS 调用
- 云调用
HTTPS 调用
请求地址
GET https://api.weixin.qq.com/wxaapi/newtmpl/getpubtemplatetitles?access_token=ACCESS_TOKEN
请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | 接口调用凭证 | |
| ids | string | 是 | 类目 id，多个用逗号隔开 | |
| start | number | 是 | 用于分页，表示从 start 开始。从 0 开始计数。 | |
| limit | number | 是 | 用于分页，表示拉取 limit 条记录。最大为 30。 |
返回值
Object
返回的 JSON 数据包
| 属性 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| count | number | 模版标题列表总数 |
| data | Array.<Object> | 模板标题列表 |
errcode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 200016 | start 参数错误 | |
| 200017 | limit 参数错误 | |
| 200018 | 类目 ids 缺失 | |
| 200019 | 类目 ids 不合法 |
data 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| tid | number | 模版标题 id |
| title | string | 模版标题 |
| type | number | 模版类型，2 为一次性订阅，3 为长期订阅 |
| categoryId | number | 模版所属类目 id |
请求示例
{
"ids": "2,616",
"start": 0,
"limit": 1
}
响应示例
{
"errcode": 0,
"errmsg": "ok",
"count": 55,
"data": [
{
"tid": 99,
"title": "付款成功通知",
"type": 2,
"categoryId": "616"
}
]
}
云调用
云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力，需要在云函数中通过 wx-server-sdk 使用。
接口方法
openapi.subscribeMessage.getPubTemplateTitleList
需在 config.json 中配置 subscribeMessage.getPubTemplateTitleList API 的权限，详情
请求参数
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| ids | string | 是 | 类目 id，多个用逗号隔开 | |
| start | number | 是 | 用于分页，表示从 start 开始。从 0 开始计数。 | |
| limit | number | 是 | 用于分页，表示拉取 limit 条记录。最大为 30。 |
返回值
Object
返回的 JSON 数据包
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | number | 错误码 |
| errMsg | string | 错误信息 |
| count | number | 模版标题列表总数 |
| data | Array.<Object> | 模板标题列表 |
errCode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 0 | 成功 |
data 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| tid | number | 模版标题 id |
| title | string | 模版标题 |
| type | number | 模版类型，2 为一次性订阅，3 为长期订阅 |
| categoryId | number | 模版所属类目 id |
异常
Object
抛出的异常
| 属性 | 类型 | 说明 |
|---|---|---|
| errCode | number | 错误码 |
| errMsg | string | 错误信息 |
errCode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 200016 | start 参数错误 | |
| 200017 | limit 参数错误 | |
| 200018 | 类目 ids 缺失 | |
| 200019 | 类目 ids 不合法 |
请求示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.subscribeMessage.getPubTemplateTitleList({
ids: '',
start: '',
limit: ''
})
return result
} catch (err) {
return err
}
}
请求示例
const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
try {
const result = await cloud.openapi.subscribeMessage.getPubTemplateTitleList({
ids: '2,616',
start: 0,
limit: 1
})
return result
} catch (err) {
return err
}
}
响应示例
{
"errCode": 0,
"errMsg": "openapi.subscribeMessage.getPubTemplateTitleList:ok",
"count": 55,
"data": [
{
"tid": 99,
"title": "付款成功通知",
"type": 2,
"categoryId": "616"
}
]
}