Download the PHP package quhang/laravel-easemob without Composer

Laravel-easemob

laravel-easemob 将环信 v3.0 服务端的操作进行了封装, 查看环信官方文档

Install

• composer 安装

  • composer require quhang/laravel-easemob

• 在 config/app.php 中添加下面两项

• 发布配置文件

php artisan vendor:publish --provider="Quhang\LaravelEasemob\EasemobServiceProvider"

• 配置 config/easemob.php
  • host 环信服务地址, http://a1.easemob.com
  • org_name
  • app_name
  • client_id
  • client_secret
  • download_file_path 下载环信资源保存目录

Usage

Resource

Token

User

ChatMessage

ChatFile

Message

ChatGroup

ChatRoom

Result

Resource 方法返回数据格式

exception = true 时, 说明此次操作存在异常, 此时应查看 message 和 data
message 保存的是程序异常信息, data 返回的是环信的错误信息, 当无响应时 data 为空数组 code = -1 表示无响应, code != -1 表示 http 状态码

Service

Service 是个单例对象存放在容器中, Resource 就是通过它进行 http 通信:

• 修改 host

• 修改 org_name

• 修改 app_name

• 修改 client_id

• 修改 client_secret

• 修改默认配置

Token

• 获取 APP 管理员 Token(不会缓存, 仅仅是一次接口调用)

User

• 注册 IM 用户[单个]

• 注册 IM 用户[批量]

• 获取 IM 用户[单个]

• 获取 IM 用户[批量]

• 删除 IM 用户[单个]

• 删除 IM 用户[批量]

• 重置 IM 用户密码

• 修改用户推送显示昵称

• 给 IM 用户添加好友

• 解除 IM 用户的好友关系

• 获取 IM 用户的好友列表

• 获取 IM 用户的黑名单

• 往 IM 用户的黑名单中加人

• 从 IM 用户的黑名单中减人

• 查看用户在线状态

• 查询离线消息数

• 查询某条离线消息状态(!! 未测试)

• 用户账号禁用

• 用户账号解禁

查看easemob官方文档

ChatMessage

• 根据时间条件下载历史消息文件

查看easemob官方文档

ChatFile

• 上传语音/图片文件

• 下载语音/图片文件

查看easemob官方文档

Message

• 发送消息

查看easemob官方文档

ChatGroup

• 分页获取 APP 下的群组

• 获取一个用户参与的所有群组

• 获取群组详情

• 创建一个群组

• 修改群组信息

• 删除群组

• 分页获取群组成员

• 添加群组成员[单个]

• 添加群组成员[批量]

• 移除群组成员[单个]

• 移除群组成员[批量]

• 获取群管理员列表

• 添加群管理员

• 移除群管理员

• 转让群组

• 查询群组黑名单

• 添加用户至群组黑名单[单个]

• 添加用户至群组黑名单[批量]

• 从群组黑名单移除用户[单个]

• 从群组黑名单移除用户[批量]

• 添加禁言

• 移除禁言

• 获取禁言列表

查看easemob官方文档

ChatRoom

• 获取 APP 中所有的聊天室

• 获取用户加入的聊天室

• 获取聊天室详情

• 创建一个聊天室

• 修改聊天室信息

• 删除聊天室

• 分页获取聊天室成员

• 添加聊天室成员[单个]

• 添加聊天室成员[批量]

• 删除聊天室成员[单个]

• 删除聊天室成员[批量]

• 获取聊天室管理员列表

• 添加聊天室管理员

• 移除聊天室管理员

• 获取禁言列表

• 添加禁言

• 移除禁言

查看easemob官方文档