接口说明

使用 HTTPS 请求头 Authorization: Bearer $AppKey
此 API 需要:AppKey

调用方式

对接口传参

参数解释

请求包体:

{
    "link_id": "68qfBEW84TQDRmb3wCPowk",
    "project_id": "X5c6Zz8CeUcwim82YXteh9",
    "title": "链接标题",
    "tag_name": ["标签1","标签2"],
    "link_data": [
        {
            "key": "couponId",
            "value": "38194"
        },
        {
            "key": "channel",
            "value": "38421"
        }
    ],
    "redirections": {
        "redirect_default": "https://www.turbolink.ai/",
        "redirect_android": "https://play.google.com/store/apps/details?id=com.branchcn.www",
        "redirect_ios": "https://apps.apple.com/cn/app/"
    },
    "link_share_title": "测试标题",
    "link_share_desc": "测试描述",
    "link_share_img": "https://x.com/xxx.png",
    "web": {
        "use_custom": 1, 
        "web_first": 0,
        "pc_type": 2,
        "pc_custom_url": "https://www.turbolink.ai/1",
        "h5_type": 2,
        "h5_custom_url": "https://www.turbolink.ai/2"
    }
}

参数说明:

参数必须类型说明
link_id是string需要修改的深度链接 ID
project_id是string项目 ID
title是string链接标题
tag_name否array(string)链接标签
link_data是array(object)深度链接自定义键值对
link_data.key否string自定义参数键
link_data.value否string自定义参数值
redirections是obj跳转配置
redirections.redirect_default否string默认跳转,PC 端跳到这
redirections.redirect_android否stringAndroid 跳转
redirections.redirect_android否stringiOS 跳转
link_share_title否string社媒分享标题
link_share_desc否string社媒分享描述
link_share_img否string社媒分享缩略图
web否objectWeb跳转配置
web.use_custom否int32是否使用自定义配置(0-否 1-是)
web.web_first否int32是否优先web跳转(0否 1是)
web.pc_type否int32pc端选择(1使用默认网址 2使用自定义)
web.pc_custom_url否int32pc端自定义网址,当pc端选择为2时使用
web.h5_type否int32h5端选择(1使用默认网址 2使用自定义)
web.h5_custom_url否int32h5端自定义网址,当h5端选择为2时使用

返回结果

{
    "code": 200,
    "msg": "请求成功",
    "data": {}
}

参数说明:

参数类型说明
codeint32操作结果代码, 200 - 成功
msgstringcode 非 200 时为错误信息
dataobj如有数据,则返回