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

目录

  • 创建业务邮箱
  • 更新业务邮箱
  • 删除业务邮箱
  • 获取业务邮箱详情
  • 模糊搜索业务邮箱
  • 创建业务邮箱

    该接口用于创建业务邮箱,指定业务邮箱使用权限。

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

    请求包体

    {
      "email": "apitest@gzdev.com",
      "name": "apitest",
      "userid_list": {
        "list": ["apitest1", "apitest2"]
      },
      "department_list": {
        "list": [1, 2]
      },
      "tag_list": {
        "list": [1, 2]
      }
    }

    参数说明

    参数类型是否必须说明
    emailstring业务邮箱地址
    namestring业务邮箱名称,不多于64个字符或32个汉字,不得与其他业务邮箱重名
    userid_liststring有权限使用业务邮箱的成员UserID列表。userid_list、department_list、taglist不能同时为空
    department_listuint32有权限使用业务邮箱的部门ID列表
    tag_listuint32有权限使用业务邮箱的标签ID列表

     

    返回示例

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

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    iduint32业务邮箱ID

     

    更新业务邮箱

    该接口用于更新业务邮箱,支持更新名称、使用权限。需要注意的是Json数组类型传空值将会清空其内容,不传则保持不变。
    例如清空userid_list:

    {
      "id": 1,
      "name": "apitest",
      "userid_list" : {"list" : []}
      // 省略
    }

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

    {
      "id": 1,
      "name": "apitest"
      // 省略
    }

     

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

    请求包体

    {
      "id" : 1,
      "name": "apitest",
      "userid_list": {
        "list": ["apitest1", "apitest2"]
      },
      "department_list": {
        "list": [1, 2]
      },
      "tag_list": {
        "list": [1, 2]
      }
    }

    参数说明

    参数类型是否必须说明
    iduint32业务邮箱ID
    namestring业务邮箱名称,不多于64个字符或32个汉字,不得与其他业务邮箱重名
    userid_liststring有权限使用业务邮箱的成员UserID列表,不传则不变,传空为清空。userid_list、department_list、taglist不能同时为空,(使用成员不允许全部清空)
    department_listuint32有权限使用业务邮箱的部门列表,不传则不变,传空为清空
    tag_listuint32有权限使用业务邮箱的标签列表,不传则不变,传空为清空

     

    返回示例

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

    参数说明

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

     

    删除业务邮箱

    该接口用于删除已有的业务邮箱。

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

    请求包体

    {
      "id": 1
    }

    参数说明

    参数类型是否必须说明
    iduint32业务邮箱ID

    返回示例

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

    参数说明

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

    获取业务邮箱详情

    该接口用于获取业务邮箱详细信息,包含业务邮箱名称、权限信息。

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

    请求包体

    {
      "id_list": [1, 2]
    }

    参数说明

    参数类型是否必须说明
    id_listuint32业务邮箱ID列表

    返回示例

    {
      "errcode": 0,
      "errmsg": "ok",
      "list": [{
        "id": 1,
        "email": "apitest3@gzdev.com",
        "name": "测试",
        "userid_list": {
          "list": [
            "member",
            "member2"
          ]
        },
        "department_list": {
          "list": [
            1,
            2
          ]
        },
        "tag_list": {
          "list": [
            1,
            2
          ]
        }
      }]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    iduint32业务邮箱ID
    emailstring业务邮箱地址
    namestring业务邮箱名称
    userid_liststring有权限使用业务邮箱的成员UserID列表
    department_listuint32有权限使用业务邮箱的部门列表
    tag_listuint32有权限使用业务邮箱的标签列表

     

    模糊搜索业务邮箱

    该接口用于模糊搜索业务邮箱,可匹配邮箱名也可匹配邮箱地址。

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

    参数说明

    参数类型是否必须说明
    fuzzyuint321开启模糊搜索,0获取全部业务邮箱
    emailstring业务邮箱名称或邮箱地址

    返回示例

    {
      "errcode": 0,
      "errmsg": "ok",
      "list": [
        {
          "id": 11,
          "email": "apitest3@gzdev.com",
          "name": "apitest3"
        },
        {
          "id": 12,
          "email": "apitest4@gzdev.com",
          "name": "apitest4"
        }
      ]
    }

    参数说明

    参数类型说明
    errcodeint32错误码
    errmsgstring错误码说明
    iduint32业务邮箱ID
    emailstring业务邮箱地址
    namestring业务邮箱名称

     

    上一篇
    管理邮件群组
    下一篇
    邮箱账号管理