获取小程序scheme码
获取小程序scheme码,适用于短信、邮件、外部网页等拉起小程序的业务场景。通过该接口,可以选择生成到期失效和永久有效的小程序码。
注意事项
- 目前仅针对国内非个人主体的小程序开放,详见获取URL scheme码
- 生成的URL Scheme仅支持从微信外打开小程序。
- 该功能基本覆盖当前用户正在使用的微信版本,开发者无需进行低版本兼容。
- 微信内的网页如需打开小程序请使用微信开放标签-小程序跳转按钮,无公众号也可以直接使用小程序身份开发网页并免鉴权跳转小程序,见云开发静态网站跳转小程序。符合开放范围的小程序可以下发支持打开小程序的短信。
- 只能生成已发布的小程序的URL Scheme。
- 通过URL Scheme跳转到微信时,可能会触发系统弹框询问,若用户选择不跳转,则无法打开小程序。请开发者妥善处理用户选择不跳转的场景。
- 单个小程序每日生成URL scheme上限为1000个。
请求地址
POST https://api.weixin.qq.com/wxa/generatescheme?access_token=ACCESS_TOKEN
请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 第三方平台接口调用令牌authorizer_access_token | |
jump_wxa | Object | 否 | 跳转到的目标小程序信息。 | |
is_expire | boolean | false | 否 | 生成的scheme码类型,到期失效:true,永久有效:false。 |
expire_time | number | 否 | 到期失效的scheme码的失效时间,为Unix时间戳。生成的到期失效scheme码在该时间前有效。生成到期失效的scheme时必填。 |
jump_wxa 的结构
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
path | string | 是 | 通过scheme码进入的小程序页面路径,必须是已经发布的小程序存在的页面,path为空时会跳转小程序主页。 | |
query | string | 是 | 通过scheme码进入小程序时的query,最大32个字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~ |
返回值
openlink
生成的小程序scheme码
异常返回
Object
JSON
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
errcode 的合法值
值 | 说明 | 最低版本 |
---|---|---|
40002 | 暂无生成权限,个人主体小程序不支持调用;或者尚未发布的小程序不支持调用 | |
40013 | 生成权限被封禁 | |
40097 | 参数expire_time填写错误 | |
40165 | 参数path填写错误 | |
40212 | 参数query填写错误 |
返回值说明
如果调用成功,会直接返回生成的小程序scheme码。如果请求失败,会返回 JSON 格式的数据。
示例
请求
{
"jump_wxa":
{
"path": "/pages/publishHomework/publishHomework",
"query": ""
},
"is_expire":true,
"expire_time":1606737600
}
返回
{
"errcode": 0,
"errmsg": "ok",
"openlink": Scheme,
}