URL Scheme获取帮助文档
方式一:小程序管理后台工具生成
一、生成步骤
1. 打开小程序管理后台工具。
2. 扫码登录。
3. 登录后进入首页,点击「工具」(在右上角)。
4. 选择「生成 URL Scheme」。
5. 进入「生成 URL Scheme」页面。
6. 根据需求填写相关信息,如有效期、scheme码类型等。
7. 点击「生成」按钮,完成URL Scheme的生成。
二、参考文档
方式二:服务器端(接口)方式
一、说明
获取小程序 scheme 码,适用于短信、邮件、外部网页、微信内等拉起小程序的业务场景。通过该接口,可以选择生成到期失效和永久有效的小程序码,目前仅针对国内非个人主体的小程序开放,详见获取 URL scheme。
调用方式:HTTPS 调用。
二、HTTPS 调用
1. 接口地址:请参考相关文档或联系开发人员获取。
2. 请求方式:POST。
3. 请求参数及说明:
(1) 请求参数:
属性 | 类型 | 默认值 | 必填 | 说明
---|---|---|---|---
access_token | string | 是 | 是 | 接口鉴权凭证
jump_wxa | Object | 否 | 是 | 跳转到的目标小程序信息。
| path | string | 是 | 通过 scheme 码进入的小程序页面路径,必须是已经发布的小程序存在的页面,不可携带 query。path 为空时会跳转小程序主页。
| query | string | 是 | 通过 scheme 码进入小程序时的 query,最大1024个字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~
(2) jump_wxa 的结构:无特定要求。
通过scheme码进入小程序时的query,最大1024个字符,只支持数字,大小写英文以及部分特殊字符:!#$&'()*+,/:;=?@-._~。
返回值:
(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万
示例:
(1) 请求:
```json
{
"jumpWxa": {
"path": "pages/index/index",
"query": "test?id=123"
},
"isExpire": false,
"expireTime": null
}
```
(2) 返回:
```json
{
"errcode": 0,
"errmsg": "success",
"openlink": "weixin://dl/chat?appid=wx2421b1c4370ec43b&path=pages/index/index&query=test%3Fid%3D123&expire_time=1629783200"
}
```
重构后的内容如下:
一、错误码
小程序未发布:40165
参数path填写错误:40165
参数query填写错误:40212
参数expire_time填写错误,时间间隔大于1分钟且小于1年:85401
生成Scheme频率过快(超过100次/秒):44990
长期有效Scheme达到生成上限10万:85400
单天生成Scheme数量超过上限50万:45009
二、返回值
(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万
三、示例
(1)请求:暂无示例,因请求需要结合具体的业务逻辑和场景。
(2)返回:暂无具体示例,因为返回的数据依赖于实际操作的结果。如有其他问题请参考官方文档。