Http api

来自恩布企业IM,协作平台文档
跳转至: 导航搜索


恩布HTTP REST API开发手册

目录

概述

支持开发环境

  • 标准HTTP[S]协议
  1. 支持所有标准HTTP[S]协议环境;
  2. 支持HTTP GET和HTTP POST二种访问方式;
  3. HTTP GET:使用key=value&…格式参数,放在URL后面;
  4. HTTP POST:使用key=value&…格式参数,放在HTTP包体后面;
  5. 返回JSON格式内容。

接口描述

使用HTTP[S] GET接口

HTTP GET是浏览器地址栏输入回车访问方式,参数KEY=VALUE格式,放在URL后面;

访问格式

http://ip/rest.v03.ebweblc.xxx?key=value&...

成功调用,返回JSON格式内容;

调用例子:

http://test-lc.entboost.com/rest.v03.ebweblc.authappid?app_id=278573612783&app_password=ec1b9c69094db40d9ada80d657e08cc6

成功返回例子:

{"code":"0","app_online_key":"05423213962293421d957b34668c1ff9010e53186f4974b0"}

使用HTTP[S] POST接口

HTTP POST类似HTML表单提交访问方式,放在HTTP包体后面;

成功调用,返回JSON格式内容;

访问格式例子参见HTTP GET接口。

字符编码说明

输入输出参数统一都为UTF-8编码,部分接口返回中文使用UNICODE编码;

相关接口、前置接口说明

前置接口:表示需要先调用前置接口成功后,才能调用当前接口;

相关接口:表示跟当前接口相关或功能相似;

接口使用流程

用户登录流程

使用用户名密码登录1(支持集群模式)

默认用户登录流程,支持集群模式;

ENTBOOST SDK API REST V03 02 565.png

使用用户名密码登录2(单服务器模式)

跟[登录1]功能完全一样。

ENTBOOST SDK API REST V03 03 565.png

集成应用单点登录

主要用于客户端访问应用入口,跳转WEB应用做验证和登录:

ENTBOOST SDK API REST V03 04 565.png

接收发送聊天消息流程

接收离线消息

接收离线消息,登录成功后,跑下面流程:

ENTBOOST SDK API REST V03 05 518.png

发送聊天消息

发送聊天消息,登录成功后,跑下面流程,一对一会话使用callaccount,群组聊天,使用callgroup:

ENTBOOST SDK API REST V03 06 518.png

新建用户帐号流程

注册个人用户(同步个人用户)

ENTBOOST SDK API REST V03 07 400.png

注册企业用户(运营平台适用)

ENTBOOST SDK API REST V03 08 389.png

企业组织结构管理流程

新建部门、修改部门资料

使用系统管理员帐号登录;

ENTBOOST SDK API REST V03 09 436.png

删除部门

使用系统管理员帐号登录;

ENTBOOST SDK API REST V03 10 436.png

新建部门员工、修改员工资料

使用系统管理员帐号登录;

ENTBOOST SDK API REST V03 11 445.png

删除部门员工

使用系统管理员帐号登录;

ENTBOOST SDK API REST V03 12 445.png

数据同步、消息推送等流程

概述

该接口免费版本不支持,仔细请咨询在线咨询恩布客服:点击联系

同步修改用户密码

同步修改用户密码,必须使用超级应用APP,如:278573612918,详细登录恩布管理后台查询,或在线咨询恩布客服:点击联系

ENTBOOST SDK API REST V03 13 225.png

同步修改用户资料

同步修改用户资料,必须使用服务端应用APP,如:278573612918,详细登录恩布管理后台查询,或在线咨询恩布客服:点击联系

ENTBOOST SDK API REST V03 14 225.png

推送广播消息

推送广播消息,必须使用服务端应用APP,如:278573612918,详细登录恩布管理后台查询,或在线咨询恩布客服:点击联系

ENTBOOST SDK API REST V03 15 225.png

登录验证

概述

登录验证,建议使用:

https://加密安全连接模式;

查询接口

ebweblc.queryuser

查询用户请求,支持用户登录查询,查询用户信息、在线状态(code=7离线状态)等;

输入参数 默认值(非空) 描述
app_id   应用ID
app_online_key   应用在线KEY
query_type 0 查询类型
1:用户注册查询(代替ebweblc.regreq
2:用户登录查询
3:用户聊天查询
6:用户信息查询
sub_type 0 查询子类型
登录查询时,输入logon_type
account   帐号,支持UID,邮箱和手机号码等帐号

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
account   用户帐号
account_type   帐号类型
0:默认IM帐号;1:邮箱帐号;
user_id   [用户登录(信息)查询]用户ID
register_server   [用户注册查询]注册服务器
register_server_ssl   [用户注册查询]注册服务器(HTTPS访问)

ebweblc.querysysinfo

查询系统信息;

输入参数 默认值(非空) 描述
     

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
forget_password_url   忘记密码URL地址
register_url   用户注册URL
account_prefix   帐号前缀
product_name   产品名称
logo_url   产品LOGO URL地址
open_register   是否开放注册权限
0:不开放注册
1:注册个人
2:注册企业
3:注册所有
open_visitor   是否开放游客登录 0/1
auth_mode   密码验证方式
server_list   登录服务器列表
实现集群及负载均衡等,数组如下:
[子元素]server   登录服务器,格式:IP:PORT

验证登录接口

ebweblc.authappid

验证开发者APPID和APPKEY,验证成功会返回app_online_key和服务器列表server_list,通过server_list实现集群和负载均衡功能,默认情况下连接server_list数组第一个服务器,调用ebwebum.logon登录。

用户开发某些APP应用,部分接口需要app_id和验证成功app_online_key才能正常访问,具体请看接口说明,或联系恩布技术支持。

APPID和APPKEY可以使用系统管理员帐号,登录恩布管理后台,添加;APPID分以下二种类型:

  • 第1种:客户端应用APP,主要用于IM用户登录等;

例如客户端应用APP:

APPID=278573612908

APPKEY=ec1b9c69094db40d9ada80d657e08cc6

MD5(278573612908ec1b9c69094db40d9ada80d657e08cc6)=b20eefef8e2dbc73ad71a1ec76213902

  • 第2种:服务器应用APP,主要用于数据同步,应用集成等管理;
输入参数 默认值(非空) 描述
app_id   开发者APP ID
app_password   开发者验证密码,32位小写
=md5([appid][appkey])

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
app_online_key   应用ID在线KEY
app_server 可选 [服务端应用]APP登录服务器
app_server_ssl 可选 [服务端应用]APP登录服务器(HTTPS访问)
deploy_id   服务器部署唯一编号
server_list   服务器列表
实现集群及负载均衡等,数组如下:
[子元素]server   登录服务器,格式:IP:PORT
[子元素]server_ssl   登录服务器,格式:IP:PORT(HTTPS访问)

ebweblc.oauth

验证用户帐号;

  • user_id和password不为空,验证用户ID密码,是否正确;
  • user_id和oauth_key不为空,用户登录;
  • 其他情况,请求开放验证;
输入参数 默认值(非空) 描述
user_id 可选 用户ID
account 可选 用户帐号
password 可选 帐号密码
oauth_key 可选 客户端唯一识别验证KEY

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
oauth_url   [开放验证]开放验证登录URL
user_id   [用户登录]用户ID
logon_type   [用户登录]登录类型
logon_server   [用户登录]登录服务器
logon_server_ssl   [用户登录]登录服务器(HTTPS访问)
account   [用户登录]用户帐号
user_online_key   [用户登录]用户在线KEY
acm_key   [用户登录]用户管理KEY
user_name   [用户登录]用户名称
description   [用户登录]备注信息
user_setting   [用户登录]个人设置
default_member_code   [用户登录]个人默认群组成员代码

ebweblc.authaccount

登录验证;用户UID参数,可以通过ebweblc.queryuser接口,用户登录查询获取;

该接口用于验证用户帐号,调用成功后,需要调用ebwebum.setlinestate登记上线,完成登录流程;

建议使用ebwebum.logon接口登录。

输入参数 默认值(非空) 描述
oauth_request_code 可选 开放验证登录请求码
user_id   用户帐号(1.12新版本参数
password   帐号密码,32位小写
恩布默认验证方式=md5([UID][密码])
MD5密码=md5(passswd)
logon_type   登录类型,详见附录;
可以使用WEB或SERVER类型,不能使用PC、IOS、ANDROID和WP登录类型;
使用SERVER类型,不处理IM业务;

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
logon_type   [用户登录]登录类型
用于ebwebum.setlinestate
logon_server   [用户登录]登录服务器
logon_server_ssl   [用户登录]登录服务器(于HTTPS)
user_id   [用户登录]用户ID
account   [用户登录]用户帐号
user_online_key   [用户登录]用户在线密钥
acm_key   [用户登录]用户管理密钥
user_name   [用户登录]用户名称
description   [用户登录]备注信息
user_setting   [用户登录]个人设置
default_member_code   [用户登录]个人默认群组成员代码
default_head_url 可选 [用户登录]个人默认头像URL
default_head_url_ssl 可选 [用户登录]个人默认头像URL(HTTPS地址)
gender   [用户登录]性别
birthday   [用户登录]生日
tel   [用户登录]电话
mobile   [用户登录]手机
email   [用户登录]邮箱
user_url   [用户登录]个人首页
address   [用户登录]地址
zip_code   [用户登录]邮编
area1_code   [用户登录]用户地区1代码
area1_name   [用户登录]用户地区1名称
area2_code   [用户登录]用户地区2代码
area2_name   [用户登录]用户地区2名称
area3_code   [用户登录]用户地区3代码
area3_name   [用户登录]用户地区3名称
area4_code   [用户登录]用户地区4代码
area4_name   [用户登录]用户地区4名称

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.setlinestate 相关接口 登记用户上线,修改在线状态

验证密码接口

ebweblc.regauth

验证新注册帐号;auth_keyuser_id+register_code二选一;

输入参数 默认值(非空) 描述
auth_key 可选1 注册验证KEY
user_id 可选2-a 用户ID
register_code 可选2-b 注册代码
reset_password 可选 重设密码;
空不重设密码;
=MD5([UID][重设新密码])
auth_only 可选,默认:0 1:只查询,不验证
2:注册验证

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

ebweblc.findpwd

请求找回密码,如果后台配置邮件发送,调用成功用户邮箱会收到一条重设密码邮件,邮件带串32位加密字符串,用于找回密码key使用;邮件30分钟内有效;

**必须使用超级管理APPID;

输入参数 默认值(非空) 描述
app_id   应用ID,需要超级APPID
app_online_key   应用在线KEY
account 可选 用户帐号,支持邮箱,UID和手机等帐号

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
user_id   [成功]返回用户ID;
account   [成功]返回用户帐号
find_password_key   [成功]返回key,可以用于ebweblc.resetpwd修改密码使用;

ebweblc.resetpwd

请求找回密码或重设密码;

找回密码KEY(key)、修改指定帐号密码(account、cur_pwd)二选一;

account支持以下各种不同帐号格式:

xx@xxx邮箱帐号、1开头11位数字手机号码帐号,900xxx*ext客服号码帐号和用户数字ID帐号;

输入参数 默认值(非空) 描述
app_id   应用ID,需要超级APPID
app_online_key   应用在线KEY
find_password_key 可选1 找回密码KEY
user_id 可选2-1 指定修改密码UID(1.12新版本参数
current_password 可选2-2 指定帐号旧密码
=MD5([UID][用户当前密码])
reset_password 可选 重设密码;
空只验证,不重设密码;
=MD5([UID][用户重设新密码])
password_salt 可选 密码盐

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

管理接口

登录状态管理接口

ebwebum.logon

用户登录,游客登录;

输入参数 默认值(非空) 描述
eb_sid 可选 3.0以上 EB Session ID
登录成功返回该参数,重新登录用
logon_type   登录类型,详见附录;
可以使用WEB或SERVER类型,不能使用PC、IOS、ANDROID和WP登录类型;
使用SERVER类型,不处理IM业务;
使用EB_LOGON_TYPE_VISITOR实现游客登录;
account   帐号,支持用户ID,用户帐号或手机帐号


password   帐号密码,32位小写
恩布默认验证方式=md5([UID][密码])
MD5密码=md5(passswd)
us_data 可选 用户自定义数据,最长150字节
line_state 可选 在线状态,不填写,默认在线
acm_key 可选 用户资源管理在线KEY
由logonaccount成功返回管理应用功能图标需要填写;
oauth_request_code 可选 开放验证登录请求码
call_key 可选 来源KEY
实现企业登录限制

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
eb_sid   [成功]2.0以上EBSessionID
enterprise_code   [成功]默认企业编号
>0企业员工
=0个人用户
my_group_info_ver   [成功]个人群组资料数据版本号
enterprise_department_info_ver   [成功]企业部门资料数据版本号
user_online_key   [成功]用户在线KEY
acm_key   [成功]用户管理KEY
logon_type   [用户登录]用户登录类型
user_id   [用户登录]用户ID
account   [用户登录]用户帐号
user_name   [用户登录]用户名称
description   [用户登录]备注信息
user_setting   [用户登录]个人设置
default_member_code   [用户登录]个人默认群组成员代码
default_head_url 可选 [用户登录]个人默认头像URL
default_head_url_ssl 可选 [用户登录]个人默认头像URL(HTTPS地址)
gender   [用户登录]性别
birthday   [用户登录]生日
tel   [用户登录]电话
mobile   [用户登录]手机
email   [用户登录]邮箱
user_url   [用户登录]个人首页
address   [用户登录]地址
zip_code   [用户登录]邮编
area1_code   [用户登录]用户地区1代码
area1_name   [用户登录]用户地区1名称
area2_code   [用户登录]用户地区2代码
area2_name   [用户登录]用户地区2名称
area3_code   [用户登录]用户地区3代码
area3_name   [用户登录]用户地区3名称
area4_code   [用户登录]用户地区4代码
area4_name   [用户登录]用户地区4名称

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.holdconnect 相关接口 保持连接,获取消息数据
ebwebum.logout 相关接口 用户登出
ebwebum.setlinestate 相关接口 登记用户上线,修改在线状态

ebwebum.logout

用户下线;

输入参数 默认值(非空) 描述
eb_sid   2.0以上EB Session ID
user_id   用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.setlinestate

登记在线状态、更新个人在线状态;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
logon_type   登录类型,详见附录;
由ebweblc.authaccount,ebwebum.logon
和ebwebum.fauth成功返回;
user_id   用户ID
user_online_key   验证成功在线KEY
由logonvistor或logonaccount成功返回;
us_data 可选 用户自定义数据,最长150字节
line_state 可选 在线状态,不填写,默认在线


acm_key 可选 用户资源管理在线KEY
由logonaccount成功返回管理应用功能图标需要填写;

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
eb_sid   [成功]2.0以上EBSessionID
enterprise_code   [成功]默认企业编号
>0企业员工
=0个人用户
my_group_info_ver   [成功]个人群组资料数据版本号
enterprise_department_info_ver   [成功]企业部门资料数据版本号
user_online_key   [成功]用户在线KEY
acm_key   [成功]用户管理KEY

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.fauth 前置接口2 帐号验证
ebweblc.authaccount 前置接口3 帐号验证
ebwebum.holdconnect 相关接口 保持连接,获取消息数据
ebwebum.logout 相关接口 用户登出

ebwebum.loadols

加载群组或用户在线状态,group_code和accounts二选一;

group_code只加载在线用户,不会加载离线用户信息;

accounts支持同时加载多个用户,使用account1,account2,…格式,只支持UID帐号查询;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
group_id   [可选]要加载群组ID
accounts   [可选]要加载用户帐号
entgroup_ols   [可选]加载所有企业部门在线人数
mygroup_ols   [可选]加载所有个人群组在线人数
group_ols_gid   [可选]加载指定群组(或部门)在线人数,支持小写逗号","分隔
contact_ols   [可选]用于加载联系人在线状态0/1
0=不加载(默认)
1=加载所有联系人在线状态

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
group_id   [成功]要加载群组ID
size   [成功]成员数量
user_ols   成员数组,详细看下面
user_id   用户ID
line_state   在线状态

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

好友联系人管理接口

ebwebum.loadug

加载好友联系人分组信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
ugs   分组信息数组,结构如下:
ug_id   分组编号
name   分组名称

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.editug

增加分组或修改分组名称;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
ug_id   分组编号,不填写空或0表示增加分组
name   分组名称

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
ug_id   分组编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.deleteug

删除一个分组信息,该分组下面好友联系人自动移到默认分组;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
ug_id   分组编号,不能为空或0

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
ug_id   分组编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.loadcontact

加载个人联系人资料;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
only_con_id 0 [可选]只加载指定好友联系人编号信息
默认0=加载所有
only_con_uid 0 [可选]只加载指定好友联系人用户ID信息
默认0=加载所有
load_flag 0 [可选]查询加载标识
默认0=加载所有;
0x1=只加载con_uid>0;
0x2=只加载con_uid=0数据;
0x4=只加载联系人头像信息;

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
contacts   联系人信息数组,结构如下:
contact_id   联系人编号
contact_user_id   联系人用户ID
contact_type   联系人类型,详见附录;
contact   联系人帐号
ug_id   分组ID
group   分组名称
name   联系人名称
phone   手机号码
email   邮箱
address   地址
description   描述信息
company   公司名称
job_title   职位
tel   电话
fax   传真
contact_url   网址
line_state   在线状态,详见附录;
load_flag   查询加载标识返回;
head_ver   头像资源版本号
head_url   头像URL
head_url_ssl   [HTTPS]访问头像URL

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.editcontact

编辑个人联系人资料,contact_user_id和contact二个参数,必须至少填写一个;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
contact_user_id   联系人用户ID(跟contact二选一)
contact   联系人帐号(跟contact_user_id二选一)
ug_id   好友分组ID
name   联系人名称
phone   手机号码
email   邮箱
address   地址
description   描述信息
company   公司名称
job_title   职位
tel   电话
fax   传真
contact_url   网址

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.deletecontact

删除个人联系人资料,contact_id和contact_user_id二个至少填写一个参数;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
contact_id 可选 联系人ID
contact_user_id 可选 联系人用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

组织结构管理接口

概述

个人群组、讨论组、部门和项目组,使用相同数据结构,统一使用group_X参数,通过group_type类型进行区分,例如group_id代表群组ID,也代表部门ID,group_name代表群组名称,也代表部门名称,其他同。

以下描述"群"表示"个人群组"、"讨论组"、"部门"或"项目组"之一。

ebwebum.loadorg

企业员工:加载企业组织结构,头像、表情等;

超过2000人员工,需要分批加载企业组织结构;就是先加载部门结构,再根据部门group_id分批加载部门成员。

注册用户:加载固定群组信息,头像、表情等;

游客用户:加载头像,表情资源等;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
group_id 0 [可选]只加载某个群组(部门)信息


>0&&load_enterprise_department=1&&
load_my_group=1返回群组(部门)资料

load_enterprise_department 1 [可选]是否加载企业部门信息 0/1
load_my_group 1 [可选]是否加载个人群组信息 0/1
load_member 1 [可选]是否加载成员信息 0/1
load_image 1 [可选]是否默认表情资源,头像信息 0/1

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
enterprise_info   公司信息,结构如下:
enterprise_code   企业代码
enterprise_name   企业名称
description   描述信息
phone   联系电话
fax   传真
email   邮箱
enterprise_url   网址
address   地址
create_time   注册时间
create_user_id   注册人UID
enterprise_ext   企业扩展数据,详见附录。
groups   群(部门、群组、讨论组)结构数组;
结构如下:
enterprise_code   企业代码,空为个人群组,讨论组
group_id   群ID(部门ID)
group_name   群名称(部门名称)
parent_id   上级ID(上级部门ID)
description   群描述,(公告)
phone   联系电话
fax   传真
email   邮箱
group_url   网址
address   地址
create_time   创建时间
create_user_id   创建人UID
manager_user_id   部门经理(或项目经理)用户ID
group_type   群类型,详见附录
my_member_code   我的成员编号
>0表示我属于该群
=0我不属于该群
member_count   成员数量
group_version   部门版本编号,用于数据同步
ext_data   群组/部门扩展数据
0x1=禁言群组,只有创建者,经理和管理员权限成员才可发言;
members   群成员(部门员工)结构数组;
结构如下:
group_id   群ID
member_user_id   成员用户ID
member_code   成员代码
member_account   成员帐号
user_name   用户名称
job_title   职位
job_position   岗位
phone   手机号码
fax   传真
tel   电话
email   邮箱
address   地址
description   个人描述
gender   性别,0未设置;1男;2女
birthday   生日,格式:YYYYMMDD
line_state   当前在线状态,详见附录
head_file_url   头像文件URL
manager_level   成员管理权限
forbid_minutes   禁言分钟数,配合manager_level&0x1000有效
-1解除禁言
0永久禁言
>0禁言分钟数
display_index   显示排序(高排上面或前面)
emotions   头像表情结构数组;
结构如下:
resource_id   资源ID
resource_url   资源URL
resource_url_ssl   资源URL(用于HTTPS访问)
resource_type   资源类型;3头像;6表情
description   头像表情描述
display_index   显示排序
type   类别,默认0
cm_service_id   CM服务ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.loadinfo

加载离线信息,离线信息通过hb长轮询连接返回;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.editent

编辑企业资料信息;

支持GET和POST方法,建议使用POST方法;

**属于管理员权限

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
enterprise_code   企业代码
phone   电话
fax   传真
email   邮箱
enterprise_url   公司网站
address   公司地址
description   描述备注
enterprise_ext 0 企业扩展数据,详见附录。

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.editgroup

新建或编辑部门(或个人群组)资料信息;

支持GET和POST方法,建议使用POST方法;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
enterprise_code   企业代码
group_id   部门(群组)ID,空为新建
parent_id 可选 上级部门(群组)ID,新建空为根部门
group_name 可选 部门(群组)名称,新建不能为空
group_type 可选 群组类型:(新建有效)
0:企业部门(enterprise_code>0有效)
1:企业项目组(enterprise_code>0有效)
2:个人群组(enterprise_code=0有效)
phone 可选 电话
fax 可选 传真
email 可选 邮箱
group_url 可选 群组(部门)URL
address 可选 地址
description 可选 描述备注
manager_uid 可选 部门经理用户ID
display_index 可选 显示排序,高排前面,或上面
forbid_minutes 可选 禁言操作,不填写不处理
-1:解除禁言
0:永久禁言
>0:保留用于以后实现按分钟数禁言

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
group_id   [成功]部门(群组)ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.deletegroup

删除部门(或个人群组);

非空企业部门,企业项目组和有下级部门不能删除;

删除个人群组,会删除群组下所有成员;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
group_id   部门(群组)ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.editmember

新建或编辑部门员工(或群组成员)资料信息;

支持GET和POST方法,建议使用POST方法;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
group_id   部门(群组)ID
member_code 可选 部门员工(或群组成员)代码
空为新建
member_account 可选 员工(成员)帐号,邮箱格式
user_name 可选 用户名称
gender 可选 性别;0=未设置;1=男;2=女
birthday 可选 生日;格式:YYYYmmDD
job_title 可选 职务;如软件工程师
job_position 可选 岗位;整数,默认0
cell_phone 可选 手机号码
fax 可选 传真
work_phone 可选 办公电话
email 可选 邮箱
address 可选 住址
display_index 可选 显示排序,高排前面,或上面
description   描述备注
manager_level 可选 权限
0x0:没有权限(普通员工)
0x3d=61:群组(部门)管理员权限
0x1000=4096被禁言(下行数据有效)
forbid_minutes 可选 禁言操作, 不填写不处理
-1:解除禁言
0:永久禁言
>0:禁言分钟数
password 可选 成员密码,新建帐号有效;
默认为空;使用系统配置默认密码;
encode_password 可选 密码是否已经加密 0/1
0:密码未加密,需要加密
1:密码已经加密,直接保存
app_id 可选 应用ID
用于标识新建用户同步密码使用;
app_online_key 可选 应用在线KEY,同上;

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
member_code   [成功]部门员工(群组成员)代码
member_user_id   [成功]员工用户ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID

ebwebum.deletemember

删除部门员工(或群组成员)资料信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
member_code   [可选]部门员工(或群组成员)代码
不填写,使用group_id,member_account二个参数;
delete_account 1 删除帐号信息 0/1
0:不删除帐号信息
1:删除帐号信息
group_id   [可选]群组(部门)ID
member_account   [可选]成员帐号,支持UID、手机号码和用户帐号

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

呼叫会话接口

ebwebum.callaccount

发起聊天请求,呼叫用户to_account(帐号)和to_member_code(成员ID)二选一必填。

请求成功,通过ebwebum.holdconnect长连接返回聊天会话信息。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
to_account 可选 呼叫对方帐号
支持帐号,用户ID,手机号码帐号
to_member_code 可选 呼叫对方成员代码
exist_call_id 可选 邀请对方进入现存会话ID
空为新会话;
call_key 可选 呼叫来源KEY
实现企业呼叫限制

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.callgroup

发起部门(群组)聊天请求,请求成功,通过ebwebum.holdconnect长连接返回聊天会话信息。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
group_id   部门(群组)ID
call_key 可选 呼叫来源KEY
实现企业呼叫限制

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.callack

响应呼叫,授受或拒绝聊天请求,接受聊天请求成功,通过ebwebum.holdconnect长连接返回聊天会话接通事件。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
call_id   呼叫ID
ack_type 1 响应类型:
1:接受聊天请求
2:拒绝聊天请求

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.hangup

挂断或退出聊天会话。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
call_id   呼叫ID
hangup 0 是否挂断会话:
0:退出会话
1:挂断会话

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

消息管理接口

ebwebum.msgack

响应确认收到一条消息,用于删除消息,接收消息请求(如申请好友验证)或拒绝消息请求。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
msg_id   消息ID
ack_type 0 响应类型:
1:接受消息请求
2:拒绝消息请求
5:删除消息

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

保持连接接口

ebwebum.holdconnect

ebwebum.logon登录成功后,调用该接口保持连接,同时查询最新数据;

查询到数据,立即返回,查询不到数据,保持30秒左右时间返回超时,客户端需要重复调用该接口,保持当前用户连接状态;

服务端超过5分钟没有收到保持连接请求,会临时设置用户为离线状态,24小时内,eb_sid重新请求用户业务接口有效,用户重新上线,eb_sid超过24小时无效,用户需要重新登录,验证帐号密码;

使用SERVER登录类型,不处理IM业务,直接返回;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
notification_type   消息类型:详见附录
error   [错误]错误描述
call_info   [会话]会话结构信息

call_info结构;

参数 默认值(非空) 描述
call_id   呼叫编号
from_account   对方帐号
from_user_id   对方用户ID
group_id   群组(部门)ID
chat_server   [会话连接]聊天服务器
chat_server_ssl 可选 [会话连接]聊天服务器(HTTPS访问)
chat_id   [会话连接]聊天编号
用于ebwebcm.chatenter
chat_key   [会话连接]聊天密钥
offline_user   [会话连接]是否离线用户 0/1

funcs数组;

参数 默认值(非空) 描述
subscribe_id   订购ID
function_name   应用名称
function_mode   应用模式
display_index   显示排序(高排前面或上面)
function_url   应用URL链接
icon_url   应用显示图标URL链接

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

用户管理接口

ebwebum.reguser

注册新用户,或者注册企业用户,或者请求重发注册验证邮件。

输入参数 默认值(非空) 描述
app_id   应用ID
app_online_key   应用在线KEY
account   用户帐号,支持全数字用户ID,手机号码,邮箱帐号等所有帐号类型
resend_register_mail 0 重发注册验证邮件 0/1
0:普通注册功能
1:请求重发注册验证邮件
user_name 可选 用户名称
password 可选 用户密码
password_salt 可选 密码盐
encode_password 0 密码是否已经加密 0/1
0:密码未加密,需要加密
1:密码已经加密,直接保存
enterprise_name 可选 企业名称
填写:注册企业用户
不填写:注册个人用户
user_ext 可选 用户扩展信息
gender 可选 性别
birthday 可选 生日;格式:YYYYmmdd,例如:19791122
address 可选 地址
auto_add_group 1 注册用户,自动加群 0/1 默认1添加
群组ID由管理后台配置,没有配置不加

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
user_id   [成功]用户ID
register_code   [成功]注册验证码

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID

ebwebum.mgraccount

管理帐号,包括重置默认密码,冻结帐号等。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
mgr_user_id   被管理用户ID
mgr_type   管理操作类型
1:重置默认密码
2:临时冻结帐号
3:启用帐号(包括冻结和未通过验证)
4:删除帐号(包括帐号所有数据)
mgr_value   [可选]管理扩展数据

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.sinfo

修改用户个人资料,不填写参数不修改;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
user_name 可选 用户名称
description 可选 备注
user_setting 可选 个人设置
default_member_code 可选 默认群组成员编号
area1_code 可选 国家或地区代码(通过ebwebum.loaddict接口获取,下同)
area2_code 可选 省份或地区代码
area3_code 可选 城市或地区代码
area4_code 可选 县或地区代码
address 可选 详细地址
user_url 可选 个人主页
gender 可选 性别,详见附录
tel 可选 联系电话
mobile 可选 手机号码
email 可选 邮箱地址
birthday 可选 生日;格式:YYYYmmDD,如19781025
phone 可选 手机号码登录帐号,唯一帐号,不能重复;
zip_code 可选 邮编
old_password 可选 旧密码,跟new_password配合,实现修改密码功能
恩布默认验证方式=md5([UID][PASSWD]
MD5密码=md5(passswd)
new_password 可选 新密码,同上

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.shead

修改用户部门员工或个人群组成员头像;《头像文件》使用HTTP POST上传。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
set_user_id 0 设置头像用户ID,默认不填0时,设置user_id个人头像,填写其他UID可用于管理员设置其他人头像;
group_id 0 [可选]部门或个人群组编号
《头像文件》   图片文件;使用HTML FORM上传头像文件

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口 验证应用ID

ebwebum.userquery

查询用户电子名片信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
query_account   要查询的帐号,支持UID,邮件格式帐号和手机帐号

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
user_id   [成功,电子名片]用户ID
account   [成功,电子名片]用户帐号
user_name   [成功,电子名片]用户名称
phone   [成功,电子名片]手机
tel   [成功,电子名片]联系电话
email   [成功,电子名片]电子邮箱
title   [成功,电子名片]部门职位
enterprise   [成功,电子名片]公司名称
address   [成功,电子名片]联系地址
head_file_url   [成功,电子名片]用户头像HTTP地址

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.searchuser

用户搜索,支持用户ID精确搜索,帐号和用户名称的模糊搜索,一次限制最大返回20条数据;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
search_key   搜索关键词

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
users   [成功]用户数组,详见下面内容;
member_code   [成功]群组成员ID
group_id   [成功]群组ID
member_user_id   [成功]成员用户ID
member_account   [成功]用户帐号
user_name   [成功]用户名称
job_title   [成功]职位
job_position   [成功]岗位
phone   [成功]手机
fax   [成功]传真
tel   [成功]联系电话
email   [成功]邮箱
address   [成功]地址
description   [成功]备注
gender   [成功]性别 0未设置;1男;2女
birthday   [成功]生日
line_state   [成功]在线状态
head_file_url   [成功]头像文件URL

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

ebwebum.getuserinfo

获取用户信息或资料;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
type 0 获取数据类型
1:获取用户默认头像
param1   参数1,配合type使用
type=1:用于获取头像的UID,支持逗号’,’分隔,获取多个
param2   参数2,配合type使用

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
user_infos   type=1获取头像返回,数组结构如下
user_id   参数输入用户UID
result   结果:
0:成功获取
1:头像用户UID不存在
2:头像用户是游客用户
3:头像用户没有设置默认头像
head_image_url   result=0成功获取返回头像URL

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

应用功能管理接口

ebwebum.fload

加载指定企业或应用ID应用功能列表;加载顺序:enterprise_code->owner_app_id->app_id

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id   指定要加载的应用ID,空为加载app_id
enterprise_code   企业编号,加载指定企业应用列表;
get_summary 0 是否获取摘要信息;0/1
offset -1 [可选]
>=0:指定加载数据;
-1:加载所有数据;
limit 1 [可选]配合offset一起使用
加载多少条,实现分布功能

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
funcs   应用功能信息数量,结构如下:
f_offset   应用功能索引:012…
app_id   应用ID
f_id   应用功能ID
description   备注信息
create_time   应用添加时间
location   应用功能显示位置,见附录;
f_name   应用功能名称
f_mode   应用功能模式,见附录;
f_url   应用功能URL
f_type   应用功能类型,由开发者自定义,用户访问时带回该参数;
width   窗口宽度,窗口模式应用有效
height   窗口高度,窗口模式应用有效
dis_contextmenu   屏蔽客户端页面右键菜单 0/1
dis_scrollbar   屏蔽客户端页面滚动条 0/1
close_prompt   关闭客户端页面提示 0/1
win_resizable   客户端页面窗口可调整 0/1
加载企业(enterprise_code>0)
应用,会增加返回以下内容
   
sub_id   订购ID
sub_level   订购等级
start_time   开始时间
end_time   结束时间,等于开始时间不限制
display_index   显示排序;高排前面,低排后面
sub_desc   订购备注信息
加载应用摘要信息    
enterprise_code   企业ID
f_count   总共多少条数据

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID

ebwebum.fedit

添加或修改应用功能信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id 0 应用功能ID,空为添加;
location 0 应用功能显示位置,见附录;
f_name   应用功能名称,不能为空
f_mode   应用功能应用模式,见附录;
f_param 1 应用功能参数:
0=没有参数;
1=使用默认恩布验证参数;
2=返

回uid&account参数;

f_url   应用功能URL,不能为空
dis_contextmenu 1 屏蔽客户端页面右键菜单 0/1
0=不屏蔽 1=屏蔽
dis_scrollbar 0 屏蔽客户端页面滚动条 0/1
0=不屏蔽 1=屏蔽
close_prompt 1 关闭客户端页面提示 0/1
0=不提示 1=提示关闭确认
win_resizable 1 客户端页面窗口可调整 0/1
0=不可调整 1=可调整大小(有最大化按钮)
f_type 0 应用功能类型,由开发者自定义,用户访问时带回该参数
width   [可选]窗口宽度,窗口模式应用有效
height   [可选]窗口高度,窗口模式应用有效
description   [可选]备注信息

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
value   [成功]应用功能ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fdel 相关接口 删除应用功能
ebwebum.fsub 相关接口 企业订购或取消应用功能

ebwebum.fseticon

设置应用功能图标,需要利用HTTP协议上传PNG图片文件;《图标文件》使用HTTP POST上传。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id 0 应用功能ID,空为添加;
《图标文件》   PNG图片文件;使用HTML FORM提交

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

ebwebum.fdel

删除应用功能信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id 0 应用功能ID,不能为空;

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fedit 相关接口 添加或编辑应用功能

ebwebum.fsub

企业(或个人)订购或取消一个应用功能信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
enterprise_code   企业编号,空为个人订购;
f_id   应用功能ID
cancel 0 取消订购应用0/1
0:正常订购;1取消订购
sub_level 0 订购等级,企业员工访问应用功能时返回
display_index 0 显示排序,相同位置高排前面,低排后面
start_time   订购开始时间,空为当前时间
格式:YYYY-mm-dd HH:MM:SS
end_time   订购结束时间,空等于start_time,不限制
格式:YYYY-mm-dd HH:MM:SS

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
sub_id   [成功]订购ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fedit 相关接口 添加或编辑应用功能

云盘资源管理接口

ebwebum.addresource

添加云盘资源信息,如云盘、附件等,type=5文件资源,需要调用ebwebcm.upload上传文件;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
parent_resource_id 0 上级目录资源ID,0存放根目录
name   资源名称,不能为空
type 5 资源类型
1:云笔记
4:目录资源
5:文件资源
flag 0 资源标识
0:正常(文档附件)
3:评论(评论附件)
from_id 0 来源ID(配合from_type使用)
from_type 0 来源类型:
1:企业资源
2:群组资源
3:个人云盘
11:计划附件(配合flag使用)
12:任务附件(同上)
13:报告附件(同上)
description   [可选]资源备注(说明)

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
resource_id   [成功]资源ID
cm_server   [成功]资源CM上传地址
cm_server_ssl   [成功]资源CM上传HTTPS地址

前置、相关接口说明:

接口名称 接口说明) 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebwebum.editresource 相关接口 修改资源
ebwebum.deleteresource 相关接口 删除资源
ebwebcm.upload 相关接口 上传资源文件

ebwebum.editresource

修改云盘资源信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
resource_id   资源ID,不能为空
parent_resource_id 可选 上级目录资源ID,用于移到指定目录
name 可选 资源名称
description 可选 资源备注(说明)

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebwebum.addresource 相关接口 添加资源
ebwebum.deleteresource 相关接口 删除资源

ebwebum.deleteresource

修改云盘资源信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
resource_id   资源ID,不能为空

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebwebum.addresource 相关接口 添加资源
ebwebum.editresource 相关接口 删除资源

ebwebum.getresource

获取资源,指定共享资源;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
resource_id   资源ID
to_share_uid 0 共享资源给对方UID,配合share_type使用
to_share_uid=user_id用于共享给自己
share_type 1 共享类型
0:不共享
1:临时共享(用户主动下线无效)

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
resources   云盘资源信息列表,结构如下:
create_user_id   资源创建用户ID
create_user_name   资源创建用户名称
resource_id   资源ID
parent_resource_id   上级资源ID(用于目录资源)
description   资源备注(或资源内容)
create_time   应用添加时间
type   资源类型(见ebwebum.addresource)
name   资源名称
flag   资源标识(见ebwebum.addresource)
size   资源大小
downloads   资源下载次数
index   资源排序 0,1,2,…
from_id   来源ID(配合from_type)
from_type   来源类型(见ebwebum.addresource)
share_url 可选 共享URL,资源下载URL
=[share_url]&acm_key=&logon_type=
share_url_ssl 可选 共享URL HTTPS(同上)
online_view_url 可选 在线浏览URL
支持Office,PDF,图片格式在线浏览
view_ext_type 可选 查看扩展类型
0:其他
1:PDF文档
2:图像文件
3:Office文档(包括word,excel等文档)

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebwebum.addresource 相关接口 添加云盘资源

ebwebum.loadresource

加载指定云盘资源列表,如个人云盘,计划附件等;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
from_id   来源ID,配合from_type使用
0=加载所有(与user_id相关的资源)
from_type   来源类型(见ebwebum.addresource)
flag -1 资源标识(见ebwebum.addresource)
type 0 资源类型(见ebwebum.addresource)
get_summary 0 是否获取摘要信息;0/1
offset -1 [可选]
>=0:指定加载数据;
-1:加载所有数据;
limit 30 [可选]配合offset一起使用
加载多少条,实现分页功能

返回协议;同ebwebum.getresource

ebwebum.loadresources

加载多个指定云盘资源列表,如个人云盘,计划附件等;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
get_summary 0 是否获取摘要信息;0/1
0:未支持
from_id[N]   来源ID,配合from_type使用
N=0,1,2,…,最大限制200(下同)
from_type[N]   来源类型(见ebwebum.addresource)
flag[N] -1 资源标识(见ebwebum.addresource)
type[N] 0 资源类型(见ebwebum.addresource)

get_summary=1返回协议;

输入参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
resources   云盘资源信息列表,结构如下:
code   查询返回状态,见附录
resource_count   资源统计数量

get_summary=0返回协议;(暂未支持)

应用导航管理接口

ebwebum.fnavload

加载指定应用ID导航信息列表;sub_id和f_id必须填一个,不能同时为空。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id   [服务器管理]应用ID
sub_id   [客户端访问]订购ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
navs   应用导航信息数量,结构如下:
f_id   应用功能ID
nav_id   应用导航ID
parent_navid   上一级应用导航ID,0为根导航
name   导航名称
url   导航URL
index   显示排序,高排上面,低排下面
type   导航类型
0=HTML网页
1=XML数据文件
2=打开外部程序路径
description   备注信息
create_time   添加时间

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fnavset 相关接口 添加、修改应用导航
ebwebum.fnavdel 相关接口 删除应用导航信息

ebwebum.fnavset

添加或修改应用导航信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id 0 应用功能ID,不能为空;
nav_id 0 应用导航ID,空为添加;
parent_navid 0 上一级应用导航ID,只支持二级导航菜单。
name   导航名称,不能为空
url   导航URL,不能为空
index 0 显示排序,高排上面,低排下面
type 0 导航类型
0=HTML网页
1=XML数据文件
2=打开外部程序路径
description   [可选]备注信息

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
nav_id   [成功]应用导航ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fnavdel 相关接口 删除应用导航
ebwebum.fnavload 相关接口 加载应用导航信息

ebwebum.fnavdel

删除应用导航信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
app_id   APP ID
app_online_key   APP online key
owner_app_id 0 指定要编辑的应用ID,空为编辑app_id
f_id 0 应用功能ID,不能为空;
nav_id 0 应用导航ID;
0=删除应用所有导航信息;
>0删除应用指定导航信息,包括子导航;

返回协议,JSON格式:

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
nav_id   [成功]应用导航ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态
ebweblc.authappid 前置接口3 验证应用ID
ebwebum.fnavset 相关接口 添加、修改应用导航
ebwebum.fnavload 相关接口 加载应用导航信息

应用功能访问

~ebwebum.freq

用户请求访问应用功能业务;

该接口需要验证用户登录状态,所以需要先做单点登录(如IM客户端),验证成功后,直接跳转到该协同功能指定业务URL地址。

(该接口由恩布协作平台客户端访问应用入口自动访问,第三方应用,不需要访问该入口。)

输入参数 默认值(非空) 描述
uid   用户ID
ok   用户单点登录在线KEY
sub_id   协同功能订购ID
fk   功能访问验证KEY
fk=md5([fk_v1]$UID;$ACM_KEY;$SUB_ID)
cid 0 [可选]会话ID
fuid 0 [可选]会话对方用户ID
facc   [可选]会话对方用户帐号
gid 0 [可选]群组ID
color   [可选]客户端主色调颜色;
格式:rrggbb,例如:ff0000(红色)

返回协议;验证成功,直接HTTP跳转到该业务指定URL。

参数 默认值(非空) 描述
302跳转URL,格式:
url?authid=&fk=&color=&ums=
   
authid   验证ID
fk   验证KEY
fk=md5([eb_fk_v1]authid;user_ip_address;appid)
color   [可选]客户端主色调颜色;
格式:rrggbb,例如:ff0000(红色)
ums   UM服务器地址

ebwebum.fauth

第三方应用,验证应用入口请求是否合法,验证成功返回应用入口用户信息及相关数据。

输入参数 默认值(非空) 描述
app_id   APP ID
app_online_key   APP online key
auth_id   请求验证ID
from_ip   [可选]用户IP地址;
默认不填写不验证用户IP,安全性并不高;
填写安全性会高一些,通过脚本开发语言的reqeust对象,取用户客户端IP地址,如192.168.1.200
logon_web 0 验证成功,是否同时登录WEB 0/1
0:不登录
1:登录WEB,返回user_online_key参数,用于ebwebum.setlinestate接口使用;
logon_type 0 [logon_web=1有效]登录类型,默认0使用 EB_LOGON_TYPE_SERVER=65536

返回协议;JSON格式

参数 默认值(非空) 描述
code   返回状态:见附录
auth_id   验证ID
user_id   用户ID
enterprise_code   企业ID
sub_id   订购ID
account   用户帐号
user_name   用户昵称
sub_level   订购等级
func_id   应用功能ID
func_type   应用功能类型
extension   扩展参数:
会话参数:
gid=[群组ID]&cid=[会话ID]&fuid=[对方用户ID]&fusid=[对方标识ID]
post_data   HTTP POST数据
主要用于保存聊天记录数据
user_online_key   用户登录WEB在线KEY
acm_key   用户登录WEB在线ACM KEY
logon_type   用户登录类型,用于ebwebum.setlinestate

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID
ebwebum.setlinestate 相关接口 登记用户上线,修改在线状态

字典管理接口

ebwebum.loaddict

加载字典(如地区)信息。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
dict_type   字典类型
1:通过地区代码加载子地区列表
2:通过地区代码加载地区信息
value   地区代码或其他,视dict_type而定。

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
areas   地区字典信息,结构如下:
code   地区代码
name   地区名称
digit   地区号(如广州:020,深圳:0755)

前置、相关接口说明:

接口名称 接口说明 功能
ebwebum.logon 前置接口1 用户登录
ebwebum.setlinestate 前置接口2 登记用户上线,修改在线状态

聊天消息

概述

聊天会话及消息管理接口;

聊天会话接口

ebwebcm.chatenter

进入聊天会话;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
logon_type   登录类型
user_id   用户ID
chat_id   聊天编号
chat_key   聊天密钥

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   聊天编号
eb_sid   [成功]2.0以上 EBSessionID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatexit 相关接口 退出聊天会话(退出消息推送会话)
ebwebcm.pushenter 相关接口 进入消息推送会话

ebwebcm.pushenter

初始化消息推送会话;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
app_online_key   应用在线KEY
通过ebweblc.authappid接口获取

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   [成功]聊天编号(消息推送服务编号)
eb_sid   [成功]2.0以上 EBSessionID

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID
ebwebcm.chatexit 相关接口 退出聊天会话(退出消息推送会话)
ebwebcm.chatenter 相关接口 进入聊天会话

ebwebcm.chatexit

退出聊天会话、退出消息推送会话;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
chat_id   聊天编号

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   聊天编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话
ebwebcm.pushenter 前置接口 进入消息推送会话

聊天消息接口

ebwebcm.sendtext

发送文本信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
chat_id   聊天编号
text   文本信息
to_user_id 可选 群组会话只发给某个UID,一对一会话免填
private 可选 群组会话,发私聊信息 0/1

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   聊天编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话
ebwebcm.pushenter 前置接口 进入消息推送会话

ebwebcm.sendrich

发送图文混排RICH信息;

该接口访问支持跟ebwebcm.sendtext相同HTTP GET参数,rich_info使用HTTP POST JSON提交;

也支持全部参数使用HTTP POST JSON参数提交,如:

// **

http://121.199.40.77:19012/rest.v03.ebwebcm.sendrich?{"user_id":"80","chat_id":"52FC574025310002","to_user_id":"888001","private":"0","rich_info":{"text":"a","res":"52DF34B0CD230002;cm-static1.entboost.com:18012;POPChatManager","text":"b"}}

或rich=JSON格式,如:

// ** http://121.199.40.77:19012/rest.v03.ebwebcm.sendrich?rich={"user_id":"80","chat_id":"52FC574025310002","to_user_id":"888001","private":"0","rich_info":{"text":"a","res":"52DF34B0CD230002;cm- static1.entboost.com:18012;POPChatManager","text":"b"}}

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
chat_id   聊天编号
to_user_id 可选 群组会话只发给某个UID,一对一会话免填
private 可选 群组会话,发私聊信息 0/1
rich_info   [会话]RICH信息结构数组

rich_info结构;

参数 默认值(非空) 描述
text   文本信息
res   表情信息;格式如下:
[resid];[server];[appname]

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   聊天编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话
ebwebcm.pushenter 前置接口 进入消息推送会话

ebwebcm.sendfile

发送图片、文件,《上传》使用HTTP POST提交文件到ebwebcm.sendfile接口;发送文件大小系统有限制,具体请咨询恩布技术客服。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
chat_id   聊天编号
《上传文件》   图片、文件;使用HTML FORM提交
to_user_id 可选 群组会话只发给某个UID,一对一会话免填
private 0 [可选]群组会话,发私聊信息 0/1
apply 0 [可选]是否申请发送文件0/1
1:申请发送文件(发送文件前调用一次)
0:发送文件
batch_number 可选 文件提交标识

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
chat_id   聊天编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话
ebwebcm.pushenter 前置接口 进入消息推送会话

ebwebcm.msgack

响应消息,包括请求接收文件消息、确认已经收到聊天消息等。

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID
chat_id   聊天编号
msg_id   消息ID
ack_type 0 响应消息;
0:确认成功收到聊天消息,不确认服务端会保存离线消息;
1:客户端发生错误(保留使用)
2:取消发送文件,或者拒绝接收文件
3:开始接收文件
10:把离线文件存入到我的云盘

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话
ebwebcm.sendfile 相关接口 发送文件

保持连接接口

ebwebcm.holdconnect

Ebwebcm.chatenter,ebwebcm.pushenter进入用户会话后,调用该接口保持连接,同时查询最新数据;查询到数据,立即返回,查询不到数据,保持30秒左右时间返回超时,客户端需要重复调用该接口,保持当前用户连接状态;

服务端超过2分钟没有收到保持连接请求,将会抛弃掉当前连接,用户会话通知退出会话事件给会话其他成员;

用户会话通过保持连接接口,实时接收会话的聊天信息;

输入参数 默认值(非空) 描述
eb_sid   2.0以上 EB Session ID
user_id   用户ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
notification_type   通知消息类型,详见附录
error   [错误]错误描述
chat_id 可选 聊天编号
from_user_id 可选 聊天信息发送帐号
from_account 可选 聊天信息发送UID
to_account 可选 聊天信息接收帐号
private 可选 [聊天信息]私聊
msg_id 可选 消息ID(用于ebwebcm.msgack接口)
rich_info   [会话]RICH信息结构数组

rich_info结构;

参数 默认值(非空) 描述
text   文本信息
image_url   表情或屏幕截图HTTP URL
image_url_ssl   表情或屏幕截图HTTP URL(HTTPS)
description [可选] 表情描述

文件上传成功,开始发送给会话成员sending消息事件参数;

参数 默认值(非空) 描述
batch_number   文件上传唯一标识,对应ebwebcm.sendfile指定参数
name   上传文件HTML表单name
file   上传成功,文件名称
该名称,可用于ebwebcm.res?file=参数
mime_type   文件类型Content-Type
msg_id   文件发送消息ID

用户成功接收文件,sended消息事件参数;

参数 默认值(非空) 描述
msg_id   文件发送消息ID
from_user_id   接收用户ID
chat_id   聊天编号

用户取消(拒绝)接收文件,cancel消息事件参数;

参数 默认值(非空) 描述
msg_id   文件发送消息ID
from_user_id   接收用户ID
chat_id   聊天编号

前置、相关接口说明:

接口名称 接口说明 功能
ebwebcm.chatenter 前置接口 进入聊天会话

资源管理

概述

主要包括表情、头像、聊天截图等;

图片文件管理接口

ebwebcm.res

加载(显示,或下载)在线资源(表情、头像或其他文件);resource_id、file二选一必填;

输入参数 默认值(非空) 描述
resource_id 可选 头像、表情资源编号
file 可选 资源文件名称

ebwebcm.upload

上传资源文件;

输入参数 默认值(非空) 描述
user_id   用户ID
logon_type   用户登录类型
acm_key   用户资源管理KEY,支持URL参数或cookie
resource_id   上传指定资源ID

返回协议;

输入参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

应用管理中心

概述

通过第三方应用中心,实现更多扩展功能。

管理接口

ebwebap.on

应用登记在线,成功上线,自动加载应用离线消息;

app_online_key由ebweblc.authappid登录成功获取;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
app_online_key   应用在线KEY
通过ebweblc.authappid接口获取

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
eb_sid   [成功]2.0以上 EBSessionID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.off 相关接口 应用下线

ebwebap.off

应用注销下线;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.on 前置接口 应用上线

ebwebap.msg

给某个APPID发送消息。

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
to_app_id   消息接收应用ID
user_id 0 用户ID
account "" 用户帐号
type 0 消息类型
name "" 消息名称
content "" 消息内容
off_save 1 是否保存应用离线信息;
1:保存离线信息
0:不保存离线信息

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
msg_id   [成功]消息ID

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.on 前置接口 应用上线

ebwebap.mack

响应某条接收消息。

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
msg_id   消息ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.on 前置接口 应用上线

保持连接

ebwebap.holdconnect

ebwebap.on应用上线后,保持连接,查询最新APP信息;

服务端超过3分钟没有收到心跳数据,将会抛弃掉当前连接;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID

返回协议;

参数 默认值(非空) 描述
code   返回状态:0成功,错误值见附录
msg   消息类型,详见附录
error   [错误]错误描述
msg_info结构   收到消息

msg_info结构;

参数 默认值(非空) 描述
from_app_id   消息来源应用ID
user_id 0 用户ID
account "" 用户帐号
type 0 消息类型
name "" 消息名称
content "" 消息内容
time "" 离线消息时间,空为当前时间

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.on 前置接口 应用上线

群发接口

ebwebap.sendbcmsg

发送广播消息,支持发送给个人,发送给群组(部门),或发送给整个企业员工;

发送对象顺序to_account->to_group_id->to_enterprise_code,三个参数同时有效,至少必需填写一个;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
app_online_key 可选 应用在线KEY
通过ebweblc.authappid接口获取
空表示长连接应用,需要ebwebap.on
不为空表示短连接应用;
from_user_id 可选 标识发送者用户ID
to_account 可选 发送给某个用户帐号,支持邮箱帐号,手机号码和用户ID;
支持逗号”,”分隔,发送给多个帐号;
to_group_id 可选 发送给某个群组(部门)下面所有成员
支持’,’逗号分隔列表
include_sub_group 可选 是否群发包含子部门,0/1,默认0不包含
to_enterprise_code 可选 发送给整个企业ID下面所有员工
支持’,’逗号分隔列表
type 0 消息类型,1-99为系统保留使用类型
除默认0及其他指定通用消息类型外,用户自定义类型,必须使用大于等于100以上类型。

3=订购应用未读消息通知,content格式: [订购ID],[未读消息数量],例如: 1002300105,3 表示 1002300105 该订购ID,有3条未读消息;

title   消息标题
content   消息内容,支持HTML格式,部分广播需要配合type参数
call_key 可选 呼叫来源KEY
用于企业限制消息来源

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID

ebwebap.sendmail

发送邮件,支持发送给个人,发送给群组、部门,和发送给整个企业员工;

发送对象顺序to_account->to_dep_id->to_ent_id,三个参数,必需填写一个;

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
app_online_key 可选 应用在线KEY
通过ebweblc.authappid接口获取
空表示长连接应用,

需要ebwebap.on
不为空表示短连接应用;

to_account 可选 发送给某个用户帐号,支持邮箱帐号,手机号码和用户ID
to_group_id 可选 发送给某个群组(部门)下面所有成员
to_enterprise_code 可选 发送给整个企业ID下面所有员工
type -1 邮件模板类型,由管理后台统一配置;该参数不填写,使用name(标题),

content(邮件内容)

name 可选 邮件名称,空使用type(邮件模板类型)发送,下content同
content   邮件内容
call_key 可选 呼叫来源KEY
用于企业限制消息来源

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID

企业同步接口

ebwebap.synceditpwd

企业同步修改员工密码接口;

old_passwordnew_password加密方式跟管理后台配置(密码验证方式)有关,如下图:

ENTBOOST SDK API REST V03 16.png

恩布默认方式(推荐):需要加密,使用MD5([UID][密码])加密,加密后是32位小写;

例如UID=888001,密码=123456,old_password(或new_password)=

md5(888001123456) = bdc62be29d721a5950f434ca16b84d8e md5(passwd)32位小写:需要加密,使用MD5([UID][密码])加密;

pbkdf2:不需要加密

**该接口属于最高安全级别接口,除了限制APPKEY,同时还需要限制调用来源IP地址,保证企业数据安全性;并且该APPID,必须是该用户的注册时所属APPID;

输入参数 默认值(非空) 描述
app_id   应用ID
app_online_key   应用在线KEY
user_id   需要修改密码用户ID
old_password   旧密码
new_password   新密码
password_salt 可选 密码盐
rebuild_account_prefix 0 重建修改帐号前缀问题 0/1
0:不处理 1:根据前缀重建帐号

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID

ebwebap.syncuserinfo

同步修改用户资料接口;

输入参数 默认值(非空) 描述
app_id   应用ID
app_online_key   应用在线KEY
user_id   需要修改资料用户ID
sync_flag 0 同步标识,0/1
sync_flag=1: group_id>0,修改群组名称,同时更新帐号名称;

sync_flag=1: group_id=0,修改帐号名称,同时更新所有部门/群组成员名称;

group_id   群组(或部门)编号
>0,修改对应群组名称(或部门员工资料)
=0,修改用户帐号
user_name   要修改用户名称

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

系统配置管理接口

ebwebap.sysedit

系统配置管理;

**该接口属于最高安全级别接口,除了限制APPKEY,同时还需要限制调用来源IP地址,保证企业数据安全性;

输入参数 默认值(非空) 描述
app_id   应用ID
app_online_key   应用在线KEY
user-pwd-callback-url 可选 用户密码回调URL
callback-appid 可选 接收回调数据应用ID,加密密钥;
callback-enc-mode 可选 回调数据加密模式,空不加密,目前只支持"3des"加密;
resend-error-cb-data 可选 请求前面错误发送次数超过最大数的回调数据,重新发送;0/1
forget-pwd-url 可选 忘记密码URL(用于登录窗口界面定制)
register-url 可选 注册URL(空使用客户端注册)
open-register 可选 开放注册功能
1:注册个人 2:注册企业 3:注册所有
open-visitor 可选 开放游客登录功能 0/1
ent-logo-url 可选 企业LOGO URL(用于登录窗口界面定制)
建议使用PNG,128*128大小图片;
product-name 可选 客户端产品名称(用于客户端界面定制,替换登录界面和主界面"恩布互联")
default-pwd 可选 默认密码,主要用于新建员工默认密码等
account-prefix 可选

**帐号前缀,用于私有云实现非邮箱格式帐号功能,具体使用请联系恩布技术;
目前支持"@"帐号前缀

passwd-auth-mode 可选

**密码验证方式:
0:恩布验证方式(默认方式)
1:md5(passwd)32位小写

build-all-default-pwd 可选 重置所有用户默认密码 0/1;默认不填写0=不重置密码;
1=重置所有用户密码为默认密码(请谨慎使用!)
build-mgr-default-pwd 可选 重置系统管理员默认密码 0/1;默认不填写0=不重置密码;
1=重置系统管理员密码为默认密码;
save-conversations 可选 保存聊天记录配置,默认3
0=不保存聊天记录
1=只保存客户端本地聊天记录
2=只保存漫游消息(在线聊天记录)
3=保存客户端和漫游消息聊天记录
invite-add2group-auth 可选 邀请用户进群组是否需要验证 默认0
0=不需要验证,直接邀请进群;
1=需要对方验证,对方接受邀请后才进群组;
备注:用于REST.editmember添加群成员和呼叫离线用户时,需要验证,其他情况下不需要验证。
onlinemsg-save-days 可选 授权版本漫游消息保存天数,默认30,单位天。
offlinemsg-save-days 可选 授权版本离线消息保存天数,默认90,单位天。
offfile-space-size 可选 授权版本离线文件空间大小,默认50,单位MB;
0不支持离线文件
user-cd-space-size 可选 授权版本个人用户云盘空间大小,默认50,单位MB;
0不支持用户个人云盘
group-cd-space-size 可选 授权版本个人群组云盘空间大小,默认50,单位MB;
0不支持个人群组云盘
department-cd-space-size 可选 授权版本公司部门云盘空间大小,默认50,单位MB;
0不支持公司部门云盘
member-change-event 可选 修改群组成员(或部门员工)名片,是否实时通知企业全部员工,默认0
0=只通知群组成员,不通知企业全部员工,其他员工需要重新登录后才能显示;
1=实时通知企业全部员工,不需要重新登录就可以显示;
default-allow-out-chat 可选 注册新用户,默认允许接受外部用户聊天请求
0:不允许,直接拒绝外部用户聊天请求;
1:允许外部用户聊天请求;
default-accept-out-chat 可选 注册新用户,默认自动接受外部用户聊天请求
0:需要手工接受外部用户聊天请求
1:自动接受外部用户聊天请求;
max-retry-count 可选 用户登录密码错误,最大重试次数,默认5,超过会临时锁定该用户一定时间(如30分钟)不能登录;
0:不限制
temp-lock-second 可选 临时锁定用户时间,单位分钟,默认30分钟,0不锁定
delete-ent-member-op 可选 删除部门员工帐号操作;
默认0:保留帐号
1:临时冻结帐号,不能登录;(如果属于企业其他部门员工不冻结)
2:删除帐号及所有数据;(如果属于企业其他部门员工不删除)
add-contact-auth 可选 添加好友是否需要验证
0:不需要验证,直接添加成功,没有在线状态
1:需要对方验证,有在线状态;
max-ug-count 可选 最大好友分组数量
max-contact-count 可选 最大联系人数量
uses-uid-list 可选 是否使用注册UID号码池 0/1
empty-uid-list-auto 可选 注册UID号码池用完,是否智能生成UID
0:注册(或添加新员工)失败;
1:智能生成新UID;
auto-open-subid 可选 登录成功自动打应用订购ID
autohide-mainframe-pc 可选 登录成功自动隐藏PC端主界面 0/1 默认0
hide-mainframe-pc 可选 隐藏PC端主界面 0/1 默认0
0:不隐藏主界面
1:隐藏主界面,使用auto-open-subid为主界面;
open-ent-mgr 可选 开放普通企业管理功能 0/1 默认0
0:普通企业不能登录管理中心后台
1:普通企业管理员可以登录管理中心后台,管理本企业数据
offlinefile-save-days 可选 离线文件保存天数,授权版本有效;
dis-user-cloud-drive 可选 禁用个人云盘功能 0/1,默认0不禁用
dis-group-shared-cloud 可选 禁用群组共享功能 0/1,默认0不禁用
dis-modify-passwd 可选 禁用客户端修改密码功能 0/1,默认0不禁用

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述

前置、相关接口说明:

接口名称 接口说明 功能
ebweblc.authappid 前置接口 验证应用ID

统计接口

ebwebap.statsareas

查询所有地区不同在线状态用户数量;

**非实时数据,默认3分钟更新一次数据,授权用户可修改更新时间。

输入参数 默认值(非空) 描述
eb_sid   [可选]2.0以上 EB Session ID
app_id   应用ID
area -1 地区编码
-1=返回所有统计数据(包括所有地区和汇总数据)
0=查询

汇总统计数据
>0=查询指定地区统计数据

返回协议;

参数 默认值(非空) 描述
code   返回状态:见附录
error   [错误]错误描述
areas   成功返回地区统计数组,字段如下
area   地区编号,0为汇总数据
name   地区名称
state   用户在线状态
count   指定地区(或汇总)在线状态用户数
last_time   最新统计时间

前置、相关接口说明:

接口名称 接口说明 功能
ebwebap.on 前置接口 登记应用上线

附录

在线状态

typedefenum EB_USER_LINE_STATE
{
    EB_LINE_STATE_UNKNOWN      // 0 未知
    , EB_LINE_STATE_RESERVE    // 1 保留
    , EB_LINE_STATE_OFFLINE    // 2 离线
    , EB_LINE_STATE_BUSY       // 3 忙碌
    , EB_LINE_STATE_AWAY       // 4 离开
    , EB_LINE_STATE_ONLINE     // 5 在线(新)
};

性别类型

typedefenum EB_GENDER_TYPE
{
    	EB_GENDER_UNKNOWN	// 0 未设置
       , EB_GENDER_MALE         // 1 男
       , EB_GENDER_FEMALE	// 2 女
};

联系人(好友)类型

typedefenum EB_CONTACT_TYPE
{
       EB_CONTACT_UNKNOWN      // 0 未知类型
       , EB_CONTACT_ADD        // 1 添加未通过验证
       , EB_CONTACT_AUTH       // 2 已经通过验证好友
};

登录类型

typedefenum EB_LOGON_TYPE
{
       EB_LOGON_TYPE_UNKNOWN      = 0
       , EB_LOGON_TYPE_EMAIL      = 0x0000001  // 1
       , EB_LOGON_TYPE_PHONE      = 0x0000002  // 2
       , EB_LOGON_TYPE_VISITOR    = 0x0000004  // 4
       , EB_LOGON_TYPE_UID        = 0x0000008  // 8
       , EB_LOGON_TYPE_PC         = 0x0000100  // 256 EB_LOGON_TYPE_PC-EB_LOGON_TYPE_APPID为多终端登录
       , EB_LOGON_TYPE_IOS        = 0x0000200  // 512
       , EB_LOGON_TYPE_ANDROID    = 0x0000400  // 1024
       , EB_LOGON_TYPE_WP         = 0x0000800  // 2048
       , EB_LOGON_TYPE_WEB        = 0x0001000  // 4096
       , EB_LOGON_TYPE_SERVER     = 0x0010000  // 65536 服务端登录,不处理IM业务
       , EB_LOGON_TYPE_PUSHAPP    = 0x0020000  // 131072 消息推送应用
       , EB_LOGON_TYPE_APPID      = 0x0100000  // 1048576 APPID验证,不处理IM业务
       , EB_LOGON_TYPE_OAUTH      = 0x0200000  // 2097152开放验证
};

企业扩展数据

typedefenum EB_ENT_EXT_DATA
{
       EB_ENT_EXT_DATA_NULL
       , EB_ENT_EXT_DATA_ENABLE_MODIFY_MEMBER_INFO    = 0x1  // 1 允许员工修改自己部门资料
};

群组类型

typedefenum EB_GROUP_TYPE
{
       EB_GROUP_TYPE_DEPARTMENT // 0 企业部门(由公司人员设定,不能随意添加用户,或退出)
       , EB_GROUP_TYPE_PROJECT  // 1 公司项目组(同上)
       , EB_GROUP_TYPE_GROUP    // 2 固定群组(所有人可以创建,管理员随时添加成员,或退出)
       , EB_GROUP_TYPE_TEMP = 9 // 9 临时讨论组(由聊天成员动态创建,所有人随时添加成员,或退出)
};

通知消息类型

消息类型:

       WM_USER=0;
       EB_WM_UNKNOWN                = 0
       , EB_WM_APPID_SUCCESS        = WM_USER+0x101
       , EB_WM_APPID_ERROR
       , EB_WM_LOGON_APPCENTER
       , EB_WM_LOGOUT_APPCENTER
       , EB_WM_AP_MSG
       , EB_WM_REGISTER_RESPONSE
       , EB_WM_EDITINFO_RESPONSE
       , EB_WM_USER_STATE_CHANGE
       , EB_WM_USER_HEAD_CHANGE
       , EB_WM_OAUTH_FORWARD
       , EB_WM_LOGON_SUCCESS
       , EB_WM_LOGON_TIMEOUT
       , EB_WM_LOGON_ERROR
       , EB_WM_ONLINE_ANOTHER
       , EB_WM_LOGOUT 
       /*==========================================================
       会话
       ===========================================================*/
       // call_info
       , EB_WM_CALL_INCOMING	    = WM_USER+0x201
       , EB_WM_CALL_ALERTING
       , EB_WM_CALL_BUSY
       , EB_WM_CALL_HANGUP
       , EB_WM_CALL_ERROR
       , EB_WM_CALL_CONNECTED
       /*==========================================================
       视频
       ===========================================================*/
       , EB_WM_V_REQUEST_RESPONSE  = WM_USER+0x211
       , EB_WM_V_ACK_RESPONSE
       , EB_WM_VIDEO_REQUEST
       , EB_WM_VIDEO_ACCEPT
       , EB_WM_VIDEO_REJECT
       , EB_WM_VIDEO_CLOSE
       /*==========================================================
       组织结构
       ===========================================================*/
       , EB_WM_ENTERPRISE_INFO	= WM_USER+0x301
       , EB_WM_GROUP_INFO
       , EB_WM_GROUP_DELETE
       , EB_WM_GROUP_EDIT_ERROR
       , EB_WM_REMOVE_GROUP
       , EB_WM_EXIT_GROUP
       , EB_WM_MEMBER_INFO
       , EB_WM_MEMBER_DELETE
       , EB_WM_MEMBER_EDIT_ERROR
       /*==========================================================
       通讯录(联系人)
       ===========================================================*/
       , EB_WM_CONTACT_INFO	= WM_USER+0x311
       , EB_WM_CONTACT_DELETE
       , EB_WM_RESOURCE_INFO
       , EB_WM_RESOURCE_DELETE
       , EB_WM_RESOURCE_MOVE
       , EB_WM_UG_INFO
       , EB_WM_UG_DELETE
       , EB_WM_CONTACT_STATE_CHANGE
       , EB_WM_BROADCAST_MSG   = WM_USER+0x321
       , EB_WM_NEW_VERSION     = WM_USER+0x401
       , EB_WM_SERVER_CHENGE   = WM_USER+0x411
       /*==========================================================
       聊天会话
       ===========================================================*/
       CR_WM_ENTER_ROOM        = WM_USER+0x1101
       , CR_WM_EXIT_ROOM
       /*
       const CCrAccountInfo* pAccountInfo = (const CCrAccountInfo*)wParam;
       */
       , CR_WM_USER_ENTER_ROOM
       , CR_WM_USER_EXIT_ROOM
       /*
       const CCrRichInfo * pRichInfo = (const CCrRichInfo*)wParam;
       */
       , CR_WM_SEND_RICH       = WM_USER+0x1111
       , CR_WM_RECEIVE_RICH
       /*
       const CCrFileInfo * pCrFileInfo = (const CCrFileInfo*)wParam;
       */
       , CR_WM_SENDING_FILE
       , CR_WM_SENDED_FILE
       , CR_WM_CANCEL_FILE
       , CR_WM_RECEIVING_FILE
       , CR_WM_RECEIVED_FILE
       /*
       const CChatRoomFilePercent * pChatRoomFilePercent = (const CChatRoomFilePercent*)wParam;
       */
       , CR_WM_FILE_PERCENT
       // const CCrInfo* pParameter = (const CCrInfo*)wp;
       , CR_WM_INVALIDATE_SESSION  = WM_USER+0x1131
       , CR_WM_ENTER_ANOTHER

返回状态码

注意:

后面的值等于前一个加1

例如:

  1. EB_STATE_ERROR =1,可得出:EB_STATE_NOT_AUTH_ERROR =2,EB_STATE_ACC_PWD_ERROR =3
  2. EB_STATE_PARAMETER_ERROR =15,可得出:EB_STATE_DATABASE_ERROR =16,EB_STATE_NEW_VERSION =17
typedef enum EB_STATE_CODE
{
   EB_STATE_OK                         = 0    //成功
  , EB_STATE_ERROR                     = 1    //其他错误
  , EB_STATE_NOT_AUTH_ERROR                   //没有权限
  , EB_STATE_ACC_PWD_ERROR                    //帐号或密码错误
  , EB_STATE_NEED_RESEND                      //需要重发数据
  , EB_STATE_TIMEOUT_ERROR                    //超时错误
  , EB_STATE_EXIST_OFFLINE_MSG                //存在离线消息
  , EB_STATE_USER_OFFLINE                     //用户离线状况
  , EB_STATE_USER_BUSY                        //用户线路忙
  , EB_STATE_USER_HANGUP                      //用户挂断会话
  , EB_STATE_OAUTH_FORWARD                    //OAUTH转发
  , EB_STATE_UNAUTH_ERROR                     //未验证错误
  , EB_STATE_ACCOUNT_FREEZE                   //帐号已经冻结
  , EB_STATE_PARAMETER_ERROR           = 15   //参数错误
  , EB_STATE_DATABASE_ERROR                   //数据库操作错误
  , EB_STATE_NEW_VERSION                      //新版本
  , EB_STATE_FILE_ALREADY_EXIST               //文件已经存在
  , EB_STATE_FILE_BIG_LONG                    //文件超过大小
  , EB_STATE_ACCOUNT_NOT_EXIST         = 20   //帐号不存在
  , EB_STATE_ACCOUNT_ALREADY_EXIST            //帐号已经存在
  , EB_STATE_ACCOUNT_DISABLE_OFFCALL          //禁止离线会话
  , EB_STATE_ACCOUNT_DISABLE_EXTCALL          //禁止外部会话
  , EB_STATE_DISABLE_REGISTER_USER     = 25   //禁止用户注册功能
  , EB_STATE_DISABLE_REGISTER_ENT             //禁止企业注册功能
  , EB_STATE_ENTERPRISE_ALREADY_EXIST  = 30   //公司名称已经存在
  , EB_STATE_ENTERPRISE_NOT_EXIST             //没有公司信息(企业不存在)
  , EB_STATE_DEP_NOT_EXIST                    //不存在群组(部门)
  , EB_STATE_EXIST_SUB_DEPARTMENT             //存在子部门
  , EB_STATE_DEP_ACC_ERROR                    //群组或成员不存在
  , EB_STATE_ENT_ACC_ERROR                    //企业员工成员不存在
  , EB_STATE_CS_MAX_ERROR                     //超过客服座席最大数量
  , EB_STATE_NOT_CS_ERROR                     //没有客服座席
  , EB_STATE_EXCESS_QUOTA_ERROR               //超过最大流量配额
  , EB_STATE_ENT_GROUP_ERROR                  //企业部门
  , EB_STATE_ONLINE_KEY_ERROR          = 40   //在线KEY错误
  , EB_STATE_UM_KEY_ERROR                     //用户管理KEY错误
  , EB_STATE_CM_KEY_ERROR                     //聊天服务KEY错误
  , EB_STATE_DEVID_KEY_ERROR                  //开发者帐号KEY错误
  , EB_STATE_APPID_KEY_ERROR                  //应用ID KEY错误
  , EB_STATE_DEVID_NOT_EXIST                  //开发者帐号不存在
  , EB_STATE_APPID_NOT_EXIST                  //应用ID不存在
  , EB_STATE_APP_ONLINE_KEY_TIMEOUT           //应用ID在线KEY超时,需要重新验证
  , EB_STATE_KEY_ERROR                        //KEY错误
  , EB_STATE_CALL_NOT_EXIST            = 50   //会话不存在
  , EB_STATE_CHAT_NOT_EXIST                   //聊天不存在
  , EB_STATE_MSG_NOT_EXIST                    //消息不存在
  , EB_STATE_RES_NOT_EXIST                    //资源不存在
  , EB_STATE_NOT_MEMBER_ERROR                 //没有成员错误
  , EB_STATE_ATTACHMENT_NOT_EXIST             //附件不存在
  , EB_STATE_FILE_NOT_EXIST                   //文件不存在
  , EB_STATE_NO_UM_SERVER              = 60   //没有用户管理服务
  , EB_STATE_NO_CM_SERVER                     //没有聊天服务
  , EB_STATE_NO_VM_SERVER                     //没有视频服务
  , EB_STATE_NO_AP_SERVER                     //没有应用服务
  , EB_STATE_NO_RD_SERVER                     //没有远程桌面服务
  , EB_STATE_ENT_BLACKLIST             = 70   //企业黑名单用户
  , EB_STATE_ANOTHER_ENT_ACCOUNT              //其他企业帐号
  , EB_STATE_MAX_CAPACITY_ERROR               //最大容量错误
  , EB_STATE_NOT_SUPPORT_VERSION_ERROR        //不支持当前版本
  , EB_STATE_FORWARD_MSG                      //转发消息
  , EB_STATE_MAX_RETRY_ERROR                  //错误次数太多,请稍候再试!
  , EB_STATE_TOKEN_ERROR                      //TOKEN错误
  , EB_STATE_MAX_UG_ERROR                     //超过最大分组数量
  , EB_STATE_MAX_CONTACT_ERROR                //超过最大联系人数量
  , EB_STATE_CONTACT_NOT_EXIST                //联系人不存在
  , EB_STATE_PHONE_ALREADY_EXIST              //手机帐号已经存在
  , EB_STATE_ALREADY_IN_REMOTE_DESKTOP        //已经在远程桌面中
  , EB_STATE_CONTENT_BIG_LENGTH               //内容超过长度
  , EB_STATE_MEMORY_ERROR                     //内存不够
  , EB_STATE_DATA_ERROR                       //数据或格式错误
  , EB_STATE_CREATE_FILE_ERROR                //创建文件失败
  
  , EB_STATE_PLAN_NOT_EXIST           = 100   //计划不存在
  , EB_STATE_TASK_NOT_EXIST                   //任务不存在
  , EB_STATE_REPORT_NOT_EXIST                 //报告不存在
}

返回状态码下载地址

应用功能应用模式

typedefenum EB_FUNC_MODE
{
       EB_FUNC_MODE_BROWSER         // 0 浏览器模式 
       , EB_FUNC_MODE_MAINFRAME     // 1 主面板(默认)
       , EB_FUNC_MODE_MODAL         // 2 对话框模式(模式)
       , EB_FUNC_MODE_PROGRAM       // 3 打开应用程序 
       , EB_FUNC_MODE_SERVER        // 4 服务模式(HTTP POST)
       , EB_FUNC_MODE_WINDOW        // 5 窗口模式(无模式)
};

应用功能客户端显示位置

/*==========================================================
应用功能显示位置
===========================================================*/
typedefenum EB_FUNC_LOCATION
{
       EB_FUNC_LOCATION_UNKNOWN                                = 0x0
       , EB_FUNC_LOCATION_MAINFRAME_BTN1                       = 0x0001        // 1 主界面按钮(上)
       , EB_FUNC_LOCATION_MAINFRAME_BTN2                       = 0x0002        // 2 主界面按钮(下)
       , EB_FUNC_LOCATION_APPFRAME_BTN                         = 0x0004        // 4 手机应用(应用面板按钮)
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_MAINFRAME           = 0x0010        // 16 主界面右键菜单 
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_USER                = 0x0020        // 32 用户右键菜单 
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_GROUP               = 0x0040        // 64 群组(部门)右键菜单 
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_ENTERPRISE          = 0x0080        // 128 企业右键菜单 
       , EB_FUNC_LOCATION_GROUP_CHAT_BTN1                      = 0x0100        // 256 群组会话上面按钮 
       , EB_FUNC_LOCATION_GROUP_CHAT_BTN2                      = 0x0200        // 512 群组会话下面按钮 
       , EB_FUNC_LOCATION_USER_CHAT_BTN1                       = 0x0400        // 1024 用户会话上面按钮 
       , EB_FUNC_LOCATION_USER_CHAT_BTN2                       = 0x0800        // 2048 用户会话下面按钮 
       , EB_FUNC_LOCATION_CALL_CHAT = 
EB_FUNC_LOCATION_GROUP_CHAT_BTN1|EB_FUNC_LOCATION_GROUP_CHAT_BTN2|EB_FUNC_LOCATION_USER_CHAT_BTN1|EB_FUNC_LOCATION_USER_CHAT_BTN2
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_USER_CHAT           = 0x1000        // 4096 个人聊天界面右键菜单 
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_GROUP_CHAT          = 0x2000        // 8192 群组聊天界面右键菜单 
       , EB_FUNC_LOCATION_RIGHT_CLICK_MENU_CHAT_RECORD         = 0x4000        // 16384 聊天记录右键菜单 
};

文档版本说明

版本日期 作者 内容
2013-08-27 HD 文档初稿。
2014-08-01 HD 重新整理。
2014-08-06 HD 1.增加应用功能管理接口说明;
2.增加部分接口相关函数、前置函数说明;
2014-08-12 HD 1.增加采集聊天记录内容数据功能;
2.ebwebum.fauth增加post_data返回参数;
2014-08-22 HD 增加注册、游客登录、忘记密码、企业LOGO等配置
2014-09-05 HD 1.ebwebum.online增加返回用户默认企业ID;
2.完善部分功能描述,和返回状态码信息;
2014-09-09 HD 1.ebwebum.reguser增加实现重发注册验证邮件功能;
2.ebwebap.sysedit增加初始化APP许可来源IP地址;
2014-09-11 HD 增加ebwebcm.pushenter进入消息推送会话接口,实现消息推送功能;
2014-10-09 HD 1.ebwebum.editmember增加app_id等参数,用于标识同步用户密码使用;
2.其他部分功能描述修改;
2014-10-15 HD 1.增加ebwebum.fseticon接口实现设置应用功能图标;
2. ebwebum.online接口增加acm_key参数,实现资源管理功能;
3.应用管理增加屏蔽客户端页面右键菜单,屏蔽滚动条功能,详细看ebwebum.fedit和ebwebum.fload参数;
2014-10-25 HD ebwebap.sysedit增加build-default-pwd可选参数,实现修改帐号前缀、密码验证方式同时修改用户密码为默认密码。
2014-11-03 HD 增加应用导航信息管理接口。
2014-11-05 HD 增加应用模式EB_FUNC_MODE_PROGRAM打开应用程序。
2014-11-17 HD 1.ebwebap.sysedit增加save-conversations配置保存聊天记录功能;
2.增加关闭客户端页面提示配置功能,详细看ebwebum.fedit和ebwebum.fload参数。


3.ebweblc.logonaccount增加返回默认头像URL。

2014-11-18 HD ebwebum.loadorg加载企业资料增加返回ent_ext字段。
2014-11-21 HD ebwebum.fedit,fload增加客户端页面窗口可调整参数。
2014-11-26 HD ebwebap.sysedit增加invite-add2group-auth参数。
2014-12-09 HD ebwebap.sysedit增加onlinemsg-save-days等参数。
2014-12-10 HD ebwebum.loadorg加载资源数据增加返回表情描述字段。
2014-12-15 HD ebwebum.loadorg加载资源数据增加返回cmserver字段,去掉appname字段;
2015-01-12 HD ebwebap.sysedit增加四个配置项;
2015-01-22 HD ebwebap.sysedit增加二个配置项;
2015-02-07 HD ebwebap.sysedit增加UID注册号码使用设置参数;
ebwebum.reguser增加性别,生日和地址输入参数;
2015-02-09 HD ebweblc.findpwd和ebweblc.resetpwd增加app_id,app_ok参数;
2015-02-11 HD ebweblc.findpwd超级权限APP增加返回uid,account等参数;
ebwebum.fauth增加logon_web输入,增加online_key返回;
2015-03-12 HD ebwebap.sysedit增加auto-open-subid, autohide-mainframe-pc,hide-mainframe-pc,open-ent-mgr, offlinefile-save-days参数;
ebweblc.resetpwd增加uid,去掉account参数,使用加密密码;
ebweblc.regauth 接口 reset_pwd 参数,使用加密密码;
增加ebwebum.mgraccount接口;
增加 ebweblc.queryuser接口;
ebweblc.reqreg增加app_id,app_ok输入参数;
2015-03-13 HD ebweblc.logonaccount增加uid,logon_type,去掉account参数;
ebwebum.fauth 增加返回 logon_type 参数;
2015-03-19 HD 增加ebwebum.sinfo接口,用于修改个人资料;
增加ebwebum.loaddict接口,用于加载获取地区信息;
ebweblc.logonvisitor,logonaccount增加返回urls参数;
2015-04-03 HD ebwebum.loadcontact增加返回参数;
2015-04-11 HD ebweblc.logonaccount,logonvisitor,authappid,oauth 如果使用https访问,会增加返回 urls 参数;
ebwebum.loadorg如果使用https访问,表情资源增加返回servers参数;
ebwebum.loadorg表情资源取消返回 cmserver 参数;
ebwebap.sysedit接口build-default-pwd 改为 build-all-default-pwd 默认为0,增加 build-mgr-default-pwd 参数;
ebweblc.logonaccount 解决不能正常返回logon_type问题,如果使用HTTPS访问,增加返回 default_head_urls 参数;
增加 ebwebum.loadug 接口,返回 ugs 数组;
增加ebwebum.editug,deleteug 接口;
** ebwebcm 优化HB等连接,信息传递机制;
a. hb 增加 from_uid 参数,去掉 chat_id 参数;
b. exit增加from_uid参数,sendfile,sendtext,sendrich 的 from_uid 参数由可选,改为必填参数;
c. ebwebcm所有返回增加 chat_id 参数,hb超时返回时不返回chat_id 参数;
增加 ebwebum.shead 接口,用于设置群成员名片头像;
增加设置登录手机号码功能;ebwebum.sinfo 增加 phone 参数;
增加ebwebap.statsareas接口,查询地区在线状态用户统计数据;
2015-05-14 HD 参数,ebwebum.fauth 增加返回 acm_key 参数;
增加 ebwebum.userquery 接口,用于查询用户电子名片信息;
2015-06-16 HD ebwebum.loadcontact 增加返回 line_state 在线状态参数;
ebwebum 增加 loadols 接口,加载在线状态;
ebwebum 增加 searchuser 接口,用于用户搜索;
2015-07-15 HD ebwebap.sysedit 增加 dis-user-cloud-drive,dis-group-shared-cloud, dis-modify-passwd 三个可选设置参数;
"在线状态"值定义,1改成5,详见附录:
2015-08-18 HD 增加 ebwebap.sendmail 接口;
ebwebum.sinfo 增加 old_pwd,passwd 参数,实现修改密码功能;
ebweblc.logonaccount 登录成功增加返回gender,birthday,tel,mobile,email,user_url,add,zipcode,area1,area1s,
area2,area2s,area3,area3s,area4,area4s参数;
ebwebum 增加广播消息事件EB_WM_BROADCAST_MSG=0x321 ,收到消息需要调用 ebwebum.msgack 确认收到广播消息;
2015-08-20 HD ebwebap.synceditpwd增加 salt 密码盐可选参数;
ebweblc.regauth增加 auth_key 可选参数,实现激活帐号功能;
2015-09-26 HD 升级REST API,2.0版本;
ebwebum.online,ebwebap.on,ebwebcm.enter 2.0版本,成功增加返回 eb_sid 参数;
ebwebum,ebwebcm,ebwebap 其他 2.0 版本IM业务接口,增加eb_sid参数,用于替换原来 cookie 的 sessionid 参数;
2015-11-05 HD 增加 ebweblc.querysysinfo 接口;
ebwebum.reguser 增加 salt 参数;增加 auto_add_group 参数 0/1,1表示自动添加到指定群组,群组ID由管理后台配置;
ebweblc.queryuser 增加 sub_type 参数,增加返回 account-type 参数;
ebwebum.loadols 增加参数,支持加载群组(部门)在线人数;
ebwebap 增加 syncuserinfo 接口,实现同步修改用户资料;
ebweblc.resetpwd 增加可选 salt 参数
2015-11-09 HD 升级REST API 3.0版本,统一参数名称,使用rest.v03调用;
2015-11-10 HD 增加ebwebum.logon接口;
2015-11-12 HD 增加使用流程章节;
2016-02-23 HD ebwebap.hb 改为 ebwebap.holdconnect
ebwebum.editgroup 增加 manager_uid 输入参数;
ebweblc.authappid SSL 访问时,增加返回 app_server_ssl,server_ssl
2016-04-26 HD ebwebum.loadorg 成员资料,增加返回 manager_level,display_index(高排上面)
ebwebum.loadinfo 增加返回订购应用列表;
ebweblc.oauth去掉account参数;
ebwebum.deletemember 增加 group_id,member_account 二个可选参数;
ebwebum.setlinestate,ebwebum.logon增加us_data自定义数据参数;
2016-05-17 HD ebwebum增加云盘资源管理接口,ebwebum.addresource等
增加ebwebcm.upload上传资源文件接口;
2016-06-06 HD 增加ebwebum.loadresources接口;
2016-07-02 HD ebwebum.loadresource增加offset,limit参数,实现分页
增加ebwebum.getuserinfo接口,实现获取用户默认头像等数据;
2016-07-11 HD ebwebum.loadorg 加载表情,增加返回 cm_service_id 参数;
2016-08-18 HD ebwebap.sendbcmsg发送广播消息,to_account参数增加支持发送多帐号
2016-09-27 HD ebwebum.editmember 增加 manager_level 参数,默认-1,不设置员工权限;
2016-11-10 HD ebwebum.shead 增加 set_user_id 参数,默认不填写或0时,设置个人头像,该接口可以用于管理员设置其他人头像会判断相应权限;
2016-11-18 HD ebwebum.fauth 增加 logon_type 可选参数,默认0使用 EB_LOGON_TYPE_SERVER=65536;

ebwebum.loadcontact 增加 load_flag 参数,加载标识,默认0=加载所有;1=只加载con_uid>0;2=只加载con_uid=0数据

2016-12-09 HD 1.ebwebap.sendbcmsg增加广播消息类型3(订购应用未读消息通知)定义;

2.ebweblc.authappid 验证APPID,增加返回 license_type 许可类型;0=未授权;1=终身授权;2=时间授权;
3.ebwebap.sendbcmsg 增加 include_sub_group 参数;
4.ebwebum.getresource,loadresource 增加 verify_valid是否验证资源有效0/1参数,默认1验证有效性;

2017-03-07 HD 1.ebwebum.loadcontact load_flag 参数,增加支持0x4,只加载联系人头像信息,并增加返回 load_flag 参数;

2.ebwebum.loadcontact 增加 only_con_id,only_con_uid 二个可选输入参数,增加返回 head_ver, head_url,head_url_ssl 头像资源参数;
3.ebwebum.loadols 增加 contact_ols 参数,用于加载联系人在线状态 0/1,成功返回;

2017-03-08 HD 1. ebwebum.editmember 优化接口将需要修改参数字段,改成可选参数,填写才修改,没有填写不更新;
2017-03-13 HD 1. ebwebum.editgroup 增加 display_index 参数,用于实现修改部门排序,同时优化需要修改参数字段,改成可选参数,填写才修改,没有填写不更新;
2017-03-27 HD 1. ebwebum.editmember 增加 display_index 参数;
2017-04-12 HD 1.ebwebum.deletecontact 增加 contact_user_id 可选参数;

2.ebwebap.syncuserinfo 增加 sync_flag 同步更新所有参数 0/1;
3.ebwebum.editgroup 增加 forbid_minutes 可选输入参数;
4.ebwebum.loadorg 加载组织结构,群组部门信息增加返回 ext_data 参数;
5.ebwebum.editmember 增加 forbid_minutes 可选输入参数;
6.ebwebap.sendbcmsg to_ent_id,to_account,to_dep_id 完善实现三个参数同时有效,增加支持','逗号分隔列表;
7.ebwebap.sendbcmsg增加from_user_id可选参数;

2017-04-22 HD 1. ebwebum.loadorg加载组织结构,群组成员信息增加返回 forbid_minutes 参数;