集成接口技术白皮书

网址:http://qiye.
163.
com/热线:400-6281-163第I页网易企业邮箱集成接口技术白皮书稳定可靠,安全无忧V2.
0.
HZ集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第II页目录1关于文档.
11.
1目标.
11.
2读者.
11.
3术语解析.
11.
4如何获得帮助.
12接口综述.
22.
1目标.
22.
2功能概述.
22.
3总体架构.
22.
4接口对接条件.
32.
5应用步骤(以Java为例)32.
6申请流程.
53部门帐号同步接口.
63.
1接口说明.
63.
2接口规范.
63.
2.
1技术规范.
63.
2.
2使用规范.
63.
3指令说明.
73.
3.
1服务提供接口列表{fuc}值.
73.
3.
2服务接口可能返回的通用错误码.
123.
3.
3注意.
123.
4参数说明.
123.
5URL示例.
133.
6应用示例.
164数据查询接口.
174.
1接口说明.
174.
2接口规范.
17集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第III页4.
2.
1技术规范.
174.
2.
2使用规范.
174.
3指令说明.
184.
3.
1服务提供接口列表{fuc}值.
184.
3.
2服务接口可能返回的通用错误码.
204.
4URL示例.
215未读邮件数量接口.
245.
1接口说明.
245.
2接口规范.
245.
2.
1技术规范.
245.
2.
2使用规范.
245.
3应用示例.
256单点登录接口.
276.
1接口说明.
276.
2接口规范.
276.
2.
1技术规范.
276.
2.
2使用规范.
276.
3应用示例.
287自定义登录框接口.
297.
1接口说明.
297.
2接口规范.
297.
2.
1技术规范.
297.
2.
2数据规范.
297.
2.
3注意事项.
307.
3应用示例.
317.
4登录验证.
31集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第1页1关于文档1.
1目标这份文档帮助客户或经销商详细了解网易企业邮箱接口集成的具体功能和操作方法.
1.
2读者这份文档的预期读者为客户IT相关负责人、经销商客服和技术支持人员.
1.
3术语解析HTTP协议超文本传输协议(HTTP)是一种通信协议,它允许将超文本标记语言(HTML)文档从web服务器传送到Web浏览器.
URL统一资源定位符(URL,英语UniformResourceLocator的缩写)也被称为网页地址,是因特网上标准的资源的地址.
统一资源定位符URL是对可以从因特网上得到的资源的位置和访问方法的一种简洁的表示.
RSA加密算法RSA加密算法是是目前最有影响力的公开密钥密码体制加密算法,它能够抵抗到目前为止已知的所有密码攻击,已被ISO推荐为公钥数据加密标准,从提出到现在的三十多年里,经历了各种攻击的考验,逐渐为人们接受,普遍认为是目前最优秀的公钥方案之一.
国内银行的网银通讯也是采用此类加密传输方式,可以有效防止数据被盗用或篡改,给予用户数据安全保护的最高级别.
1.
4如何获得帮助如对文档有任何疑问,欢迎致电400-6281-163或发邮件kf@qiye.
163.
com进行咨询并作深入的了解.
集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第2页2接口综述2.
1目标网易企业邮箱拥有多个集成接口供客户使用,并能与其他业务系统进行集成.

2.
2功能概述网易企业邮箱提供多种集成接口与客户应用系统进行无缝集成,可实现与用户应用系统中组织架构同步和未读邮件数同步,并且可以在用户应用系统或者用户网站登录首页实现单点登录或者嵌入自定义登录的入口,解决了网易企业邮箱系统与客户应用系统的集成问题.
集成接口采用了RSA加密算法和服务请求IP地址过滤等技术保障数据交互接口的安全.
2.
3总体架构集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第3页2.
4接口对接条件接口类型对接条件组织架构同步单点登录未读邮件数自定义登录RSA公钥登记√√√服务器时间一致√√服务器出口IP登记√√开通接口权限√√√√系统部门数据结构一致√2.
5应用步骤(以Java为例)1.
引用RSA工具包:RSA-1.
1.
1.
jar2.
生成密钥:com.
netease.
domainmail.
Utils.
createKeyPair();3.
把公钥和IP地址告诉接口提供方进行授权.
(注:单点登录接口不需要限定IP,可以不提供)4.
生成操作参数(原始字符串).
5.
参数加密:com.
netease.
domainmail.
Utils.
encrypt(StringpriKey,Stringsource);其中,priKey是私钥,source是原始字符串,返回加密后的字符串.
GeneratingapairofRSAkey.
.
.
pubKey:30819f300d06092a864886f70d010101050003818d003081890281810085802e30d10d33197354c6c2d0785526ff17b4741048745f17e8e91cb38c70dd60e9bce1bf9b73d9215ccb56ad68c5efcf3d7f62677cd685cb1664601b57f1535138ea1e60apriKey:30820276020100300d06092a864886f70d0101010500048202603082025c0201000281810085802e30d10d33197354c6c2d0785526ff17b4741048745f17e8e91cb38c70dd60e9bce1bf9b73d9215ccb56ad68c5efcf3d7f62677cd685cb1664601b57f1535138ea1e60a42e8ccbb813ba8f7c91d27fcfde305cd1edc04a5aa26afba8e04c87c786113c2616f2fb8b6f5b9e0c55fb141eb96ae7426d35fbe9de581fccb6210201024-bitRSAkeyGENERATED.
集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第4页6.
组装完整URL请求地址.
7.
发送POST请求.
8.
返回操作结果.
整个接口应用过程中,接口调用流程如下:集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第5页2.
6申请流程注:上述流程图中红色字体部分的是客户申请需提供的资料集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第6页3部门帐号同步接口3.
1接口说明部门帐号同步接口通过HTTPS协议提交.
同步接口支持创建、更新和删除部门,创建、禁用、删除和恢复帐号,修改帐号密码和属性,创建和删除帐号别名.

3.
2接口规范3.
2.
1技术规范1.
接口采用HTTPS协议,使用POST方法访问.
2.
通过接口提交的指令参数必须经过RSA算法加密,禁止明文传输.
客户按标准RSA算法(1024位密钥长度)生成公私钥,将公钥提供给网易企业邮箱用于解密,私钥自行妥善保管用于指令加密.
3.
网易企业邮箱对客户服务器IP地址进行服务授权,进一步增强接口安全性.
4.
接口访问频率限制,同一时间只允许三个请求,超过三个请求则返回失败.

3.
2.
2使用规范1.
POST请求到URL:https://apihz.
qiye.
163.
com/qiyeservice/api/{func}domain=*&product=*&sign=*&time=*2.
*:真实URL中替换为实际操作要填入的参数值.
3.
{func}:访问接口路径,如查询帐号接口名称:account/getAccount4.
domain:企业邮箱注册域名,用于标识客户.
5.
product:由网易提供给客户,企业标识.
6.
time:生成URL的服务器当前时间(单位ms,至现在所经过的UTC毫秒数).
7.
sign:RSA加密内容,参数名按字母顺序进行排列,每个参数后面带上等号和参数值,参数之间用&连接,加密明文如:domain=*&product=*&time=*8.
参数值使用URLEncoder.
encode(String,"utf-8")编码,以保证不存在特殊字符干扰参数值的解析.
注意:签名在编码之前,请在对参数编码前先签名.

9.
接口返回数据编码为utf-8,响应数据以json格式表示,结构如下:集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第7页{"suc":true,"error_code":"错误代码"}suc:执行结果是否正确,false-执行失败,true-执行成功.
error_code:错误代码,用来表示执行失败的原因.
3.
3指令说明3.
3.
1服务提供接口列表{fuc}值以下接口列表中所列出的参数中均不再列出ver,sign参数操作名操作说明操作参数参数中文名称参数属性备注/unit/createUnit创建部门domain域名必填匹配项parent_id上级部门id选填录入项创建下级部门时使用product企业标识必填匹配项unit_desc部门描述选填录入项unit_name部门名称必填录入项/unit/updateUnit更新部门domain域名必填匹配项product企业标识必填匹配项unit_desc部门描述选填录入项更新部门描述unit_id部门id必填匹配项unit_name部门名称选填录入项更新部门名称/unit/deleteUnit删除部门domain域名必填匹配项product企业标识必填匹配项unit_id部门id必填匹配项要求该部门没有邮箱帐号/account/createAcco创建帐号account_name帐号名必填录入项集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第8页操作名操作说明操作参数参数中文名称参数属性备注untaddress_right是否有查看企业通讯录权限选填录入项0-没有,1-有addr_visible是否在通讯录中显示选填录入项0-不显示,1-显示domain域名必填匹配项exp_time过期时间选填录入项格式yyyy-MM-dd,不传表示无过期时间fwd是否有自动转发权限选填录入项0-否,1-是fwdauth自动转发是否需要手机验证选填录入项0-否,1-是job_no工号选填录入项mobile手机号码选填录入项nickname姓名必填录入项pass_type密码类型选填录入项密码是否md5编码过,0-明文,1-md5编码passchange_req帐号首次登录是否需要修改密码选填录入项0-不需要,1-web登录需要,客户端不需要,2-web登录需要且未改密码前客户端不能登录password密码必填录入项product企业标识必填匹配项quota邮箱总容量选填录入项如果企业未开通容量自由分配功能,此参数无效resetpass_mobile是否允许通过手机重置密码选填录入项0-否,1-是集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第9页操作名操作说明操作参数参数中文名称参数属性备注resetpass_general是否允许将军令重置密码选填录入项0-否,1-是unit_id所属部门id选填录入项默认部门传default/account/updateAccount更新帐号account_name帐号名必填匹配项addr_right是否有查看企业通讯录权限选填录入项0-没有,1-有addr_visible是否在通讯录中显示选填录入项0-不显示,1-显示domain域名必填匹配项exp_time过期时间选填录入项yyyy-MM-dd,不传表示无过期时间fwd是否有自动转发权限选填录入项0-否,1-是fwdauth自动转发是否需要手机验证选填录入项0-否,1-是job_no工号选填录入项mobile手机号码选填录入项nickname姓名选填录入项更新姓名product企业标识选填匹配项quota邮箱总容量选填录入项如果企业未开通容量自由分配功能,此参数无效resetpass_mobile是否允许通过手机重置密码选填录入项0-否,1-是resetpass_general是否允许将军令重置密码选填录入项0-否,1-是集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第10页操作名操作说明操作参数参数中文名称参数属性备注/account/suspendAccount禁用帐号account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/account/deleteAccountSim删除帐号account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/account/recoverAccount恢复帐号account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/account/updatePassword更新帐号密码account_name帐号名必填匹配项domain域名必填匹配项pass_type密码类型选填录入项passchange_req首次登陆是否修改密码选填录入项password密码必填录入项product企业标识必填匹配项/account/addAccountAlias创建帐号别名account_name帐号名必填匹配项alias_name别名必填录入项domain域名必填匹配项product企业标识必填匹配项/account/deleteAcco删除帐号account_name帐号名必填匹配项集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第11页操作名操作说明操作参数参数中文名称参数属性备注untAlias别名alias_name别名必填匹配项domain域名必填匹配项product企业标识必填匹配项/account/moveUnit移动帐号所属部门account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项unit_id部门id必填录入项默认部门"default"/account/updateDefaultSender更新默认发件人account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项sender发件人必填录入项完整的emai地址,帐号部分必须为主帐号或帐号的别名,域名部分必须为主域名或域别名/mobile/addMobile绑定手机号码account_name帐号名必填匹配项domain域名必填匹配项mobile手机号码必填录入项product企业标识必填匹配项/mobile/deleteMobile删除绑定手机号码account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第12页3.
3.
2服务接口可能返回的通用错误码SYSTEM.
IPDENY:IP被禁止SYSTEM.
ERROR:其他错误SYSTEM.
PARAMNULL:参数不能为空SYSTEM.
PARAMINVALID:参数不合法SYSTEM.
SIGNINVALID:签名错误SYSTEM.
FUNCDENY:没有权限访问此接口SYSTEM.
PRODUCTNULL:产品号为空SYSTEM.
ACCESSOVER:访问过于频繁SYSTEM.
TIMEOUT:访问时间超出限制3.
3.
3注意1.
操作名区分大小写!
2.
参数属性为"匹配项",参数值必须匹配数据库中已有数据,否则操作失败3.
参数属性为"录入项",参数值将存入网易企业邮箱数据库.
3.
4参数说明参数名类型名称长度限制unit_nameString部门名称0~50个字节unit_descString部门描述0~128个字节account_nameString帐号名1~32个字节nicknameString姓名1~30个字节passwordString密码6~16个字节job_noString工号0~20个字节集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第13页alias_nameString别名帐号1~20个字节3.
5URL示例注意:红色字体为需要签名内容RSASignatureToQiye.
generateSigature(priKey,src);1.
创建部门https://apihz.
qiye.
163.
com/qiyeservice/api/unit/createUnitdomain=abc.
com&product=abc_com&unit_desc=%E6%B5%8B%E8%AF%95%E9%83%A8%E9%97%A8&unit_name=%E6%B5%8B%E8%AF%95%E9%83%A8%E9%97%A8&sign=domain=abc.
com&product=abc_com&time=1418378176267&unit_desc=测试部门&unit_name=测试部门成功结果:{"con":{"unit_desc":"测试部门","unit_id":"335017","unit_name":"测试部门"},"suc":true,"ver":0}失败结果:{"error_code":"UNIT.
NAMEEXIST","suc":false,"ver":0}2.
创建子部门https://apihz.
qiye.
163.
com/qiyeservice/api/unit/createUnitdomain=abc.
com&parent_id=335017&product=abc_com&time=1418378704477&unit_desc=%E5%AD%90%E9%83%A8%E9%97%A8&unit_name=%E5%AD%90%E9%83%A8%E9%97%A8&sign=domain=abc.
com&parent_id=335017&product=abc_com&time=1418378704477&unit_desc=子部门&unit_name=子部门成功结果:{"con":{"parent_id":"335017","unit_desc":"子部门","unit_id":"335018","unit_name":"子部门"},"suc":true,"ver":0}失败结果:{"error_code":"UNIT.
PARENTNOTEXIST","suc":false,"ver":0}3.
更新部门https://apihz.
qiye.
163.
com/qiyeservice/api/unit/updateUnitdomain=abc.
com&product=abc_com&time=1418378451504&unit_desc=%E6%AD%A3%E5%BC%8F%E9%83%A8%E9%97%A8&unit_id=335017&unit_name=%E6%AD%A3%E5%BC%8F%E9%83%A8%E9%97%A8&sign=domain=abc.
com&product=abc_com&time=1418378451504&unit_desc=正式部门&unit_id=335017&unit_name=正式部门成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"UNIT.
NOTEXIST","suc":false,"ver":0}4.
删除部门https://apihz.
qiye.
163.
com/qiyeservice/api/unit/deleteUnitdomain=abc.
com&product=abc_com&time=1418381515027&unit_id=335018&sign=domain=abc.
com&product=abc_com&time=1418381515027&unit_id=335018成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"DEPT.
DELETE.
NOTEMPTY","suc":false,"ver":0}集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第14页5.
创建用户https://apihz.
qiye.
163.
com/qiyeservice/api/account/createAccountaccount_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=%E5%BC%A0%E4%B8%89&pass_type=0&passchange_req=1&password=test123&product=abc_com&time=1418381664475&unit_id=default&sign=account_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=张三&pass_type=0&passchange_req=1&password=test123&product=abc_com&time=1418381664475&unit_id=default成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}6.
更新帐号https://apihz.
qiye.
163.
com/qiyeservice/api/account/updateAccountaccount_name=zhangsan&addr_right=0&addr_visible=0&domain=abc.
com&exp_time=2020-01-01&job_no=5555&mobile=13612312312&nickname=%E6%B5%8B%E8%AF%95%E5%B8%90%E5%8F%B7&product=abc_com"a=5120&time=1418382062669&sign=account_name=zhangsan&addr_right=0&addr_visible=0&domain=abc.
com&exp_time=2020-01-01&job_no=5555&mobile=13612312312&nickname=测试帐号&product=abc_com"a=5120&time=1418382062669成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
NOTEXIST:zhangsa1n","suc":false,"ver":0}7.
禁用帐号https://apihz.
qiye.
163.
com/qiyeservice/api/account/suspendAccountaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558324257&sign=account_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558324257成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}8.
恢复帐号https://apihz.
qiye.
163.
com/qiyeservice/api/account/recoverAccountaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558514579&sign=account_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558514579成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}9.
更新帐号密码https://apihz.
qiye.
163.
com/qiyeservice/api/account/updatePasswordaccount_name=zhangsan&domain=abc.
com&passchange_req=0&password=654321&product=abc_com&time=1418558629335&sign=account_name=zhangsan&domain=abc.
com&passchange_req=0&password=654321&product=abc_com&time=1418558629335成功结果:{"suc":true,"ver":0}集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第15页失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}10.
删除帐号https://apihz.
qiye.
163.
com/qiyeservice/api/account/deleteAccountSimaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558732584&sign=account_name=zhangsan&domain=abc.
com&product=abc_com&time=1418558732584成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}11.
添加帐号别名https://apihz.
qiye.
163.
com/qiyeservice/api/account/addAccountAliasaccount_name=zhangsan&alias_name=zs&domain=abc.
com&product=abc_com&time=1418558973610&sign=account_name=zhangsan&alias_name=zs&domain=abc.
com&product=abc_com&time=1418558973610成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}12.
删除帐号别名https://apihz.
qiye.
163.
com/qiyeservice/api/account/deleteAccountAliasaccount_name=zhangsan&alias_name=zs&domain=abc.
com&product=abc_com&time=1418559168253&sign=account_name=zhangsan&alias_name=zs&domain=abc.
com&product=abc_com&time=1418559168253成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}13.
绑定手机号码https://apihz.
qiye.
163.
com/qiyeservice/api/mobile/addMobileaccount_name=zhangsan&domain=abc.
com&mobile=13612312312&product=abc_com&time=1418559787507&sign=account_name=zhangsan&domain=abc.
com&mobile=13612312312&product=abc_com&time=1418559787507成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"MOBILE.
INVALID","suc":false,"ver":0}14.
删除绑定手机号码https://apihz.
qiye.
163.
com/qiyeservice/api/mobile/deleteMobileaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418559994256&sign=account_name=zhangsan&domain=abc.
com&product=abc_com&time=1418559994256成功结果:{"suc":true,"ver":0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第16页3.
6应用示例以创建用户为例:(假设客户域名为abc.
com,cid值为abc_com)原始参数:account_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=张三&pass_type=0&passchange_req=1&password=test123&product=abc_com&time=1418560970749&unit_id=defaultRSA加密后参数:197cb2dff85512a0e6f615c02029e86f00f5acc47ec1c4d71d6353a6bc3be8ae37581c04bc4aa3c388194f62197c21d7099d548134b90fb645523cfb5ba90e2c3f2c7f0e4d6147d97874cb616f465663bcffb974a46fc8cf08e13b8c9cf24d14d5418eec78aeabbb98445793106e184847a46457794c34c0800d7f1d266f0ea4完整的请求地址:https://apihz.
qiye.
163.
com/qiyeservice/api/account/createAccountaccount_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=%E5%BC%A0%E4%B8%89&pass_type=0&passchange_req=1&password=test123&product=abc_com&sign=197cb2dff85512a0e6f615c02029e86f00f5acc47ec1c4d71d6353a6bc3be8ae37581c04bc4aa3c388194f62197c21d7099d548134b90fb645523cfb5ba90e2c3f2c7f0e4d6147d97874cb616f465663bcffb974a46fc8cf08e13b8c9cf24d14d5418eec78aeabbb98445793106e184847a46457794c34c0800d7f1d266f0ea4&time=1418560970749&unit_id=default接口解析之后的地址(即原始请求):https://apihz.
qiye.
163.
com/qiyeservice/api/account/createAccountaccount_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=%E5%BC%A0%E4%B8%89&pass_type=0&passchange_req=1&password=test123&product=abc_com&time=1418381664475&unit_id=default&sign=account_name=zhangsan&domain=abc.
com&mobile=13612312312&nickname=张三&pass_type=0&passchange_req=1&password=test123&product=abc_com&time=1418381664475&unit_id=default集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第17页4数据查询接口4.
1接口说明数据查询接口通过HTTPS协议提交.
查询接口支持查询部门列表、帐号列表、帐号别名列表、绑定手机信息和收发信记录.
4.
2接口规范4.
2.
1技术规范1.
接口采用HTTPS协议,使用POST方法访问.
2.
通过接口提交的指令参数必须经过RSA算法加密,禁止明文传输.
客户按标准RSA算法(1024位密钥长度)生成公私钥,将公钥提供给网易企业邮箱用于解密,私钥自行妥善保管用于指令加密.
3.
网易企业邮箱对客户服务器IP地址进行服务授权,进一步增强接口安全性.
4.
接口访问频率限制,同一时间只允许三个请求,超过三个请求则返回失败.

4.
2.
2使用规范1.
POST请求到URL:https://apihz.
qiye.
163.
com/qiyeservice/api/{func}domain=*&product=*&sign=*&time=*2.
*:真实URL中替换为实际操作要填入的参数值.
3.
{func}:访问接口路径,如查询帐号接口名称:account/getAccount4.
domain:企业邮箱注册域名,用于标识客户.
5.
product:由网易提供给客户,企业标识.
6.
time:生成URL的服务器当前时间(单位ms,至现在所经过的UTC毫秒数).
7.
sign:RSA加密内容,参数名按字母顺序进行排列,每个参数后面带上等号和参数值,参数之间用&连接,加密明文如:domain=*&product=*&time=*8.
ver:数据版本号.
部分查询接口会返回ver属性,用于表示该对象当前版本号,客户可将版本号与对象关联保存,在下次访问时将ver作为参数值提交给接口,当本地版本号与网易系统版本号一致,只返回版本号告知客户当前对象没有变集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第18页化,当本地版本号与网易系统版本号不一致,则返回整个对象数据.
此参数的目的是减少对同一个对象多次查询所需要的数据量,降低网络流量消耗,加快响应速度.
9.
参数值使用URLEncoder.
encode(String,"utf-8")编码,以保证不存在特殊字符干扰参数值的解析.
注意:签名在编码之前,请在对参数编码前先签名.

10.
接口返回数据编码为utf-8,响应数据以json格式表示,结构如下:{"con":"具体响应结果","suc":true,"ver":1385523476730,"error_code":"错误代码","error_msg":"错误描述"}suc:执行结果是否正确,false-执行失败,true-执行成功.
ver:当前请求对象的版本号,具体见接口介绍里的说明.
error_code:错误代码,用来表示执行失败的原因.
error_msg:错误描述,用来表示执行失败的描述,用户可以使用此描述或根据错误代码自行设计描述内容.
con:执行结果,具体内容见下面的详细接口说明.
4.
3指令说明4.
3.
1服务提供接口列表{fuc}值以下接口列表中所列出的参数中均不再列出ver,sign参数操作名操作说明操作参数参数中文名称参数属性备注/unit/getUnit获取部门信息domain域名必填匹配项product企业标识必填匹配项unit_id部门id必填匹配项/unit/getAccountList获取部门帐号信息domain域名必填匹配项page_num分页数选填匹配项每页默认帐号数2000集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第19页操作名操作说明操作参数参数中文名称参数属性备注product企业标识必填匹配项recursion是否显示子部门帐号选填匹配项true显示,false不显示unit_id部门id必填匹配项/unit/getUnitList获取所有部门列表domain域名必填匹配项product企业标识必填匹配项/account/getAccount获取帐号信息account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/account/getAccountAliasList获取帐号别名列表account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/domain/getDomain获取企业信息domain域名必填匹配项product企业标识必填匹配项/mobile/getMobile获取绑定手机号码account_name帐号名必填匹配项domain域名必填匹配项product企业标识必填匹配项/mail/getSentMailLogs获取发信记录accounts帐号名必填匹配项domain域名必填匹配项end结束时间选填匹配项yyyy-MM-dd或yyyy-MM-ddHH:mm:ss集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第20页操作名操作说明操作参数参数中文名称参数属性备注page_num分页的页数选填匹配项page_size分页大小选填匹配项默认1000product企业标识必填匹配项start开始时间选填匹配项yyyy-MM-dd或yyyy-MM-ddHH:mm:ss/mail/getReceivedMailLogs获取收信记录accounts帐号名必填匹配项domain域名必填匹配项end结束时间选填匹配项yyyy-MM-dd或yyyy-MM-ddHH:mm:sspage_num分页的页数选填匹配项page_size分页大小选填匹配项默认1000product企业标识必填匹配项start开始时间选填匹配项yyyy-MM-dd或yyyy-MM-ddHH:mm:ss4.
3.
2服务接口可能返回的通用错误码SYSTEM.
IPDENY:IP被禁止SYSTEM.
ERROR:其他错误SYSTEM.
PARAMNULL:参数不能为空SYSTEM.
PARAMINVALID:参数不合法SYSTEM.
SIGNINVALID:签名错误集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第21页SYSTEM.
FUNCDENY:没有权限访问此接口SYSTEM.
PRODUCTNULL:产品号为空SYSTEM.
ACCESSOVER:访问过于频繁SYSTEM.
TIMEOUT:访问时间超出限制4.
4URL示例注意:红色字体为需要签名内容RSASignatureToQiye.
generateSigature(priKey,src);1.
获取所有部门列表https://apihz.
qiye.
163.
com/qiyeservice/api/unit/getUnitListdomain=abc.
com&product=abc_com&time=1418558015552&sign=domain=abc.
com&product=abc_com&time=1418558015552成功结果:{'con':[{'unit_desc':'正式部门','unit_id':'335017','unit_name':'正式部门'},{'unit_id':'335020','unit_name':'test'}],'suc':true,'ver':1418554605599}失败结果:{"error_code":"SYSTEM.
ERROR","suc":false,"ver":0}2.
获取帐号别名https://apihz.
qiye.
163.
com/qiyeservice/api/account/getAccountAliasListaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418559066063&sign=account_name=zhangsan&domain=abc.
com&product=abc_com&time=1418559066063成功结果:{'con':['zs001','zs'集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第22页],'suc':true,'ver':1418558906403}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}3.
获取绑定手机号码https://apihz.
qiye.
163.
com/qiyeservice/api/mobile/getMobileaccount_name=zhangsan&domain=abc.
com&product=abc_com&time=1418559871893&time=1418559871893&sign=account_name=zhangsan&domain=abc.
com&product=abc_com成功结果:{'con':{'account_name':'zhangsan','domain':'abc.
com','mobile':'13612312312'},'suc':true,'ver':0}失败结果:{"error_code":"ACCOUNT.
EXIST","suc":false,"ver":0}4.
获取发信记录https://apihz.
qiye.
163.
com/qiyeservice/api/mail/getSentMailLogsaccounts=zhangsan&domain=abc.
com&end=2014-12-31&product=abc_com&start=2014-12-01&time=1418560567753&sign=accounts=zhangsan&domain=abc.
com&end=2014-12-31&product=abc_com&start=2014-12-01&time=1418560567753成功结果:{'con':{'list':[{'mailfrom':'zhangsan@abc.
com','mailsize':'1959','mailto':'admin@abc.
com','mid':'132853932','result':'1','sendip':'223.
68.
189.
235','sendtime':'2014-12-1420:18:14','subject':'测试邮件'}],集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第23页'total':1},'suc':true,'ver':0}5.
获取收信记录https://apihz.
qiye.
163.
com/qiyeservice/api/mail/getReceivedMailLogsaccounts=zhangsan&domain=abc.
com&end=2014-12-31&product=abc_com&start=2014-12-01&time=1418560371694&sign=accounts=zhangsan&domain=abc.
com&end=2014-12-31&product=abc_com&start=2014-12-01&time=1418560371694成功结果:{'con':{'list':[{'mailfrom':'admin@abc.
com','mailsize':'8708','mailto':'zhangsan@abc.
com','mid':'130622869','result':'1','sendtime':'2014-12-1218:54:35','subject':'欢迎您使用abc.
com邮箱!
'}],'total':1},'suc':true,'ver':0}集成接口技术白皮书网址:http://qiye.
163.
com/热线:400-6281-163第24页5未读邮件数量接口5.
1接口说明采用RSA加密算法的HTTPS协议接口,客户提交加密的邮箱帐号和服务器时间信息,网易企业邮箱验证并解密参数后,返回对应邮箱帐号所有未读邮件的数量.