客服电话：13904310313 
新网开发平台使用文件xinnet-mail-openapi
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
loginuserid |
string |
必须 |
|
登录全账号，邮箱格式 |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
必须 |
|
返回数据 |
|
|
├─ loginuserid |
string |
必须 |
|
登录全账号，邮箱格式 |
|
|
├─ orgNames |
string |
必须 |
|
所属部门id，多部门逗号分隔 |
|
|
├─ firstname |
string |
必须 |
|
用户姓名-名 |
|
|
├─ lastname |
string |
必须 |
|
用户姓名-姓 |
|
|
├─ position |
string |
必须 |
|
职位 |
|
|
├─ mobile |
string |
必须 |
|
手机号 |
|
|
├─ telephone |
string |
必须 |
|
座机号 |
|
|
├─ gender |
string |
必须 |
|
性别，0-男,1-女,2-未知，默认为2 |
|
|
├─ birthday |
string |
必须 |
|
生日，yyyy-MM-dd格式 |
|
邮件列表管理
邮件列表添加
基本信息
Path： /api/maillist/addMailList?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002010 |
邮件列表名称不能为空 |
|
20002011 |
需要审批功能的时候，列表审批员Email不能为空 |
|
40006902 |
邮件列表已经存在 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
mailListName |
string |
必须 |
|
列表名称 |
|
|
mailListDesc |
string |
非必须 |
|
列表描述 |
|
|
listMode |
integer |
非必须 |
|
列表模式，0-普通列表,1-部门列表，默认为0 |
|
|
listType |
integer |
非必须 |
|
列表类型，1-公有,2-私有,3-管制,4-智能,5-域内,6-指定名单，默认为1 |
|
|
checkSend |
boolean |
非必须 |
|
发送列表时是否需要审批，false-无需审批,true-需要审批，默认为false |
|
|
checkAdd |
boolean |
非必须 |
|
加入列表时是否需要审批，false-无需审批,true-需要审批，默认为false |
|
|
deptId |
string |
非必须 |
|
部门id，多部门逗号分隔 |
|
|
maxUserNum |
integer |
非必须 |
|
最大用户数，默认为0 |
|
|
checkerListEmail |
string |
非必须 |
|
列表审批员Email(选择需审批后该属性必填) |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
非必须 |
|
返回数据 |
|
邮件列表修改
基本信息
Path： /api/maillist/updateMailList?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002010 |
邮件列表名称不能为空 |
|
20002011 |
需要审批功能的时候，列表审批员Email不能为空 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
mailListName |
string |
必须 |
|
列表名称，不可修改 |
|
|
mailListDesc |
string |
非必须 |
|
列表描述 |
|
|
listMode |
integer |
非必须 |
|
列表模式，0-普通列表,1-部门列表 |
|
|
listType |
integer |
非必须 |
|
列表类型，1-公有,2-私有,3-管制,4-智能,5-域内,6-指定名单 |
|
|
checkSend |
boolean |
非必须 |
|
发送列表时是否需要审批，false-无需审批,true-需要审批 |
|
|
checkAdd |
boolean |
非必须 |
|
加入列表时是否需要审批，false-无需审批,true-需要审批 |
|
|
deptId |
string |
非必须 |
|
部门id，多部门逗号分隔 |
|
|
maxUserNum |
string |
非必须 |
|
最大用户数 |
|
|
checkerListEmail |
string |
非必须 |
|
列表审批员Email(选择需审批后该属性必填) |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
非必须 |
|
返回数据 |
|
邮件列表删除
基本信息
Path： /api/maillist/deleteMailList?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
mailListNameList |
string [] |
必须 |
|
列表名称数组 |
item 类型: string |
|
├─ |
|
非必须 |
|
|
|
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
非必须 |
|
返回数据 |
|
邮件列表获取
基本信息
Path： /api/maillist/getMailList?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
mailListName |
string |
必须 |
|
列表名称 |
|
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
必须 |
|
返回数据 |
|
|
├─ mailListName |
string |
必须 |
|
列表名称 |
|
|
├─ mailListDesc |
string |
必须 |
|
列表描述 |
|
|
├─ listMode |
integer |
必须 |
|
列表模式，0-普通列表,1-部门列表 |
|
|
├─ listType |
integer |
必须 |
|
列表类型，1-公有,2-私有,3-管制,4-智能,5-域内,6-指定名单 |
|
|
├─ checkSend |
boolean |
必须 |
|
发送列表时是否需要审批，0-无需审批,1-需要审批 |
|
|
├─ checkAdd |
boolean |
必须 |
|
加入列表时是否需要审批，0-无需审批,1-需要审批 |
|
|
├─ deptId |
string |
必须 |
|
部门id，多部门逗号分隔 |
|
|
├─ maxUserNum |
integer |
必须 |
|
最大用户数 |
|
|
├─ checkerListEmail |
string |
必须 |
|
列表审批员Email |
|
邮件列表查询
基本信息
Path： /api/maillist/queryMailLists?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002012 |
searchType必须是0或者1 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
pageNo |
integer |
非必须 |
|
第几页，默认1 |
|
|
pageSize |
integer |
非必须 |
|
每页记录数，默认20 |
|
|
searchType |
integer |
必须 |
|
查询类型，0-普通列表,1-部门列表,2-智能列表 |
|
|
searchValue |
string |
非必须 |
|
查询值，模糊匹配列表名称或描述 |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
必须 |
|
返回数据 |
|
|
├─ count |
number |
必须 |
|
总记录数 |
|
|
├─ result |
object [] |
必须 |
|
结果数组 |
item 类型: object |
|
├─ mailListName |
string |
必须 |
|
列表名称 |
|
|
├─ mailListDesc |
string |
必须 |
|
列表描述 |
|
|
├─ listMode |
integer |
必须 |
|
列表模式，0-普通列表,1-部门列表 |
|
|
├─ listType |
integer |
必须 |
|
列表类型，1-公有,2-私有,3-管制,4-智能,5-域内,6-指定名单 |
|
|
├─ checkSend |
boolean |
必须 |
|
发送列表时是否需要审批，false-无需审批,true-需要审批 |
|
|
├─ checkAdd |
boolean |
必须 |
|
加入列表时是否需要审批，false-无需审批,true-需要审批 |
|
|
├─ deptId |
string |
必须 |
|
部门id，多部门逗号分隔 |
|
|
├─ maxUserNum |
integer |
必须 |
|
最大用户数 |
|
|
├─ checkerListEmail |
string |
必须 |
|
列表审批员Email |
|
邮件列表成员添加
基本信息
Path： /api/maillist/batchAddUsers?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002010 |
邮件列表名称不能为空 |
|
20002013 |
addresses不能为空 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
mailListName |
string |
必须 |
|
邮件列表名 |
|
|
addresses |
string [] |
必须 |
|
成员邮件地址数组 |
item 类型: string |
|
├─ |
|
非必须 |
|
|
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
非必须 |
|
返回数据 |
|
邮件列表成员删除
基本信息
Path： /api/maillist/batchDeleteUsers?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002010 |
邮件列表名称不能为空 |
|
20002013 |
addresses不能为空 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
mailListName |
string |
必须 |
|
邮件列表名 |
|
|
addresses |
string [] |
必须 |
|
成员邮件地址数组 |
item 类型: string |
|
├─ |
|
非必须 |
|
|
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
非必须 |
|
返回数据 |
|
邮件列表成员查询
基本信息
Path： /api/maillist/queryUsers?access_token=ACCESS_TOKEN&corpid=CORPID&ts=TS&uuid=UUID&sign=SIGN
Method： POST
接口描述：
业务错误码
|
错误码 |
说明 |
|
20002010 |
邮件列表名称不能为空 |
请求参数
Headers
|
参数名称 |
参数值 |
是否必须 |
示例 |
备注 |
|
Content-Type |
application/json |
是 |
|
|
Query
|
参数名称 |
是否必须 |
示例 |
备注 |
|
access_token |
是 |
|
见公共参数说明 |
|
corpid |
是 |
|
见公共参数说明 |
|
ts |
是 |
|
见公共参数说明 |
|
uuid |
是 |
|
见公共参数说明 |
|
sign |
是 |
|
见公共参数说明 |
Body
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
domainName |
string |
非必须 |
|
公司所对应的域名，默认采用系统指定的 |
|
|
pageNo |
integer |
非必须 |
|
第几页，默认1 |
|
|
pageSize |
integer |
非必须 |
|
每页记录数，默认20 |
|
|
mailListName |
string |
必须 |
|
邮件列表名，精确匹配 |
|
|
keyWord |
string |
非必须 |
|
成员邮件地址关键字，模糊匹配 |
|
返回数据
|
名称 |
类型 |
是否必须 |
默认值 |
备注 |
其他信息 |
|
code |
string |
必须 |
|
返回码 |
|
|
msg |
string |
非必须 |
|
文本描述 |
|
|
data |
object |
必须 |
|
返回数据 |
|
|
├─ count |
integer |
必须 |
|
总记录数 |
|
|
├─ result |
string [] |
必须 |
|
结果数组 |
item 类型: string |
|
├─ |
|
非必须 |
|
|
|
