上下游企业分组管理

最后更新:2026/08/18

企业可通过本组接口查询、创建、修改、删除上下游企业分组,并对下游企业进行加入分组、移出分组、调整分组归属和查询所有分组归属等操作。

使用说明

  1. 本组接口只操作当前 access_token 对应的上游企业数据,请求体中不需要传入上游企业 tenant_id
  2. 分组查询返回分组主数据,包含分组层级、路径和是否有子分组等字段。
  3. 企业查询和企业归属查询返回企业分组归属数据,包含主分组、多分组和分组路径等字段。
  4. 特殊分组 ID 说明:
    • 0:默认分组。企业查询、企业调整的来源分组和目标分组允许使用。
    • 1:根节点。创建一级分组时 parent_id 可使用;企业归组操作不允许使用。
    • 大于 1:业务分组。

查询企业分组列表

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/group/list?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "search_name": "华东",
  "parent_id": 1
}
参数 类型 必填 说明
search_name string 分组名称搜索关键字
parent_id long 父分组 ID。为空时查询全部分组数据;传入时查询该节点下的分组数据

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": [
    {
      "id": 2089299227464173890,
      "tenant_id": "wpDkH9EAAAiUqMy8eay_nTYyUJn420pQ",
      "ws_tenant_id": 10001,
      "parent_id": 1,
      "group_name": "华东区",
      "group_order": 1,
      "level": 1,
      "path_group_ids": [2089299227464173890],
      "path_group_names": ["华东区"],
      "has_children": true,
      "child_count": 2,
      "corp_count": 10,
      "version": 1,
      "gmt_create": 1787043600,
      "gmt_modified": 1787043600
    }
  ]
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data object[] 分组列表
  id long 分组 ID
  tenant_id string 上游企业租户 ID
  ws_tenant_id long 微盛租户 ID
  parent_id long 父分组 ID
  group_name string 分组名称
  group_order long 分组排序值
  level int 分组层级,一级分组为 1
  path_group_ids long[] 从一级分组到当前分组的 ID 路径
  path_group_names string[] 从一级分组到当前分组的名称路径
  has_children bool 是否存在子分组
  child_count long 直接子分组数量
  corp_count long 当前分组下企业数量
  version int 数据版本号
  gmt_create long 创建时间,秒级时间戳
  gmt_modified long 修改时间,秒级时间戳

创建企业分组

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/group/create?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "group_name": "华东一区",
  "parent_id": 1
}
参数 类型 必填 说明
group_name string 分组名称
parent_id long 父分组 ID。创建一级分组时传 1;不允许传默认分组 0

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": 2089299227464173890
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data long 新创建的分组 ID

修改企业分组名称

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/group/update?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "group_id": 2089299227464173890,
  "group_name": "华东一区"
}
参数 类型 必填 说明
group_id long 分组 ID。只允许传大于 1 的业务分组 ID
group_name string 修改后的分组名称

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": true
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data bool 是否修改成功

删除企业分组

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/group/delete?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "group_id": 2089299227464173890
}
参数 类型 必填 说明
group_id long 分组 ID。只允许传大于 1 的业务分组 ID

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": true
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data bool 是否删除成功

查询分组下的下游企业列表

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/relation/cursor?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "search_key": "示例企业",
  "group_id": 2089299227464173890,
  "group_ids": [2089299227464173890],
  "cursor": "0",
  "page_size": 20,
  "soft": 1
}
参数 类型 必填 说明
search_key string 企业名称或搜索关键字
group_id long 分组 ID。传 0 查询默认分组企业;传业务分组 ID 查询该分组下企业
group_ids long[] 多分组过滤 ID 集合
cursor string 游标。首次查询可不传,后续查询传上次返回的 next_cursor
page_size int 每页数量,默认 20
soft int 排序方向,沿用系统内部排序语义

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "next_cursor": "99",
    "page_size": 20,
    "records": [
      {
        "relation_tenant_id": "wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW",
        "relation_corp_name": "示例下游企业",
        "gmt_create": "2026-08-18 10:00:00",
        "gmt_modified": "2026-08-18 11:00:00",
        "group_id": 2089299227464173890,
        "primary_group_id": 2089299227464173890,
        "group_ids": [2089299227464173890],
        "group_names": ["华东一区"],
        "group_paths": [
          {
            "group_id": 2089299227464173890,
            "group_name": "华东一区",
            "path_group_ids": [2089299227464173890],
            "path_group_names": ["华东一区"]
          }
        ]
      }
    ]
  }
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data object 游标分页结果
  next_cursor string 下一页游标;无更多数据时可能为空
  page_size int 每页数量
  records object[] 下游企业列表
    relation_tenant_id string 下游企业租户 ID
    relation_corp_name string 下游企业名称
    gmt_create string 关系创建时间
    gmt_modified string 关系修改时间
    group_id long 兼容字段,企业当前分组 ID
    primary_group_id long 主业务分组 ID
    group_ids long[] 企业所属业务分组 ID 集合
    group_names string[] 企业所属业务分组名称集合
    group_paths object[] 企业所属业务分组路径集合
      group_id long 分组 ID
      group_name string 分组名称
      path_group_ids long[] 从一级分组到当前分组的 ID 路径
      path_group_names string[] 从一级分组到当前分组的名称路径

企业加入指定分组

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/relation/groups/add?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "relation_tenant_ids": ["wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW"],
  "group_ids": [2089299227464173890],
  "primary_group_id": 2089299227464173890
}
参数 类型 必填 说明
relation_tenant_ids string[] 下游企业租户 ID 列表,单次最多 10 个
group_ids long[] 要加入的业务分组 ID 列表,单个企业最多支持 5 个业务分组;只允许传大于 1 的业务分组 ID
primary_group_id long 主业务分组 ID;传入时必须是大于 1 的业务分组 ID

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": true
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data bool 是否加入成功

企业从指定分组移出

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/relation/groups/unrelate?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "relation_tenant_ids": ["wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW"],
  "group_id": 2089299227464173890
}
参数 类型 必填 说明
relation_tenant_ids string[] 下游企业租户 ID 列表
group_id long 待移出的业务分组 ID。只允许传大于 1 的业务分组 ID

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "success_relation_tenant_ids": ["wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW"],
    "noop_relation_tenant_ids": []
  }
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data object 移出结果
  success_relation_tenant_ids string[] 成功移出的下游企业租户 ID 集合
  noop_relation_tenant_ids string[] 无需处理的下游企业租户 ID 集合,例如企业不在该分组下

调整企业分组归属

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/relation/groups/move?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "relation_tenant_ids": ["wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW"],
  "source_group_id": 0,
  "target_group_id": 2089299227464173890
}
参数 类型 必填 说明
relation_tenant_ids string[] 下游企业租户 ID 列表,单次最多 10 个
source_group_id long 来源分组 ID。允许传默认分组 0 或大于 1 的业务分组 ID,不允许传根节点 1
target_group_id long 目标分组 ID。允许传默认分组 0 或大于 1 的业务分组 ID,不允许传根节点 1

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "success_relation_tenant_ids": ["wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW"],
    "noop_relation_tenant_ids": []
  }
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data object 调整结果
  success_relation_tenant_ids string[] 成功调整的下游企业租户 ID 集合
  noop_relation_tenant_ids string[] 无需处理的下游企业租户 ID 集合,例如企业不属于来源分组

查询企业所有分组归属

请求方式: POST(HTTPS)

请求地址: https://open.wshoto.com/openapi/tenant/appshare/relation/groups/query?access_token=x

Query参数:

参数 类型 必填 说明
access_token string 调用接口凭证

Body参数:

{
  "relation_tenant_ids": [
    "wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW",
    "wpDkH9EAAARjY-2kJluRJl7tLDZ_DRMW"
  ]
}
参数 类型 必填 说明
relation_tenant_ids string[] 下游企业租户 ID 列表

返回值:

{
  "code": 0,
  "msg": "请求成功",
  "data": {
    "wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW": {
      "relation_tenant_id": "wpDkH9EAAARjY-1kJluRJl7tLDZ_DRMW",
      "relation_corp_name": "示例下游企业",
      "gmt_create": "2026-08-18 10:00:00",
      "gmt_modified": null,
      "group_id": 2089299227464173890,
      "primary_group_id": 2089299227464173890,
      "group_ids": [2089299227464173890],
      "group_names": ["华东一区"],
      "group_paths": [
        {
          "group_id": 2089299227464173890,
          "group_name": "华东一区",
          "path_group_ids": [2089299227464173890],
          "path_group_names": ["华东一区"]
        }
      ]
    }
  }
}

返回说明:

参数 类型 说明
code int 出错返回码,为 0 表示成功,非 0 表示调用失败
msg string 返回码描述
data object 企业分组归属映射,key 为下游企业租户 ID,value 为分组归属详情
  relation_tenant_id string 下游企业租户 ID
  relation_corp_name string 下游企业名称
  gmt_create string 关系创建时间
  gmt_modified string 关系修改时间,可能为空
  group_id long 兼容字段,企业当前分组 ID
  primary_group_id long 主业务分组 ID
  group_ids long[] 企业所属业务分组 ID 集合
  group_names string[] 企业所属业务分组名称集合
  group_paths object[] 企业所属业务分组路径集合
    group_id long 分组 ID
    group_name string 分组名称
    path_group_ids long[] 从一级分组到当前分组的 ID 路径
    path_group_names string[] 从一级分组到当前分组的名称路径

results matching ""

    No results matching ""