抖音开放平台Logo
控制台

生成SchemaV2

收藏
我的收藏

接口说明

该接口用于生成能够直接在端内跳转小程序的 schema。

根据参数生成 schema 链接，在端内跳转到指定小程序页面。

  1. 长期有效 schema，可通过no_expire指定，生成后可永久使用。
  2. 短期有效 schema，需传入到期时间的 Unix 时间戳，最长距离当前时间 180 天。

使用限制

该接口设有频次限制，如有特殊需求请 oncall。

  • 短期有效：每日上限不超过50万条，qps最高100
  • 长期有效：配置上限不超过10万条，qps最高100。

基本信息

名称描述
HTTP URL
HTTP Method
POST
Scope
ma.share.schema
权限要求

需要小程序通过试运营期

请求头

名称字段类型是否必填示例描述
access-tokenString是clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ
调用https://open.douyin.com/oauth/client_token/生成的token
content-typeString是application/json
固定值"application/json"

请求参数

Body

名称字段类型是否必填示例描述
app_idString是tt**************

小程序ID

no_expireBool是true

生成的 scheme 码类型，短期有效:false，长期有效:true。默认值false。

expire_timeInt64否1685090014

到期失效的 schema 的失效时间，为 Unix 时间戳，短期有效schema必传，最长间隔天数为180天。

pathString否pages/index

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

queryString否{"id":"123***789"}

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

请求示例

curl --location 'https://open.douyin.com/api/apps/v1/url/generate_schema/' \
--header 'access-token: clt.01********3d3d' \
--header 'Content-Type: application/json' \
--data '{
    "app_id":"tt5da*****",
    "query":"{\"key1\":\"val1\",\"key2\":\"val2\"}",
    "path":"test_miniapp",
    "no_expire":false,
    "expire_time":1685090014
}'

响应参数

Body

名称字段类型是否必填示例描述
err_msgString否""
err_noInt32否0
log_idString否202008121419360101980821035705926A

响应示例

正常响应示例

{
  "data": {
    "schema": "sslocal://miniapp?ticket=v1_*****"
  },
  "err_msg": "",
  "err_no": 0,
  "log_id": "20230828105040791DAA4F7CABB43F2E0D"
}

异常响应示例

{
  "data": {},
  "err_msg": "access_token无效",
  "err_no": 28001003,
  "log_id": "2023******5ACF"
}

错误码

http状态码错误码错误码描述排查建议
2000
成功
20028005015
权限被封禁
权限被封禁
20028005002
内部错误
重试
20028005078
到期时间不在范围内
到期时间不在范围内
20028005075
生成Schema频率过快
生成Schema频率过快
20028005076
生成Schema数量超过上限
生成Schema数量超过上限
20028001003
access_token无效
重新获取access_token