查询上级单位列表

使用场景： 查询上级单位列表

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
应用凭证 支持 -
用户凭证 支持 租户管理员角色 + 机构管理员角色
机构凭证 不支持 -

请求方式：[GET] (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/corp/office/list_by_suite?access_token=ACCESS_TOKEN

请求示例： https://test-oapi.epaas.qq.com/corp/office/list_by_suite?access_token=USERTOKEN&is_name_fuzzy=true&name=test&page_index=1&page_size=30

参数说明：

参数 类型 必须 说明
access_token string 是 调用接口凭证
name string 否 机构名称
is_name_fuzzy bool 否 是否名称模糊搜索
level int 否 级别
province_id int 否 省
city_id int 否 市
area_id int 否 区/县
page_index int 否 第几页，默认:1
page_size int 否 每页数量,默认:10

返回结果：

{
    "errmsg": "ok",
    "errcode": 0,
    "page_info": {
        "total": 1,
        "page_index": 1,
        "page_size": 30
    },
    "data_list": [
        {
            "corpid": 100001,
            "name": "测试教育局",
            "level": "省/市辖区",
            "org_level": 2,
            "qywx_corpid": "",
            "address": {
                "location": "",
                "country_id": 0,
                "province_id": 6,
                "province_name": "福建省",
                "city_id": 602,
                "city_name": "厦门市",
                "area_id": 60204,
                "area_name": "同安区",
                "detail_address": "",
                "province_code": 123, 
                "city_code": 123, 
                "area_code": 123
            }
        }
    ],
    "total": 1
}

参数说明：

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
total 总数
data_list.corpid 机构ID
data_list.name 机构名称
data_list.level 级别
data_list.qywx_corpid 企微corpid
data_list.address.country_id 国家ID
data_list.address.province_id 省份ID
data_list.address.province_name 省份名字
data_list.address.city_id 城市ID
data_list.address.city_name 城市名字
data_list.address.area_id 区/县ID
data_list.address.area_name 地区名字
data_list.address.detail_address 机构详细地址
data_list.address.province_code 省份行政区代码，参数值通过接口《批量查询地区详情》 查询
data_list.address.city_code 市行政区代码，参数值通过接口《批量查询地区详情》 查询
data_list.address.area_code 区县行政区代码，参数值通过接口《批量查询地区详情》 查询

查询行政单位详情

使用场景： 根据ID查询行政单位详细信息

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 教育局或租户票据，必须是管理员角色
机构凭证 支持 仅查询本机构

请求方式：[GET, POST] (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/get?access_token=ACCESS_TOKEN

{
  "corpid": 1,
  "extend_fields": [
    "FieldA",
    "FieldB"
  ]
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
corpid 否 机构ID，机构管理员或者机构票据请求时从票据信息中取机构
extend_fields 否 应用托管资料字段

返回结果：

{
  "address": {
    "province_id": 10,
    "province_name": "湖南省",
    "city_id": 10,
    "city_name": "长沙市",
    "area_id": 10,
    "area_name": "岳麓区",
    "detail_address": "",
    "province_code": 123, 
    "city_code": 123, 
    "area_code": 123
  },
  "corpid": 2,
  "name": "腾讯",
  "full_name": "腾讯教育局全称",
  "code": "xxxx",
  "level": 1,
  "creator_info": {
    "name": "腾讯",
    "mobile": "18692234433"
  },
  "qywx_corpid": "xxxxxxxxxx",
  "use_type": 1,
  "manage_style": 10,
  "start_date": "2018-01-01",
  "extend_profile": "{\"FieldA\": 01,\"FieldB\": 02}",
  "logo":""
}

参数说明：

参数 说明
corpid 机构id
name 名字
full_name 行政单位全称
code 机构编码
address.province_id 省份ID
address.province_name 省份名字
address.city_id 城市ID
address.city_name 城市名字
address.area_id 区/县ID
address.area_name 地区名字
address.detail_address 详细地址
address.province_code 省份行政区代码，参数值通过接口《批量查询地区详情》 查询
address.city_code 市行政区代码，参数值通过接口《批量查询地区详情》 查询
address.area_code 区县行政区代码，参数值通过接口《批量查询地区详情》 查询
level 机构级别 1 国家 2 省/市辖区 3 地市级 4 区/县
creator_info.name 创建人姓名
creator_info.mobile 创建人联系电话
qywx_corpid 企业微信ID
use_type 使用类型 1 正式，2 试用，3测试
manage_style 数据管理方式 100 新双向同步，110 1:N根节点，111 1:N子节点
start_date 开始使用日期
extend_profile 应用托管资料
logo logo

批量查询行政单位详情

使用场景： 根据ID列表批量查询行政单位详细信息

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 教育局或租户票据，必须是管理员角色
机构凭证 未支持 -

请求方式：[POST] (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/batch_get?access_token=ACCESS_TOKEN

{
  "corpids": [1,2]
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
corpids 是 机构ID列表

返回结果：

{
    "errmsg": "ok",
    "errcode": 0,
    "data_list": [
        {
            "corpid": 1071141,
            "name": "机构jimmy测试菜单1",
            "code": "123465kljk",
            "level": 1,
            "start_date": "2021-06-29",
            "use_type": 1,
            "address": {
                "country_id": 312829,
                "province_id": 1,
                "province_name": "北京市",
                "city_id": 3118,
                "city_name": "北京市",
                "area_id": 102,
                "area_name": "西城区",
                "detail_address": "梅溪湖",
                "province_code": 123, 
                "city_code": 123, 
                "area_code": 123
            },
            "manage_style": 1,
            "qywx_corpid": "",
            "creator_info": {
                "name": "易坚",
                "mobile": "17311112222"
            },
            "extend_profile": "",
            "corp_inner_secret": "",
            "inner_sync_mode": 2,
            "inner_sync_type": 1,
            "encrypt_type": 0,
            "full_name": "",
            "logo":""
        }
    ]
}

参数说明：

参数 说明
data_list 数据列表
corpid 机构id
name 名字
full_name 行政单位全称
code 机构编码
level 机构级别 1 国家 2 省/市辖区 3 地市级 4 区/县
start_date 开始使用日期
use_type 使用类型 1 正式，2 试用，3测试
address.province_id 省份ID
address.province_name 省份名字
address.city_id 城市ID
address.city_name 城市名字
address.area_id 区/县ID
address.area_name 地区名字
address.detail_address 详细地址
address.province_code 省份行政区代码，参数值通过接口《批量查询地区详情》 查询
address.city_code 市行政区代码，参数值通过接口《批量查询地区详情》 查询
address.area_code 区县行政区代码，参数值通过接口《批量查询地区详情》 查询
manage_style 数据管理方式 100 新双向同步，110 1:N根节点，111 1:N子节点
qywx_corpid 企业微信ID
creator_info.name 创建人姓名
creator_info.mobile 创建人联系电话
extend_profile 应用托管资料
corp_inner_secret 内部通讯录获取token的秘钥
inner_sync_mode 内部通讯录同步模式 1 Corpid + CorpInnerSecret, 2 内部通讯录（默认2）
inner_sync_type 内部通讯录的同步类型 0不同步 1双向 2正向 3反向
encrypt_type 加密方式 1 明文 2 密文
logo logo

扩展资料检索行政单位

使用场景： 扩展资料检索行政单位列表

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 仅租户管理员
机构凭证 未支持 -

请求方式：[POST] (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/profile/search?access_token=ACCESS_TOKEN

请求包体：

{
  "search_keys": [
    {
      "key": "search_key1",
      "value": "xxxxxx"
    }
  ],
  "page_index": 1,
  "page_size": 10
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
search_keys 是 搜索关键字列表
search_keys.key 是 关键字名
search_keys.value 是 搜索值
page_index 是 分页参数、页数
page_size 是 分页参数、单页大小

返回结果：

{
  "errmsg": "ok",
  "errcode": 0,
  "data_list": [
    {
      "corpid": "111",
      "name": "机构名"
    }
  ],
  "total": 1
}

参数说明：

参数 说明
data_list 行政单位列表
data_list.corpid 机构ID
data_list.name 机构名字
total 结果总数

创建行政单位

使用场景： 创建行政单位

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 仅租户管理员
机构凭证 未支持 -

请求方式：POST (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/create?access_token=ACCESS_TOKEN

{
  "errcode": 0,
  "errmsg": "ok",
  "address": {
    "country_id": 312829,
    "province_id": 1,
    "city_id": 3118,
    "area_id": 311413,
    "detail_address": "湖南省长沙市岳麓区梅西湖路"
  },
  "name": "腾讯",
  "full_name": "腾讯教育局全称",
  "code": "xxxx",
  "level": 1,
  "creator_info": {
    "name": "腾讯",
    "mobile": "18692234433"
  },
  "qywx_corpid": "xxxxxxxxxx",
  "use_type": 1,
  "manage_style": 10,
  "extend_profile": "{\"FieldA\": 1,\"FieldB\": 2}"
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
name 是 行政单位名字
full_name 否 行政单位全称
code 是 机构编码
creator_info.name 是 创建人姓名
creator_info.mobile 是 创建人联系电话
address.country_id 是 国家ID
address.province_id 是 省份ID
address.city_id 是 城市ID
address.area_id 是 区/县ID
address.detail_address 是 机构详细地址
level 否 机构级别 1 国家 2 省/市辖区 3 地市级 4 区/县；默认区/县
qywx_corpid 否 企业微信ID，不传为简洁版
use_type 否 使用类型 1 正式，2 试用，3测试；默认正式
manage_style 否 数据管理方式 100 新双向同步，110 1:N根节点，111 1:N子节点；默认双向同步
extend_profile 否 应用托管资料

备注：省、市、区等创建后，暂不支持修改，创建时，请谨慎选择

返回结果：

{
  "corpid": 1
}

参数说明：

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
corpid 成功创建的行政单位ID

更新行政单位

使用场景： 更新行政单位信息

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 仅租户管理员
机构凭证 未支持 -

请求方式：POST (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/update?access_token=ACCESS_TOKEN

{
  "corpid": 1,
  "name": "腾讯",
  "full_name": "腾讯教育局全称",
  "code": "xxxx",
  "creator_info": {
    "name": "腾讯",
    "mobile": "18692234433"
  },
  "detail_address": "湖南省长沙市岳麓区梅西湖路",
  "use_type": 1,
  "extend_profile": "{\"FieldA\": 01,\"FieldB\": 02}"
}

参数说明：

参数 必须 说明
access_token 是 调用接口凭证
corpid 是 机构ID
name 否 行政单位名称
full_name 否 行政单位全称
code 否 机构编码
detail_address 否 机构详细地址
creator_info.name 否 联系人名字
creator_info.mobile 否 创建人联系电话
use_type 否 使用类型 1 正式，2 试用，3测试
extend_profile 否 应用托管资料

备注：省、市、区等创建后，暂不支持修改

返回结果：

{
  "errmsg": "ok",
  "errcode": 0
}

参数说明：

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容

删除行政单位（暂不支持）

使用场景： 删除行政单位

权限说明

权限项 说明 备注
应用是否需要申请白名单 需要
用户凭证 支持 仅租户管理员
机构凭证 未支持 -

请求方式：POST (HTTPS）

请求地址：https://test-oapi.epaas.qq.com/office/delete?access_token=ACCESS_TOKEN

请求包体：

{
  "corpid": 3
}

参数说明：

参数 必须 说明
access_token 是 用户调用接口凭证
corpid 否 机构ID

返回结果：

{
  "errcode": 0,
  "errmsg": ""
}

参数说明：

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
© 1998 - 2021 Tencent Inc. All Rights Reserved all right reserved，powered by ePaaS.更新时间： 2024-08-22 10:14:39

results matching ""

    No results matching ""

    results matching ""

      No results matching ""