ailuoy/neteaseim

Netease im PHP SDK

v0.0.1 2020-08-23 06:15 UTC

Requires

• php: >=7.0
• guzzlehttp/guzzle: ^6.3
• illuminate/validation: ^5.8

MIT

• ailuoy

• netease
• neteaseim
• ailuoy

README

NeteaseIm

Introduce

Netease im php sdk

Requirement

• PHP 7.0+
• Composer

Installation

composer require ailuoy/neteaseim

Usage

$appId = 'your neteaseim appid';
$secret = 'your neteaseim secret';
$neteaseIm = new \Ailuoy\NeteaseIm\Client($appId, $secret);
try {
    $response = $neteaseIm->user->getUinfos->go(['1']);
} catch (\Ailuoy\NeteaseIm\Exceptions\NeteaseImException $e) {
    var_dump($e->getMessage());
}
var_dump($response);

API List

网易云通信ID

• 创建网易云通信ID
• 网易云通信ID更新
• 更新并获取新token
• 封禁网易云通信ID
• 解禁网易云通信ID

用户名片

• 更新用户名片
• 获取用户名片

用户设置

• 设置桌面端在线时，移动端是否需要推送
• 账号全局禁言
• 账号全局禁用音视频

用户关系依托

• 加好友
• 更新好友相关信息
• 删除好友
• 获取好友关系
• 设置黑名单/静音
• 查看指定用户的黑名单和静音列表

消息功能

• 发送普通消息
• 批量发送点对点普通消息
• 发送自定义系统通知
• 批量发送点对点自定义系统通知
• 文件上传
• 文件上传（multipart方式）
• 上传NOS文件清理任务
• 消息撤回
• 发送广播消息

群组功能（高级群）

• 创建群
• 拉人入群
• 踢人出群
• 解散群
• 编辑群资料
• 群信息与成员列表查询
• 获取群组详细信息
• 获取群组已读消息的已读详情信息
• 移交群主
• 任命管理员
• 移除管理员
• 获取某用户所加入的群信息
• 修改群昵称
• 修改消息提醒开关
• 禁言群成员
• 主动退群
• 将群组整体禁言
• 获取群组禁言列表

聊天室

• 创建聊天室
• 查询聊天室信息
• 批量查询聊天室信息
• 更新聊天室信息
• 修改聊天室开/关闭状态
• 设置聊天室内用户角色
• 请求聊天室地址
• 发送聊天室消息
• 往聊天室内添加机器人
• 从聊天室内删除机器人
• 设置临时禁言状态
• 往聊天室有序队列中新加或更新元素
• 从队列中取出元素
• 排序列出队列中所有元素
• 删除清理整个队列
• 初始化队列
• 将聊天室整体禁言
• 查询聊天室统计指标TopN
• 分页获取成员列表
• 批量获取在线成员信息
• 变更聊天室内的角色信息
• 批量更新聊天室队列元素
• 查询用户创建的开启状态聊天室列表

历史记录

• 单聊云端历史消息查询
• 群聊云端历史消息查询
• 聊天室云端历史消息查询
• 删除聊天室云端历史消息
• 用户登录登出事件记录查询
• 批量查询广播消息
• 查询单条广播消息

在线状态

• 订阅在线状态事件
• 取消在线状态事件订阅
• 取消全部在线状态事件订阅
• 查询在线状态事件订阅关系

todo

• 目前没有检查json count 的rule 所以先暂时去掉json的元素个数统计,看是否可以自定义validate规则