注意：以下文档只适用于TOP接口，请谨慎使用！
注意：以下文档只适用于TOP接口，请谨慎使用！
OpenIM服务端提供了7个TOP接口，提供的功能点有：
在集成前你可能需要用到：
开发者在服务端，需要调用这些接口对用户信息进行相关操作，以便后续客户端登录时用户能够正常使用IM功能。
定义用户信息的结构体：
Userinfos//账号管理场景需要用到
{
"userid": "test0", //用户名
"password": "123456", //密码
"nick": "书通", //用户昵称
"mobile": "18958090000", //手机
"email": "hehe@taobao.com",//邮箱
"icon_url": "http://xxx.com/xxx"
}
OpenImUser//群管理、聊天记录导出场景需要用到
{
"app_key": "23018936",
"taobao_account": false,
"uid": "test0"
}
| 字段名 | 最大长度 | 是否必选 | 额外说明 |
|---|---|---|---|
| userinfos | 100 | 是 | 该入参为账号数组，最大长度限制为100个账号. |
| userid | 64 | 是 | 只允许字符集为：所有小写字母（大写字母也会被转换成小写）以及符号(.@-_) |
| password | 64 | 是 | 密码，可用任意编码方式进行编码处理，OpenIM不需要真正的密码 |
| mobile | 64 | 否 | 电话号码，可选 |
| 128 | 否 | 邮箱，可选 | |
| taobaoid | 64 | 否 | 淘宝账号，可选 |
开发者需要将自己的账号体系做一定的处理，再导入IM服务端。这些账号在IM这里用来做唯一标识符。因此可以不传真实的账号。
| API名称 | 功能 |
| taobao.openim.users.add | 批量将账号导入IM服务器 |
| taobao.openim.users.get | 批量查询账号 |
| taobao.openim.users.delete | 批量将账号从IM服务器删除 |
| taobao.openim.users.update | 批量更新账号 |
在服务端，支持给IM用户发送消息。
| API名称 | 功能 |
| taobao.openim.custmsg.push | IM用户推送消息，客户端能接到新消息 |
开发者可以导出在IM里面所有的聊天记录数据。
| API名称 | 功能 |
| taobao.openim.relations.get | 获取聊天对象 |
| taobao.openim.chatlogs.get | 根据聊天对象查询具体的聊天内容 |
开发者可以在服务端，进行群相关的操作。包括群的增/减、群成员管理、群信息管理。
| API名称 | 功能 |
| taobao.openim.tribe.create | 创建群 |
| taobao.openim.tribe.getalltribes | 获取当前账号群列表 |
| taobao.openim.tribe.gettribeinfo | 获取单个群详情 |
| taobao.openim.tribe.quit | 主动退出群 |
| taobao.openim.tribe.join | 主动加入群 |
| taobao.openim.tribe.expel | 踢出群成员 |
| taobao.openim.tribe.setmanager | 设置群管理员 |
| taobao.openim.tribe.dismiss | 解散群 |
| taobao.openim.tribe.invite | 邀请加入群 |
| taobao.openim.tribe.getmembers | 群成员获取 |
| taobao.openim.tribe.unsetmanager | 取消管理员 |
| taobao.openim.tribe.modifytribeinfo | 群信息修改 |
错误码分为两种：
demo:
{
"error_response": {
"code": 15,
"msg": "Remote service error",
"sub_code": "isv.param-error",
"sub_msg": "userid must in a-zA-Z0-9._-@"
}
}
| 节点 | 含义 |
|---|---|
| err_response | 返回结构根节点 |
| code | 返回值。该值为top平台提供。 15 为后端服务返回错误。 |
| msg | 错误描述 |
| sub_code | 后端服务错误码。该错误码为真正的业务服务产生的错误。 |
| sub_msg | 具体服务错误原因 |
OPENIM 接口返回的sub_code 包括：
