me.chanjar.weixin.cp.api

接口 WxCpChatService

所有已知实现类:

WxCpChatServiceImpl

public interface WxCpChatService

群聊服务.

作者:

gaigeshen

方法概要

限定符和类型	方法和说明
String	create(String name, String owner, List<String> users, String chatId) 创建群聊会话，注意：刚创建的群，如果没有下发消息，在企业微信不会出现该群.
WxCpChat	get(String chatId) 获取群聊会话.
void	sendMsg(WxCpAppChatMessage message) 应用支持推送文本、图片、视频、文件、图文等类型.
void	update(String chatId, String name, String owner, List<String> usersToAdd, List<String> usersToDelete) 修改群聊会话.

方法详细资料

create

String create(String name,
              String owner,
              List<String> users,
              String chatId)
       throws WxErrorException

创建群聊会话，注意：刚创建的群，如果没有下发消息，在企业微信不会出现该群.

参数:

name - 群聊名，最多50个utf8字符，超过将截断

owner - 指定群主的id。如果不指定，系统会随机从userlist中选一人作为群主

users - 群成员id列表。至少2人，至多500人

chatId - 群聊的唯一标志，不能与已有的群重复；字符串类型，最长32个字符。只允许字符0-9及字母a-zA-Z。如果不填，系统会随机生成群id

返回:

创建的群聊会话chatId string

抛出:

WxErrorException - 异常

update

void update(String chatId,
            String name,
            String owner,
            List<String> usersToAdd,
            List<String> usersToDelete)
     throws WxErrorException

修改群聊会话.

参数:

chatId - 群聊id

name - 新的群聊名。若不需更新，请忽略此参数（null or empty）。最多50个utf8字符，超过将截断

owner - 新群主的id。若不需更新，请忽略此参数（null or empty）

usersToAdd - 添加成员的id列表，若不需要更新，则传递空对象或者空集合

usersToDelete - 踢出成员的id列表，若不需要更新，则传递空对象或者空集合

抛出:

WxErrorException - 异常

get

WxCpChat get(String chatId)
      throws WxErrorException

获取群聊会话.

参数:

chatId - 群聊编号

返回:

群聊会话 wx cp chat

抛出:

WxErrorException - 异常

sendMsg

void sendMsg(WxCpAppChatMessage message)
      throws WxErrorException

应用支持推送文本、图片、视频、文件、图文等类型. 请求方式： POST（HTTPS） 请求地址： https://qyapi.weixin.qq.com/cgi-bin/appchat/send?access_token=ACCESS_TOKEN 文档地址：...

参数:

message - 要发送的消息内容对象

抛出:

WxErrorException - 异常