群组相关接口
这些接口提供给 APP 服务端调用,客户端不能直接调用;访问方法见:服务端 REST API 接口介绍 。
创建群组
- 请求URL : /api/platform/group/create
- 请求方式 : POST
- 请求参数
- member(必填): 创建时邀请加入群组的人,用逗号隔开
- name : 群名称
- desc : 群描述
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4042, "error":"群组成员数超过限制" }
//包含群成员具体信息 { "id": "2d9384c03dbb11e69860d7e34c9bca74", "creator": "d67bae603dba11e69860d7e34c9bca74", "create_time": 1467178481420, "update_time": 1467179440035, "desc": "desc123", "name": "groupTest", "number": 3, "member": [ { "id": "038cda003dbb11e69860d7e34c9bca74", "nickname": "jack", "createTime": 1467178410923, }, { "id": "d67bae603dba11e69860d7e34c9bca74", "nickname": "nick", "createTime": 1467178335355, }, { "id": "ec9d6c103dba11e69860d7e34c9bca74", "nickname": "tom", "createTime": 1467178372442, } ], "conversation": 0 }
更新群组
- 请求URL : /api/platform/group/update
- 请求方式 : POST
- 请求参数
- groupId(必填): 群组id
- name : 群名称
- desc : 群描述
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4019, "error": "群组不存在" }
{ "error_code": 4020, "error": "对不起,您没有权限" }
{ "error_code": 2000, }
获取群组信息
- 请求URL : /api/platform/group/get
- 请求方式 : POST
- 请求参数
- groupId(必填): 群组id
- exclude : 是否排除返回属性,如果传member则不返回群组的详细信息
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4019, "error": "群组不存在" }
{ "error_code": 4020, "error": "对不起,您没有权限" }
//包含群成员具体信息 { "id": "2d9384c03dbb11e69860d7e34c9bca74", "creator": "d67bae603dba11e69860d7e34c9bca74", "create_time": 1467178481420, "update_time": 1467179440035, "desc": "desc123", "name": "groupTest", "number": 3, "member": [ { "id": "038cda003dbb11e69860d7e34c9bca74", "nickname": "jack", "createTime": 1467178410923, }, { "id": "d67bae603dba11e69860d7e34c9bca74", "nickname": "nick", "createTime": 1467178335355, }, { "id": "ec9d6c103dba11e69860d7e34c9bca74", "nickname": "tom", "createTime": 1467178372442, } ], "conversation": 0 }
加入群组
- 请求URL : /api/platform/group/join
- 请求方式 : POST
- 请求参数
- groupId(必填): 群组id
- member(必填): 拉进群的成员,用逗号隔开
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4019, "error": "群组不存在" }
{ "error_code": 4020, "error": "对不起,您没有权限" }
{ "error_code": 4042, "error": "超过群组成员限制" }
{ "error_code": 2000, "join_member":[ { "id": "038cda003dbb11e69860d7e34c9bca74", "nickname": "jack", "createTime": 1467178410923, } ] }
将用户从群组中移除
- 请求URL : /api/platform/group/remove
- 请求方式 : POST
- 请求参数
- groupId(必填): 群组id
- member(必填): 被移除的成员,用逗号隔开
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4019, "error": "群组不存在" }
{ "error_code": 4020, "error": "对不起,您没有权限" }
{ "error_code": 2000, }
退出群组
- 这个不需要!!!
- 请求URL : /api/platform/group/exit
- 请求方式 : POST
- 请求参数
- groupId(必填): 群组id
- 响应
{ "error_code":401, "error": "账户未登陆" }
{ "error_code": 4001, "error": "缺少参数" }
{ "error_code": 4019, "error": "群组不存在" }
{ "error_code": 2000, }