Index | 网易云信Laravel API

A

$NetEaseIM#appKey — Property in class NetEaseIM
$NetEaseIM#appSecret — Property in class NetEaseIM
NetEaseIM::arrCheckAndPush() — Method in class NetEaseIM: 数组检查追加

B

$NetEaseIM#baseUrl — Property in class NetEaseIM
NetEaseIM::boolConvertToString() — Method in class NetEaseIM: 布尔转字符串
NetEaseIMServiceProvider::boot() — Method in class NetEaseIMServiceProvider: Boot the service provider.

C

CodeStatus — Class in namespace shankesgk2\NetEaseIM\Exception
CodeStatus::codeStatus() — Method in class CodeStatus
CodeStatus::codeStatusWithError() — Method in class CodeStatus
$NetEaseIM#client — Property in class NetEaseIM
$NetEaseIM#CurTime — Property in class NetEaseIM
$NetEaseIM#CheckSum — Property in class NetEaseIM
ChatRoomTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 聊天室
ChatRoomTrait::chatRoomCreate() — Method in class ChatRoomTrait: 创建聊天室
ChatRoomTrait::chatRoomGet() — Method in class ChatRoomTrait: 查询聊天室信息
ChatRoomTrait::chatRoomGetBatch() — Method in class ChatRoomTrait: 批量查询聊天室信息
ChatRoomTrait::chatRoomUpdate() — Method in class ChatRoomTrait: 更新聊天室信息
ChatRoomTrait::chatRoomToggleCloseStatus() — Method in class ChatRoomTrait: 修改聊天室开/关闭状态
ChatRoomTrait::chatRoomSetMemberRole() — Method in class ChatRoomTrait: 设置聊天室内用户角色
ChatRoomTrait::chatRoomRequestAddress() — Method in class ChatRoomTrait: 请求聊天室地址与令牌
ChatRoomTrait::chatRoomSendMsg() — Method in class ChatRoomTrait: 发送聊天室消息
ChatRoomTrait::chatRoomSendTxtMessage() — Method in class ChatRoomTrait: 发送聊天室文字消息封装
ChatRoomTrait::chatRoomAddRobot() — Method in class ChatRoomTrait: 往聊天室内添加机器人，机器人过期时间为24小时。
ChatRoomTrait::chatRoomRemoveRobot() — Method in class ChatRoomTrait: 从聊天室内删除机器人
ChatRoomTrait::chatRoomTemporaryMute() — Method in class ChatRoomTrait: 将聊天室内成员设置为临时禁言
ChatRoomTrait::chatRoomQueueOffer() — Method in class ChatRoomTrait: 往聊天室有序队列中新加或更新元素
ChatRoomTrait::chatRoomQueuePoll() — Method in class ChatRoomTrait: 从队列中取出元素
ChatRoomTrait::chatRoomQueueList() — Method in class ChatRoomTrait: 排序列出队列中所有元素
ChatRoomTrait::chatRoomQueueDrop() — Method in class ChatRoomTrait: 删除清理整个队列
ChatRoomTrait::chatRoomQueueInit() — Method in class ChatRoomTrait: 初始化队列
ChatRoomTrait::chatRoomMuteRoom() — Method in class ChatRoomTrait: 设置聊天室整体禁言状态（仅创建者和管理员能发言）
ChatRoomTrait::chatRoomTopn() — Method in class ChatRoomTrait: 查询聊天室统计指标TopN
ChatRoomTrait::chatRoomMembersByPage() — Method in class ChatRoomTrait: 分页获取成员列表
ChatRoomTrait::chatRoomQueryMembers() — Method in class ChatRoomTrait: 批量获取在线成员信息
ChatRoomTrait::chatRoomUpdateMyRoomRole() — Method in class ChatRoomTrait: 变更聊天室内的角色信息
ChatRoomTrait::chatRoomQueueBatchUpdateElements() — Method in class ChatRoomTrait: 批量更新聊天室队列元素
ChatRoomTrait::chatRoomQueryUserRoomIds() — Method in class ChatRoomTrait: 查询用户创建的开启状态聊天室列表

D

$NetEaseIM#debug — Property in class NetEaseIM

G

NetEaseIM::getFacadeAccessor() — Method in class NetEaseIM: Get the registered name of the component.

H

HistoryTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 历史记录
HistoryTrait::historyQuerySessionMsg() — Method in class HistoryTrait: 单聊云端历史消息查询
HistoryTrait::historyQueryTeamMsg() — Method in class HistoryTrait: 群聊云端历史消息查询
HistoryTrait::historyQueryChatroomMsg() — Method in class HistoryTrait: 聊天室云端历史消息查询此接口有频控限制，每分钟可调用不超过1200次
HistoryTrait::historyDeleteHistoryMessage() — Method in class HistoryTrait: 删除聊天室云端历史消息
HistoryTrait::historyQueryUserEvents() — Method in class HistoryTrait: 用户登录登出事件记录查询跟据时间段查询用户的登录登出记录，每次最多返回100条。不提供分页支持，第三方需要跟据时间段来查询。
HistoryTrait::historyDeleteMediaFile() — Method in class HistoryTrait: 删除音视频/白板服务器录制文件
HistoryTrait::historyQueryBroadcastMsg() — Method in class HistoryTrait: 批量查询广播消息
HistoryTrait::historyQueryBroadcastMsgById() — Method in class HistoryTrait: 查询单条广播消息

M

MessageTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 消息功能
MessageTrait::messageSendMsg() — Method in class MessageTrait: 发送普通消息
MessageTrait::messageSendTxtMsgToUser() — Method in class MessageTrait: 给个人发送文本消息封装
MessageTrait::messageSendCustomMsgToUser() — Method in class MessageTrait: 给个人发送自定义消息封装
MessageTrait::messageMsgSendBatchMsg() — Method in class MessageTrait: 批量发送点对点普通消息 1.给用户发送点对点普通消息，包括文本，图片，语音，视频，地理位置和自定义消息。 2.最大限500人，只能针对个人,如果批量提供的帐号中有未注册的帐号，会提示并返回给用户。 3.此接口受频率控制，一个应用一分钟最多调用120次，超过会返回416状态码，并且被屏蔽一段时间；具体消息参考官方文档。
MessageTrait::messageMsgSendAttachMsg() — Method in class MessageTrait: 发送自定义系统通知 1.自定义系统通知区别于普通消息，方便开发者进行业务逻辑的通知； 2.目前支持两种类型：点对点类型和群类型（仅限高级群），根据msgType有所区别。应用场景：如某个用户给另一个用户发送好友请求信息等，具体attach为请求消息体，第三方可以自行扩展，建议是json格式
MessageTrait::messageMsgSendBatchAttachMsg() — Method in class MessageTrait: 批量发送点对点自定义系统通知 1.系统通知区别于普通消息，应用接收到直接交给上层处理，客户端可不做展示； 2.目前支持类型：点对点类型； 3.最大限500人，只能针对个人,如果批量提供的帐号中有未注册的帐号，会提示并返回给用户； 4.此接口受频率控制，一个应用一分钟最多调用120次，超过会返回416状态码，并且被屏蔽一段时间；应用场景：如某个用户给另一个用户发送好友请求信息等，具体attach为请求消息体，第三方可以自行扩展，建议是json格式
MessageTrait::messageMsgUpload() — Method in class MessageTrait: 文件上传文件上传，字符流需要base64编码，最大15M。
MessageTrait::messageMsgFileUpload() — Method in class MessageTrait: 文件上传（multipart方式）文件上传，最大15M
MessageTrait::messageMsgRecall() — Method in class MessageTrait: 消息撤回消息撤回接口，可以撤回一定时间内的点对点与群消息
MessageTrait::messageMsgBroadcastMsg() — Method in class MessageTrait: 发送广播消息 1、广播消息，可以对应用内的所有用户发送广播消息，广播消息目前暂不支持第三方推送（APNS、小米、华为等）； 2、广播消息支持离线存储，并可以自定义设置离线存储的有效期，最多保留最近100条离线广播消息； 3、此接口受频率控制，一个应用一分钟最多调用10次，一天最多调用1000次，超过会返回416状态码； 4、该功能目前需申请开通，详情可咨询您的客户经理。

N

NetEaseIMException — Class in namespace shankesgk2\NetEaseIM\Exception
NetEaseIM — Class in namespace shankesgk2\NetEaseIM\Facade
NetEaseIM — Class in namespace shankesgk2\NetEaseIM: 网易云信API
$NetEaseIM#Nonce — Property in class NetEaseIM
NetEaseIMServiceProvider — Class in namespace shankesgk2\NetEaseIM

P

NetEaseIM::post() — Method in class NetEaseIM: 组装网易云接口必要数据,发送http post请求
NetEaseIMServiceProvider::provides() — Method in class NetEaseIMServiceProvider: Get the services provided by the provider.

R

NetEaseIMServiceProvider::register() — Method in class NetEaseIMServiceProvider: Register the service provider.

S

NetEaseIM::setDebug() — Method in class NetEaseIM: 设置\GuzzleHttp\Client调试
SmsTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 短信功能
SmsTrait::smsSendcode() — Method in class SmsTrait: 发送短信/语音短信验证码
SmsTrait::smsVerifycode() — Method in class SmsTrait: 校验指定手机号的验证码是否合法。
SmsTrait::smsSendtemplate() — Method in class SmsTrait: 发送模板短信
SmsTrait::smsQuerystatus() — Method in class SmsTrait: 查询通知类和运营类短信发送状态根据短信的sendid(sendtemplate.action接口中的返回值)，查询短信发送结果。

T

TeamTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 群组功能(高级群)
TeamTrait::teamCreate() — Method in class TeamTrait: 创建群组
TeamTrait::teamAdd() — Method in class TeamTrait: 拉人入群
TeamTrait::teamKick() — Method in class TeamTrait: 踢人出群
TeamTrait::teamRemove() — Method in class TeamTrait: 解散群
TeamTrait::teamUpdate() — Method in class TeamTrait: 更新群组
TeamTrait::teamQuery() — Method in class TeamTrait: 群信息与成员列表查询高级群信息与成员列表查询，一次最多查询30个群相关的信息，跟据ope参数来控制是否带上群成员列表；查询群成员会稍微慢一些，所以如果不需要群成员列表可以只查群信息；此接口受频率控制，某个应用一分钟最多查询30次，超过会返回416，并且被屏蔽一段时间；群成员的群列表信息中增加管理员成员admins的返回
TeamTrait::teamQueryDetail() — Method in class TeamTrait: 获取群组详细信息查询指定群的详细信息（群信息+成员详细信息）
TeamTrait::teamGetMarkReadInfo() — Method in class TeamTrait: 获取群组已读消息的已读详情信息
TeamTrait::TeamChangeOwner() — Method in class TeamTrait: 移交群主转换群主身份；群主可以选择离开此群，还是留下来成为普通成员。
TeamTrait::teamAddManager() — Method in class TeamTrait: 任命管理员提升普通成员为群管理员，可以批量，但是一次添加最多不超过10个人。
TeamTrait::teamRemoveManager() — Method in class TeamTrait: 移除管理员解除管理员身份，可以批量，但是一次解除最多不超过10个人
TeamTrait::teamJoinTeams() — Method in class TeamTrait: 获取某个用户所加入高级群的群信息
TeamTrait::teamUpdateTeamNick() — Method in class TeamTrait: 修改群昵称
TeamTrait::teamMuteTeam() — Method in class TeamTrait: 修改消息提醒开关
TeamTrait::teamMuteTlist() — Method in class TeamTrait: 禁言群成员
TeamTrait::teamLeave() — Method in class TeamTrait: 主动退群
TeamTrait::teamMuteTlistAll() — Method in class TeamTrait: 将群组整体禁言
TeamTrait::teamListTeamMute() — Method in class TeamTrait: 获取群组禁言列表

U

UserTrait — Class in namespace shankesgk2\NetEaseIM\Traits: 网易云通信ID 用户名片、设置、关系托管
UserTrait::userCreateUserId() — Method in class UserTrait: 创建云信ID 1.第三方帐号导入到云信平台； 2.注意accid，name长度以及考虑管理秘钥token
UserTrait::userUpdateUserId() — Method in class UserTrait: 更新云信ID
UserTrait::userRefreshToken() — Method in class UserTrait: 更新并获取新token
UserTrait::userBlockUser() — Method in class UserTrait: 封禁网易云通信ID
UserTrait::userUnBlockUser() — Method in class UserTrait: 解封网易云通信ID
UserTrait::userUpdateUserInfo() — Method in class UserTrait: 更新用户名片
UserTrait::userGetUserInfo() — Method in class UserTrait: 获取用户名片
UserTrait::userSetDonnop() — Method in class UserTrait: 设置桌面端在线时，移动端是否需要推送
UserTrait::userMute() — Method in class UserTrait: 账号全局禁言设置或取消账号的全局禁言状态；账号被设置为全局禁言后，不能发送“点对点”、“群”、“聊天室”消息
UserTrait::userMuteAv() — Method in class UserTrait: 账号全局禁用音视频账号被设置为禁用音视频后，不能发起点对点音视频、创建多人音视频、发起点对点白板、创建多人白板
UserTrait::userAddFriend() — Method in class UserTrait: 添加好友
UserTrait::userUpdateFriend() — Method in class UserTrait: 更新好友相关信息
UserTrait::userDeleteFriend() — Method in class UserTrait: 删除好友
UserTrait::userGetFriend() — Method in class UserTrait: 获取好友关系
UserTrait::userSetSpecialRelation() — Method in class UserTrait: 设置黑名单/静音
UserTrait::userListBlackAndMuteList() — Method in class UserTrait: 查看/获取指定用户的黑名单和静音列表

_

NetEaseIMException::__construct() — Method in class NetEaseIMException
NetEaseIM::__construct() — Method in class NetEaseIM: NetEaseIM constructor.