API 列表

xiaodian.share.relation.searchByTime

  • 免费
  • 无需授权

API功能描述(支持get和post)

根据时间查询分享关系

公共参数

名称 类型 必选 描述
app_key Long 是 接入时申请的app_key
method String 是 接口名称
access_token String 是 Oauth2.0授权获得的access_token
sign String 是 对 API 调用参数（除sign外）进行 md5 加密获得。参数的顺序为字母表的顺序
timestamp Long 是 时间戳，使用Unix时间戳格式
format String 是 响应格式。默认为json格式，固定
sign_method String 否 参数的加密方法选择，当前只支持Md5
version String 否 API协议版本，固定值为：1.0

输入参数

名称 类型 必选 描述 示例值
relationParam Object 是 分享关系入参
beginTime Number 是 开始时间(时间戳精确到秒)
endTime Number 是 结束时间(时间戳精确到秒)开始日期时间和结束时间不能超过1天
type Number 是 业务域(分享传2)
subType Number 否 业务子类型
pageNum Number 是 分页页码,从1开始
pageSize String 是 分页查询每页的条数

返回参数

名称 类型 描述 默认值
relations Object[] 分享关系列表
relation Object[] 关系列表
inviteUserId Number 分享人id
inviteNickName String 分享人昵称
inviteTel String 分享人手机号
followUserId Number 被分享人id
followNickName String 被分享人昵称
followTel String 被分享人手机号
total Number 所有分享关系数目
pageNum Number 分页页码,从1开始
pageSize Number 分页查询每页的条数

请求参数示例

1).
{
	"relationParam": {
		"userId": 325497729,
		"beginTime": 1537186645,
		"endTime": 1586568534,
		"type": 2
	}
}

返回示例

1).
{
	"result": {
		"data": {
			"relations": ["relation": {
				"inviteUserId": 1001,
				"inviteNickName": "张三",
				"inviteTel": "13590423345",
				"followUserId": "1002",
				"followNickName": "李四",
				"followTel": "123456789"
			}]
		}
	}
}

异常示例

1).
{
	"result": {},
	"status": {
		"code": "1200001",
		"msg": "该参数无结果值"
	}
}

API测试工具