是
否
一、 说明
获取小程序 scheme 码,适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。通过该接口,可以选择生成到期失效和永久有效的小程序码,目前仅针对国内非个人主体的小程序开放,详见获取 URL scheme。
调用方式:
二、 HTTPS 调用
1、接口地址
地址 | 请求方式 |
---|---|
https://api.weixin.qq.com/wxa/generatescheme?access_token=ACCESS_TOKEN | POST |
2、请求参数及说明
(1) 请求参数
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
access_token | string | 是 | 接口调用凭证 | |
jump_wxa | Object | 否 | 跳转到的目标小程序信息。 | |
is_expire | boolean | false | 否 | 生成的 scheme 码类型,到期失效:true,永久有效:false。 |
expire_time | number | 否 | 到期失效的 scheme 码的失效时间,为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为1年。生成到期失效的scheme时必填。 |
(2) jump_wxa 的结构
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
path | string | 是 | 通过 scheme 码进入的小程序页面路径,必须是已经发布的小程序存在的页面,不可携带 query。path 为空时会跳转小程序主页。 | |
query | string | 是 | 通过 scheme 码进入小程序时的 query,最大1024个字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~ |
3、返回值
(1) 返回值说明
属性 | 类型 | 说明 |
---|---|---|
errcode | number | 错误码 |
errmsg | string | 错误信息 |
openlink | string | 生成的小程序 scheme 码 |
(2) errcode合法值说明
值 | 说明 |
---|---|
40002 | 暂无生成权限 |
40013 | 生成权限被封禁 |
85079 | 小程序未发布 |
40165 | 参数path填写错误 |
40212 | 参数query填写错误 |
85401 | 参数expire_time填写错误,时间间隔大于1分钟且小于1年 |
44990 | 生成Scheme频率过快(超过100次/秒) |
85400 | 长期有效Scheme达到生成上限10万 |
45009 | 单天生成Scheme数量超过上限50万 |
4、示例:
(1)请求
{
"jump_wxa":
{
"path": "/pages/publishHomework/publishHomework",
"query": ""
},
"is_expire":true,
"expire_time":1606737600
}
(2)返回
{
"errcode": 0,
"errmsg": "ok",
"openlink": Scheme,
}