api

API 列表

查找

查找均从 Collection 中查找对应的对象

全局注解

• username 用户的UserName，微信分配的随机唯一ID
• nickname 昵称
• remark 备注
• alias 微信号
• blur 为模糊匹配

BaseCollection

方法名	解释
getUsernameByNickname($nickname, $blur = false)	根据昵称查找username
getUsernameByRemarkName($remark, $blur = false)	根据备注查找username
getUsername($search, $key, $blur = false)	search 为要查询的内容，key为字段，返回符合的第一个username
getObject($search, $key, $first = false, $blur = false	first为true时返回单个对象，默认获取多个
update($username, $default = null)	根据接口更新最新的数据

Contact

方法名	解释
getContactByAlias($alias)	根据微信号搜索联系人对象
getUsernameByAlias($alisa)	根据微信号搜索联系人username

Group

方法名	解释
getMembersByNickname($groupUsername, $memberNickname, $blur = false)	根据昵称查找群成员
setMap($username, $id)	根据username设置群组ID，方便查找
getUsernameById($id)	根据ID查找群组
getMemberByUsername($username, $memberUsername)	根据username获取群成员

操作

contact()

方法名	解释
setRemarkName($username, $remark)	设置备注。
setStick($username, $isStick)	设置置顶。isStick为true为置顶，false为取消置顶
add($username, $content)	主动添加好友。content为验证内容

group()

方法名	解释
create(array $usernames)	创建群聊天。usernames为群成员的username数组
deleteMember($username, $members)	删除群成员。members可以为数组或username字符串
addMember($username, $members)	添加群成员。members可以为数组或username字符串
setGroupName($username, $name)	设置群名称。

account()

方法名	解释
getAccount($username)	获取对象。当不知道username属于哪个类型时可用