该接口用于生成能够直接跳转到端内小程序的 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 URL |
https://developer.toutiao.com/api/apps/url_link/generate |
HTTP Method |
POST |
权限要求 |
access_token 鉴权 |
请求头
名称 |
类型 |
是否必须 |
描述 |
---|---|---|---|
Content-Type |
string |
是 |
固定值 “application/json” |
请求参数
名称 |
类型 |
是否必填 |
描述 |
示例值 |
---|---|---|---|---|
access_token |
string |
是 |
接口调用凭证 |
0801**************** |
ma_app_id |
string |
是 |
小程序ID |
tt************** |
app_name |
string |
是 |
宿主名称,可选 douyin,douyinlite |
douyin |
path |
string |
否 |
通过URL Link进入的小程序页面路径,必须是已经发布的小程序存在的页面,不可携带 query。path 为空时会跳转小程序主页。 |
pages/index |
query |
string |
否 |
通过URL Link进入小程序时的 query(json形式),若无请填{}。最大1024个字符,只支持数字,大小写英文以及部分特殊字符:`{}!#$&'()*+,/:;=?@-._~%“。 |
{“id”:”123***789″} |
expire_time |
int64 |
是 |
到期失效的URL Link的失效时间。为 Unix 时间戳,实际失效时间为距离当前时间小时数,向上取整。最长间隔天数为180天。 |
1665158399 |
请求示例
curl --location --request POST 'https://developer.toutiao.com/api/apps/url_link/generate' \
--header 'Content-Type: application/json' \
--data-raw '{
"access_token":"0801121***********",
"ma_app_id":"tt***********",
"app_name":"douyin",
"path":"xxxx",
"query":"{xxx:xxxx}",
"expire_time":1644464021
}'
响应参数
名称 |
类型 |
是否必填 |
描述 |
示例值 |
---|---|---|---|---|
err_no |
int64 |
是 |
错误码 |
0 |
err_tips |
string |
是 |
错误信息 |
“” |
url_link |
string |
是 |
生成的url |
“https://z.douyin.com/Lu86lrX” |
响应示例
正常返回
{
"err_no": 0,
"err_tips": "",
"url_link": "https://z.douyin.com/Lu86lrX"
}
错误返回
{
"err_no": 12020,
"err_tips": "生成URL_Link频率过快",
"url_link": ""
}
错误码
HTTP状态码 |
错误码 |
描述 |
排查建议 |
---|---|---|---|
200 |
0 |
成功 |
无 |
200 |
1 |
参数填写错误 |
参数填写错误 |
200 |
2 |
权限被封禁 |
权限被封禁 |
200 |
-1 |
内部错误 |
重试 |
200 |
12018 |
参数解析失败,请检查参数格式 |
参数解析失败,请检查参数格式 |
200 |
12019 |
到期时间不在范围内 |
到期时间不在范围内 |
200 |
12020 |
生成URL_Link频率过快 |
生成URL_Link频率过快 |
200 |
12021 |
生成URL_Link数量超过上限 |
生成URL_Link数量超过上限 |
200 |
12022 |
链接生成失败,联系开发人员 |
链接生成失败,联系开发人员 |
200 |
12024 |
access_token错误 |
重新获取access_token,见getAccessToken |
200 |
12025 |
access_token过期或无权限 |
重新获取access_token,见getAccessToken |
没有回复内容