- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
生成 Link V2
更新时间 2024-07-24 02:58:49
收藏接口说明
该接口用于生成能够直接跳转到端内小程序的 url link。
根据参数生成 url link 链接，需传入到期时间的 Unix 时间戳，最长距离当前时间 180 天。
- 实际有效时间按照小时计算，不满一小时自动向上取整。
- 假设当前时间（ct）为2022-2-2 16:23，传入到期时间（et）为 2022-2-2 18:00
- et-ct = 一小时37分钟，向上取整为2小时
- 因此，实际到期时间为2小时，即2022-2-2 18:23过期
使用限制
接口有频次限制，每个小程序，100qps，50w 次/自然日。如有特殊需求联系 oncall。
基本信息
| 名称 | 描述 |
|---|---|
| HTTP URL | |
| HTTP Method | POST |
| Scope | apps.url_link.generate |
| 权限要求 |
|
请求头
| 名称 | 字段类型 | 是否必填 | 示例 | 描述 |
|---|---|---|---|---|
| access-token | String | 是 | clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ | |
| content-type | String | 是 | application/json | 固定值"application/json" |
请求参数
Body
| 名称 | 字段类型 | 是否必填 | 示例 | 描述 |
|---|---|---|---|---|
| app_id | String | 是 | tt********* | 小程序ID |
| app_name | String | 是 | douyin | 宿主名称，可选 douyin，douyinlite，toutiao，toutiaolite |
| expire_time | Int64 | 是 | 1665158399 | 到期失效的URL Link的失效时间。为 Unix 时间戳，实际失效时间为距离当前时间小时数，向上取整。最长间隔天数为180天。 |
| path | String | 否 | pages/index | 通过URL Link进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。 |
| query | String | 否 | {"id":"123***789"} | 通过URL Link进入小程序时的 query（json形式），若无请填{}。最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`{}!#$&'()*+,/:;=?@-._~%``。 |
请求示例
curl --location --request POST 'https://open.douyin.com/api/apps/v1/url_link/generate/' \
--header 'Content-Type: application/json' \
--header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******' \
--data-raw '{
"app_id":"tt********",
"app_name":"douyin",
"path":"xxxx",
"query":"{xxx:xxxx}",
"expire_time":1644464021,
}'
响应参数
Body
| 名称 | 字段类型 | 是否必填 | 示例 | 描述 |
|---|---|---|---|---|
| data | Struct | 是 | ||
| err_msg | String | 是 | "" | 错误信息 |
| err_no | Int32 | 是 | 0 | 错误码 |
| log_id | String | 是 |
响应示例
正常响应示例
{
"err_no": 0,
"err_msg": "",
"log_id": "202008121419360101980821035705926A",
"data": {
"url_link": "https://z.douyin.com/Lu86lrX"
}
}异常响应示例
{
"err_no": 28005001,
"err_msg": "参数解析失败",
"log_id": "202008121419360101980821035705926A"
}错误码
| http状态码 | 错误码 | 错误码描述 | 排查建议 |
|---|---|---|---|
| 200 | 28005001 | 参数解析失败 | 参数解析失败，请检查参数格式 |
| 200 | 28005014 | 到期时间不在范围内 | 到期时间不在范围内 |
| 200 | 28001003 | access_token过期或无权限 | 重新获取access_token，见client_token获取说明 |
| 200 | 28005015 | 权限被封禁 | 权限被封禁 |
| 200 | 28005017 | schema编码异常 | 请检查参数格式 |
| 200 | 28005016 | 生成URL_Link频率过快 | 生成URL_Link频率过快 |
| 200 | 28005018 | 生成URL_Link数量超过上限 | 生成URL_Link数量超过上限 |
| 200 | 28005022 | 链接生成失败，联系开发人员 | 链接生成失败，联系开发人员 |
| 200 | 28005002 | 系统异常 | 重试 |
特殊行业类目
以下行业类目下的小程序，默认直接拥有权限
行业 | 服务类目 |
生活服务 | 餐饮-餐饮-餐饮门店 |
生活服务 | 餐饮-餐饮-美食团购平台 |
生活服务 | 餐饮-餐饮-外卖平台 |
生活服务 | 餐饮-餐饮-点餐平台 |
生活服务 | 餐饮-餐饮-点评与推荐 |
生活服务 | 餐饮-餐饮-菜谱 |
生活服务 | 餐饮-餐饮-餐厅排队 |
生活服务 | 生活服务-生活服务-营业性演出票务 |
生活服务 | 生活服务-生活服务-摄影/扩印 |
生活服务 | 生活服务-生活服务-搬家公司 |
生活服务 | 生活服务-生活服务-家政 |
生活服务 | 生活服务-生活服务-高空清洗 |
生活服务 | 生活服务-生活服务-月嫂/育儿嫂 |
生活服务 | 生活服务-生活服务-电路检测维修 |
生活服务 | 生活服务-生活服务-防水补漏/装修修缮 |
生活服务 | 生活服务-生活服务-燃烧器具安装/维 |
生活服务 | 酒店旅游-酒店旅游-酒店住宿 |
生活服务 | 酒店旅游-酒店旅游-景区服务 |
生活服务 | 酒店旅游-酒店旅游-酒旅平台 |
生活服务 | 零售-零售-商场百货 |
生活服务 | 零售-零售-超市/便利店 |
生活服务 | 零售-零售-品牌商 |
生活服务 | 生活服务-生活服务-休闲玩乐平台 |
生活服务 | 生活服务-生活服务-娱乐场所 |
生活服务 | 交通出行-交通出行-航空 |
咨询 | 商业服务-商业服务-法律服务 |
咨询 | 商业服务-商业服务-律师事务所 |
咨询 | 商业服务-商业服务-心理咨询 |
电商 | 电商-电商插件-任务玩法 |
电商 | 电商-电商插件-权益营销 |
电商 | 电商-电商插件-创意互动 |
电商 | 电商-电商插件-商品展示 |
电商 | 电商-电商插件-推荐导购 |
电商 | 电商-电商插件-C2B定制 |
电商 | 电商-电商插件-特殊交易 |
电商 | 电商-电商插件-线下服务/线下活动 |
电商 | 电商-电商插件-售后/其他品牌服务 |
线索 | 房地产-房地产-商品房预售 |
线索 | 房地产-房地产-房地产开发商 |
线索 | 房地产-房地产-房地产资讯 |
线索 | 房地产-房地产-房屋中介 |
线索 | 房地产-房地产-物业管理 |
线索 | 汽车-汽车-二手车 |
线索 | 汽车-汽车-汽车报价/比价 |
线索 | 汽车-汽车-养车/修车 |
线索 | 汽车-汽车-汽车资讯 |
线索 | 汽车-汽车-车展服务 |
线索 | 汽车-汽车-汽车厂商/下属子（分）公司 |
线索 | 汽车-汽车-汽车经销商/4S店 |
线索 | 商业服务-商业服务-法律服务 |
线索 | 商业服务-商业服务-律师事务所 |
线索 | 房地产-房地产-装修/建材 |
线索 | 商业服务-商业服务-招聘/求职（中介） |
线索 | 商业服务-商业服务-第三方人力资源服务 |
线索 | 商业服务-商业服务-供应链企业 |
点击纠错
