获取分享模板列表

我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序获取已设置的分享模板列表。

注意：

关于该接口作用以及该能力使用的更多说明，可以参考文档小程序接入分享指南。

请求

基本信息

基本
`HTTP URL`	`https://open.microapp.bytedance.com/openapi/v1/microapp/operation/share_tpl_list`
`HTTP Method`	`GET`
`权限要求`	授权小程序授予运营管理权限

查询参数

参数名	参数类型	是否必须	备注
`component_appid`	`string`	是	第三方小程序应用 appid
`authorizer_access_token`	`string`	是	授权小程序接口调用凭据
`page`	`int`	是	页码，从 1 开始
`size`	`int`	是	页长，从 1 开始，最多为 50

响应

响应体

参数名	参数类型	备注
`errno`	`int`	错误码
`message`	`string`	错误信息
`data`	`object`

data 说明：

参数名	参数类型	备注
`shareTplList`	`Array<object>`	分享模板列表
`total`	`int`	分享模板总数

shareTplList 说明：

参数名	参数类型	备注
`templateId`	`string`	分享模板 id
`title`	`string`	分享标题
`description`	`string`	分享文案
`imageUrl`	`string`	分享图案
`auditStatus`	`int`	分享信息审核状态, 0 表示没有提交, 1 表示审核中, 2 表示审核通过, 3 表示没有通过审核
`isDefault`	`int`	是否是默认模板，0 表示不是，1 表示是
`mtime`	`int`	更新时间
`reason`	`string`	拒绝原因
`auditTime`	`int`	最新审核结果出来的时间

响应体示例

{
    "errno": 0,
    "message": "success",
    "data":{
        "shareTplList": [
            {
                "templateId": "4immde7fdnb12sh6et",
                "title": "分享标题",
                "description": "分享文案",
                "imageUrl": "https://xxx",
                "auditStatus": 3,
                "isDefault": 0,
                "ctime": 1618456896,
                "reason": "[\"xxx\", \"xxx\"]",
                "mtime": 1618453991
            },
            ......
        ],
        "total": 9,
    }
}

错误码

错误码	message
30019	错误的页码
30020	错误的页长
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40036	授权小程序未授予该接口对应的权限

上一篇：查询「获取用户手机号」能力申请状态

下一篇：新增分享模板