上海騰曦網絡服務有限公司
騰訊企業郵箱上海經銷商
作者:騰訊企業微信郵箱 發布時間:2022-07-31 11:28:21 訪問量:2742
導讀:相信最近兩年申請的騰訊企業微信郵箱用戶,會發信騰訊企業微信和企業郵箱做了深度的融合。在騰訊企業微信的后臺,可以更好的協作管理企業郵箱,對于一些在使用oa的用戶來說,想跟企業微信郵箱做對接,就需要調用企業微信郵箱api接口。今天上海騰訊企業微信郵箱經銷商騰曦小編就跟大家分享一下。
相信最近兩年申請的騰訊企業微信郵箱用戶,會發信騰訊企業微信和企業郵箱做了深度的融合。在騰訊企業微信的后臺,可以更好的協作管理企業郵箱,對于一些在使用oa的用戶來說,想跟企業微信郵箱做對接,就需要調用企業微信郵箱api接口。今天上海騰訊企業微信郵箱經銷商騰曦小編就跟大家分享一下。
一、企業通過調用企業微信郵件API,可以更加高效地管理郵件群組、業務郵箱等功能。
注:郵箱API功能灰度測試中,將會逐步開放secret獲取入口。
開發流程
進入管理后臺—協作—郵件,進入郵箱管理—郵件API設置頁;
點擊「查看」,「企業微信團隊」服務號將下發郵件功能的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]
}
}
參數說明
參數
類型
是否必須
說明
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
點贊 1 來源:qq企業郵箱 相關推薦: 企業郵箱能看到所有人的郵件嗎?我的郵件可以不被監控嗎?騰訊企業郵箱:賬號密碼忘記了該怎么辦 用戶必備 [騰訊企業郵箱]outlook2016郵箱設置方法 QQ企業郵箱如何做POP3/SMTP設置 騰訊企業郵箱如何獲取客戶端專用密碼(授權碼)? 聲明:本文由騰訊企業微信郵箱收集整理的《騰訊企業微信郵箱如何調用api接口?》,如轉載請保留鏈接:http://www.mypaintedlips.com/news_in/1561 |