腾讯企业邮箱

上海腾曦网络服务有限公司

腾讯企业邮箱上海经销商

销售热线:400-900-2208
腾讯企业邮箱

腾讯邮箱设置

当前位置:腾讯企业邮箱-> 新闻资讯

腾讯企业微信邮箱如何调用api接口?

作者:腾讯企业微信邮箱    发布时间:2022-07-31 11:28:21  访问量:111  


导读:相信最近两年申请的腾讯企业微信邮箱用户,会发信腾讯企业微信和企业邮箱做了深度的融合。在腾讯企业微信的后台,可以更好的协作管理企业邮箱,对于一些在使用oa的用户来说,想跟企业微信邮箱做对接,就需要调用企业微信邮箱api接口。今天上海腾讯企业微信邮箱经销商腾曦小编就跟大家分享一下。



  相信最近两年申请的腾讯企业微信邮箱用户,会发信腾讯企业微信和企业邮箱做了深度的融合。在腾讯企业微信的后台,可以更好的协作管理企业邮箱,对于一些在使用oa的用户来说,想跟企业微信邮箱做对接,就需要调用企业微信邮箱api接口。今天上海腾讯企业微信邮箱经销商腾曦小编就跟大家分享一下。

  一、企业通过调用企业微信邮件API,可以更加高效地管理邮件群组、业务邮箱等功能。

  注:邮箱API功能灰度测试中,将会逐步开放secret获取入口。

  开发流程

  进入管理后台—协作—邮件,进入邮箱管理—邮件API设置页;

img

  点击「查看」,「企业微信团队」服务号将下发邮件功能的secret;

  通过secret及corpid获取到对应的的access_token;

  通过access_token调用邮件相关接口。

  二、管理员邮件群组

  创建邮件群组

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

  请求方式: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]

  }

  }

  参数说明

  

参数

类型

是否必须

说明





groupid

string

邮件群组ID,邮箱格式

groupname

string

邮件群组名称,不能与其他群组重名,长度限定64字节

email_list

string

群组内成员邮箱地址,读取成员的biz_mail字段,email_list,group_list,department_list,tag_list至少填写一个,不可同时为空。成员由email_list,group_list,department_list,tag_list共同组成

tag_list

uint32

群组内包含的标签ID

department_list

uint32

群组内包含的部门ID

group_list

string

群组内包含的群组邮箱

allow_type

uint32

群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。当值为0、1、2时,不得传入allow_emaillist,allow_departmentlist,allow_taglist。当值为3时,必须传入allow_emaillist,allow_departmentlist,allow_taglist至少一项

allow_emaillist

string

允许使用群组群发的成员邮箱地址,读取成员的biz_mail字段

allow_departmentlist

uint32

允许使用群组群发的部门ID

allow_taglist

uint32

允许使用群组群发的标签ID


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok"

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明


  更新邮件群组

  该接口用于更新邮件群组,可以修改群组名称、群组成员、群组使用权限等。需要注意的是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]

  }

  }

  参数说明

  

参数

类型

是否必须

说明





groupid

string

邮件群组ID,邮箱格式

groupname

string

邮件群组名称,不能与其他群组重名,长度限定64字节

email_list

string

群组内成员邮箱地址,读取成员的biz_mail字段,不传则不变,传空则清空。成员由email_list,group_list,department_list,tag_list共同组成,不允许全部清空

tag_list

uint32

群组内包含的标签ID,不传则不变,传空为清空

department_list

uint32

群组内包含的部门ID,不传则不变,传空为清空

group_list

string

群组内包含的群组邮箱ID,不传则不变,传空为清空

allow_type

uint32

群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。当值为0、1、2时,不得传入allow_emaillist,allow_departmentlist,allow_taglist。当值为3时,必须传入allow_emaillist,allow_departmentlist,allow_taglist至少一项。若不需更新则不传入参数。

allow_emaillist

string

允许使用群组群发的成员邮箱地址,不传则不变,传空为清空

allow_departmentlist

uint32

允许使用群组群发的部门ID,不传则不变,传空为清空

allow_taglist

uint32

允许使用群组群发的标签ID,不传则不变,传空为清空


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok"

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明


  删除邮件群组

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

  请求方式:POST(HTTPS)

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

  请求包体

  {

  "groupid": "zhangsangroup@gzdev.com"

  }

  参数说明

  

参数

类型

是否必须

说明





groupid

string

邮件群组ID,邮箱格式


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok"

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明


  获取邮件详情

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

  请求方式:GET(HTTPS)

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

  参数说明

  

参数

类型

是否必须

说明





groupid

string

邮件群组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]

  }

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明

groupid

string

邮件群组ID,邮箱格式

groupname

string

邮件群组名称

email_list

string

群组内成员邮箱地址

tag_list

uint32

群组内包含的标签ID

department_list

uint32

群组内包含的部门ID

group_list

string

群组内包含的群组邮箱ID

allow_type

uint32

群组使用权限。0: 企业成员, 1任何人, 2:组内成员,3:自定义成员。

allow_emaillist

string

允许使用群组群发的成员邮箱地址

allow_departmentlist

uint32

允许使用群组群发的部门ID

allow_taglist

uint32

允许使用群组群发的标签ID


  模糊搜索邮件群组

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

  请求方式:GET(HTTPS)

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

  参数说明

  

参数

类型

是否必须

说明





fuzzy

uint32

1开启模糊搜索,0获取全部邮件群组

groupid

string

邮件群组ID,邮箱格式


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok",

  "count": 2.

  "groups": [

  {

  "groupid": "g_all@gzdev.com",

  "groupname": "任何人"

  },

  {

  "groupid": "g_inner@gzdev.com",

  "groupname": "组内成员"

  }

  ]

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明

count

string

返回条数

groupid

string

邮件群组ID

groupname

string

邮件群组名称


  三、管理业务邮箱

  创建业务邮箱

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

  请求方式: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]

  }

  }

  参数说明

  

参数

类型

是否必须

说明





email

string

业务邮箱地址

name

string

业务邮箱名称,不多于64个字符或32个汉字,不得与其他业务邮箱重名

userid_list

string

有权限使用业务邮箱的成员UserID列表。userid_list、department_list、taglist不能同时为空

department_list

uint32

有权限使用业务邮箱的部门ID列表

tag_list

uint32

有权限使用业务邮箱的标签ID列表


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok",

  "id" : 1

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明

id

uint32

业务邮箱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]

  }

  }

  参数说明

  

参数

类型

是否必须

说明





id

uint32

业务邮箱ID

name

string

业务邮箱名称,不多于64个字符或32个汉字,不得与其他业务邮箱重名

userid_list

string

有权限使用业务邮箱的成员UserID列表,不传则不变,传空为清空。userid_list、department_list、taglist不能同时为空,(使用成员不允许全部清空)

department_list

uint32

有权限使用业务邮箱的部门列表,不传则不变,传空为清空

tag_list

uint32

有权限使用业务邮箱的标签列表,不传则不变,传空为清空


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok"

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明


  删除业务邮箱

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

  请求方式:POST(HTTPS)

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

  请求包体

  {

  "id": 1

  }

  参数说明

  

参数

类型

是否必须

说明





id

uint32

业务邮箱ID


  返回示例

  {

  "errcode": 0.

  "errmsg": "ok"

  }

  参数说明

  

参数

类型

说明




errcode

int32

错误码

errmsg

string

错误码说明


  获取业务邮箱详情

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

  请求方式:POST(HTTPS)

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

  请求包体

  {

  "id_list": [1. 2]

  }

  参数说明

  

参数

类型

是否必须

说明





id_list

uint32

业务邮箱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

  ]

  }

  }]

  }

  参数说明

  

参数

类型

说明

<t



&l




点赞  0  来源:qq企业邮箱





声明:本文由腾讯企业微信邮箱收集整理的《腾讯企业微信邮箱如何调用api接口?》,如转载请保留链接:http://www.qq366.cn/news_in/1561

上海腾曦网络服务公司是腾讯企业邮箱官方授权经销商;腾讯企业邮箱又叫QQ企业邮箱,唯一与微信完美结合的企业邮箱,可以在微信中收发邮件的企业邮箱。

  • QQ企业邮箱
  • QQ企业邮箱
  • QQ企业邮箱
  • QQ企业邮箱

售前咨询

售后客服

微信咨询

服务热线:
4009002208