新增分享模板

我的收藏

接口介绍

该接口用于第三方小程序应用为授权小程序新增分享模板。

请求

基本信息

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

查询参数

参数名	参数类型	是否必须	备注
`component_appid`	`string`	是	第三方小程序应用 appid
`authorizer_access_token`	`string`	是	授权小程序接口调用凭据

请求体（json）

参数名	参数类型	是否必须	备注
`title`	`string`	是	分享标题，最多 14 个字
`description`	`string`	是	分享文案，最多 28 个字
`imagePath`	`string`	是	分享图案路径需要使用代授权小程序上传资源接口返回的路径才可以，接口调用时入参 material_type 字段为 6，否则报错。

请求体示例

{
  "title": "xxx",
  "description": "xxx",
  "imagePath": "xxxx/xxxx"
}

响应

响应体

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

响应体示例

{
  "errno": 0,
  "message": "success"
}

错误码

错误码	message
30010	最多拥有 10 套分享模板
40001	参数错误
40003	找不到相关第三方小程序应用
40004	找不到相关授权小程序
40020	第三方小程序应用 authorizer_access_token 不正确或者已过期
40033	获取不到上传的材料，请确认文件路径正确
40036	授权小程序未授予该接口对应的权限

分享模板审核结果通知

分享模板审核结果出来之后，会自动触发消息发送，然后开放平台服务器会向第三方小程序应用的【消息与事件接收 URL】以 HTTP POST 方式推送相应授权小程序的分享模板的审核结果。

POST 数据示例：

{
  "Nonce": "4464221",
  "TimeStamp": "1535551395",
  "Encrypt": "Encrypt Message xxxxxxxx",
  "MsgSignature": "ba394c04acece6c2c0edee058c5dddf82474b8ee"
}

其中 Encrypt 字段需要解密，解密详情见消息推送及加解密说明部分。解密后消息格式如下：

{
  "AppId": "授权小程序的appid",
  "TpAppId": "第三方小程序应用appid",
  "EventTime": "2019-01-14 12:45:10",
  "Event": "APPLY_SHARE_TEMPLATE",
  "ApplyShareTemplateResults": {
    "templateId": "xxx",
    "status": 0,
    "reason": "[\"xxx\",\"xxx\"]"
  }
}

消息体字段含义如下：

参数名	参数类型	备注
`AppId`	`string`	授权小程序 appid
`TpAppId`	`string`	第三方小程序应用 appid
`EventTime`	`string`	推送事件时间
`Event`	`string`	推送事件类型
`ApplyShareTemplateResults`	`object`	分享模板的审核结果
`templateId`	`string`	模板 id
`reason`	`string`	如果被拒，被拒原因
`status`	`int`	0 或 1，0 代表不通过，1 代表通过

注意：

如果检测到该模板是第一个审核通过的模板，则会自动将该模板设置成默认模板。

上一篇：获取分享模板列表

下一篇：修改分享模板