接口说明

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

调用方式

对接口传参

参数解释

请求包体:

{
    "link_id": "68qfBEW84TQDRmb3wCPowk"
}

参数说明:

参数必须类型说明
link_idstring需要查询的深度链接Hash ID

返回结果

{
    "code": 200,
    "msg": "请求成功",
    "data": {
        "link_id": "68qfBEW84TQDRmb3wCPowk",
        "project_id": "X5c6Zz8CeUcwim82YXteh9",
        "title": "链接标题",
        "tag_name": [
            "标签1",
            "标签2"
        ], 
        "unique_mark": "", 
        "valid_invite_time": 0,
        "invite_num": 0,
        "total_invite_num": 0,    
        "invite_list": [
            {
                "user_id": "被邀请人用户ID",
                "device_id": "被邀请人设备ID",
                "invite_time": 1695693901,
                "redeem_type": 0
            },
            {
                "user_id": "被邀请人用户ID",
                "device_id": "被邀请人设备ID",
                "invite_time": 1695693901,
                "redeem_type": 1
            }
        ]
        "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_code": "¥1lMxt2E9Xd¥",
        "download_page": {
            "media_type": "ImageText",
            "image_text": [
            {
                "nick_name": "Jeff",
                "avatar": "https://dev.branchcn.com/flink/assets/images/flink.svg",
                "title": "AIGC酷毙了",
                "desc": "我用AIGC生成了一张图,美美的,大家也来玩一下吧。",
                "image": "https://img0.baidu.com/it/u=3891311026,3101645143&fm=253&fmt=auto&app=120&f=JPEG?w=658&h=989"
            }
            ]
        },
        "link_share_title": "测试标题",
        "link_share_desc": "测试描述",
        "link_share_img": "https://x.com/xxx.png"    
    }
}

参数说明:

参数类型说明
codeint32操作结果代码, 200 - 成功
msgstringcode 非 200 时为错误信息
dataobj链接数据
data.link_idstring深度链接 ID
data.project_idstring项目 ID
data.titlestring链接标题
data.tag_namearray(string)链接标签
data.unique_markstring创建唯一链接标识
data.valid_invite_timeint32链接有效的邀请时间,单位:s
data.invite_numint32有效的被邀请人数
data.total_invite_numint32总的被邀请人数,包含历史失效的邀请
data.invite_listarray(object)被邀请人列表
data.invite_list.user_idString被邀请人用户ID
data.invite_list.device_idString被邀请人设备ID
data.invite_list.invite_timeint32受邀时间
data.invite_list.redeem_typeint32被邀请人的状态,非0都是已经失效。0-正常,1-被兑换, 2-过期, 10-其它
data.link_dataarray(object)深度链接自定义键值对
data.link_data.keystring自定义参数键
data.link_data.valuestring自定义参数值
data.redirectionsobj跳转配置
data.redirections.redirect_defaultstring默认跳转,PC 端跳到这
data.redirections.redirect_androidstringAndroid 跳转
data.redirections.redirect_androidstringiOS 跳转
link_codeString口令code
download_pageobject动态下载页的内容 效果查看
download_page.media_typestring内容类型:ImageText (图文)
download_page.image_textarray(object)图文内容信息
download_page.image_text.avatarstring用户头像URL
download_page.image_text.nick_namestring用户昵称
download_page.image_text.titlestring内容标题
download_page.image_text.descstring内容描述
download_page.image_text.imagestring用户头像
link_share_titlestring
link_share_descstring
link_share_imgstring