Web2App交互协议
※※※※※ 已完成 ※※※※※
创建群（普通版）
command
createGroup
args请求参数
- groupType：群类型（字符串）
- “Work" ：工作群，成员上限 200 人，不支持由用户主动加入，需要他人邀请入群，适合用于类似微信中随意组建的工作群。
- “Public" ：公开群，成员上限 2000 人，任何人都可以申请加群，但加群需群主或管理员审批，适合用于类似 QQ 中由群主管理的兴趣群。
- “Meeting" ：会议群，成员上限 6000 人，任何人都可以自由进出，且加群无需被审批，适合用于视频会议和在线培训等场景。
- “AVChatRoom" ：直播群，人数无上限，任何人都可以自由进出，消息吞吐量大，适合用作直播场景中的高并发弹幕聊天室。
- groupID：自定义群组 ID，可以传 nil。传 nil 时系统会自动分配 groupID，并通过 succ 回调返回
- groupName：** 群名称，不能为 nil
返回参数：
- groupID：群ID(字符串)
创建群（指定初始成员版）
command
createGroupWithMemberList
args请求参数
- info：群信息（对象）
- groupID ：(字符串)
- groupType ：(字符串) 注意：直播群不能指定初始成员，所以groupType不能为AVChatRoom
- groupName ：(字符串)
- notification ：(字符串)
- introduction ：(字符串)
- faceURL：(字符串)
- memberList: 初始成员列表（对象）
- role
- userID（字符串）
返回参数：
- groupID：群ID(字符串)
获取群聊历史
command
getGroupHistoryMessageList
args请求参数
- groupID：群ID
- count: 拉取消息的个数，不宜太多，会影响消息拉取的速度，这里建议一次拉取 20 个
- lastMsg: 获取消息的起始消息，如果传 “”，起始消息为会话的最新消息
返回参数：
- msgs: (V2TIMMessage模型数组)
发送群文本消息
command
sendGroupTextMessage
Args请求参数：
- text: 发送文本（字符串）
- groupID: 群ID（字符串）
- priority：优先级（整形）
- 0：默认
- 1：高 高优先级，一般用于礼物等重要消息
- 2：普通 常规优先级，一般用于普通消息
- 3：低 低优先级，一般用于点赞消息
返回参数：
- 无
收到群聊消息
command
sendGroupTextMessage
args请求参数
- text: 发送文本（字符串）
- groupID: 群ID（字符串）
- priority：优先级（整形）
- 0：默认
- 1：高 高优先级，一般用于礼物等重要消息
- 2：普通 常规优先级，一般用于普通消息
- 3：低 低优先级，一般用于点赞消息
返回参数：
- 无
获取群信息:
command
getGroupsInfo
args请求参数：
- groupIDList:群ID数组(字符串数组)
返回参数：
- groupResultList:(对象数组)
- resultCode：0为成功，非0失败（整形）
- resultMsg：错误原因，成功时为空（字符串）
- info：群信息（对象）
- groupID:群ID（字符串）
- groupType：群类型（字符串）
- groupName：群名称（字符串）
- notification：群公告（字符串）
- introduction：群简介（字符串）
- faceURL：群头像（字符串）
- allMuted：是否全员禁言（布尔）
- owner：创建人管理员（字符串）
- createTime：创建时间（整形，单位秒）
- memberCount： 群成员总数量（整形）
- onlineCount：在线成员数量（整形）
- 等等以实际为准
获取群成员列表:
command
getGroupMemberList
args请求参数：
- groupID:群ID(字符串)
- filter:成员类型过滤（整形）
- 0：全部成员
- 1：群主
- 2：管理员
- 4：普通成员
也可以填写：1，2，4分别按位与的结果 ( 例如5为群主和普通成员 )
- nextSeq: 分页拉取标志（整形，第一次拉取填0，回调成功如果 nextSeq 不为零，需要分页，传入再次拉取，直至为 0）
返回参数：
- nextSeq: 分页拉取标志（整形，第一次拉取填0，回调成功如果 nextSeq 不为零，需要分页，传入再次拉取，直至为 0）
- memberList：群成员信息数组（对象数组）
- userID：用户 ID（字符串）
- nickName：用户昵称（字符串）
- friendRemark：用户好友备注（字符串）
- nameCard：群成员名片（字符串）
- faceURL：用户头像（字符串）
- role：群成员角色（整形）
- 200：群成员
- 300：群管理员
- 400：群主
- muteUntil：禁言结束时间（整形）
- 等等以实际为准
踢人
command
kickGroupMember
注意: 不同类型的群有如下限制：
- 工作群（Work）：只有群主或 APP 管理员可以踢人。
- 公开群（Public）、会议群（Meeting）：群主、管理员和 APP 管理员可以踢人
- 直播群（AVChatRoom）：只支持禁言（muteGroupMember），不支持踢人。
args请求参数：
- groupID: 群ID（字符串）
- memberList：用户userID列表（字符串数组）
- reason：踢人原因（字符串）
返回参数：
- resultList：结果对象列表（对象数组）
- userID：用户ID（字符串）
- result：返回状态（整形）
- 0, 操作失败
- 1, 操作成功
- 2, 无效操作，加群时已经是群成员，移除群组时不在群内
- 3, 等待处理，邀请入群时等待对方处理
退出群
command
quitGroup
args请求参数：
- groupID: 群ID（字符串）
返回参数：
- 无
邀请他人入群:
command
inviteUserToGroup
注意: 不同类型的群有如下限制：
- 工作群（Work）：群里的任何人都可以邀请其他人进群。
- 会议群（Meeting）和公开群（Public）：只有通过rest api 使用 App 管理员身份才可以邀请其他人进群。
- 直播群（AVChatRoom）：不支持此功能。
args请求参数：
- groupID: 群ID（字符串）
- userList：用户userID列表（字符串数组）
返回参数：
- resultList：结果对象列表（对象数组）
- userID：用户ID（字符串）
- result：返回状态（整形）
- 0, // 操作失败
- 1, // 操作成功
- 2, // 无效操作，加群时已经是群成员，移除群组时不在群内
- 3, /// 等待处理，邀请入群时等待对方处理
解散群
command
dismissGroup
args请求参数：
- groupID: 群ID（字符串）
返回参数：
- 无
网友评论