Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface OpenIMClient

OCR Connector client interface

Hierarchy

  • OpenIMClient

Index

Methods

Methods

GetRoleByUserId

  • GetRoleByUserId(rid: string, uid: string): IMResponse

  • 根据userId查角色信息

    Parameters

    • rid: string

      房间id

    • uid: string

      用户id

    Returns IMResponse

adminLogin

  • adminLogin(operationID: string, platform: number): LoginResponse

  • 管理员登录

    Parameters

    • operationID: string

      操作ID，必选

    • platform: number

      平台ID，取值范围 [1,7]，必选

    Returns LoginResponse

    返回登录信息 Data(ExpiredTime,Token,UserID), ErrCode, ErrMsg

createGroup

  • createGroup(id: string, operationID: string, groupName: string, groupID: string, groupType: number): GroupResponse

  • 创建群组

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • groupName: string

      群组名称，必选

    • groupID: string

      群组ID，必选

    • groupType: number

      群组类型，必选

    Returns GroupResponse

    返回群组信息 Data(GroupID,GroupName,MemberCount,Notification,Status), ErrCode, ErrMsg

createRoom

  • 创建房间

    Parameters

    • rid: string

      房间id

    Returns IMResponse

deleteRole

  • deleteRole(uid: string, rid: string): string

  • 删除角色

    Parameters

    • uid: string

      用户ID

    • rid: string

      房间id

    Returns string

    uid

deleteRoom

  • deleteRoom(rid: string): string

  • 删除房间

    Parameters

    • rid: string

      房间id

    Returns string

deleteRoomHistory

  • deleteRoomHistory(uuid: string, rid: string): string

  • 删除历史聊天记录

    Parameters

    • uuid: string

      消息记录的uuid, 可查询获取

    • rid: string

      房间id

    Returns string

dismissGroup

  • dismissGroup(id: string, operationID: string, groupID: string): GroupResponse

  • 解散群组

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • groupID: string

      群组ID，必选

    Returns GroupResponse

    返回 ErrCode, ErrMsg

getGroupAllMemberList

  • 获取群组中的用户列表

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • groupID: string

      群组ID，必选

    • offset: number

      查询偏移量，从 0 开始，必选

    • count: number

      查询多少个， 0 查询全部，必选

    Returns GetGrpAllMemberListResponse

    返回用户列表 Data(...), ErrCode, ErrMsg

getRole

  • 查所有角色信息

    Parameters

    • rid: string

      房间id

    Returns IMResponse

getRoomCount

  • 查询房间人数

    Parameters

    • rid: string

      房间id

    Returns IMResponse

    人数信息

getRoomHistory

  • 查询历史聊天记录

    Parameters

    • rid: string

      房间id

    Returns IMResponse

    历史聊天记录

getRoomMember

  • getRoomMember(rid: string, offset: number, limit: number): IMResponse

  • 查询房间人员

    Parameters

    • rid: string

      房间id

    • offset: number

      起始位

    • limit: number

      限制数

    Returns IMResponse

    房间人员信息

getUsersOnlineStatus

  • 获取群组中的用户列表

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • userList: string[]

      用户列表，必选

    Returns GetUsersOnlineStatusResponse

    返回用户列表 Data(...), ErrCode, ErrMsg

inviteUserToGroup

  • inviteUserToGroup(id: string, operationID: string, groupID: string, userList: string[]): GroupResponse

  • 邀请用户进入群组

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • groupID: string

      群组ID，必选

    • userList: string[]

      用户列表，必选

    Returns GroupResponse

    返回 ErrCode, ErrMsg

kickGroup

  • kickGroup(id: string, operationID: string, groupID: string, userList: string[]): GroupResponse

  • 把用户从踢出群组

    Parameters

    • id: string

      是登录接口返回的 token，必选

    • operationID: string

      操作ID，必选

    • groupID: string

      群组ID，必选

    • userList: string[]

      用户列表，必选

    Returns GroupResponse

    返回 ErrCode, ErrMsg

login

  • 用户登录

    Parameters

    • operationID: string

      操作ID，必选

    • platform: number

      平台ID，取值范围 [1,7]，必选

    Returns LoginResponse

    返回登录信息 Data(ExpiredTime,Token,UserID), ErrCode, ErrMsg

pushRoom

  • pushRoom(rid: string, flag: string, msg: string): IMResponse

  • 发送消息

    Parameters

    • rid: string

      房间id

    • flag: string

      "s"或"S时发送信令操作 "m", "M"时广播到房间消息操作

    • msg: string

      消息内容

    Returns IMResponse

pushUser

  • 发布订阅消息

    Parameters

    • uid: string

      接收消息的user

    • msg: string

      消息内容

    Returns IMResponse

register

  • register(userID: string, operationID: string, platform: number, faceURL: string, gender: number, nickname: string, email: string, ex: string): RegisterResponse

  • 注销新用户

    Parameters

    • userID: string

      待注册的用户ID，字符串类型，必选

    • operationID: string

      操作ID，必选

    • platform: number

      平台ID，取值范围 [1,7]，必选

    • faceURL: string

      头像URL，可选

    • gender: number

      性别，取值范围 [0,1] 女=0，男=1，必选

    • nickname: string

      昵称，必选

    • email: string

      电子邮箱，可选

    • ex: string

      扩展信息，可选

    Returns RegisterResponse

    返回注册信息 Data(ExpiredTime,Token,UserID), ErrCode, ErrMsg

restrictRoom

  • restrictRoom(rid: string, uid: string, restrict: boolean): IMResponse

  • 禁言

    Parameters

    • rid: string

      房间id

    • uid: string

      用户ID

    • restrict: boolean

      禁言标识

    Returns IMResponse

setRole

  • setRole(uid: string, rid: string, role: string): IMResponse

  • 设置角色

    Parameters

    • uid: string

      用户id

    • rid: string

      房间id

    • role: string

      角色

    Returns IMResponse