主要使用场景:需要获取用户关系时使用,包括好友信息、好友验证和学生家长关联信息
区域平台可以调用验证用户是否为好友接口,验证是否为好友。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/relation/validateFriend?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
personId |
必选 |
Body(json) |
String |
64.0 |
用户id |
2 |
friendId |
必选 |
Body(json) |
String |
64.0 |
好友的用户id |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6.0 |
返回码 |
2 |
retDesc |
必选 |
String |
100.0 |
返回消息说明 |
请求报文: { "personId" : "d3bb9b8dd0fc4b9******", "friendId" : "1e2490ff158040618e******" } 返回报文: { "retCode": "000000", "retDesc":"验证成功" }
学生查看绑定家长、家长查看绑定学生。
获取接口访问凭证:accessToken
url | https://opengate.huijiaoyun.com/baseInfo/relation/getStuParentBindList?accessToken=ACCESS_TOKEN |
请求方式 | post |
格式 | json |
是否需要鉴权 | 是 |
请求数限制 | 是 |
接口方向 | 第三方应用>开放平台 |
序号 | 字段名 | 约束 | 位置 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|---|
1 |
personId |
必选 |
Body(json) |
String |
64.0 |
用户Id:如果传递的是学生Id,返回的是家长的信息;如果传递的是家长Id,返回的是学生的信息 |
2 |
start |
可选 |
Body(json) |
String |
8.0 |
获取开始位置 |
3 |
end |
可选 |
Body(json) |
String |
8.0 |
获取结束位置 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
retCode |
必选 |
String |
6.0 |
结果000000:绑定成功 |
2 |
retDesc |
可选 |
String |
100.0 |
结果描述 |
3 |
start |
必选 |
Integer |
8.0 |
获取开始位置 |
4 |
end |
必选 |
Integer |
8.0 |
获取结束位置 |
5 |
count |
必选 |
Integer |
8.0 |
总记录条数 |
6 |
userList |
可选 |
Json对象 |
- |
用户信息列表 |
6.1 |
personId |
可选 |
String |
32.0 |
用户id |
6.2 |
name |
可选 |
String |
20.0 |
姓名 |
6.3 |
gender |
可选 |
String |
1.0 |
性别 |
请求报文: { "personId":"0037edfa22b64b02b3b21d3e10593ebe", "start":"0", "end":"5" } 应答报文: { "retCode": "000000", "retDesc": "success", "count": 2, "start": 0, "userList": [ { "gender": "1", "name": "鲁泽伟的爸爸", "personId": "88e5b666747346218da6b0017196cac2" }, { "gender": "0", "name": "鲁泽伟的妈妈", "personId": "d32502bf670e4337bde02e65bcd44cb2" } ], "end": 5 }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:text |
1.1 |
text |
必选 |
Json |
- |
text消息体 |
1.1.1 |
content |
必选 |
String |
消息内容 |
{ "msgtype": "text", "text": { "content": "zhxy msg text test 12" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:link |
2 |
link |
必选 |
Json |
- |
link消息体 |
2.1 |
pcUrl |
必选 |
String |
PC端消息点击链接地址 |
|
2.2 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
2.3 |
title |
必选 |
String |
消息标题 |
|
2.4 |
busiId |
必选 |
String |
对应业务的id |
|
2.5 |
content |
必选 |
String |
消息描述 |
|
2.6 |
picUrl |
必选 |
String |
图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图640*320,小图80*80。如不填,在客户端不显示图片 |
{ "msgtype": "link", "link": { "pcUrl": "http://www.baidu.com", "appUrl": "http://www.baidu.com", "picUrl": "http://xxx.yyy.com/zzz.jpg", "content": "百度一下", "title": "百度", "busiId":"AQWER1234" } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
msgType |
必选 |
String |
10 |
消息类型,此时固定为:oa |
2 |
busiId |
必选 |
String |
- |
该条oa消息在业务系统对应的id |
3 |
pcUrl |
必选 |
String |
消息点击链接地址 |
|
4 |
appUrl |
必选 |
String |
移动客户端点击消息时跳转到的H5地址 |
|
5 |
oa |
必选 |
Json |
- |
oa类型消息体 |
5.1 |
head |
必选 |
Json |
255 |
消息头部Json |
5.1.1 |
text |
必选 |
String |
255 |
消息的头部标题 |
5.1.2 |
bgColor |
可选 |
String |
消息头部的背景颜色。长度限制为8个英文字符,其中前2为表示透明度,后6位表示颜色值。不要添加0x。默认值:FFCC0000 |
|
5.2 |
body |
可选 |
Json |
消息体 |
|
5.2.1 |
title |
可选 |
String |
消息体的标题 |
|
5.2.2 |
content |
可选 |
String |
消息体的正文 |
|
5.2.3 |
imageUrl |
可选 |
String |
消息体中的图片url |
|
5.2.4 |
fileCount |
可选 |
String |
自定义的附件数目。此数字仅供显示,不作验证 |
|
5.2.5 |
author |
可选 |
String |
自定义的作者名字 |
|
5.2.6 |
form |
可选 |
Json数组 |
消息体的表单,最多6个 |
|
5.2.7 |
key |
可选 |
String |
消息体的关键字 |
|
5.2.8 |
value |
可选 |
String |
消息体的关键字对应的值 |