第三方平台
接口说明
常见问题排查指南

新增分享模版

为授权小程序新增分享模版

请求地址

POST   https://open.microapp.bytedance.com/openapi/v1/microapp/operation/add_share_tpl

 

Query 参数

参数名参数类型是否必须备注
component_appidstring第三方平台的 appid
authorizer_access_tokenstring授权小程序的接口调用令牌

Body 参数(json)

参数名参数类型是否必须备注
titlestring分享标题,最多 14 个字
descriptionstring分享文案,最多 28 个字
imagePathstring分享图案
注意:需要使用代授权小程序上传资源接口返回的路径才可以,否则报错。

Body 参数示例

{
  "title": "xxx",
  "description": "xxx",
  "imagePath": "thirdparty/${tpAppId}/${authAppId}/${prefix}/${hash}"
}

 

返回值

参数名参数类型备注
errnoint错误码
messagestring错误信息

返回值示例

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

错误码

错误码message
30010最多拥有 10 套分享模板
40001参数错误
40033获取不到上传的图片材料,请确认文件路径正确

 

分享模版审核结果通知

分享模版审核结果出来之后,会自动触发消息发送,然后第三方平台服务器会向第三方平台【消息与事件接收 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\"]"
  }
}

消息体字段含义如下:

参数名参数类型备注
AppIdstring授权小程序的 appid
TpAppIdstring第三方平台的 appid
EventTimestring推送事件时间
Eventstring推送事件类型
ApplyShareTemplateResultsobject分享模版的审核结果
templateIdstring模板 id
reasonstring如果被拒,被拒原因
statusint0 或 1,0 代表不通过,1 代表通过

注意:

  • 如果检测到该模板是第一个审核通过的模板,则会自动将该模板设置成默认模板。
点击纠错
评价此篇文档