主要使用场景：组织机构接口7.0
根据各种条件查询机构、学校等组织
获取接口访问凭证：accessToken
| url | https://gateway.tianyuyun.com/user/openapi/org/query-org?accessToken=ACCESS_TOKEN |
| 请求方式 | post |
| 是否需要鉴权 | 是 |
| 请求数限制 | 否 |
| 接口方向 | 第三方应用->开放平台 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
org_id |
可选 |
String |
机构、学校等组织id | |
2 |
org_name |
可选 |
String |
机构、学校等组织名称 | |
3 |
org_type |
可选 |
String |
组织类型，多个使用英文逗号分隔(1机构，2学校，8企业，9教学工作室，10平台) | |
4 |
province_code |
可选 |
String |
所属地理省份 | |
5 |
city_code |
可选 |
String |
所属地理市 | |
6 |
area_code |
可选 |
String |
所属地理区 | |
7 |
status |
可选 |
String |
状态,多个使用英文逗号分隔(0:组织未激活,1:正常,2注销)默认不限 | |
8 |
platform_code |
可选 |
String |
实体平台编码 | |
9 |
v_platform_code |
可选 |
String |
虚拟平台编码 | |
10 |
certification |
可选 |
String |
认证(0:未认证,1:已认证) | |
11 |
org_category |
可选 |
String |
组织的类别(每个类型的组织都有自己的小类别) | |
12 |
org_level_code |
可选 |
String |
行政区划(行政上所属的区域) | |
13 |
org_parent_id |
可选 |
String |
上级机构id(查的是直属下级单位) | |
14 |
org_parent_ids |
可选 |
String |
附属上级机构id(查的是所有的下级单位，包括跨行政级别的下级单位组织) | |
15 |
flag |
可选 |
String |
标记,多个使用英文逗号分隔,默认正常和演示(0:正常,1:演示,2:测试) | |
16 |
org_record_status |
可选 |
String |
教育局备案状态,0:未备案，1：已备案 | |
17 |
page |
可选 |
Int |
查询页 | |
18 |
page_size |
可选 |
Int |
查询条数，默认10，上限100 | |
19 |
sort |
可选 |
string |
默认为空，传time : 创建时间倒序 |
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
1 |
code |
必选 |
string |
结果编码,000000：成功, 100001：失败 | |
2 |
message |
必选 |
string |
结果描述 | |
3 |
result |
必选 |
json[] |
json数组 | |
3.1 |
page |
必选 |
int |
当前页 | |
3.2 |
page_size |
必选 |
int |
查询量 | |
3.3 |
count |
必选 |
int |
总数 | |
3.4 |
lists |
必选 |
array |
数组对象 | |
3.4.1 |
org_id |
必选 |
string |
组织id | |
3.4.2 |
org_name |
必选 |
string |
组织名称 | |
3.4.3 |
org_type |
必选 |
string |
组织类型 |
请求示例
https://gateway.tianyuyun.com/user/openapi/org/query-org?accessToken=ACCESS_TOKEN
{
"org_name" : "小学",
"org_type":"2",
"org_category":"0"
}
返回示例
{
"code": "000000",
"message": "成功",
"result": {
"page": 1,
"page_size": 10,
"count": 2,
"lists": [
{
"org_id": "dde57a52919d11e9b8620200f766f6f0",
"org_name": "武汉市电教中心",
"org_type": 1
},
{
"org_id": "34e6b70e8c4311e9bc3b0200f70dd853",
"org_name": "武汉市教育局",
"org_type": 1
}
]
}
}
| 序号 | 字段名 | 约束 | 类型 | 长度 | 说明 |
|---|---|---|---|---|---|
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 |
消息体的关键字对应的值 |
鄂公网安备 42018502000485号