接口说明

该接口用于生成能够直接跳转到端内小程序的 url link。

使用限制

接口有频次限制，每个小程序，100qps，50w 次/自然日。如有特殊需求联系 oncall。

基本信息

名称	描述
HTTP URL	正式地址：https://open.douyin.com/api/apps/v1/url_link/generate/ 沙盒地址：https://open-sandbox.douyin.com/api/apps/v1/url_link/generate/
HTTP Method	POST
Scope	apps.url_link.generate
权限要求	此能力仅支持小程序通过试运营期后可用，默认获取权限，或满足指定行业类目的小程序则默认拥有权限（见文章末尾说明）

请求参数

请求头

access-token必填String

示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

调用https://open.douyin.com/oauth/client_token/生成的token

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天。

根据参数生成 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过期

pathString

示例：pages/index

通过URL Link进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。

queryString

示例：{"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"
  }
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	28005001	参数解析失败	参数解析失败，请检查参数格式
200	28005014	到期时间不在范围内	到期时间不在范围内。检查expire_time是否符合要求。
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	系统异常	重试

准入条件

能力的准入条件如下：

1.

账号主体需为企业主体

2.

小程序已上线。

3.

信用分不低于 90 分

4.

小程序主营类目符合类目条件

一级类目	二级类目	三级类目
餐饮	餐饮	点餐平台
餐饮	餐饮	外卖平台
餐饮	餐饮	点评与推荐
餐饮	餐饮	菜谱
餐饮	餐饮	餐厅排队
餐饮	餐饮	餐饮门店
餐饮	餐饮	美食团购平台
生活服务	生活服务	传统娱乐
生活服务	生活服务	休闲玩乐平台
生活服务	生活服务	营业性演出票务
生活服务	生活服务	摄影/扩印
生活服务	生活服务	搬家服务
生活服务	生活服务	家政服务
生活服务	生活服务	高空清洗
生活服务	生活服务	月嫂/育儿嫂
生活服务	生活服务	电路检测维修
生活服务	生活服务	防水补漏/装修修缮
生活服务	生活服务	燃烧器具安装/维修
酒店旅游	酒店旅游	酒店住宿
酒店旅游	酒店旅游	景区服务
酒店旅游	酒店旅游	酒旅平台
零售	零售	综合商场
零售	零售	超市/便利店
零售	零售	品牌商家
交通出行	交通出行	航空
商业服务	商业服务	法律服务
商业服务	商业服务	律师事务所
商业服务	商业服务	心理咨询
电商	商家工具	任务玩法
电商	商家工具	权益营销
电商	商家工具	创意互动
电商	商家工具	商品展示
电商	商家工具	推荐导购
电商	商家工具	C2B购后定制
电商	商家工具	特殊交易
电商	商家工具	线下服务/线下活动
电商	商家工具	售后/其他品牌服务
房地产	房地产	商品房预售
房地产	房地产	房地产开发商
房地产	房地产	房地产资讯
房地产	房地产	房屋中介
房地产	房地产	物业管理
汽车	汽车	二手车
汽车	汽车	汽车报价/比价
汽车	汽车	汽车维修保养
汽车	汽车	汽车资讯
汽车	汽车	车展服务
汽车	汽车	汽车厂商/下属子（分）公司
汽车	汽车	汽车经销商/4S店
房地产	房地产	装修/建材
商业服务	商业服务	招聘/求职（中介）
商业服务	商业服务	第三方人力资源服务
商业服务	商业服务	工业品供应商
电商	商家工具	C2B购前定制

开发者文档

生成 Link V2

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

准入条件

生成 Link V2在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

准入条件

生成 Link V2