MCP Python API 接口文档 - 通讯录体系

• 1. 成员
  • 1.1 获取成员详细信息
  • 1.2 成员列表
  • 1.3 修改成员信息
  • 1.4 修改成员属性信息
  • 1.5 修改成员职位
  • 1.6 员工离职
  • 1.7 员工离职恢复
  • 1.8 删除成员
  • 1.9 指定部门下添加一位成员
  • 1.10 成员转外部联系人
• 2. 部门
  • 2.1 创建部门
  • 2.2 修改部门名称
  • 2.3 修改父级部门
  • 2.4 查询指定部门下的所有子部门信息
  • 2.5 查询部门信息
  • 2.6 删除部门
  • 2.7 获取部门成员
  • 2.8 获取职位列表
• 3. 职位
  • 3.1 获取职位列表
  • 3.2 添加职位
  • 3.3 修改职位
  • 3.4 删除职位
• 4. 角色
  • 4.1 新建角色或角色组
  • 4.2 修改角色或角色组
  • 4.3 获取角色或角色组
  • 4.4 获取角色或角色组列表
  • 4.5 删除角色或角色组
  • 4.6 获取角色成员列表
  • 4.7 批量创建角色
  • 4.8 批量创建角色组
  • 4.9 批量删除角色或角色组
  • 4.10 角色组添加成员
  • 4.11 删除角色成员
• 5. 外部联系人分组
  • 5.1 获取外部联系人分组列表
  • 5.2 获取外部联系人分组成员列表
  • 5.3 获取外部联系人分组信息
  • 5.4 新建外部联系人分组
  • 5.5 修改外部联系人分组名称
  • 5.6 删除外部联系人分组
  • 5.7 批量删除外部联系人分组
  • 5.8 批量新增外部联系人分组
• 6. 外部联系人管理
  • 6.1 获取外部联系人成员信息
  • 6.2 修改外部联系人成员信息
  • 6.3 外部联系人删除
  • 6.4 外部联系人成员删除恢复
  • 6.5 外部联系人转成员
• 7. 互联组织
  • 7.1 列出我连接的企业
  • 7.2 查询互联企业角色列表
  • 7.3 查询互联企业对接部门列表
  • 7.4 查询互联企业对接部门的成员
  • 7.5 列出我连接的企业的对接人
  • 7.6 获取我连接的企业对接人的详细信息
• 8. 管理组
  • 8.1 新建管理组
  • 8.2 查询管理组列表
  • 8.3 查询管理组详情
  • 8.4 删除管理组
  • 8.5 修改普通管理组详情
  • 8.6 修改系统管理组管理员

1. 成员

1.1 获取成员详细信息

python调用方法名: bmcp.user_info

入参结构:

字段名	字段类型	是否必填	说明
user_id	string	是	需要查询的成员字符串id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	成功或失败详情
user	Object
user.user_id	string	成员字符串id
user.name	string	名称
user.account	string	账号
user.country_code	string	手机区号
user.mobile	string	手机号
user.email	string	邮箱
user.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
user.frozen	string	成员是否被禁用（0表示启用，1表示禁用
user.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
user.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
user.uniqueid	string	企业内用户ID
user.remark	string	成员的备注信息
user.title	string	成员的职位
user.departments	string Array	所属部门id
user.job_title	Object Array
job_title.dept_id	string	部门id
job_title.job_title	string	职位
user.roles	string array	所属角色组id

入参和响应示例:

入参示例：

{
  "user_id": "6663f034699af3458734f91c"
}

响应示例：

{
  "user": {
    "user_id": "6663f034699af3458734f91c",
    "name": "测试",
    "account": "user_wlsbap89940",
    "country_code": "86",
    "mobile": "18911111112",
    "email": "123456@qq.com",
    "category": "2",
    "frozen": "0",
    "mobilestatus": "0",
    "emailstatus": "0",
    "uniqueid": "CeShi",
    "remark": "",
    "title": "主管",
    "departments": [
      "51d1177b964603db9e60a962"
    ],
    "job_title": [
      {
        "dept_id": "51d1177b964603db9e60a962",
        "job_title": "组长"
      }
    ],
    "roles": [
      "525fb26fdcb1d02adda3dc6d",
      "5ee8f9e0706af569e58b1cfa"
    ]
  }
}

Python插件开发代码示例:

import bmcp

def user_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "6663f034699af3458734f91c"
    result = bmcp.user_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.2 成员列表

python调用方法名: bmcp.user_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
users	Object Array
users.user_id	string	成员字符串id
users.name	string	名称
users.account	string	账号
users.country_code	string	手机区号
users.mobile	string	手机号
users.email	string	邮箱
users.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
users.frozen	string	成员是否被禁用（0表示启用，1表示禁用
users.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
users.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
users.uniqueid	string	企业内用户ID
users.remark	string	成员的备注信息
users.title	string	成员的职位
users.departments	string Array	所属部门id
users.job_title	Object Array
job_title.dept_id	string	部门id
job_title.job_title	string	职位
users.roles	string array	所属角色组id

入参和响应示例:

入参示例：

{}

响应示例：

{
  "users": [
    {
      "user_id": "6663f034699af3458734f91c",
      "name": "测试",
      "account": "user_wlsbap89940",
      "country_code": "86",
      "mobile": "18911111112",
      "email": "123456@qq.com",
      "category": "2",
      "frozen": "0",
      "mobilestatus": "0",
      "emailstatus": "0",
      "uniqueid": "CeShi",
      "remark": "",
      "title": "主管",
      "departments": [
        "51d1177b964603db9e60a962"
      ],
      "job_title": [
        {
          "dept_id": "51d1177b964603db9e60a962",
          "job_title": "组长"
        }
      ],
      "roles": [
        "525fb26fdcb1d02adda3dc6d",
        "5ee8f9e0706af569e58b1cfa"
      ]
    }
  ]
}

Python插件开发代码示例:

import bmcp

def user_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.user_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.3 修改成员信息

python调用方法名: bmcp.user_update

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员字符串id
name	string	否	名称
remark	string	否	备注
uniqueid	string	否	企业内用户ID
departments	string array	否	要修改的部门id
job_title	Object string	否	要修改的职位信息
job_title.dept_id	string	否	部门id
job_title.job_title	string	否	职位
roles	string array	否	要修改的角色id列表
frozen	string	否	启用/禁用, 0表示启用，1表示禁用

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string
user	Object
user.user_id	string	成员字符串id
user.name	string	名称
user.account	string	账号
user.country_code	string	手机区号
user.mobile	string	手机号
user.email	string	邮箱
user.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
user.frozen	string	成员是否被禁用（0表示启用，1表示禁用
user.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
user.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
user.uniqueid	string	企业内用户ID
user.remark	string	成员的备注信息
user.title	string	成员的职位
user.departments	string Array	所属部门id
user.job_title	Object Array
job_title.dept_id	string	部门id
job_title.job_title	string	职位
user.roles	string array	所属角色组id

入参和响应示例:

入参示例：

{
  "user_id": "5b97538e651451aef9317653",
  "name": "test001"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "user": {
    "account": "user_r6ccx216631",
    "category": "-1",
    "country_code": "86",
    "departments": [
      "8e4e47d5aa8448f5ee293ce8"
    ],
    "email": "test001@163.com",
    "emailstatus": "0",
    "frozen": "",
    "job_title": [],
    "mobile": "13312332144",
    "mobilestatus": "0",
    "name": "test001",
    "remark": "",
    "roles": [],
    "title": "",
    "uniqueid": "007378865",
    "user_id": "5b97538e651451aef9317653"
  }
}

Python插件开发代码示例:

import bmcp

def user_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "5b97538e651451aef9317653"
    params["name"] = "test001"
    result = bmcp.user_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.4 修改成员属性信息

python调用方法名: bmcp.user_update_info

修改成员详细信息，仅支持企业微信团队的手机号、邮箱

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员字符串id
mobile	string	否	手机号码
email	string	否	邮箱

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情

入参和响应示例:

入参示例：

{
  "user_id": "4e0f43b5b602aca69a14c789",
  "email": "1234567890@qq.com"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def user_update_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "4e0f43b5b602aca69a14c789"
    params["email"] = "1234567890@qq.com"
    result = bmcp.user_update_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.5 修改成员职位

python调用方法名: bmcp.user_update_job_title

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	表单id
job_title	Object Array	是	数据id
job_title.dept_id	string	是	部门字符串id
job_title.job_title	strijng	是	职称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果
user	Object
user.user_id	string	成员字符串id
user.name	string	名称
user.account	string	账号
user.country_code	string	手机区号
user.mobile	string	手机号
user.email	string	邮箱
user.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
user.frozen	string	成员是否被禁用（0表示启用，1表示禁用
user.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
user.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
user.uniqueid	string	企业内用户ID
user.remark	string	成员的备注信息
user.title	string	成员的职位
user.departments	string Array	所属部门id
user.job_title	Object Array
job_title.dept_id	string	部门id
job_title.job_title	string	职位
user.roles	string array	所属角色组id

入参和响应示例:

入参示例：

{
  "user_id": "7067493898b407dec4a5a754",
  "job_title": [
    {
      "dept_id": "550606b07bcc60d41cd9b2de",
      "job_title": "AAAA12"
    }
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "user": {
    "account": "user_oprocg824711",
    "category": "2",
    "country_code": "86",
    "departments": [
      "550606b07bcc60d41cd9b2de"
    ],
    "email": "i811nobyq@tempmail.cn",
    "emailstatus": "1",
    "frozen": "",
    "job_title": [
      {
        "deptId": "550606b07bcc60d41cd9b2de",
        "jobTitle": "AAAA12"
      }
    ],
    "mobile": "",
    "mobilestatus": "0",
    "name": "测试外部联系人11111",
    "remark": "",
    "roles": [],
    "title": "",
    "uniqueid": "023772748",
    "user_id": "7067493898b407dec4a5a754"
  }
}

Python插件开发代码示例:

import bmcp

def user_update_job_title(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "7067493898b407dec4a5a754"
    params["job_title"] = [{"dept_id": "550606b07bcc60d41cd9b2de", "job_title": "AAAA12"}]
    result = bmcp.user_update_job_title(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.6 员工离职

python调用方法名: bmcp.user_dismission

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	表单id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果

入参和响应示例:

入参示例：

{
  "user_id": "7067493898b407dec4a5a754"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def user_dismission(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "7067493898b407dec4a5a754"
    result = bmcp.user_dismission(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.7 员工离职恢复

python调用方法名: bmcp.user_recover

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	表单id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果

入参和响应示例:

入参示例：

{
  "user_id": "7067493898b407dec4a5a754"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def user_recover(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "7067493898b407dec4a5a754"
    result = bmcp.user_recover(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.8 删除成员

python调用方法名: bmcp.user_delete

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	表单id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果

入参和响应示例:

入参示例：

{
  "user_id": "7067493898b407dec4a5a754"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def user_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "7067493898b407dec4a5a754"
    result = bmcp.user_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.9 指定部门下添加一位成员

python调用方法名: bmcp.user_create

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	表单id
uniqueid	string	否	企业内用户id
name	string	是	名称
departments	string array	否	要加入的部门id
title	string	否	成员职位
remark	string	否	备注

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果
user	Object
user.user_id	string	成员字符串id
user.name	string	名称
user.account	string	账号
user.country_code	string	手机区号
user.mobile	string	手机号
user.email	string	邮箱
user.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
user.frozen	string	成员是否被禁用（0表示启用，1表示禁用
user.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
user.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
user.uniqueid	string	企业内用户ID
user.remark	string	成员的备注信息
user.title	string	成员的职位
user.departments	string Array	所属部门id
user.job_title	Object Array
job_title.dept_id	string	部门id
job_title.job_title	string	职位
user.roles	string array	所属角色组id

入参和响应示例:

入参示例：

{
  "uniqueid": "WangXieaoMei1",
  "name": "王小美",
  "departments": [
    "57692aedbb6039b04cf15eca"
  ],
  "title": "职位",
  "remark": "备注"
}

响应示例：

{
  "user": {
    "user_id": "57c38102d8e647dcee87befc",
    "name": "王小美",
    "account": "user_dehgal52997",
    "country_code": "86",
    "mobile": "",
    "email": "",
    "category": "2",
    "mobilestatus": "0",
    "emailstatus": "0",
    "uniqueid": "WangXieaoMei1",
    "remark": "备注",
    "title": "职位",
    "departments": [
      "57692aedbb6039b04cf15eca"
    ],
    "roles": []
  }
}

Python插件开发代码示例:

import bmcp

def user_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["uniqueid"] = "WangXieaoMei1"
    params["name"] = "王小美"
    params["departments"] = ["57692aedbb6039b04cf15eca"]
    params["title"] = "职位"
    params["remark"] = "备注"
    result = bmcp.user_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

1.10 成员转外部联系人

python调用方法名: bmcp.user_transfer_outsider

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员字符串id
group_id	string	是	外部联系人分组字符串id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	执行结果

入参和响应示例:

入参示例：

{

    "user_id":"6ab949b5a3f0ea1d14dde47b",
    "group_id":"2edf8217fdc8d85fe75e8a76"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def user_transfer_outsider(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.user_transfer_outsider(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2. 部门

2.1 创建部门

python调用方法名: bmcp.department_create

入参结构：

字段名	字段类型	是否必填	说明
name	string	是	部门名称
parent_id	string	是	上级部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
department	Object
department.dept_no	int	部门编号
department.dept_id	string	部门id
department.parent_no	int	上级部门编号
department.parent_id	string	上级部门id
department.name	string	部门名称

入参和响应示例:

入参示例：

{
  "name": "test01",
  "parent_id": "550606b07bcc60d41cd9b2de"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "department": {
    "dept_no": 14,
    "dept_id": "fa9b482aa6d0e536b11ffc2e",
    "parent_no": 6,
    "parent_id": "550606b07bcc60d41cd9b2de",
    "name": "test01"
  }
}

Python插件开发代码示例:

import bmcp

def department_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test01"
    params["parent_id"] = "550606b07bcc60d41cd9b2de"
    result = bmcp.department_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.2 修改部门名称

python调用方法名: bmcp.department_update

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id
name	string	是	部门名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
department	Object
department.dept_no	int	部门编号
department.dept_id	string	部门id
department.name	string	部门名称

入参和响应示例:

入参示例：

{
  "name": "test02",
  "dept_id": "fa9b482aa6d0e536b11ffc2e"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "department": {
    "dept_no": 14,
    "dept_id": "fa9b482aa6d0e536b11ffc2e",
    "name": "test02"
  }
}

Python插件开发代码示例:

import bmcp

def department_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test02"
    params["dept_id"] = "fa9b482aa6d0e536b11ffc2e"
    result = bmcp.department_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.3 修改父级部门

python调用方法名: bmcp.department_update_parent

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id
parent_id	string	是	父级部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
departments	Object
departments.dept_no	int	部门编号
departments.dept_id	string	部门id
departments.parent_no	int	上级部门编号
departments.parent_id	string	上级部门id
departments.name	string	部门名称

入参和响应示例:

入参示例：

{
  "dept_id": "fa9b482aa6d0e536b11ffc2e",
  "parent_id": "540bb8ce11613ea6a3e67524"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "departments": {
    "dept_no": 14,
    "dept_id": "fa9b482aa6d0e536b11ffc2e",
    "parent_no": 8,
    "parent_id": "540bb8ce11613ea6a3e67524",
    "name": "test01"
  }
}

Python插件开发代码示例:

import bmcp

def department_update_parent(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["dept_id"] = "fa9b482aa6d0e536b11ffc2e"
    params["parent_id"] = "540bb8ce11613ea6a3e67524"
    result = bmcp.department_update_parent(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.4 查询指定部门下的所有子部门信息

python调用方法名: bmcp.department_list

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id
has_child	boolean	否	是否递归查询，默认false

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
departments	Object Array
department.dept_no	int	部门编号
department.dept_id	string	部门id
department.parent_no	int	上级部门编号
department.parent_id	string	上级部门id
department.name	string	部门名称

入参和响应示例:

入参示例：

{
  "dept_id": "540bb8ce11613ea6a3e67524"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "departments": [
    {
      "dept_no": 14,
      "dept_id": "fa9b482aa6d0e536b11ffc2e",
      "parent_no": 8,
      "parent_id": "540bb8ce11613ea6a3e67524",
      "name": "test02"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def department_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["dept_id"] = "540bb8ce11613ea6a3e67524"
    result = bmcp.department_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.5 查询部门信息

python调用方法名: bmcp.department_info

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
department	Object
department.dept_no	int	部门编号
department.dept_id	string	部门id
department.parent_no	int	上级部门编号
department.parent_id	string	上级部门id
department.name	string	部门名称

入参和响应示例:

入参示例：

{
  "dept_id": "fa9b482aa6d0e536b11ffc2e"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "departments": {
    "dept_no": 14,
    "dept_id": "fa9b482aa6d0e536b11ffc2e",
    "parent_no": 8,
    "parent_id": "540bb8ce11613ea6a3e67524",
    "name": "test02"
  }
}

Python插件开发代码示例:

import bmcp

def department_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["dept_id"] = "fa9b482aa6d0e536b11ffc2e"
    result = bmcp.department_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.6 删除部门

python调用方法名: bmcp.department_delete

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情

入参和响应示例:

入参示例：

{
  "dept_id": "fa9b482aa6d0e536b11ffc2e"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "departments": {
    "dept_no": 14,
    "dept_id": "fa9b482aa6d0e536b11ffc2e",
    "parent_no": 8,
    "parent_id": "540bb8ce11613ea6a3e67524",
    "name": "test02"
  }
}

Python插件开发代码示例:

import bmcp

def department_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["dept_id"] = "fa9b482aa6d0e536b11ffc2e"
    result = bmcp.department_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.7 获取部门成员

python调用方法名: bmcp.department_member_list

入参结构：

字段名	字段类型	是否必填	说明
dept_id	string	是	部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
users	Object Array
users.user_id	String	成员id
users.name	String	成员名称
users.account	String	账号
users.country_code	String	手机区号
users.mobile	String	手机号
users.email	String	邮箱
users.category	String	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
users.mobilestatus	String	手机验证状态, 0(未验证) 1(已验证)
users.emailstatus	String	邮箱验证状态, 0(未验证) 1(已验证)
users.uniqueid	String	企业内用户ID
users.remark	String	备注
users.title	String	成员的职位（旧职位字段已废弃）
users.departments	Array	所在部门id
users.job_title	Array	职位信息
users.job_title.dept_id	String	部门id
users.job_title.job_title	String	职位
users.roles	Array	所在角色组id

入参和响应示例:

入参示例：

{
  "dept_id": "fa9b482aa6d0e536b11ffc2e"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "users": [
    {
      "account": "user_d9mmkg90861",
      "category": "",
      "country_code": "86",
      "departments": [
        "540bb8ce11613ea6a3e67524"
      ],
      "email": "xlmd@votnz.com",
      "emailstatus": "1",
      "frozen": "",
      "job_title": null,
      "mobile": "13530485146",
      "mobilestatus": "1",
      "name": "tt002",
      "remark": "",
      "roles": [
        "2f8c4dc1b8a0583015fef85f",
        "c25046a5b44f3aa29d5b0eb4"
      ],
      "title": "",
      "uniqueid": "014562721",
      "user_id": "57485153a936aad06de22096"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def department_member_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["dept_id"] = "fa9b482aa6d0e536b11ffc2e"
    result = bmcp.department_member_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

2.8 获取职位列表

python调用方法名: bmcp.department_job_title

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
list	string array

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "msg": "success",
  "list": [
    "AAAA12"
  ]
}

Python插件开发代码示例:

import bmcp

def department_job_title(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.department_job_title(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

3. 职位

3.1 获取职位列表

python调用方法名: bmcp.jobtitle_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情
list	string array

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "msg": "success",
  "list": [
    "AAAA12",
    "BBBB"
  ]
}

Python插件开发代码示例:

import bmcp

def jobtitle_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.jobtitle_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

3.2 添加职位

python调用方法名: bmcp.jobtitle_add

入参结构：

字段名	字段类型	是否必填	说明
job_title	string array	是	职称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情

入参和响应示例:

入参示例：

{
  "job_title": [
    "test01"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def jobtitle_add(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["job_title"] = ["test01"]
    result = bmcp.jobtitle_add(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

3.3 修改职位

python调用方法名: bmcp.jobtitle_update

入参结构：

字段名	字段类型	是否必填	说明
update	Object Array	是
update.name	string	是	旧名称
update.new_name	string	是	新名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情

入参和响应示例:

入参示例：

{
  "update": [
    {
      "name": "职位1",
      "new_name": "职位1-1"
    },
    {
      "name": "职位2",
      "new_name": "职位2-1"
    }
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def jobtitle_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["update"] = [{"name": "职位1", "new_name": "职位1-1"}, {"name": "职位2", "new_name": "职位2-1"}]
    result = bmcp.jobtitle_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

3.4 删除职位

python调用方法名: bmcp.jobtitle_delete

入参结构：

字段名	字段类型	是否必填	说明
job_title	string array	是	职位

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	code非200时的错误详情

入参和响应示例:

入参示例：

{
  "job_title": [
    "test002"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def jobtitle_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["job_title"] = ["test002"]
    result = bmcp.jobtitle_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4. 角色

4.1 新建角色或角色组

python调用方法名: bmcp.role_create

入参结构：

字段名	字段类型	是否必填	说明
name	string	是	角色或角色组名称
parent	int	否	父级角色组编号：默认0，0为顶级
type	int	否	类型：0 角色 1 角色组

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{
  "name": "test001",
  "parent": 0,
  "type": 1
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": {
    "name": "test001",
    "parent": 0,
    "role_id": "168d4baf9914be56e8663e20",
    "role_no": 16,
    "sort": 17,
    "type": 0
  }
}

Python插件开发代码示例:

import bmcp

def role_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test001"
    params["parent"] = 0
    params["type"] = 1
    result = bmcp.role_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.2 修改角色或角色组

python调用方法名: bmcp.role_update

入参结构：

字段名	字段类型	是否必填	说明
name	string	是	角色或角色组名称
parent	int	否	父级角色组编号：默认0，0为顶级
role_id	string	否	角色或角色组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{
  "name": "test001",
  "parent": 3
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": {
    "name": "test001",
    "parent": 3,
    "role_id": "168d4baf9914be56e8663e20",
    "role_no": 16,
    "sort": 17,
    "type": 0
  }
}

Python插件开发代码示例:

import bmcp

def role_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test001"
    params["parent"] = 3
    result = bmcp.role_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.3 获取角色或角色组

python调用方法名: bmcp.role_info

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{
  "role_id": "168d4baf9914be56e8663e20"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": {
    "name": "test002",
    "parent": 3,
    "role_id": "168d4baf9914be56e8663e20",
    "role_no": 16,
    "sort": 17,
    "type": 0
  }
}

Python插件开发代码示例:

import bmcp

def role_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = "168d4baf9914be56e8663e20"
    result = bmcp.role_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.4 获取角色或角色组列表

python调用方法名: bmcp.role_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": [
    {
      "name": "test001",
      "parent": 0,
      "role_id": "168d4baf9914be56e8663e20",
      "role_no": 16,
      "sort": 17,
      "type": 0
    }
  ]
}

Python插件开发代码示例:

import bmcp

def role_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.role_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.5 删除角色或角色组

python调用方法名: bmcp.role_delete

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "role_id": "168d4baf9914be56e8663e20"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def role_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = "168d4baf9914be56e8663e20"
    result = bmcp.role_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.6 获取角色成员列表

python调用方法名: bmcp.role_member_list

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
users	Object Array
users.user_id	string	成员id
users.name	string	成员名称
users.account	string	账号
users.country_code	string	手机区号
users.mobile	string	手机号
users.email	string	邮箱
users.category	string	成员状态（-1表示被邀请的人尚未同意其邀请，同意后自动变为2，0表示团队创建者，2表示普通成员，-2离职成员）
users.mobilestatus	string	手机验证状态, 0(未验证) 1(已验证)
users.emailstatus	string	邮箱验证状态, 0(未验证) 1(已验证)
users.uniqueid	string	企业内用户ID
users.remark	string	备注
users.title	string	成员的职位（旧职位字段已废弃）
users.departments	string array	所在部门id
users.job_title	string array	职位信息
users.job_title.dept_id	string	部门id
users.job_title.job_title	string	职位
users.roles	string array	所在角色组id

入参和响应示例:

入参示例：

{
  "role_id": "c25046a5b44f3aa29d5b0eb4"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "users": [
    {
      "account": "user_amu5ib49708",
      "category": "-1",
      "country_code": "",
      "departments": [
        "8e4e47d5aa8448f5ee293ce8"
      ],
      "email": "1341871900@qq.com",
      "emailstatus": "1",
      "frozen": "0",
      "job_title": null,
      "mobile": "",
      "mobilestatus": "1",
      "name": "112233",
      "remark": "",
      "roles": [
        "c25046a5b44f3aa29d5b0eb4",
        "51094cb2af680a23d64fff3d"
      ],
      "title": "",
      "uniqueid": "100056000023",
      "user_id": "5478a4a666a3a213fda1f88b"
    },
    {
      "account": "user_d9mmkg90861",
      "category": "2",
      "country_code": "",
      "departments": [
        "540bb8ce11613ea6a3e67524"
      ],
      "email": "xlmd@votnz.com",
      "emailstatus": "1",
      "frozen": "1",
      "job_title": null,
      "mobile": "",
      "mobilestatus": "1",
      "name": "tt002",
      "remark": "",
      "roles": [
        "2f8c4dc1b8a0583015fef85f",
        "c25046a5b44f3aa29d5b0eb4"
      ],
      "title": "",
      "uniqueid": "014562721",
      "user_id": "57485153a936aad06de22096"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def role_member_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = "c25046a5b44f3aa29d5b0eb4"
    result = bmcp.role_member_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.7 批量创建角色

python调用方法名: bmcp.role_batch_create

入参结构：

字段名	字段类型	是否必填	说明
name	string array	是	角色或角色组名称
parent	int	否	父级角色组编号：默认0，0为顶级

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{
  "name": [
    "test20260730a",
    "test20260730b"
  ],
  "parent": 0
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": [
    {
      "name": "test20260730a",
      "parent": 0,
      "role_id": "58d842edbbe16d00801227b9",
      "role_no": 17,
      "sort": 18,
      "type": 0
    },
    {
      "name": "test20260730b",
      "parent": 0,
      "role_id": "d23e4b62891ee44686bfcdc6",
      "role_no": 18,
      "sort": 19,
      "type": 0
    }
  ]
}

Python插件开发代码示例:

import bmcp

def role_batch_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = ["test20260730a", "test20260730b"]
    params["parent"] = 0
    result = bmcp.role_batch_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.8 批量创建角色组

python调用方法名: bmcp.role_group_batch_create

入参结构：

字段名	字段类型	是否必填	说明
name	string array	是	角色或角色组名称
parent	int	否	父级角色组编号：默认0，0为顶级

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
role	Object array
role.role_id	string	角色或角色组id
role.role_no	int	角色或角色组编号
role.name	string	角色或角色组名称
role.type	int	类型，0 角色 1 角色组
role.parent	int	父级角色组编号，0为顶级
role.sort	int	排序

入参和响应示例:

入参示例：

{
  "name": [
    "test20260730c",
    "test20260730d"
  ],
  "parent": 0
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "role": [
    {
      "name": "test20260730c",
      "parent": 0,
      "role_id": "544d4c9e8cd100f28f1e44a9",
      "role_no": 19,
      "sort": 20,
      "type": 1
    },
    {
      "name": "test20260730d",
      "parent": 0,
      "role_id": "72b944a8ad462ede90a7c5dd",
      "role_no": 20,
      "sort": 21,
      "type": 1
    }
  ]
}

Python插件开发代码示例:

import bmcp

def role_group_batch_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = ["test20260730c", "test20260730d"]
    params["parent"] = 0
    result = bmcp.role_group_batch_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.9 批量删除角色或角色组

python调用方法名: bmcp.role_batch_delete

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "role_id": [
    "72b944a8ad462ede90a7c5dd"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def role_batch_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = ["72b944a8ad462ede90a7c5dd"]
    result = bmcp.role_batch_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.10 角色组添加成员

python调用方法名: bmcp.role_member_add

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id
user_id	string array	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "role_id": "5d7664098c0e0bb8e9f4e0b8",
  "user_id": [
    "57c38102d8e647dcee87befc"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def role_member_add(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = "5d7664098c0e0bb8e9f4e0b8"
    params["user_id"] = ["57c38102d8e647dcee87befc"]
    result = bmcp.role_member_add(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

4.11 删除角色成员

python调用方法名: bmcp.role_member_delete

入参结构：

字段名	字段类型	是否必填	说明
role_id	string	是	角色或角色组id
user_id	string array	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "role_id": "58d842edbbe16d00801227b9",
  "user_id": [
    "5972fb2a6e3285fef0a23004"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def role_member_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["role_id"] = "58d842edbbe16d00801227b9"
    params["user_id"] = ["5972fb2a6e3285fef0a23004"]
    result = bmcp.role_member_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5. 外部联系人分组

5.1 获取外部联系人分组列表

python调用方法名: bmcp.outsider_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
outsiders	Object Array
outsiders.group_id	string	外部联系人分组id
outsiders.name	string	外部联系人分组名称

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "msg": "success",
  "outsiders": [
    {
      "group_id": "2edf8217fdc8d85fe75e8a76",
      "name": "默认分组"
    },
    {
      "group_id": "f6edbdee1fe03a3ab5cab6a8",
      "name": "哈喽11"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def outsider_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.outsider_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.2 获取外部联系人分组成员列表

python调用方法名: bmcp.outsider_member_list

入参结构：

字段名	字段类型	是否必填	说明
group_id	string	是	外部联系人分组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
users	Object Array
users.user_id	string	成员id
users.group_id	string	外部联系人分组id
users.uniqueid	string	企业内用户ID
users.name	string	联系人名称
users.remark	string	备注

入参和响应示例:

入参示例：

{
  "group_id": "47c7429ba8c04aae79130733"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "users": [
    {
      "group_id": "47c7429ba8c04aae79130333",
      "name": "AA17",
      "remark": "",
      "uniqueid": "025620542",
      "user_id": "0d68447b8c1e776f907c6b76"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def outsider_member_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = "47c7429ba8c04aae79130333"
    result = bmcp.outsider_member_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.3 获取外部联系人分组信息

python调用方法名: bmcp.outsider_info

入参结构：

字段名	字段类型	是否必填	说明
group_id	string	是	外部联系人分组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
outsider	Object
outsiders.group_id	string	外部联系人分组id
outsiders.name	string	外部联系人分组名称

入参和响应示例:

入参示例：

{
  "group_id": "47c7429ba8c04aae79133333"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "outsider": {
    "group_id": "47c7429ba8c04aae79133333",
    "name": "A1"
  }
}

Python插件开发代码示例:

import bmcp

def outsider_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = "47c7429ba8c04aae79133333"
    result = bmcp.outsider_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.4 新建外部联系人分组

python调用方法名: bmcp.outsider_create

入参结构：

字段名	字段类型	是否必填	说明
name	是	String	外部联系人分组名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
group_id	string	外部联系人分组id
name	string	外部联系人分组名称

入参和响应示例:

入参示例：

{
  "name": "test20260801"
}

响应示例：

{
  "code": 200,
  "group_id": "aa1445f1a815a54c83d92220",
  "msg": "success",
  "name": "test20260801"
}

Python插件开发代码示例:

import bmcp

def outsider_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test20260801"
    result = bmcp.outsider_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.5 修改外部联系人分组名称

python调用方法名: bmcp.outsider_update

入参结构：

字段名	字段类型	是否必填	说明
group_id	是	String	外部联系人分组id
name	是	String	外部联系人分组名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
data	Object
data.group_id	string	外部联系人分组id
data.name	string	外部联系人分组名称

入参和响应示例:

入参示例：

{
  "name": "test20260801001",
  "group_id": "aa1445f1a815a54c83d901b0"
}

响应示例：

{
  "code": 200,
  "data": {
    "group_id": "aa1445f1a815a54c83d901b0",
    "name": "test20260801001"
  },
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test20260801001"
    params["group_id"] = "aa1445f1a815a54c83d901b0"
    result = bmcp.outsider_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.6 删除外部联系人分组

python调用方法名: bmcp.outsider_delete

入参结构：

字段名	字段类型	是否必填	说明
group_id	是	String	外部联系人分组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "group_id": "aa1445f1a815a54c83d901b0"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = "aa1445f1a815a54c83d901b0"
    result = bmcp.outsider_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.7 批量删除外部联系人分组

python调用方法名: bmcp.outsider_batch_delete

入参结构：

字段名	字段类型	是否必填	说明
group_id	是	String Array	外部联系人分组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "group_id": [
    "a59e48d6b451a83cd07c73d0"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_batch_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = ["a59e48d6b451a83cd07c73d0"]
    result = bmcp.outsider_batch_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

5.8 批量新增外部联系人分组

python调用方法名: bmcp.outsider_batch_create

入参结构：

字段名	字段类型	是否必填	说明
name	是	Array	外部联系人分组名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
outsiders	Object Array
outsiders.group_id	string	外部联系人分组id
outsiders.name	string	外部联系人分组名称

入参和响应示例:

入参示例：

{
  "name": [
    "test20260801002"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "outsiders": [
    {
      "group_id": "aaf14a9ba83425688a9b91e5",
      "name": "test20260801002"
    }
  ]
}

Python插件开发代码示例:

import bmcp

def outsider_batch_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = ["test20260801002"]
    result = bmcp.outsider_batch_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

6. 外部联系人管理

6.1 获取外部联系人成员信息

python调用方法名: bmcp.outsider_member_info

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
user	Object
user.user_id	int	外部联系人成员id
user.group_id	string	外部联系人分组id
user.uniqueid	string	企业内用户id
user.name	string	外部联系人名称
user.remark	string	联系人备注

入参和响应示例:

入参示例：

{
  "user_id": "504b61da50bd46b1cb4b1146"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "user": {
    "group_id": "d67b62e6ee3bddbd9e717a74",
    "name": "阿呀呀",
    "remark": "test",
    "uniqueid": "03963158901",
    "user_id": "504b61da50bd46b1cb4b1146"
  }
}

Python插件开发代码示例:

import bmcp

def outsider_member_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "504b61da50bd46b1cb4b1146"
    result = bmcp.outsider_member_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

6.2 修改外部联系人成员信息

python调用方法名: bmcp.outsider_member_update

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	外部联系人成员id
remark	string	否	备注
group_id	string	否	外部联系人分组id
name	string	否	外部联系人名称
uniqueid	string	否	企业内用户ID

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "user_id": "58f6c848c09a917dd4342458",
  "remark": "备注",
  "group_id": "aaf14a9ba83425688a9b91e5",
  "name": "名称",
  "uniqueid": "1256997001"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_member_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "58f6c848c09a917dd4342458"
    params["remark"] = "备注"
    params["group_id"] = "aaf14a9ba83425688a9b91e5"
    params["name"] = "名称"
    params["uniqueid"] = "1256997001"
    result = bmcp.outsider_member_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

6.3 外部联系人删除

python调用方法名: bmcp.outsider_member_dismission

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "user_id": "58f6c848c09a917dd4342458"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_member_dismission(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "58f6c848c09a917dd4342458"
    result = bmcp.outsider_member_dismission(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

6.4 外部联系人成员删除恢复

python调用方法名: bmcp.outsider_member_recover

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "user_id": "58f6c848c09a917dd4342458"
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_member_recover(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "58f6c848c09a917dd4342458"
    result = bmcp.outsider_member_recover(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

6.5 外部联系人转成员

python调用方法名: bmcp.outsider_member_transfer

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员id
dept_id	string array	是	加入部门id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "user_id": "58f6c848c09a917dd4342458",
  "dept_id": [
    "8e4e47d5aa8448f5ee293ce8"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def outsider_member_transfer(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "58f6c848c09a917dd4342458"
    params["dept_id"] = ["8e4e47d5aa8448f5ee293ce8"]
    result = bmcp.outsider_member_transfer(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7. 互联组织

7.1 列出我连接的企业

python调用方法名: bmcp.guest_corp_list

入参结构：

字段名	字段类型	是否必填	说明
corp_id	string	否	互联企业id，不填查询全部

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object
list.corp_id	string	互联企业id
list.name	string	互联企业名称

入参和响应示例:

入参示例：

{
  "corp_id": "55cb7d09cd8f71479f31f2f5"
}

响应示例：

{
  "code": 200,
  "list": [
    {
      "corp_id": "55cb7d09cd8f71479f31f2f5",
      "name": "知乎"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_corp_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["corp_id"] = "55cb7d09cd8f71479f31f2f5"
    result = bmcp.guest_corp_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7.2 查询互联企业角色列表

python调用方法名: bmcp.guest_role_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object
list.role_id	string	角色id
list.name	string	角色名称

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "list": [
    {
      "name": "AA",
      "role_id": "2e37a82fe2236480826eb6d4"
    },
    {
      "name": "BB",
      "role_id": "f87d610baea9f79e02d98211"
    },
    {
      "name": "XX",
      "role_id": "4b11e6138fd31f6c72f0b464"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_role_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.guest_role_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7.3 查询互联企业对接部门列表

python调用方法名: bmcp.guest_corp_department

入参结构：

字段名	字段类型	是否必填	说明
corp_id	string	否	互联企业id，不填查询全部
skip	int	否	翻页起始值索引
limit	int	否	查询的数据条数，1~300，默认300

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object
list.dept_id	string	部门id
list.name	string	部门名称

入参和响应示例:

入参示例：

{
  "user_id": "58f6c848c09a917dd4342458"
}

响应示例：

{
  "code": 200,
  "list": [
    {
      "dept_id": "9d414676a46cfc364775b3ae",
      "name": "测试三"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_corp_department(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "58f6c848c09a917dd4342458"
    result = bmcp.guest_corp_department(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7.4 查询互联企业对接部门的成员

python调用方法名: bmcp.guest_corp_department_user

入参结构：

字段名	字段类型	是否必填	说明
corp_id	string	是	互联企业id
dept_id	string	是	对接部门id
skip	int	否	翻页起始值索引
limit	int	否	查询的数据条数，1~300，默认300

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object Array	对接部门的成员列表
list.user_id	string	成员id
list.name	string	成员名称
list.status	int

入参和响应示例:

入参示例：

{
  "corp_id": "3e624c26a49f0747ae41c454",
  "dept_id": "9d414676a46cfc364775b3ae"
}

响应示例：

{
  "code": 200,
  "list": [
    {
      "name": "测试",
      "status": 0,
      "user_id": "94bad6fe2ac00b8cf3f15043"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_corp_department_user(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["corp_id"] = "3e624c26a49f0747ae41c454"
    params["dept_id"] = "9d414676a46cfc364775b3ae"
    result = bmcp.guest_corp_department_user(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7.5 列出我连接的企业的对接人

python调用方法名: bmcp.guest_user_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object Array	对接部门的成员列表
list.corp_id	String	互联企业id
list.user_id	string	成员id
list.name	string	成员名称
list.status	int

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "member_list": [
    {
      "corp_id": "111745b0a611e9e79bb889a4",
      "name": "测试人员",
      "status": 1,
      "user_id": "a99d45e28a8c8f1697ada172"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_user_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.guest_user_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

7.6 获取我连接的企业对接人的详细信息

python调用方法名: bmcp.guest_user

入参结构：

字段名	字段类型	是否必填	说明
user_id	string	是	成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
list	Object	对接部门的成员列表
list.user_id	string	成员id
list.name	string	成员名称
list.status	int

入参和响应示例:

入参示例：

{
  "user_id": "a99d45e28a8c8f1697ada172"
}

响应示例：

{
  "code": 200,
  "member": {
    "corp_id": "111745b0a611e9e79bb889a4",
    "name": "测试人员",
    "status": 1,
    "user_id": "a99d45e28a8c8f1697ada172"
  },
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def guest_user(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["user_id"] = "a99d45e28a8c8f1697ada172"
    result = bmcp.guest_user(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8. 管理组

8.1 新建管理组

python调用方法名: bmcp.manage_group_create

入参结构：

字段名	字段类型	是否必填	说明
name	string	是	管理组名称

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
group_id	int	管理组id
name	string	管理组名称

入参和响应示例:

入参示例：

{
  "name": "test001"
}

响应示例：

{
  "code": 200,
  "msg": "success",
  "group_id": 4,
  "name": "test001"
}

Python插件开发代码示例:

import bmcp

def manage_group_create(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["name"] = "test001"
    result = bmcp.manage_group_create(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8.2 查询管理组列表

python调用方法名: bmcp.manage_group_list

入参结构：

无

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
manageGroups	Object Array
manageGroups.group_id	int	管理组id
manageGroups.name	string	管理组名称

入参和响应示例:

入参示例：

{}

响应示例：

{
  "code": 200,
  "manageGroups": [
    {
      "group_id": -1,
      "name": "系统管理组"
    },
    {
      "_id": "640144f387581af8f926f47a",
      "group_id": 4,
      "name": "test001"
    }
  ],
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def manage_group_list(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    result = bmcp.manage_group_list(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8.3 查询管理组详情

python调用方法名: bmcp.manage_group_info

入参结构：

字段名	字段类型	是否必填	说明
group_id	int	是	管理组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果
apps	Object Array	应用权限应用列表
apps.appId	string	应用id
apps.appName	string	应用名称
dept_range	Object Array	通讯录管理范围
dept_range.dept_id	string	部门id
dept_range.name	string	部门名称
dept_range.dept_no	int	部门编号
role_range	Object Array	角色管理范围
role_range.role_id	string	角色id
role_range.name	string	角色名称
role_range.role_no	int	角色编号
outsider_range	Object Array	外部联系人管理范围
outsider_range.group_id	string	外部联系人分组id
outsider_range.name	string	外部联系人分组名称
members	Object Array	管理员
members.user_id	string	成员id
members.name	string	成员名称
name	string	管理组名称
op	Object
op.memberManage	bool	是否有通讯录管理权限
op.userInvite	bool	是否开启人员邀请
op.memberInvite	bool	是否勾选成员邀请
op.outsiderMemberInvite	bool	是否勾选外部联系人邀请
op.userRemove	bool	是否开启人员删除
op.memberRemove	bool	是否勾选人员删除
op.outsiderMemberRemove	bool	是否勾选外部联系人删除
op.organizationRemove	bool	是否开启部门/外部联系人分组删除
op.deptRemove	bool	是否勾选部门删除
op.outsiderRemove	bool	是否勾选外部联系人分组删除
op.is_sec_pol	bool	是否受安全策略限制

入参和响应示例:

入参示例：

{
  "group_id": 4
}

响应示例：

{
  "code": 200,
  "data": {
    "apps": [],
    "corp_id": "c5054c39bd7f8c5ef0c0911c",
    "dept_range": [
      {
        "_id": "5968c6970071889a8c75a78f",
        "name": "test1"
      }
    ],
    "group_id": 4,
    "members": [
      {
        "_id": "51804f8cae4778f55aa717ab",
        "editable": true,
        "mode": "member",
        "nickname": "通讯录重构测试三",
        "status": 2
      },
      {
        "_id": "5e8ceaa6545cdd93973d9e16",
        "editable": true,
        "mode": "member",
        "nickname": "tt11002001",
        "status": 2
      }
    ],
    "name": "test001",
    "op": {
      "appUpdate": true,
      "deptRemove": true,
      "is_sec_pol": true,
      "memberInvite": true,
      "memberManage": true,
      "memberRemove": true,
      "organizationRemove": true,
      "outsiderMemberInvite": true,
      "outsiderMemberRemove": true,
      "outsiderRemove": false,
      "syncUser": true,
      "userInvite": true,
      "userRemove": true
    },
    "outsider_range": [
      {
        "_id": "05603a9931bbfedbf47cb6f8",
        "mode": "outsiderGroup",
        "name": "外联部门1",
        "status": 1
      },
      {
        "_id": "f6edbdee1fe03a3ab5cab6a8",
        "mode": "outsiderGroup",
        "name": "哈喽11",
        "status": 1
      }
    ],
    "owner": {},
    "role_range": [
      {
        "_id": "130f4cafaca3e5bd69dd77a3",
        "mode": "role",
        "name": "etest222",
        "role_id": 2
      },
      {
        "_id": "2f8c4dc1b8a0583015fef85f",
        "mode": "role",
        "name": "test1112222",
        "role_id": 1
      }
    ]
  },
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def manage_group_info(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = 4
    result = bmcp.manage_group_info(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8.4 删除管理组

python调用方法名: bmcp.manage_group_delete

入参结构：

字段名	字段类型	是否必填	说明
group_id	int	是	管理组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "group_id": 4
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def manage_group_delete(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = 4
    result = bmcp.manage_group_delete(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8.5 修改普通管理组详情

python调用方法名: bmcp.manage_group_update

入参结构：

字段名	字段类型	是否必填	说明
group_id	int	是	管理组id
members	string array	否	设置管理员，内容为成员id
apps	string array	否	设置应用管理权限，内容为应用id
memberManage	Boolean	否	是否开启通讯录管理权限
userInvite	Boolean	否	是否开启人员邀请
memberInvite	Boolean	否	是否勾选成员邀请
outsiderMemberInvite	Boolean	否	是否勾选外部联系人邀请
userRemove	Boolean	否	是否开启人员删除
memberRemove	Boolean	否	是否勾选人员删除
outsiderMemberRemove	Boolean	否	是否勾选外部联系人删除
organizationRemove	Boolean	否	是否开启部门/外部联系人分组删除
deptRemove	Boolean	否	是否勾选部门删除
outsiderRemove	Boolean	否	是否勾选外部联系人分组删除
is_sec_pol	Boolean	否	是否启用安全策略限制
dept_range	string array	否	设置通讯录管理范围，内容为部门id
role_range	string array	否	设置角色管理范围，内容为角色id
outsider_range	string array	否	设置外部联系人管理范围，内容为联系人分组id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "group_id": 4,
  "members": [
    "5e8ceaa6545cdd93973d9e16"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def manage_group_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["group_id"] = 4
    params["members"] = ["5e8ceaa6545cdd93973d9e16"]
    result = bmcp.manage_group_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)

8.6 修改系统管理组管理员

python调用方法名: bmcp.manage_sys_group_update

入参结构：

字段名	字段类型	是否必填	说明
members	string array	是	设置管理员，内容为成员id

响应结构:

字段名	字段类型	说明
code	int	执行结果码，200代表成功，其他代表失败
msg	string	结果

入参和响应示例:

入参示例：

{
  "members": [
    "5e8ceaa6545cdd93973d9e16"
  ]
}

响应示例：

{
  "code": 200,
  "msg": "success"
}

Python插件开发代码示例:

import bmcp

def manage_sys_group_update(args: Args) -> Output:
    # 插件定义好入参后除了动态部分，其他部分无需调整的可以直接按如下方式继承
    params = args.params
    # 如果需要固定参数 可以如下指定
    params["members"] = ["5e8ceaa6545cdd93973d9e16"]
    result = bmcp.manage_sys_group_update(params)
    # 如果必须返回 Output 类型实例，可以强制转换，否则直接返回 dict 也可被接受
    return Output(result)