生成 Link V2

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

使用限制

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

接口说明

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

错误码

需要以表格形式提供完整的错误码信息，表格中必须包含 HTTP 状态码、错误码、描述和排查建议 4 项。描述在代码中是英文，这里建议换行补充对应的中文描述，方便开发者理解。

HTTP 状态码	错误码	描述	排查建议
200	28005001	参数解析失败	参数解析失败，请检查参数格式
200	28005014	到期时间不在范围内	到期时间不在范围内
200	28001003	accesstoken过期或无权限	重新获取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	系统异常	重试

curl --location --request POST 'http://dev-cn.your-api-server.com/api/apps/v1/url_link/generate' \ --header 'access-token: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******' \ --header 'Content-Type: application/json' \ --data-raw '{ "app_id":"tt********", "app_name":"douyin", "path":"xxxx", "query":"{xxx:xxxx}", "expire_time":1644464021, }'

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

access-token

string

必需

调用/oauth/client_token/生成的 token，此 token 不需要用户授权。示例：clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******

示例值:

clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******

Body 参数application/json

app_id

string

小程序ID

必需

app_name

string

必需

宿主名称，可选 douyin，douyinlite

path

string

可选

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

query

string

可选

通过URL Link进入小程序时的 query（json形式），若无请填{}。最大1024个字符，只支持数字，大小写英文以及部分特殊字符：`{}!#$&'()*+,/:;=?@-._~%``。

expire_time

integer

必需

到期失效的URL Link的失效时间。为 Unix 时间戳，实际失效时间为距离当前时间小时数，向上取整。最长间隔天数为180天。

示例

application/json

Body

err_no

integer

错误码

必需

err_msg

string

必需

err_tips

string

错误信息

必需

data

object

必需

url_link

string

生成的url

必需

生成 Link V2

使用限制#

接口说明#

错误码#

请求参数

返回响应

使用限制

接口说明

错误码