主要使用场景:第三方应用接入平台后,需要与平台会话保持一致时使用
通过用户编号获取用户隐私信息(支持批量数据,不超过200,建议数据10 - 50)
获取接口访问凭证:accessToken
url | https://gateway.tianyuyun.com/baseInfo/user/privacy/batch?accessToken={{accessToken}} |
请求方式 | post |
是否需要鉴权 | 是 |
请求数限制 | 否 |
接口方向 | 第三方应用->开放平台 |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
user_id |
必选 |
array |
用户编号 | |
2 |
privacy |
必选 |
array |
隐私类型,0:帐号 account 1:手机 phone 2:邮箱 email 3:证件 card_code(身份证) 4:学生学籍号 student_id 5:教师资格证号 teacher_id 6:qq号码 qq 7:地址 address 8:街道 street 9:社区 community |
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
1 |
code |
必选 |
string |
结果编码 | |
2 |
message |
必选 |
string |
结果描述 | |
3 |
result |
必选 |
json |
结果对象 |
请求示例 https://gateway.tianyuyun.com/baseInfo/user/privacy/batch?accessToken={{accessToken}} { "user_id": ["4743b8d8c89911e99d270200f7dc4d78","ca7a27888cb611e9af1e0200f72bb845","6a97e0548c3d11e9884d0200f7b17acf"], "privacy": ["0", "1"] } 返回示例 { "code": "000000", "message": "请求成功", "result": { "4743b8d8c89911e99d270200f7dc4d78": { "0_num": "9f3ac572e4f26d215d5a43d25f1018ed", "1_num": "c1b99b21b775c6c5f425ad02e6c2db3d" }, "6a97e0548c3d11e9884d0200f7b17acf": { "0_num": "c8aabd9411bc5705f101b2ca7096de90", "1_num": "0fca9b7d5ce7576ecdee4f9ebbb5e9ce" }, "ca7a27888cb611e9af1e0200f72bb845": { "0_num": "a987db35ce5b2ea1485665d995d0b7ed", "1_num": "4d1aa8179db806fc7544c1273fef5317" } } }
序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |