API接口文档Word下载.docx

1、 域开通时间，格式为“2009-04-23” ended: 域到期时间，格式为“2013-01-01” password: 此域的域管理员密码，如没有此项密码默认为“12345678” pwd_encode:（新增）此域的域管理员密码，如没有此项密码默认为“12345678”（base64加密）。password,pwd_encode两个参数，优先取pwd_encode3、输出数据输出容及含义如下： param_error: 传递的参数错误 verify_error: 验证超级管理员密码错误 domain_exist: 已存在此域名 add_error: 添加域名出错 ok: 成功添加域名二、

2、删除域名接口domain/webmail/api/delDomain.php?domain=abc. 要删除的域名，例如“abc.” domain_not_exist: 不存在此域名 del_error: 删除域名出错 成功删除域名三、添加用户接口domain/webmail/api/addUser.php?adminname=admin&mailbox=userabc.&password=11111&fullname=name&mailquota=100&filequota=50 adminname: 域管理员名称 域管理员MD5后的密码 mailbox: 要添加的全称，例如userabc.

3、 customdata: 自定义字段数据，如”10001” 此要设置的密码（新增）此要设置的密码（base64加密）。 fullname: 用户（如果为中文字符请使用UTF-8格式，并进行URL 编码） mailquota: 空间限额，单位为“M”，只能为数字 filequota: 网络文件柜空间限额，单位为“M”，只能为数字 域管理员验证错误 mailbox_exist: 已存在此 添加错误 数字: 成功添加返回用户id值四、获取用户信息接口使用名称调用（未开启自定义用户字段功能）：domain/webmail/api/userInfo.php?mailbox=userabc.使用自定义字段

4、调用：cfv=xxx 取得信息的全称，例如“userabc.” cfv: 自定义字段对应值，例如学号“100001” 自定义字段对应用户所在的域名名称，例如“abc.” 正常情况下输出的信息为XML，其格式如下： user userabc.name!CDATA用户/namepassword用户密码custom_valueCDATA自定义用户字段对应值/custom_value/user出现错误的时候输出容为字符串，输出类型及其含义如下： mailbox_not_exist: 不存在此五、搜索用户接口domain/webmail/api/searchUser.php?domain=test.&k

5、eyword=user 要搜索用户的域 keyword: 搜索关键字，为UTF-8编码，需进行URL Encode转换。系统会根据此关键字对名、用户名、自定义用户字段进行查询。userlist 123 六、修改用户接口domain/webmail/api/updateUser.php? 要修改的全称，例如“userabc.” 如修改此密码请使用此参数（新增）如修改此密码请使用此参数（base64加密）。 如修改用户请使用此参数（如果为中文字符请使用UTF-8格式，并进行URL 编码） 如修改空间限额请使用此参数，单位为“M”，只能为数字 如修改网络文件柜空间限额请使用此参数，单位为“M”，只能

6、为数字 dept_old:原部门id dept_new:新部门id。如果dept_old和dept_new都存在，则是将原部门删除，添加新部门，即修改部门如果存在dept_old，dept_new=0，则表示删除原部门。如果存在dept_new，dept_old=0，则表示添加新部门。如果两个都不存在，无操作。 status：状态,1启用，-1禁用 intra_only只允许网登陆，1为是，-1为否 english_name英文名 order_no权重，数字越大越靠前显示 sex ：性别，1为男，2为女position职位worknum工号birthday出生日期，格式为2012-01-01m

7、obile手机telextnum分机号groupnum集团号qqmsnqq/msn is_hidden不在企业通讯录中显示，1为是，-1为否 memo备注 update_error: 更新错误 成功更新七、删除用户接口domain/webmail/api/delUser.php? 要删除的全称，例如“userabc.” 删除错误八、获取别名接口domain/webmail/api/alias.php?act=get 要查看别名的全称，例如“userabc.” act: 操作类型，获取别名时为“get”出错时的输出容： 参数错误正常时输出的容为XML格式，其格式如下：rootitemalias1

8、abc.alias2abc.九、获取部门列表接口domain/webmail/api/getDept.php?adminpass=xxx 要获取部门列表的域名department_listdepartmentparent_id-1CDATA部门名称tel1234567fax7654321linkmanCDATA三/linkmanmanagerCDATA四/managertesttest.CDATA联系地址/address/department/department_list “department”段结构说明： id: 部门ID parent_id: 上级部门ID，如果为“-1”则表示无上级部

9、门 name: 部门名称 tel: 部门 fax: 部门传真 linkman: 联系人名称 manager: 负责人名称 email: 地址 address: 联系地址十、添加部门接口domain/webmail/api/addDept.php?dept_name=部门名称&parent_id=-1&tel=123456&fax=654321&linkname=三&manager=四&email=testtest.&address=通信地址 要添加部门的域名 （必填） 域管理员名称（必填） 域管理员MD5后的密码（必填） dept_name: 部门名称（必填）（如果为中文字符请使用UTF-8格

10、式，并进行url编码） 上级部门ID，如无上级部门则需填写为“-1” （必填） 联系人名称（如果为中文字符请使用UTF-8格式，并进行url编码） 负责人名称（如果为中文字符请使用UTF-8格式，并进行url编码） 联系地址（如果为中文字符请使用UTF-8格式，并进行url编码） 添加部门错误 添加部门成功十一、修改部门接口domain/webmail/api/updateDept.php?dept_id=12345&dept_name=DepartmentName& 要更新部门信息的域名（必填） dept_id: 部门ID（必填） department_not_exist: 不存在指定部门

11、修改部门信息出错 修改部门信息成功十二、删除部门接口domain/webmail/api/delDept.php?dept_id=1234 要删除部门的域名 要删除的部门ID existing_child: 存在下级部门，需要先删除下级部门后才能删除此部门 删除部门出错 删除部门成功十三、获取部门成员接口domain/webmail/api/getDeptMember.php? 要取得部门成员的域名 要获取成员的部门IDmember_listmemberfullname/fullname/member/member_list “member”段结构说明： 用户地址 用户名称十四、添加部门成员接

12、口domain/webmail/api/addDeptMember.php?dept_id=1234&user_id=4321 要添加部门成员的域名 要添加成员的部门ID user_id: 要添加的成员ID user_not_exist: 不存在指定用户 添加部门成员出错 添加成功十五、删除部门成员接口domain/webmail/api/delDeptMember.php? 要删除部门成员的域名 要删除成员的部门ID 要删除的成员ID 删除部门成员出错 删除成功十六、添加别名接口act=add&alias=aliasabc. 要添加别名的全称，例如“userabc.” 操作类型，添加别名时为“add” alias: 要添加的别名 error: 添加别名时发生错误 添加别名成功十七、修改别名接口act=edit&alias=aliasabc.&alias_new=alias-newabc. 要修改别名的全称，例如“userabc.” 操作类型，修改别名时为“edit” 要修改的旧别名（如果为中文字符请使用UTF-8格式，并进行url编码） alias_new: 要修改的新别名（如果为中文字符请使用UTF-8格式，并进行url编码） 修改别名时发生错误 修改别名成功十八、删除别名接口act=del&需要以G