API 文档/短链查询

查询短链列表

分页查询短链列表,支持按域名、类型、访问码、状态、创建时间、点击次数等条件过滤。

POST/api/link/list查询短链列表

请求参数 (application/json)

字段类型必填说明
pageSize
integer (int32)可选每页数量
pageNum
integer (int32)可选页码
domain
string可选当前选中的域名,为 null 则查全部
linkType
string可选短链类型:OY 普通短链、WL 微信外链、WMP 小程序链接
visitCode
string可选短链访问码
status
integer (int32)可选状态:0 正常、1 停止访问、2 被封禁
createdTimeStart
string (date-time)可选创建时间-开始
createdTimeEnd
string (date-time)可选创建时间-结束
totalClickCntMin
integer (int64)可选最小访问次数
totalClickCntMax
integer (int64)可选最大访问次数

响应字段

字段类型必填说明
code
string可选状态码
message
string可选提示信息
data
object可选分页数据
pageNum
integer (int64)可选当前页码
pageSize
integer (int64)可选页容
total
integer (int64)可选数据总数
list
array可选结果集
id
integer (int64)可选短链 ID
linkType
string可选短链类型:OY 普通短链、WL 微信外链、WMP 小程序链接
sourceLink
string可选原始链接
visitPrefix
string可选访问前缀(域名部分)
visitCode
string可选短链访问码
ownDomain
integer (int32)可选是否自有域名 0-否 1-是
sslFlag
integer (int32)可选是否开启 SSL 0-否 1-是
status
integer (int32)可选状态 0-正常 1-停止访问 2-被封禁
totalClickCnt
integer (int64)可选累计点击次数
todayClickCnt
integer (int64)可选今日点击次数
expireDate
string (date-time)可选过期时间
createdTime
string (date-time)可选创建时间
success
boolean可选请求是否成功
cURL
curl -X POST 'https://open.xnanlink.com/api/link/list' \
  -H 'Content-Type: application/json' \
  -H 'Token: YOUR_TOKEN' \
  -d '{
    "pageNum": 1,
    "pageSize": 20,
    "domain": "lxs.la",
    "status": 0
  }'
JSON
{
  "code": "OK",
  "message": "成功",
  "data": {
    "pageNum": 1,
    "pageSize": 20,
    "total": 158,
    "list": [{
      "id": 100001,
      "linkType": "OY",
      "sourceLink": "https://www.example.com/page?id=123",
      "visitPrefix": "lxs.la",
      "visitCode": "abc123",
      "ownDomain": 0,
      "sslFlag": 1,
      "status": 0,
      "totalClickCnt": 3580,
      "todayClickCnt": 42,
      "createdTime": "2026-01-15T10:30:00"
    }]
  },
  "success": true
}