主题
接口描述
渠道查询名下渠道客列表
请求路径
GET
/v1/subchannel/list
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
query | string | form | 否 | 手机号,支持模糊匹配 |
vendorId | int | form | 否 | 供应商 Id |
regSource | string | form | 否 | 注册来源,当不传时表示查所有供应商,,取值: self 表示NiuLink自有, oem 表示oem渠道 |
nodeTypes | string | form | 否 | 节点类型,","分隔
|
vendorType | string | form | 否 | 供应商类型
|
isValidate | bool | form | 否 | 是否实名验证 |
signState | int | form | 否 | 签约状态
|
startTime | int | form | 否 | 注册开始时间,单位:毫秒 |
endTime | int | form | 否 | 注册结束时间,单位:毫秒 |
page | int | form | 否 | 页数,从 1 开始 |
size | int | form | 否 | 项目数限制,默认 100 |
返回值
名称 | 类型 | 描述 |
---|---|---|
list | []PortalSubchannelDetail | 渠道客列表 |
count | int | 渠道客数量 |
PortalSubchannelDetail
名称 | 类型 | 描述 |
---|---|---|
subchannelId | uint32 | 渠道客 Id |
regSource | string | 注册来源,取值: self 表示NiuLink自有, oem 表示oem渠道 |
cooperationType | string | 合作方式 |
createAt | int64 | 注册时间 毫秒 |
vendorType | string | 供应商类型 |
nodeTypes | []string | 拥有节点类型列表 |
isValidate | bool | 是否实名验证 |
signState | int | 签约状态 |
latestOnlineAt | int64 | 最近一次在线时间 |
请求示例
http://niulinkcloud-example/v1/subchannel/list?page=1&size=20&signState=0
返回值示例
json
正常请求:
http code 200
{
"list": [
{
"subchannelId": 100000,
"regSource": "self",
"cooperationType": "sub-channel",
"createAt": 1743384181733,
"vendorTypes": "个人认证",
"nodeTypes": [
"node"
],
"isValidate": false,
"signState": 0,
"latestOnlineAt": -62135596800000
},
],
"count": 1
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}
错误码列表
错误码 | 描述 |
---|---|
401 | 鉴权失败 |
如接口返回错误码未列举,可在错误码总览中查找