摘要

本文档的概要说明如下： 本文档介绍 Fx.userGroup 的接口定义、使用方式及相关说明。

1. queryGroupByName 通过名字模糊查询用户组list

Fx.userGroup.queryGroupByName(<string name>, <integer status>)

参数说明

入参格式

参数名称	object	描述	是否必填
name	string	模糊搜索的用户名	是
status	integer	用户组状态 //0:启用 ，1:禁用	是

Groovy 举例

String name ="hb"
int status = 0
def(boolean error, List data, String message) = Fx.userGroup.queryGroupByName(name, status)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

2. queryGroupMembers 通过用户组ID获取用户组下的用户Ids

Fx.userGroup.queryGroupMembers()

Groovy 举例

List groupIdList = ["63bf8075028c7a0001058fc4"]
def(boolean error, Map data, String message) = Fx.userGroup.queryGroupMembers(groupIdList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

负责人：张佳鑫ZhangJiaxin(已停用)

3. insertGroupMem 用户组添加组成员

Fx.userGroup.insertGroupMem()

Groovy 举例

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.insertGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

负责人：张佳鑫ZhangJiaxin(已停用)

4. updateGroupMem 用户组更新组成员

Fx.userGroup.updateGroupMem()

Groovy 举例

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1000","1001","1003","1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.updateGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

负责人：张佳鑫ZhangJiaxin(已停用)

5. deleteGroupMem 用户组删除组成员

Fx.userGroup.deleteGroupMem()

Groovy 举例

String groupId = "63bf8075028c7a0001058fc4"
List userIdsList = ["1004"]
def(boolean error, boolean data, String message) = Fx.userGroup.deleteGroupMem(groupId, userIdsList)
if (error) {
  log.info("error: " + message)
} else {
  log.info(data)
}

负责人：张佳鑫ZhangJiaxin(已停用)

版本记录

版本	日期	变更内容	负责人
v1.0	2026-05-19	初始版本

背景说明

本文档详细描述 Fx.userGroup 的相关接口功能和使用方法，帮助开发者快速集成相关能力。

适用场景

具体适用场景由实际业务需求决定，开发者可根据需要选择相应的接口进行集成。

前置条件

• 已接入纷享销客开放平台
• 已完成应用授权与配置
• 了解相关业务领域基础知识

操作步骤

具体操作步骤请参考各接口的详细说明。

注意事项

• 调用接口前请确保满足前置条件
• 注意接口调用频率限制
• 异常情况请参考错误码说明进行处理

以上代码示例执行后将返回对应接口的调用结果。

兼容性说明：当前版本暂无可用的废弃或兼容性说明。