client/docs/relation/match.md

119 lines
2.6 KiB
Markdown
Raw Permalink Normal View History

2025-09-29 16:42:36 +08:00
# Match
relation-关系管理:匹配
- [/relation.Match/Fetch](#relationmatchfetch)
- [/relation.Match/Get](#relationmatchget)
- [/relation.Match/DoJoin](#relationmatchdojoin)
- [/relation.Match/DoIgnore](#relationmatchdoignore)
## /relation.Match/Fetch
获取匹配列表
### Request
```javascript
{
page_no: "0", // type<int64>, 页数
page_size: "0", // type<int64>, 每页记录数
params: {
"": ""
}, // map<string,string>, 条件参数,key=val,eg key:category_id=?,vlaue=11
}
```
### Reply
```javascript
{
total: "0", // type<int64>, 总记录数
data: [{
identity: "", // type<string>
nickname: "", // type<string>, 昵称
remark_name: "", // type<string>, 备注名称
popular: 0, // type<int32>, 是否置顶
avatar: "", // type<string>
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
tags: [""], // list<string>, 所属标签组
foreign_status: 0, // type<int32>, 外表的状态值,根据表不同,值的作用不同
}], // list<RelationItem>
}
```
## /relation.Match/Get
获取匹配详情
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
identity: "", // type<string>
nickname: "", // type<string>, 昵称
remark_name: "", // type<string>, 备注名称
popular: 0, // type<int32>, 是否置顶
avatar: "", // type<string>
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
tags: [""], // list<string>, 所属标签组
foreign_status: 0, // type<int32>, 外表的状态值,根据表不同,值的作用不同
}
```
## /relation.Match/DoJoin
执行通过,加为好友
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /relation.Match/DoIgnore
执行忽略
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
data: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```