小程序开放平台

文档中心
API 简介
登录
接口调用凭证
小程序码与链接
获取URL Link
获取小程序二维码
获取不限制的小程序二维码
小程序基础信息
本地担保交易能力
通用担保交易能力
电商担保交易能力
地点管理能力
客服能力
群聊能力
小说能力
短剧能力
服务组件能力
直播能力

获取URL Link

开发
>
服务端 API
>
小程序码与链接
>
获取URL Link
>
更新时间:2025-02-28 14:11:24

支持第三方调用

支持沙箱环境调用

获取小程序 URL Link,适用于短信、邮件、网页等小红书站外拉起小程序的业务场景。通过该接口,可以生成有效期最长不超过365天的小程序链接。单个小程序每天生成link上限为1000条,link支持被不同用户重复使用。

请求地址

POST https://miniapp.xiaohongshu.com/api/rmp/url

公共请求参数

名称
类型
是否必须
描述
app_idstring小程序appid
access_tokenstring小程序调用凭证

业务请求参数

名称
类型
是否必须
描述
page_urlstring扫码进入的小程序页面路径,根路径前不要添加 /,可携带 query,最大 1024 个字符
expire_intervalint32失效间隔天数。生成的到期失效链接在该间隔时间到达前有效。最长间隔天数为 365 天,不填默认为 365 天

请求示例

{
    "page_url":"string",
    "expire_interval":0
}

响应参数

名称
类型
是否必须
描述
data
struct
url
string小程序 URL Link
successbool是否成功
msgstring说明,正确响应时为 success,错误响应时为错误描述
codeint32错误码,正确响应时为 0,错误响应时非0

响应示例

{
    "data":{
        "url":"string"
    },
    "success":true,
    "msg":"string",
    "code":0
}

业务错误码

参见错误码