SDK

SDK

即时通信 IM SDK 基本概念:

基本概念 说明
Message(消息) IM SDK 中 Message 表示要发送给对方的内容,消息包括若干属性,例如自己是否为发送者,发送人帐号以及消息产生时间等。
Conversation(会话) IM SDK 中 Conversation 分为两种:
  • C2C(Client to Client)会话,表示单聊情况,自己与对方建立的对话。
  • GROUP(群)会话,表示群聊情况下群内成员组成的会话。
  • Profile(资料) IM SDK 中 Profile 描述个人的常用基本信息,例如昵称、性别、个性签名以及头像地址等。
    Group(群组) IM SDK 中 Group 表示一个支持多人聊天的通信系统,支持私有群、公开群、聊天室以及音视频聊天室。
    GroupMember(群成员) IM SDK 中 GroupMember 描述群内成员的常用基本信息,例如 ID、昵称、群内身份以及入群时间等。
    群提示消息 当有用户被邀请加入群组或被移出群组等事件发生时,群内会产生提示消息,接入侧可以根据实际需求展示给群组用户或忽略。
    群提示消息有多种类型,详细描述请参见 Message.GroupTipPayload
    群系统通知消息 当有用户申请加群等事件发生时,管理员会收到申请加群等系统消息。管理员同意或拒绝加群申请,IM SDK 会通过群系统通知消息将申请加群等相应消息发送给接入侧,由接入侧展示给用户。
    群系统通知消息有多种类型,详细描述请参见 Message.GroupSystemNoticePayload
    消息上屏 用户单击发送后,事先输入的文字或选择的图片等信息显示在用户电脑屏幕或手机屏幕上的过程。

    支持的平台:

    • IM SDK 支持 IE 9+、Chrome、微信、手机QQ、QQ 浏览器、FireFox、Opera 和 Safari。

    Web项目集成 SDK

    集成方式 示例
    NPM 集成 // IM Web SDK
    npm install tim-js-sdk --save
    // 发送图片、文件等消息需要的 COS SDK
    npm install cos-js-sdk-v5 --save
    Script 集成 在您的项目中使用 script 标签引入 SDK,并初始化
    IM Web SDK 下载地址:IM Web SDK
    腾讯云 COS JS SDK 源码下载地址:腾讯云 COS JS SDK

    微信小程序项目集成 SDK

    集成方式 示例
    NPM 集成 // IM 小程序 SDK
    npm install tim-wx-sdk --save
    // 发送图片、文件等消息需要的 COS SDK
    npm install cos-wx-sdk-v5 --save
    Example
    import TIM from 'tim-js-sdk';
    // import TIM from 'tim-wx-sdk'; // 微信小程序环境请取消本行注释,并注释掉 import TIM from 'tim-js-sdk';
    import COS from 'cos-js-sdk-v5';
    // import COS from 'cos-wx-sdk-v5'; // 微信小程序环境请取消本行注释,并注释掉 import COS from 'cos-js-sdk-v5';
    
    // 创建 SDK 实例,TIM.create() 方法对于同一个 SDKAppID 只会返回同一份实例
    let options = {
      SDKAppID: 0 // 接入时需要将0替换为您的即时通信应用的 SDKAppID
    };
    let tim = TIM.create(options); // SDK 实例通常用 tim 表示
    // 设置 SDK 日志输出级别为 release 级别,详细分级请参见 setLogLevel 接口的说明
    tim.setLogLevel(1);
    
    // 将腾讯云对象存储服务 SDK (以下简称 COS SDK)注册为插件,IM SDK 发送文件、图片等消息时,需要用到腾讯云的 COS 服务
    // HTML5 环境,注册 COS SDK
    tim.registerPlugin({'cos-js-sdk': COS});
    
    // 微信小程序环境,注册 COS SDK
    //tim.registerPlugin({'cos-wx-sdk': COS}); // 微信小程序环境请取消本行注释,并注释掉 tim.registerPlugin({'cos-js-sdk': COS});
    
    // 监听事件,如:
    tim.on(TIM.EVENT.SDK_READY, function(event) {
      // 收到离线消息和会话列表同步完毕通知,接入侧可以调用 sendMessage 等需要鉴权的接口
      // event.name - TIM.EVENT.SDK_READY
    });
    
    tim.on(TIM.EVENT.MESSAGE_RECEIVED, function(event) {
      // 收到推送的单聊、群聊、群提示、群系统通知的新消息,可通过遍历 event.data 获取消息列表数据并渲染到页面
      // event.name - TIM.EVENT.MESSAGE_RECEIVED
      // event.data - 存储 Message 对象的数组 - [Message]
    });
    
    tim.on(TIM.EVENT.CONVERSATION_LIST_UPDATED, function(event) {
      // 收到会话列表更新通知,可通过遍历 event.data 获取会话列表数据并渲染到页面
      // event.name - TIM.EVENT.CONVERSATION_LIST_UPDATED
      // event.data - 存储 Conversation 对象的数组 - [Conversation]
    });
    
    tim.on(TIM.EVENT.GROUP_LIST_UPDATED, function(event) {
      // 收到群组列表更新通知,可通过遍历 event.data 获取群组列表数据并渲染到页面
      // event.name - TIM.EVENT.GROUP_LIST_UPDATED
      // event.data - 存储 Group 对象的数组 - [Group]
    });
    
    tim.on(TIM.EVENT.GROUP_SYSTEM_NOTICE_RECEIVED, function(event) {
      // 收到新的群系统通知
      // event.name - TIM.EVENT.GROUP_SYSTEM_NOTICE_RECEIVED
      // event.data.type - 群系统通知的类型,详情请参见 GroupSystemNoticePayload 的 <a href="https://imsdk-1252463788.file.myqcloud.com/IM_DOC/Web/Message.html#.GroupSystemNoticePayload"> operationType 枚举值说明</a>
      // event.data.message - Message 对象,可将 event.data.message.content 渲染到到页面
    });
    
    tim.on(TIM.EVENT.PROFILE_UPDATED, function(event) {
      // 收到自己或好友的资料变更通知
      // event.name - TIM.EVENT.PROFILE_UPDATED
      // event.data - 存储 Profile 对象的数组 - [Profile]
    });
    
    tim.on(TIM.EVENT.BLACKLIST_UPDATED, function(event) {
      // 收到黑名单列表更新通知
      // event.name - TIM.EVENT.BLACKLIST_UPDATED
      // event.data - 存储 userID 的数组 - [userID]
    });
    
    tim.on(TIM.EVENT.ERROR, function(event) {
      // 收到 SDK 发生错误通知,可以获取错误码和错误信息
      // event.name - TIM.EVENT.ERROR
      // event.data.code - 错误码
      // event.data.message - 错误信息
    });
    
    tim.on(TIM.EVENT.SDK_NOT_READY, function(event) {
      // 收到 SDK 进入 not ready 状态通知,此时 SDK 无法正常工作
      // event.name - TIM.EVENT.SDK_NOT_READY
    });
    
    tim.on(TIM.EVENT.KICKED_OUT, function(event) {
      // 收到被踢下线通知
      // event.name - TIM.EVENT.KICKED_OUT
      // event.data.type - 被踢下线的原因,例如 TIM.TYPES.KICKED_OUT_MULT_ACCOUNT 多账号登录被踢
    });
    
    // 开始登录
    tim.login({userID: 'your userID', userSig: 'your userSig'});
    Parameters:
    Name Type Description
    options Object

    应用配置

    Properties
    Name Type Description
    SDKAppID Number

    云通信应用的 SDKAppID

    Methods

    login(options) → {Promise}

    使用 用户ID(userID) 和 签名串(userSig) 登录即时通信 IM,登录流程有若干个异步执行的步骤,使用返回的 Promise 对象处理登录成功或失败。

    注意1:登录成功,需等待 sdk 处于 ready 状态后(监听事件 TIM.EVENT.SDK_READY)才能调用 sendMessage 等需要鉴权的接口。
    注意2:默认情况下,不支持多实例登录,即如果此帐号已在其他页面登录,若继续在当前页面登录成功,有可能会将其他页面踢下线。用户被踢下线时会触发事件TIM.EVENT.KICKED_OUT,用户可在监听到事件后做相应处理。
    如需支持多实例登录(允许在多个网页中同时登录同一帐号),请到 即时通信 IM 控制台,找到相应 SDKAppID,【应用配置】 > 【功能配置】> 【Web端实例同时在线】配置实例个数。配置将在50分钟内生效。

    Example
    let promise = tim.login({userID: 'your userID', userSig: 'your userSig'});
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 登录成功
    }).catch(function(imError) {
      console.warn('login error:', imError); // 登录失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    登录配置

    Properties
    Name Type Description
    userID String

    用户 ID

    userSig String

    用户登录即时通信 IM 的密码,其本质是对 UserID 等信息加密后得到的密文。
    具体生成方法请参见生成 UserSig

    Returns:
    Type
    Promise

    logout() → {Promise}

    登出即时通信 IM,通常在切换帐号的时候调用,清除登录态以及内存中的所有数据。

    注意:在多实例被踢时(同一设备,多个页面登录同一账号),SDK 内部会执行登出流程,再抛出 KICKED_OUT 事件。接入侧可在事件触发时,跳转到登录页面。

    Example
    let promise = tim.logout();
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 登出成功
    }).catch(function(imError) {
      console.warn('logout error:', imError);
    });
    Returns:
    Type
    Promise

    on(eventName, handler, contextopt)

    监听事件。

    注意:请在调用 login 接口前调用此接口监听事件,避免漏掉 SDK 派发的事件。

    Example
    let onMessageReceived = function(event) {
      // 收到推送的单聊、群聊、群提示、群系统通知的新消息,可通过遍历 event.data 获取消息列表数据并渲染到页面
      // event.name - TIM.EVENT.MESSAGE_RECEIVED
      // event.data - 存储 Message 对象的数组 - [Message]
    };
    tim.on(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);
    Parameters:
    Name Type Attributes Description
    eventName String

    事件名称。所有的事件名称都存放在 TIM.EVENT 变量中,如需要查看可以使用 console.log(TIM.EVENT) 把所有的事件显示出来。事件列表

    handler function

    处理事件的方法,当事件触发时,会调用此handler进行处理。

    context * <optional>

    期望 handler 执行时的上下文

    off(eventName, handler, contextopt, onceopt)

    取消监听事件。

    Example
    let onMessageReceived = function(event) {
      // 收到推送的单聊、群聊、群提示、群系统通知的新消息,可通过遍历 event.data 获取消息列表数据并渲染到页面
      // event.name - TIM.EVENT.MESSAGE_RECEIVED
      // event.data - 存储 Message 对象的数组 - [Message]
    };
    tim.off(TIM.EVENT.MESSAGE_RECEIVED, onMessageReceived);
    Parameters:
    Name Type Attributes Description
    eventName String

    事件名称。所有的事件名称都存放在 TIM.EVENT 变量中,如需要查看可以使用 console.log(TIM.EVENT) 把所有的事件显示出来。事件列表

    handler function

    处理事件的方法,当事件触发时,会调用此handler进行处理。

    context * <optional>

    期望 handler 执行时的上下文

    once Boolean <optional>

    registerPlugin(optoins)

    注册插件。
    插件是一种遵循一定规范的应用程序接口编写出来的程序。在即时通信 IM SDK,发送图片、文件消息需要先将图片、文件上传到腾讯云对象存储,发送文本消息则不用,
    且在 HTML5 和小程序环境,上传图片、文件需要用到不同的文件上传 SDK 。因此我们将此功能设计成插件机制,方便您根据实际需要做定制化开发。

    Examples
    // 微信小程序环境
    import COS from 'cos-wx-sdk-v5';
    tim.registerPlugin({'cos-wx-sdk': COS}); // 在 login 前调用,以支持文件上传腾讯云对象存储
    tim.login({userID: 'your userID', userSig: 'your userSig'});
    // HTML5 环境
    import COS from 'cos-js-sdk-v5';
    tim.registerPlugin({'cos-js-sdk': COS}); // 在 login 前调用,以支持文件上传腾讯云对象存储
    tim.login({userID: 'your userID', userSig: 'your userSig'});
    Parameters:
    Name Type Description
    optoins Object

    插件配置

    Properties
    Name Type Description
    key String

    插件名称,目前支持的插件名称有:

    value Class

    插件类

    setLogLevel(level)

    设置日志级别,低于 level 的日志将不会输出。

    Example
    tim.setLogLevel(1);
    Parameters:
    Name Type Description
    level Number

    日志级别

    • 0 普通级别,日志量较多,接入时建议使用
    • 1 release级别,SDK 输出关键信息,生产环境时建议使用
    • 2 告警级别,SDK 只输出告警和错误级别的日志
    • 3 错误级别,SDK 只输出错误级别的日志
    • 4 无日志级别,SDK 将不打印任何日志

    createTextMessage(options) → {Message}

    创建文本消息的接口,此接口返回一个消息实例,可以在需要发送文本消息时调用 发送消息 接口发送消息。

    Example
    // 发送文本消息,Web 端与小程序端相同
    // 1. 创建消息实例,接口返回的实例可以上屏
    let message = tim.createTextMessage({
      to: 'user1',
      conversationType: TIM.TYPES.CONV_C2C,
      payload: {
        text: 'Hello world!'
      }
    });
    // 2. 发送消息
    let promise = tim.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    to String

    消息接收方的 userID 或 groupID

    conversationType String

    会话类型,取值TIM.TYPES.CONV_C2C(端到端会话) 或 TIM.TYPES.CONV_GROUP(群组会话)

    payload Object

    消息内容的容器

    Properties
    Name Type Description
    text String

    消息文本内容

    Returns:

    消息实例

    Type
    Message

    createImageMessage(options) → {Message}

    创建图片消息的接口,此接口返回一个消息实例,可以在需要发送图片消息时调用 发送消息 接口发送消息。

    Examples
    // Web 端发送图片消息
    // 1. 创建消息实例,接口返回的实例可以上屏
    let message = tim.createImageMessage({
      to: 'user1',
      conversationType: TIM.TYPES.CONV_C2C,
      payload: {
        file: document.getElementById('imagePicker'),
      },
      onProgress: function(event) { console.log('file uploading:', event) }
    });
    // 2. 发送消息
    let promise = tim.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
    // 小程序端发送图片
    // 1. 选择图片
    wx.chooseImage({
      sourceType: ['album'], // 从相册选择
      count: 1, // 只选一张,目前 SDK 不支持一次发送多张图片
      success: function (res) {
        // 2. 创建消息实例,接口返回的实例可以上屏
        let message = tim.createImageMessage({
          to: 'user1',
          conversationType: TIM.TYPES.CONV_C2C,
          payload: { file: res },
          onProgress: function(event) { console.log('file uploading:', event) }
        });
        // 3. 发送图片
        let promise = tim.sendMessage(message);
        promise.then(function(imResponse) {
          // 发送成功
          console.log(imResponse);
        }).catch(function(imError) {
          // 发送失败
          console.warn('sendMessage error:', imError);
        });
      }
    })
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    to String

    消息接收方的 userID 或 groupID

    conversationType String

    会话类型,取值TIM.TYPES.CONV_C2C(端到端会话) 或 TIM.TYPES.CONV_GROUP(群组会话)

    payload Object
    Properties
    Name Type Description
    file HTMLInputElement | Object

    用于选择图片的 DOM 节点(Web)或者微信小程序 wx.chooseImage 接口的 success 回调参数。SDK 会读取其中的数据并上传图片。

    onProgress function

    获取上传进度的回调函数

    Returns:

    消息实例

    Type
    Message

    createAudioMessage(options) → {Message}

    创建音频消息实例的接口,此接口返回一个消息实例,可以在需要发送音频消息时调用 发送消息 接口发送消息。 目前 createAudioMessage 只支持在微信小程序环境使用。

    Example
    // 示例:使用微信官方的 RecorderManager 进行录音,参考 https://developers.weixin.qq.com/minigame/dev/api/media/recorder/RecorderManager.start.html
    // 1. 获取全局唯一的录音管理器 RecorderManager
    const recorderManager = wx.getRecorderManager();
    
    // 录音部分参数
    const recordOptions = {
      duration: 60000, // 录音的时长,单位 ms,最大值 600000(10 分钟)
      sampleRate: 44100, // 采样率
      numberOfChannels: 1, // 录音通道数
      encodeBitRate: 192000, // 编码码率
      format: 'aac' // 音频格式,选择此格式创建的音频消息,可以在即时通信 IM 全平台(Android、iOS、微信小程序和Web)互通
    };
    
    // 2.1 监听录音错误事件
    recorderManager.onError(function(errMsg) {
      console.warn('recorder error:', errMsg);
    });
    // 2.2 监听录音结束事件,录音结束后,调用 createAudioMessage 创建音频消息实例
    recorderManager.onStop(function(res) {
      console.log('recorder stop', res);
    
      // 4. 创建消息实例,接口返回的实例可以上屏
      const message = tim.createAudioMessage({
        to: 'user1',
        conversationType: TIM.TYPES.CONV_C2C,
        payload: {
          file: res
        }
      });
    
      // 5. 发送消息
      let promise = tim.sendMessage(message);
      promise.then(function(imResponse) {
        // 发送成功
        console.log(imResponse);
      }).catch(function(imError) {
        // 发送失败
        console.warn('sendMessage error:', imError);
      });
    });
    
    // 3. 开始录音
    recorderManager.start(recordOptions);
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    to String

    消息接收方的 userID 或 groupID

    conversationType String

    会话类型,取值TIM.TYPES.CONV_C2C(端到端会话) 或 TIM.TYPES.CONV_GROUP(群组会话)

    payload Object
    Properties
    Name Type Description
    file Object

    录音后得到的文件信息

    Returns:

    消息实例

    Type
    Message

    createFileMessage(options) → {Message}

    创建文件消息的接口,此接口返回一个消息实例,可以在需要发送文件消息时调用 发送消息 接口发送消息。

    注意:微信小程序目前不支持选择文件的功能,故该接口暂不支持微信小程序端。

    Example
    // 发送文件消息
    // 1. 创建文件消息实例,接口返回的实例可以上屏
    let message = createFileMessage({
      to: 'user1',
      conversationType: TIM.TYPES.CONV_C2C,
      payload: {
        file: document.getElementById('filePicker'),
      },
      onProgress: function(event) { console.log('file uploading:', event) }
    });
    // 2. 发送消息
    let promise = tim.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    to String

    消息接收方的 userID 或 groupID

    conversationType String

    会话类型,取值TIM.TYPES.CONV_C2C(端到端会话) 或 TIM.TYPES.CONV_GROUP(群组会话)

    payload Object
    Properties
    Name Type Description
    file HTMLInputElement

    用于选择文件的 DOM 节点,SDK 会读取其中的数据并上传文件。

    onProgress function

    获取上传进度的回调函数

    Returns:

    消息实例

    Type
    Message

    createCustomMessage(options) → {Message}

    创建自定义消息实例的接口,此接口返回一个消息实例,可以在需要发送自定义消息时调用 发送消息 接口发送消息。 当 SDK 提供的能力不能满足您的需求时,可以使用自定义消息进行个性化定制,例如投骰子功能。

    Example
    // 示例:利用自定义消息实现投骰子功能
    // 1. 定义随机函数
    function random(min, max) {
      return Math.floor(Math.random() * (max - min + 1) + min);
    }
    // 2. 创建消息实例,接口返回的实例可以上屏
    let message = tim.createCustomMessage({
      to: 'user1',
      conversationType: TIM.TYPES.CONV_C2C,
      payload: {
        data: 'dice', // 用于标识该消息是骰子类型消息
        description: String(random(1,6)), // 获取骰子点数
        extension: ''
      }
    });
    // 3. 发送消息
    let promise = tim.sendMessage(message);
    promise.then(function(imResponse) {
      // 发送成功
      console.log(imResponse);
    }).catch(function(imError) {
      // 发送失败
      console.warn('sendMessage error:', imError);
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    to String

    消息接收方的 userID 或 groupID

    conversationType String

    会话类型,取值TIM.TYPES.CONV_C2C(端到端会话) 或 TIM.TYPES.CONV_GROUP(群组会话)

    payload Object
    Properties
    Name Type Description
    data String

    自定义消息的数据字段

    description String

    自定义消息的说明字段

    extension String

    自定义消息的扩展字段

    Returns:

    消息实例

    Type
    Message

    sendMessage(message) → {Promise}

    发送消息的接口,需先调用下列的创建消息实例的接口获取消息实例后,再调用该接口发送消息实例。

    注意1:调用该接口发送消息实例,需要 sdk 处于 ready 状态,否则将无法发送消息实例。sdk 状态,可通过监听以下事件得到:

    注意2:接收推送的单聊、群聊、群提示、群系统通知的新消息,需监听事件 TIM.EVENT.MESSAGE_RECEIVED
    注意3:本实例发送的消息,不会触发事件 TIM.EVENT.MESSAGE_RECEIVED。同账号从其他端(或通过 REST API)发送的消息,会触发事件 TIM.EVENT.MESSAGE_RECEIVED

    Parameters:
    Name Type Description
    message Message

    消息实例

    Returns:
    Type
    Promise

    resendMessage(message) → {Promise}

    重发消息的接口,当消息发送失败时,调用该接口进行重发。

    注意:目前暂不支持图片和文件消息重发。

    Example
    // 重发消息
    let promise = tim.resendMessage(message); // 传入需要重发的消息实例
    promise.then(function(imResponse) {
      // 重发成功
      console.log(imResponse.data.message);
    }).catch(function(imError) {
      // 重发失败
      console.warn('resendMessage error:', imError);
    });
    Parameters:
    Name Type Description
    message Message

    待重发的消息实例

    Returns:
    Type
    Promise

    getMessageList(options) → {Promise}

    分页拉取指定会话的消息列表的接口,当用户进入会话首次渲染消息列表或者用户“下拉查看更多消息”时,需调用该接口。

    注意:该接口可用于"拉取历史消息"

    See:
    Examples
    // 打开某个会话时,第一次拉取消息列表
    let promise = tim.getMessageList({conversationID: 'C2Ctest', count: 15});
    promise.then(function(imResponse) {
      const messageList = imResponse.data.messageList; // 消息列表。
      const nextReqMessageID = imResponse.data.nextReqMessageID; // 用于续拉,分页续拉时需传入该字段。
      const isCompleted = imResponse.data.isCompleted; // 表示是否已经拉完所有消息。
    });
    // 下拉查看更多消息
    let promise = tim.getMessageList({conversationID: 'C2Ctest', nextReqMessageID, count: 15});
    promise.then(function(imResponse) {
      const messageList = imResponse.data.messageList; // 消息列表。
      const nextReqMessageID = imResponse.data.nextReqMessageID; // 用于续拉,分页续拉时需传入该字段。
      const isCompleted = imResponse.data.isCompleted; // 表示是否已经拉完所有消息。
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Default Description
    conversationID String

    会话 ID

    nextReqMessageID String

    用于分页续拉的消息 ID。第一次拉取时该字段可不填,每次调用该接口会返回该字段,续拉时将返回字段填入即可。

    count Number <optional>
    15

    需要拉取的消息数量,默认值和最大值为15,即一次拉取至多返回15条消息。

    Returns:
    Type
    Promise

    setMessageRead(options) → {Promise}

    将某会话下的未读消息状态设置为已读,置为已读的消息不会计入到未读统计,当打开会话或切换会话时调用该接口。如果在打开/切换会话时,不调用该接口,则对应的消息会一直是未读的状态。

    Example
    // 将某会话下所有未读消息已读上报
    let promise = tim.setMessageRead({conversationID: 'C2Cexample'});
    promise.then(function(imResponse) {
      // 已读上报成功
    }).catch(function(imError) {
      // 已读上报失败
      console.warn('setMessageRead error:', imError);
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    conversationID String

    会话 ID

    Returns:
    Type
    Promise

    getConversationList() → {Promise}

    获取会话列表的接口,该接口拉取最近的100条会话,当需要刷新会话列表时调用该接口。

    See:
    Example
    // 拉取会话列表
    let promise = tim.getConversationList();
    promise.then(function(imResponse) {
      const conversationList = imResponse.data.conversationList; // 会话列表,用该列表覆盖原有的会话列表
    }).catch(function(imError) {
      console.warn('getConversationList error:', imError); // 获取会话列表失败的相关信息
    });
    Returns:
    Type
    Promise

    getConversationProfile(conversationID) → {Promise}

    获取会话资料的接口,当点击会话列表中的某个会话时,调用该接口获取会话的详细信息。

    See:
    • 会话结构描述
    Example
    let promise = tim.getConversationProfile(conversationID);
    promise.then(function(imResponse) {
      // 获取成功
      console.log(imResponse.data.conversation); // 会话资料
    }).catch(function(imError) {
      console.warn('getConversationProfile error:', imError); // 获取会话资料失败的相关信息
    });
    Parameters:
    Name Type Description
    conversationID String

    会话 ID

    Returns:
    Type
    Promise

    deleteConversation(conversationID) → {Promise}

    根据会话 ID 删除会话的接口。该接口只删除会话,不删除消息,例如:删除与用户 A 的会话,下次再与用户 A 发起会话时,之前的聊天信息仍在。

    See:
    • 会话结构描述
    Example
    let promise = tim.deleteConversation('C2CExample');
    promise.then(function(imResponse) {
      //删除成功。
      const { conversationID } = imResponse.data;// 被删除的会话 ID
    }).catch(function(imError) {
      console.warn('deleteConversation error:', imError); // 删除会话失败的相关信息
    });
    Parameters:
    Name Type Description
    conversationID String

    会话ID

    Returns:
    Type
    Promise

    getMyProfile() → {Promise}

    获取个人资料

    See:
    • 资料结构描述
    Example
    let promise = tim.getMyProfile();
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 个人资料 - Profile 实例
    }).catch(function(imError) {
      console.warn('getMyProfile error:', imError); // 获取个人资料失败的相关信息
    });
    Returns:
    Type
    Promise

    getUserProfile(options) → {Promise}

    获取其他用户资料

    注意:每次拉取的用户数不超过100,避免因回包数据量太大导致回包失败。如果传入的数组长度大于100,则只取前100个用户进行查询,其余丢弃。

    Example
    let promise = tim.getUserProfile({
      userIDList: ['user1', 'user2'] // 请注意:即使只拉取一个用户的资料,也需要用数组类型,例如:userIDList: ['user1']
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 存储用户资料的数组 - [Profile]
    }).catch(function(imError) {
      console.warn('getUserProfile error:', imError); // 获取其他用户资料失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    搜索参数

    Properties
    Name Type Description
    userIDList Array.<String>

    用户的账号列表,类型为数组

    Returns:
    Type
    Promise

    updateMyProfile(options) → {Promise}

    更新个人资料

    Example
    let promise = tim.updateMyProfile({
      nick: '我的昵称',
      avatar: 'http(s)://url/to/image.jpg',
      gender: TIM.TYPES.GENDER_MALE,
      selfSignature: '我的个性签名',
      allowType: TIM.TYPES.ALLOW_TYPE_ALLOW_ANY
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 更新资料成功
    }).catch(function(imError) {
      console.warn('updateMyProfile error:', imError); // 更新资料失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    资料参数

    Properties
    Name Type Description
    nick String

    昵称

    avatar String

    头像地址

    gender String

    性别:

    • TIM.TYPES.GENDER_UNKNOWN(未设置性别)
    • TIM.TYPES.GENDER_FEMALE(女)
    • TIM.TYPES.GENDER_MALE(男)
    selfSignature String

    个性签名

    allowType String

    当被加人加好友时:

    • TIM.TYPES.ALLOW_TYPE_ALLOW_ANY(允许直接加为好友)
    • TIM.TYPES.ALLOW_TYPE_NEED_CONFIRM(需要验证)
    • TIM.TYPES.ALLOW_TYPE_DENY_ANY(拒绝)
    birthday Number

    生日 推荐用法:20000101

    location String

    所在地 推荐用法:App 本地定义一套数字到地名的映射关系 后台实际保存的是4个 uint32_t 类型的数字: 其中第一个 uint32_t 表示国家; 第二个 uint32_t 用于表示省份; 第三个 uint32_t 用于表示城市; 第四个 uint32_t 用于表示区县

    language Number

    语言

    messageSettings Number

    消息设置 0:接收消息,1:不接收消息

    adminForbidType String

    管理员禁止加好友标识:

    • TIM.TYPES.FORBID_TYPE_NONE(默认值,允许加好友)
    • TIM.TYPES.FORBID_TYPE_SEND_OUT(禁止该用户发起加好友请求)
    level Number

    等级 建议拆分以保存多种角色的等级信息

    role Number

    角色 建议拆分以保存多种角色信息

    Returns:
    Type
    Promise

    getBlacklist() → {Promise}

    获取我的黑名单列表

    Example
    let promise = tim.getBlacklist();
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 我的黑名单列表,结构为包含用户 userID 的数组 - [userID]
    }).catch(function(imError) {
      console.warn('getBlacklist error:', imError); // 获取黑名单列表失败的相关信息
    });
    Returns:
    Type
    Promise

    addToBlacklist(options) → {Promise}

    添加用户到黑名单列表。将用户加入黑名单后可以屏蔽来自 TA 的所有消息,因此该接口可以实现“屏蔽该用户消息”的功能。

    • 如果用户 A 与用户 B 之间存在好友关系,拉黑时会解除双向好友关系。
    • 如果用户 A 与用户 B 之间存在黑名单关系,二者之间无法发起会话。
    • 如果用户 A 与用户 B 之间存在黑名单关系,二者之间无法发起加好友请求。
    Example
    let promise = tim.addToBlacklist({userIDList: ['user1', 'user2']}); // 请注意:即使只添加一个用户帐号到黑名单,也需要用数组类型,例如:userIDList: ['user1']
    promise.then(function(imResponse) {
      console.log(imResponse.data); // 成功添加到黑名单的账号信息,结构为包含用户 userID 的数组 - [userID]
    }).catch(function(imError) {
      console.warn('addToBlacklist error:', imError); // 添加用户到黑名单列表失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    userIDList Array.<String>

    待添加为黑名单的用户 userID 列表,单次请求的 userID 数不得超过1000

    Returns:
    Type
    Promise

    removeFromBlacklist(options) → {Promise}

    将用户从黑名单中移除。移除后,可以接收来自 TA 的所有消息。

    Example
    let promise = tim.removeFromBlacklist({userIDList: ['user1', 'user2']}); // 请注意:即使只从黑名单中移除一个用户帐号,也需要用数组类型,例如:userIDList: ['user1']
    result.then(function(imResponse) {
      console.log(imResponse.data); // 从黑名单中成功移除的账号列表,结构为包含用户 userID 的数组 - [userID]
    }).catch(function(imError) {
      console.warn('removeFromBlacklist error:', imError); // 将用户从黑名单中移除失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    option.userIDList Array.<String>

    待从黑名单中移除的 userID 列表,单次请求的 userID 数不得超过1000

    Returns:
    Type
    Promise

    getGroupList(options) → {Promise}

    需要渲染或刷新【我的群组列表】时,调用该接口获取群组列表,更多详情请参见 Group

    注意:接口返回的群组列表,不包含 TIM.TYPES.GRP_AVCHATROOM(音视频聊天室)类型的群组。

    See:
    Examples
    // 该接口默认只会拉取这些资料:群类型、群名称、群头像、最后一条消息的时间。
    let promise = tim.getGroupList();
    promise.then(function(imResponse) {
      console.log(imResponse.data.groupList); // 群组列表
    }).catch(function(imError) {
      console.warn('getGroupList error:', imError); // 获取群组列表失败的相关信息
    });
    // 若默认拉取的字段不满足需求,可以参考下述代码,拉取额外的资料字段。
    let promise = tim.getGroupList({
       groupProfileFilter: [TIM.TYPES.GRP_PROFILE_OWNER_ID],
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data.groupList); // 群组列表
    }).catch(function(imError) {
      console.warn('getGroupList error:', imError); // 获取群组列表失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    请求参数

    Properties
    Name Type Attributes Description
    groupProfileFilter Array.<String> <optional>

    群资料过滤器。除默认拉取的群资料外,指定需要额外拉取的群资料,支持的值如下:

    • TIM.TYPES.GRP_PROFILE_OWNER_ID(群主 ID)
    • TIM.TYPES.GRP_PROFILE_CREATE_TIME(群创建时间)
    • TIM.TYPES.GRP_PROFILE_LAST_INFO_TIME(最后一次群资料变更时间)
    • TIM.TYPES.GRP_PROFILE_MEMBER_NUM(群成员数量)
    • TIM.TYPES.GRP_PROFILE_MAX_MEMBER_NUM(最大群成员数量)
    • TIM.TYPES.GRP_PROFILE_JOIN_OPTION(申请加群选项)
    • TIM.TYPES.GRP_PROFILE_INTRODUCTION(群介绍)
    • TIM.TYPES.GRP_PROFILE_NOTIFICATION(群公告)
    Returns:
    Type
    Promise

    getGroupProfile(options) → {Promise}

    获取群详细资料

    See:
    Example
    let promise = tim.getGroupProfile({ groupID: 'group1', groupCustomFieldFilter: ['key1','key2'], memberCustomFieldFilter: ['key1', 'key2']});
    promise.then(function(imResponse) {
      console.log(imResponse.data.group);
    }).catch(function(imError) {
      console.warn('getGroupProfile error:', imError); // 获取群详细资料失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    groupID String

    群组ID

    groupCustomFieldFilter Array.<String> <optional>

    群组维度的自定义字段过滤器,指定需要获取的群组维度的自定义字段,详情请参阅 自定义字段

    memberCustomFieldFilter Array.<String> <optional>

    群成员维度的自定义字段过滤器,指定需要获取的群成员维度的自定义字段,详情请参阅 自定义字段

    Returns:
    Type
    Promise

    createGroup(options) → {Promise}

    创建群组

    注意:该接口创建 TIM.TYPES.GRP_AVCHATROOM(音视频聊天室) 后,需调用 joinGroup 接口加入群组后,才能进行消息收发流程。

    See:
    Example
    // 创建私有群
    let promise = tim.createGroup({
      type: TIM.TYPES.GRP_PRIVATE,
      name: 'WebSDK',
      memberList: [{userID: 'user1'}, {userID: 'user2'}] // 如果填写了 memberList,则必须填写 userID
    });
    promise.then(function(imResponse) { // 创建成功
      console.log(imResponse.data.group); // 创建的群的资料
    }).catch(function(imError) {
      console.warn('createGroup error:', imError); // 创建群组失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    参数集

    Properties
    Name Type Attributes Default Description
    name String

    必填,群组名称,最长30字节

    type String <optional>
    TIM.TYPES.GRP_PRIVATE

    群组类型,包括:

    • TIM.TYPES.GRP_PRIVATE(私有群,默认)
    • TIM.TYPES.GRP_PUBLIC(公开群)
    • TIM.TYPES.GRP_CHATROOM(聊天室)
    • TIM.TYPES.GRP_AVCHATROOM(音视频聊天室)
    groupID String <optional>

    群组ID。不填该字段时,会自动为群组创建一个唯一的群 ID

    introduction String <optional>

    群简介,最长240字节

    notification String <optional>

    群公告,最长300字节

    avatar String <optional>

    群头像 URL,最长100字节

    maxMemberNum Number <optional>

    最大群成员数量,缺省时的默认值:私有群是200,公开群是2000,聊天室是10000,音视频聊天室和在线成员广播大群无限制

    joinOption String <optional>
    TIM.TYPES.JOIN_OPTIONS_FREE_ACCESS

    申请加群处理方式。

    • TIM.TYPES.JOIN_OPTIONS_FREE_ACCESS (自由加入)
    • TIM.TYPES.JOIN_OPTIONS_NEED_PERMISSION (需要验证)
    • TIM.TYPES.JOIN_OPTIONS_DISABLE_APPLY (禁止加群)
      注意:创建 TIM.TYPES.GRP_PRIVATE, TIM.TYPES.GRP_CHATROOM, TIM.TYPES.GRP_AVCHATROOM 类型的群组不能填写该字段。私有群禁止申请加群,聊天室和音视频聊天室自由加入。
    memberList Array.<Object> <optional>

    初始群成员列表,最多500个。创建音视频聊天室时不能添加成员

    Properties
    Name Type Attributes Description
    userID String

    必填,群成员的 userID

    role String <optional>

    成员身份,可选值只有Admin,表示添加该成员并设其为管理员

    memberCustomField Array.<Object> <optional>

    群成员维度的自定义字段,默认情况是没有的,需要开通,详情请参阅自定义字段

    groupCustomField Array.<Object> <optional>

    群组维度的自定义字段,默认情况是没有的,需要开通,详情请参阅群成员资料

    Returns:
    Type
    Promise

    dismissGroup(groupID) → {Promise}

    群主可调用该接口解散群组。

    注意:群主不能解散私有群。

    See:
    Example
    let promise = tim.dismissGroup('group1');
    promise.then(function(imResponse) { // 解散成功
      console.log(imResponse.data.groupID); // 被解散的群组 ID
    }).catch(function(imError) {
      console.warn('dismissGroup error:', imError); // 解散群组失败的相关信息
    });
    Parameters:
    Name Type Description
    groupID String

    群组 ID

    Returns:
    Type
    Promise

    updateGroupProfile(options) → {Promise}

    修改群组资料

    See:
    Example
    let promise = tim.updateGroupProfile({
      groupID: 'group1',
      name: 'new name', // 修改群名称
      introduction: 'this is introduction.', // 修改群公告
      groupCustomField: [{ key: 'group_level', value: 'high'}] // 修改群组维度自定义字段
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data.group) // 修改成功后的群组详细资料
    }).catch(function(imError) {
      console.warn('updateGroupProfile error:', imError); // 修改群组资料失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object

    请求参数

    Properties
    Name Type Attributes Default Description
    groupID Object

    群ID

    name Object <optional>

    群名称,最长30字节

    avatar Object <optional>

    群头像URL,最长100字节

    introduction Object <optional>

    群简介,最长240字节

    notification Object <optional>

    群公告,最长300字节

    maxMemberNum Number <optional>

    最大群成员数量,最大为6000

    joinOption String <optional>
    TIM.TYPES.JOIN_OPTIONS_FREE_ACCESS

    申请加群处理方式。

    • TIM.TYPES.JOIN_OPTIONS_FREE_ACCESS (自由加入)
    • TIM.TYPES.JOIN_OPTIONS_NEED_PERMISSION (需要验证)
    • TIM.TYPES.JOIN_OPTIONS_DISABLE_APPLY (禁止加群)
      注意:TIM.TYPES.GRP_PRIVATE, TIM.TYPES.GRP_CHATROOM, TIM.TYPES.GRP_AVCHATROOM 类型群组的该属性不允许修改。私有群禁止申请加群,聊天室和音视频聊天室自由加入。
    groupCustomField Array.<Object> <optional>

    群自定义字段。默认情况是没有的。开通群组维度的自定义字段详情请参见 自定义字段

    Properties
    Name Type Description
    key String

    自定义字段的 Key

    value String

    自定义字段的 Value

    Returns:
    Type
    Promise

    joinGroup(options) → {Promise}

    申请加群的接口,申请加入某个群组时调用。

    注意:

    1. 私有群不允许申请加群,只能通过 addGroupMember 方式添加
    2. TIM.TYPES.GRP_AVCHATROOM(音视频聊天室)有两种加群方式:
      2.1 正常加群,即登录加群。此时 SDK 内的所有接口都能正常调用。
      2.2 匿名加群,即不登录加群。此时只能收消息,其他任何需要鉴权的接口都不能调用。
    3. 同一用户同时只能加入一个音视频聊天室。【例如】用户已在音视频聊天室 A 中,再加入音视频聊天室 B,SDK 会先退出音视频聊天室 A,然后加入音视频聊天室 B
    See:
    Example
    let promise = tim.joinGroup({ groupID: 'group1', type: TIM.TYPES.GRP_AVCHATROOM });
    promise.then(function(imResponse) {
      switch (imResponse.data.status) {
        case TIM.TYPES.JOIN_STATUS_WAIT_APPROVAL: // 等待管理员同意
          break;
        case TIM.TYPES.JOIN_STATUS_SUCCESS: // 加群成功
          console.log(imResponse.data.group); // 加入的群组资料
          break;
        case TIM.TYPES.JOIN_STATUS_ALREADY_IN_GROUP: // 已经在群中
          break;
        default:
          break;
      }
    }).catch(function(imError){
      console.warn('joinGroup error:', imError); // 申请加群失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    groupID String
    applyMessage String

    附言

    type String <optional>

    要加入群组的类型,加入音视频聊天室时该字段必填。可选值:

    • TIM.TYPES.GRP_PUBLIC(公开群)
    • TIM.TYPES.GRP_CHATROOM (聊天室)
    • TIM.TYPES.GRP_AVCHATROOM (音视频聊天室)
    Returns:
    Type
    Promise

    quitGroup(groupID) → {Promise}

    退出群组。

    注意:群主只能退出私有群,退出后该私有群无群主。

    See:
    Example
    let promise = tim.quitGroup('group1');
    promise.then(function(imResponse) {
      console.log(imResponse.data.groupID); // 退出成功的群 ID
    }).catch(function(imError){
      console.warn('quitGroup error:', imError); // 退出群组失败的相关信息
    });
    Parameters:
    Name Type Description
    groupID String

    群组 ID

    Returns:

    成功时 then 回调参数中包含退出的群组 ID

    Type
    Promise

    searchGroupByID(groupID) → {Promise}

    通过 groupID 搜索群组。

    注意:TIM.TYPES.GRP_PRIVATE 类型的群组(私有群)不能被搜索。

    See:
    Example
    let promise = tim.searchGroupByID('group1');
    promise.then(function(imResponse) {
      const group = imResponse.data.group; // 群组信息
    }).catch(function(imError) {
      console.warn('searchGroupByID error:', imError); // 搜素群组失败的相关信息
    });
    Parameters:
    Name Type Description
    groupID String

    群组 ID

    Returns:
    Type
    Promise

    changeGroupOwner(options) → {Promise}

    转让群组。只有群主有权限操作。

    注意:只有群主拥有转让的权限。TIM.TYPES.GRP_AVCHATROOM(音视频聊天室)类型的群组不能转让。

    See:
    Example
    let promise = tim.changeGroupOwner({
      groupID: 'group1',
      newOwnerID: 'user2'
    });
    promise.then(function(imResponse) { // 转让成功
      console.log(imResponse.data.group); // 群组资料
    }).catch(function(imError) { // 转让失败
      console.warn('changeGroupOwner error:', imError); // 转让群组失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    groupID String

    待转让的群组 ID

    newOwnerID String

    新群主的 ID

    Returns:
    Type
    Promise

    handleGroupApplication(options) → {Promise}

    处理申请加群(同意或拒绝)

    See:
    Example
    let promise = tim.handleGroupApplication({
      handleAction: 'Agree',
      handleMessage: '欢迎欢迎',
      message: message // 申请加群群系统通知的消息实例
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 群组资料
    }).catch(function(imError){
      console.warn('handleGroupApplication error:', imError); // 错误信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    handleAction String

    处理结果 Agree(同意) / Reject(拒绝)

    handleMessage String <optional>

    附言

    message Message

    对应【群系统通知】的消息实例

    Returns:
    Type
    Promise

    setMessageRemindType(options) → {Promise}

    设置自己的群消息提示类型。

    See:
    Example
    let promise = tim.setMessageRemindType({ groupID: 'group1', messageRemindType: TIM.TYPES.MSG_REMIND_DISCARD }); // 拒收消息
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 设置后的群资料。
    }).catch(function(imError) {
      console.warn('setMessageRemindType error:', imError);
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    groupID String
    messageRemindType String

    群消息提示类型。详细如下:

    • TIM.TYPES.MSG_REMIND_ACPT_AND_NOTE(SDK 接收消息并通知接入侧(抛出 收到消息事件),接入侧做提示)
    • TIM.TYPES.MSG_REMIND_ACPT_NOT_NOTE(SDK 接收消息并通知接入侧(抛出 收到消息事件),接入侧不做提示)
    • TIM.TYPES.MSG_REMIND_DISCARD(SDK 拒收消息)
    Returns:
    Type
    Promise

    getGroupMemberList(options) → {Promise}

    获取群成员列表

    See:
    Example
    let promise = tim.getGroupMemberList({ groupID: 'group1', count: 30, offset:0 }); // 从0开始拉取30个群成员
    promise.then(function(imResponse) {
      console.log(imResponse.data.memberList); // 群成员列表
    }).catch(function(imError) {
      console.warn('getGroupMemberList error:', imError);
    });
    Parameters:
    Name Type Description
    options Object

    请求参数

    Properties
    Name Type Attributes Default Description
    groupID String

    群组的 ID

    count Number <optional>
    15

    需要拉取的数量。最大值:100,避免回包过大导致请求失败。若传入超过100,则只拉取前100个。

    offset Number <optional>
    0

    偏移量,默认从0开始拉取

    Returns:
    Type
    Promise

    addGroupMember(options) → {Promise}

    添加群成员。详细规则如下:

    • TIM.TYPES.GRP_PRIVATE(私有群):任何群成员都可邀请他人加群,且无需被邀请人同意,直接将其拉入群组中。
    • TIM.TYPES.GRP_PUBLIC(公开群)/ TIM.TYPES.GRP_CHATROOM(聊天室):只有 App 管理员可以邀请他人入群,且无需被邀请人同意,直接将其拉入群组中。
    • TIM.TYPES.GRP_AVCHATROOM(音视频聊天室):不允许任何人邀请他人入群(包括 App 管理员)。
    See:
    Example
    let promise = tim.addGroupMember({groupID: 'group1', userIDList: ['user1','user2','user3']});
    promise.then(function(imResponse) {
      console.log(imResponse.data.successUserIDList); // 添加成功的群成员 userIDList
      console.log(imResponse.data.failureUserIDList); // 添加失败的群成员 userIDList
      console.log(imResponse.data.existedUserIDList); // 已在群中的群成员 userIDList
      console.log(imResponse.data.group); // 添加后的群组信息
    }).catch(function(imError) {
      console.warn('addGroupMember error:', imError); // 错误信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    groupID String
    userIDList Array.<String>

    待添加的群成员 ID 数组。单次最多添加500个成员

    Returns:
    Type
    Promise

    deleteGroupMember(options) → {Promise}

    删除群成员。群主可移除群成员。

    See:
    Example
    let promise = tim.deleteGroupMember({groupID: 'group1', userIDList:['user1'], reason: '你违规了,我要踢你!'});
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 删除后的群组信息
      console.log(imResponse.data.userIDList); // 被删除的群成员的 userID 列表
    }).catch(function(imError) {
      console.warn('deleteGroupMember error:', imError); // 错误信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    groupID String

    群ID

    userIDList Array.<String>

    待删除的群成员的 ID 列表

    reason String <optional>

    踢人的原因

    Returns:
    Type
    Promise

    setGroupMemberMuteTime(options) → {Promise}

    设置群成员的禁言时间,可以禁言群成员,也可取消禁言。TIM.TYPES.GRP_PRIVATE 类型的群组(即私有群)不能禁言。

    注意:只有群主和管理员拥有该操作权限:

    • 群主可以禁言/取消禁言管理员和普通群成员。
    • 管理员可以禁言/取消禁言普通群成员。
    See:
    Example
    let promise = tim.setGroupMemberMuteTime({
      groupID: 'group1',
      userID: 'user1',
      muteTime: 600 // 禁言10分钟;设为0,则表示取消禁言
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 修改后的群资料
    }).catch(function(imError) {
      console.warn('setGroupMemberMuteTime error:', imError); // 禁言失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    groupID String
    userID String
    muteTime Number

    禁言时长,单位秒。如设为1000,则表示从现在起禁言该用户1000秒;设为0,则表示取消禁言。

    Returns:
    Type
    Promise

    setGroupMemberRole(options) → {Promise}

    修改群成员角色。只有群主拥有操作的权限。

    See:
    Example
    let promise = tim.setGroupMemberRole({
      groupID: 'group1',
      userID: 'user1',
      role: TIM.TYPES.GRP_MBR_ROLE_ADMIN // 将群 ID: group1 中的用户:user1 设为管理员
    });
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 修改后的群资料
    }).catch(function(imError) {
      console.warn('setGroupMemberRole error:', imError); // 错误信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Description
    groupID String
    userID String
    role String

    可选值:TIM.TYPES.GRP_MBR_ROLE_ADMIN(群管理员) 或 TIM.TYPES.GRP_MBR_ROLE_MEMBER(群普通成员)

    Returns:
    Type
    Promise

    setGroupMemberNameCard(options) → {Promise}

    设置群成员名片。

    • 群主:可设置所有群成员的名片。
    • 管理员:可设置自身和其他普通群成员的群名片。
    • 普通群成员:只能设置自身群名片。
    See:
    Example
    let promise = tim.setGroupMemberNameCard({ groupID: 'group1', userID: 'user1', nameCard: '用户名片' });
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 设置后的群资料
    }).catch(function(imError) {
      console.warn('setGroupMemberNameCard error:', imError); // 设置群成员名片失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    groupID String
    userID String <optional>

    可选,默认修改自身的群名片

    nameCard String
    Returns:
    Type
    Promise

    setGroupMemberCustomField(options) → {Promise}

    设置群成员自定义字段。

    注意:普通群成员只能设置自己的自定义字段。

    See:
    Example
    let promise = setGroupMemberCustomField({ groupID: 'group1', memberCustomField: [{key: 'group_member_test', value: 'test'}]});
    promise.then(function(imResponse) {
      console.log(imResponse.data.group); // 设置后的群资料
    }).catch(function(imError) {
      console.warn('setGroupMemberCustomField error:', imError); // 设置群成员自定义字段失败的相关信息
    });
    Parameters:
    Name Type Description
    options Object
    Properties
    Name Type Attributes Description
    groupID String

    群 ID

    userID String <optional>

    可选,不填则修改自己的群成员自定义字段

    memberCustomField Array.<Object>

    群成员自定义字段

    Properties
    Name Type Description
    key String

    自定义字段的 Key

    value String

    自定义字段的 Value

    Returns:
    Type
    Promise