企业内部开发 服务端API 效率工具 企业邮箱 管理邮件群组
管理邮件群组

目录

  • 创建邮件群组
  • 更新邮件群组
  • 删除邮件群组
  • 获取邮件详情
  • 模糊搜索邮件群组
  • 创建邮件群组

    该接口用于创建新邮件群组,可以指定群组成员,定义群组使用权限范围。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/create?access_token=ACCESS_TOKEN

    请求包体

    {
      "groupid": "zhangsangroup@gzdev.com",
      "groupname": "zhangsangroup",
      "email_list": {
        "list": ["lisi@gzdev.com", "wangwu@gzdev.com"]
      },
      "tag_list": {
        "list": [2, 5]
      },
      "department_list": {
        "list": [1, 2]
      },
      "group_list": {
        "list": ["aaa@gzdev.com"]
      },
      "allow_type": 3,
      "allow_emaillist": {
        "list": ["zhangsanp@gzdev.com"]
      },
      "allow_departmentlist": {
        "list": [1, 2]
      },
      "allow_taglist": {
        "list": [1, 3]
      }
    }

    参数说明

    参数类型是否必须说明
    groupidstring邮件群组ID,邮箱格式
    groupnamestring邮件群组名称,不能与其他群组重名,长度限定64字节
    email_liststring群组内成员邮箱地址,读取成员的biz_mail字段,email_list,group_list,department_list,tag_list至少填写一个,不可同时为空。成员由email_list,group_list,department_list,tag_list共同组成
    tag_listuint32群组内包含的标签ID
    department_listuint32群组内包含的部门ID
    group_liststring群组内包含的群组邮箱
    allow_typeuint32群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。当值为0、1、2时,不得传入allow_emaillist,allow_departmentlist,allow_taglist。当值为3时,必须传入allow_emaillist,allow_departmentlist,allow_taglist至少一项
    allow_emailliststring允许使用群组群发的成员邮箱地址,读取成员的biz_mail字段
    allow_departmentlistuint32允许使用群组群发的部门ID
    allow_taglistuint32允许使用群组群发的标签ID

    返回示例

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

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明

     

    更新邮件群组

    该接口用于更新邮件群组,可以修改群组名称、群组成员、群组使用权限等。需要注意的是Json数组类型传空值将会清空其内容,不传则保持不变。
    例如清空email_list:

    {
      "groupid": "zhangsangroup@gzdev.com",
      "groupname": "zhangsangroup",
      "email_list" : {"list" : []}
      // 省略
    }

    若需保持不变则不传即可:

    {
      "groupid": "zhangsangroup@gzdev.com",
      "groupname": "zhangsangroup"
      // 省略
    }

     

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/update?access_token=ACCESS_TOKEN

    请求包体

    {
      "groupid": "zhangsangroup@gzdev.com",
      "groupname": "zhangsangroup",
      "email_list": {
        "list": ["lisi@gzdev.com", "wangwu@gzdev.com"]
      },
      "tag_list": {
        "list": [2, 5]
      },
      "department_list": {
        "list": [1, 2]
      },
      "group_list": {
        "list": ["aaa@gzdev.com"]
      },
      "allow_type": 3,
      "allow_emaillist": {
        "list": ["zhangsanp@gzdev.com"]
      },
      "allow_departmentlist": {
        "list": [1, 2]
      },
      "allow_taglist": {
        "list": [1, 3]
      }
    }

    参数说明

    参数类型是否必须说明
    groupidstring邮件群组ID,邮箱格式
    groupnamestring邮件群组名称,不能与其他群组重名,长度限定64字节
    email_liststring群组内成员邮箱地址,读取成员的biz_mail字段,不传则不变,传空则清空。成员由email_list,group_list,department_list,tag_list共同组成,不允许全部清空
    tag_listuint32群组内包含的标签ID,不传则不变,传空为清空
    department_listuint32群组内包含的部门ID,不传则不变,传空为清空
    group_liststring群组内包含的群组邮箱ID,不传则不变,传空为清空
    allow_typeuint32群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。当值为0、1、2时,不得传入allow_emaillist,allow_departmentlist,allow_taglist。当值为3时,必须传入allow_emaillist,allow_departmentlist,allow_taglist至少一项。若不需更新则不传入参数。
    allow_emailliststring允许使用群组群发的成员邮箱地址,不传则不变,传空为清空
    allow_departmentlistuint32允许使用群组群发的部门ID,不传则不变,传空为清空
    allow_taglistuint32允许使用群组群发的标签ID,不传则不变,传空为清空

    返回示例

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

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明

    删除邮件群组

    该接口用于删除已有的邮件群组。

    请求方式:POST(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/delete?access_token=ACCESS_TOKEN

    请求包体

    {
      "groupid": "zhangsangroup@gzdev.com"
    }

    参数说明

    参数类型是否必须说明
    groupidstring邮件群组ID,邮箱格式

    返回示例

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

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明

    获取邮件详情

    该接口用于获取邮件群组详细信息,包含群组名称、群组成员、群组使用权限等。

    请求方式:GET(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/get?access_token=ACCESS_TOKEN

    参数说明

    参数类型是否必须说明
    groupidstring邮件群组ID,邮箱格式

    返回示例

    {
       "errcode": 0,
       "errmsg": "ok",
        "groupid": "zhangsangroup@gzdev.com",
        "groupname": "zhangsangroup",
        "email_list": {
        "list": ["lisi@gzdev.com", "wangwu@gzdev.com"]
        },
        "tag_list": {
        "list": [2, 5]
        },
        "department_list": {
        "list": [1, 2]
        },
        "group_list": {
        "list": ["aaa@gzdev.com"]
        },
        "allow_type": 3,
        "allow_emaillist": {
        "list": ["zhangsanp@gzdev.com"]
        },
        "allow_departmentlist": {
        "list": [1, 2]
        },
        "allow_taglist": {
        "list": [1, 3]
        }
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    groupidstring邮件群组ID,邮箱格式
    groupnamestring邮件群组名称
    email_liststring群组内成员邮箱地址
    tag_listuint32群组内包含的标签ID
    department_listuint32群组内包含的部门ID
    group_liststring群组内包含的群组邮箱ID
    allow_typeuint32群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。
    allow_emailliststring允许使用群组群发的成员邮箱地址
    allow_departmentlistuint32允许使用群组群发的部门ID
    allow_taglistuint32允许使用群组群发的标签ID

    模糊搜索邮件群组

    该接口用于通过群组ID模糊搜索邮件群组。

    请求方式:GET(HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/exmail/group/search?access_token=ACCESS_TOKEN

    参数说明

    参数类型是否必须说明
    fuzzyuint321开启模糊搜索,0获取全部邮件群组
    groupidstring邮件群组ID,邮箱格式

    返回示例

    {
      "errcode": 0,
      "errmsg": "ok",
      "count": 2,
      "groups": [
        {
          "groupid": "g_all@gzdev.com",
          "groupname": "任何人"
        },
        {
          "groupid": "g_inner@gzdev.com",
          "groupname": "组内成员"
        }
      ]
    }
    

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    countstring返回条数
    groupidstring邮件群组ID
    groupnamestring邮件群组名称

     

    上一篇
    概述
    下一篇
    管理业务邮箱