H5分享跳转链接获取

我的收藏

该接口用于快速获取 H5 分享场景的二维码。产生的链接能力可以参考 H5 分享能力介绍

该接口在生成 H5 分享链接时通过短链能力对链接长度进行压缩，可以有效的降低二维码信息密度，提高扫码的成功率。

使用限制

无

接口说明

接口返回的schema字段可以直接扫码拉起抖音
入参中的过期时间为生产短链的过期时间，会与传入的client ticket共同控制是否可以拉起编辑页面或发布页面。
image_path、image_list_path 和video_path，三者至少要传一个，否则会报错。
生成 Schema 的参考方式如下：H5 分享 Schema 生成示例。
想获取用户分享结果，请获取share_id将其填写到 state 字段。
图片格式支持：png/jpg/gif/(多图分享不支持 gif)；视频格式支持：mp4/mov。目前通过请求头中content-type进行校验，视频格式支持的content-type有video/3gpp、video/quicktime、video/mp4，图片格式是image/*。

基本信息

名称	描述
HTTP URL	https://open.douyin.com/api/douyin/v1/schema/get_share/
HTTP Method	POST
Scope	jump.basic
权限要求	此接口jump.basic权限默认开通需要应有具有H5分享的权限需要应用鉴权

请求头

名称	类型	必填	描述
content-type	string	是	固定值 "application/json"
access-token	string	是	调用`/oauth/client_token/`生成的 token，此 token 不需要用户授权。示例：`clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1******`

响应参数

名称	类型	是否必填	描述	示例

暂无数据

请求示例

curl --location 'https://open.douyin.com/api/douyin/v1/schema/get_share/' \
--header 'access-token: clt.e3331253187dc9dff97fa99a3f694f2dCEDejXkOxxxxx' \
--header 'Content-Type: application/json' \
--data '{
    "client_ticket": "#N8vMF6eko0RZRN/c4KWBMG7YaFjDqQkx+bwU6gpO428lz6ad+NNKlTDCr7v3Vthje7ToUT/xGxxxxx",
    "expire_at": 1684116049,
    "hashtag_list": [
        "hashtag1",
        "hashtag2",
        "hashtag3",
    ],
    "micro_app_info": {
        "app_id": "ttef9b992670bxxxx",
        "app_title": "小程序title",
        "app_url": "pages/movie/index?utm_source=share_wxapp&cityId=10&cityName=%E4%B8%8A%E6%B5%B7",
        "description": "小程序描述语"
    },
    "poi_id": "6678492553072936971",
    "share_to_publish": 0,
    "state": "1759435947641859",
    "title": "测试视频",
    "video_path": "https://xxxxx/over40M.mp4"
}'

响应参数

名称	类型	是否必填	描述	示例

暂无数据

响应示例

正常示例

{
  "data": {
    "schema": "snssdk1128://webview?url=https%3A%2F%2Fopen.douyin.com%2Fplatform%2Foauth%2Fslink%2F%3Ftoken%3D3f88af29866b5e15e0cd70390181d2d9d2a7%26client_key%3Dawr8bfr64vxgk036"
  },
  "err_msg": "",
  "err_no": 0,
  "log_id": "2023030419213553F1D75DDEBBF96B037B"
}

异常示例

{
  "err_no": -1,
  "err_msg": "系统错误",
  "log_id": "20220919151647010174244209010DE6B6"
}

错误码

HTTP 状态码	错误码	描述	排查建议
200	28001003	access_token无效	检查access_token是否正确有效
200	28001007	参数不合法	查看传参是否正确，如过期时间是否符合范围

上一篇：通过ItemID获取IFrame代码

下一篇：个人页跳转链接获取