tencentSimpleIM

立即使用

初始化

init

setSDKListener

removeSDKListener

destroy

登录及登出

login

logout

getLoginUser

getLoginStatus

简单消息收发

setSimpleMsgListender

removeSimpleMsgListener

sendC2CTextMessage

sendC2CCustomMessage

sendGroupTextMsg

sendGroupCustomMessage

群组管理

setGroupListener

removeGroupListener

createGroup

joinGroup

quitGroup

dismissGroup

资料管理

getUsersInfo

setSelfInfo

论坛示例

该论坛提供了模块使用和问题反馈的入口,你可以在论坛中找到使用的Demo,以及问题反馈

概述

简介

该模块提供了简单易用的接口, 用于满足聊天、直播、视频等需要简单快速沟通的场景,可以用于简单聊天,以及实现主播和观众沟通、弹幕、送礼物等即时通信场景

模块接口

init

初始化IM

init({params}, function(ret, err))

params

sdkAppID:

  • 类型: 字符串类型
  • 描述: (必填项)应用ID, 可以在控制台中获取; 腾讯云 IM 服务用于区分客户帐号的唯一标识

logLevel:

  • 类型: 整数类型
  • 描述: (可选项)日志级别
  • 取值范围:
    • 0: 代表V2TIM_LOG_NONE, 不输出任何 log
    • 1: 代表V2TIM_LOG_DEBUG, 输出 DEBUG,INFO,WARNING,ERROR 级别的 log
    • 2: 代表V2TIM_LOG_INFO, 输出 INFO,WARNING,ERROR 级别的 log
    • 3: 代表V2TIM_LOG_WARN, 输出 WARNING,ERROR 级别的 log
    • 4: 代表V2TIM_LOG_ERROR, 输出输出 ERROR 级别的 log

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true
}
  • 字段描述: status:
    • 类型: 布尔类型
    • 描述: 初始化是否成功; true表示操作成功, false表示操作失败

代码示例

var Im = api.require('tencentSimpleIM');
Im.init({
    sdkAppID: 1400385274
}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

setSDKListener

设置SDK监听 主要用户返回各种SDK相关的事件

setSDKListener({}, function(ret))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    eventType: "onConnectSuccess",
    code: -1,
    msg: "错误信息",
    info: {
        ...
    }
}
  • 字段详情:

    eventType:

    • 类型: 字符串类型
    • 描述: 事件名称
    • 取值范围:

      • onConnectSuccess: 已经成功连接到腾讯云服务器
      • onConnectFailed: 连接腾讯云服务器失败
      • onKickedOffline: 当前用户被踢下线,此时可以 UI 提示用户,并再次调用login()函数重新登录
      • onUserSigExpired: 在线时票据过期:此时您需要生成新的 userSig 并再次调用login()函数重新登录
      • onSelfInfoUpdated: 登录用户的资料发生了更新

      onConnectFailed事件

      code:

    • 类型: 整数类型
    • 描述: 错误码

      msg:

    • 类型: 字符串类型
    • 描述: 错误信息

      onUserSigExpired:

      info:

    • 类型: JSON对象
    • 描述: 用户信息更新
    • 字段详情: userFullInfo

示例代码

Im.setSDKListener({}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

removeSDKListener

移除SDK监听

removeSDKListener()

示例代码

Im.removeSDKListener();

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

destroy

销毁模块

destroy()

示例代码

Im.destroy();

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

login

登录

login({params}, function(ret, err))

params

userID:

  • 类型: 字符串类型
  • 描述: (必填项)用户ID, 建议只包含大小写英文字母、数字、下划线和连词符集中类型的字符,长度最大不超过32字节

userSig:

  • 类型: 字符串类型
  • 描述: (必填项)用户签名, 登录票据,由您的业务服务器进行计算以保证安全生成UserSig

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    status: true 
}
  • 字段详情:

    status:

    • 类型: 布尔类型
    • 描述: true表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 6206    
    msg: '签名过期' 
}
  • 字段详情:

    code:

    • 类型: 整数类型
    • 描述: 错误码

      msg:

    • 类型: 字符串类型
    • 描述: 错误信息
  • 注意事项:

    • 登陆时票据过期:login 函数的返回ERR_USER_SIG_EXPIRED: 6206 错误码,此时生成新的 userSig 重新登录
    • 在线时票据过期:用户在线期间也可能收到onUserSigExpired 回调,此时也是需要您生成新的 userSig 并重新登录
    • 在线时被踢下线:用户在线情况下被踢,会通过 onKickedOffline 回调通知给您,此时可以 UI 提示用户,并再次调用 login() 重新登录

示例代码

Im.login({
    userID: 'ry134354',
    userSig: 'fdadfdafkasj3431432xxxx'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

logout

登出 如果切换账号,需要 logout 回调成功或者失败后才能再次 login,否则 login 可能会失败

logout()

callback

ret:

  • 类型: JSON对象
  • 内部字段
{
    status: true
}
  • 字段详情:

    status:

    • 类型: 布尔类型
    • 描述: true表示操作成功

err:

  • 类型: JSON对象
{
    code: 2013
    msg: '登出失败'
}
  • 内部字段:

    code:

    • 类型: 整数类型
    • 描述: 错误码

      msg:

    • 类型: 字符串类型
    • 描述: 错误信息

示例代码

Im.logout({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

getLoginUser

获取登录用户

getLoginUser({}, function(ret, err))

callback

ret:

  • 类型: JSON对象
{
    status: true 
    userID: 'test001'
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: true表示操作成功

      userID

    • 类型: 字符串类型
    • 描述: 用户ID

err:

  • 类型: JSON对象
{
    code: -35,          
    msg: '获取失败' 
}
  • 内部字段:

    code:

    • 类型: 整数类型
    • 描述: 错误码

      msg:

    • 类型: 字符串类型
    • 描述: 错误信息

示例代码

Im.getLoginUser();

可用性

iOS系统,Android系统

可提供1.0.0及更高版本

getLoginStatus

获取登录状态 如果用户已经处于已登录和登录中状态,请勿再频繁调用登录接口登录

getLoginStatus({}, function(ret, err))

callback(ret, err)

ret:

  • 类型: JSON对象
  • 内部字段
{
    status: true
    loginStatus: 0
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: true表示操作成功

      loginStatus:

    • 类型: 整数类型
    • 描述: 当前的登录状态
    • 取值范围:
      • 0: 已登录, 表示V2TIM_STATUS_LOGINED
      • 1: 登录中, V2TIM_STATUS_LOGINING
      • 2: 无登录, V2TIM_STATUS_LOGOUT

err:

  • 类型: JSON对象
  • 内部字段
{
    code: -1                
    msg: "获取登录状态失败"
}
  • 内部字段:

    code:

    • 类型: 整数类型
    • 描述: 错误码

      msg:

    • 类型: 字符串类型
    • 描述: 错误信息

示例代码

Im.getLoginStatus({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

setSimpleMsgListener

设置基本消息(文本消息和自定义消息)的事件监听器

addSimpleMsgListener({}, function(ret))

callback

ret:

  • 类型: JSON对象
{
    eventType: 'onRecvC2CTextMessage'
    msgID: '234dxerewe',
    text: '这是一段文本',
    sender: userInfo
}
  • 内部字段: eventType:

    • 类型: 字符串类型
    • 描述: 事件名称
    • 取值范围:

      • onRecvC2CTextMessage: 收到 C2C 文本消息
      • onRecvC2CCustomMessage: 收到 C2C 自定义(信令)消息
      • onRecvGroupTextMessage: 收到群文本消息
      • onRecvGroupCustomMessage: 收到群自定义(信令)消息

      msgID:

    • 类型: 字符串类型
    • 描述: 消息唯一标识

      text:

    • 类型: 字符串类型
    • 描述: 接收到的文本内容

      customMsg:

    • 类型: 字符串类型
    • 描述: 自定义的内容

      groupID:

    • 类型: 字符串类型
    • 描述: 群ID

      sender:

    • 类型: JSON对象
    • 描述: 发送方信息或者发送方群成员信息
    • 内部字段: userInfo

示例代码

Im.addSimpleMsgListener({}, function(ret) {
    if (ret) {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

removeSimpleMsgListener

除基本消息(文本消息和自定义消息)的事件监听器

removeSimpleMsgListener()

示例代码

Im.removeSimpleMsgListener();

可用性

iOS, Android系统

可提供的1.0.0及更高版本

sendC2CTextMessage

发送单聊普通文本消息(最大支持 8KB) 该接口发送的消息默认不会推送(前提是在OfflinePushManager 开启了推送), 如果需要自定义推送(标题和内容), 请调用sendMessage 接口

sendC2CTextMessage({params}, function(ret, err))

params

text:

  • 类型: 字符串类型
  • 描述: (必填项)要发送的文本

userID:

  • 类型: 字符串类型
  • 描述: (必填项)消息接收者的UserID

callback

ret:

  • 类型: JSON对象
{
    status: true 
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0  
    msg: "发送失败" 
}
  • 内部字段

    code: 类型: 整数类型 描述: 错误码

    msg: 类型: 字符串类型 描述: 错误信息

示例代码

Im.sendC2CTextMessage({
    text: '这是一个测试消息',
    userID: 'xxx3435cs3d22xxx'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(ret));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

sendC2CCustomMessage

发送单聊自定义(信令)消息(最大支持 8KB)

sendC2CCustomMessage({params}, function(ret, err))

params

customMsg:

  • 类型: 字符串类型
  • 描述: (必填项)要发送的自定义消息

userID:

  • 类型: 字符串类型
  • 描述: (必填项)消息接收者的UserID

callback

ret:

  • 类型: JSON对象
{
    status: true 
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0     
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.sendC2CCustomMessage({
    customMsg: '{cmd: 'dbc', msg: 'abc'}',
    userID: 'c2dfdafs2xxxx'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

sendGroupTextMessage

发送群聊普通文本消息(最大支持 8KB) 该接口发送的消息默认不会推送(前提是在 V2TIMOfflinePushManager 开启了推送),如果需要自定义推送(标题和内容),请调用sendMessage 接口

sendGroupTextMessage({params}, function(ret, err))

params

text:

  • 类型: 字符串类型
  • 描述: (必填项)要发送的文本

groupID:

  • 类型: 字符串类型
  • 描述: (必填项)指定目标群组的 groupID,该群中的所有用户均能收到消息

priority:

  • 类型: 整数类型
  • 描述: (可选项)设置消息的优先级,我们没有办法所有消息都能 100% 送达每一个用户,但高优先级的消息会有更高的送达成功率
  • 取值范围:
    • 0: 默认等级
    • 1: 云端会优先传输,适用于在群里发送重要消息,比如主播发送的文本消息等
    • 2: 云端按默认优先级传输,适用于在群里发送非重要消息,比如观众发送的弹幕消息等

callback

ret:

  • 类型: JSON对象
{
    status: true 
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0  
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 错误码

    msg: 类型: 字符串类型 描述: 错误信息

示例代码

Im.sendGroupTextMsg({
    text: '这是测试消息',
    groupID: 'cdfda2c2332'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

sendGroupCustomMessage

发送群聊自定义(信令)消息(最大支持 8KB) 该接口发送的消息默认不会推送,如果需要推送,请调用 sendMessage 接口

sendGroupCustomMessage({params}, function(ret))

params

customMsg:

  • 类型: 字符串类型
  • 描述: (必填项)要发送的自定义消息

groupID:

  • 类型: 字符串类型
  • 描述: (必填项)指定目标群组的 groupID,该群中的所有用户均能收到消息

priority:

  • 类型: 整数类型
  • 描述: (可选项)设置消息的优先级,我们没有办法所有消息都能 100% 送达每一个用户,但高优先级的消息会有更高的送达成功率
  • 取值范围:
    • 0: 默认等级
    • 1: 云端会优先传输,适用于在群里发送重要消息,比如主播发送的文本消息等
    • 2: 云端按默认优先级传输,适用于在群里发送非重要消息,比如观众发送的弹幕消息等

callback

ret:

  • 类型: JSON对象
{
    status: true
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0 
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.sendGroupCustomMessage({
    customData: '{abc: 'fdads'}',
    groupID: '3fdafdxxx', 
    priority: 0
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

setGroupListener

设置群组监听器

snapshot({}, function(ret))

callback

ret:

  • 类型: JSON对象
  • 内部字段:
{
    eventType: 'onMemberEnter',
    groupId: 'xdfasdf3233',
    member: memberInfo
    memberList: [
        memberInfo,
        ...
    ],
    infoList: [
        groupMemberChangeInfo,
        ...
    ]
    opUser: memberInfo,
    customData: 'jfkdafsdd2d3d'
}
  • 内部字段:

    eventType:

    • 类型: 字符串类型
    • 描述: 事件名称
    • 取值范围:

      • onMemberEnter: 有用户加入群(全员能够收到)
      • onMemberLeave: 有用户离开群(全员能够收到)
      • onMemberInvited: 某些人被拉入某群(全员能够收到)
      • onMemberKicked: 某些人被踢出某群(全员能够收到)
      • onMemberInfoChanged: 群成员信息被修改(全员能收到)
      • onGroupCreated: 创建群(主要用于多端同步)
      • onGroupDismissed: 群被解散了(全员能收到)
      • onGroupRecycled: 群被回收(全员能收到)
      • onGroupInfoChanged: 群信息被修改(全员能收到)
      • onReceiveJoinApplication: 有新的加群请求(只有群主或管理员会收到)
      • onApplicationProcessed: 加群请求已经被群主或管理员处理了(只有申请人能够收到)
      • onGrantAdministrator: 指定管理员身份
      • onRevokeAdministrator: 取消管理员身份
      • onQuitFromGroup: 主动退出群组(主要用于多端同步, 直播群(AVChatRoom)不支持)
      • onReceiveRESTCustomData: 收到 RESTAPI 下发的自定义系统消息
      • onGroupAttributeChanged: 收到群属性更新的回调

      groupID:

    • 类型: 字符串类型
    • 描述: 群 ID

      opUser:

    • 类型: JSON对象
    • 描述: 处理人
    • 内部字段: groupMemberInfo

      memberList:

    • 类型: JSONArray
    • 描述: 被处理的群成员
    • 内部成员: groupMemberInfo

      infoList:

    • 类型: JSONArray
    • 描述: 被修改的群成员信息
    • 内部成员: groupMemberChangeInfo

      customData:

    • 类型: 字符串类型
    • 描述: 自定义数据

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0 
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.setGroupListener({}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

removeGroupListener

移除群组监听器

removeGroupListener()

示例代码

Im.removeGroupListener();

createGroup

创建群组 不支持在同一个 SDKAPPID 下创建两个相同 groupID 的群

createGroup({params}, function(ret, err))

params

groupType:

  • 类型: 字符串类型
  • 描述: (必填项)群类型, 我们为您预定义好了四种常用的群类型, 您也可以在控制台定义自己需要的群类型
  • 取值范围:
    • Work: 工作群,成员上限 200 人, 不支持由用户主动加入, 需要他人邀请入群, 适合用于类似微信中随意组建的工作群(对应老版本的 Private 群)
    • Public: 公开群,成员上限 2000 人, 任何人都可以申请加群, 但加群需群主或管理员审批, 适合用于类似 QQ 中由群主管理的兴趣群
    • Meeting: 会议群,成员上限 6000 人, 任何人都可以自由进出, 且加群无需被审批, 适合用于视频会议和在线培训等场景(对应老版本的 ChatRoom 群)
    • AVChatRoom: 直播群, 人数无上限, 任何人都可以自由进出, 消息吞吐量大, 适合用作直播场景中的高并发弹幕聊天室

groupID:

  • 类型: 字符串类型
  • 描述: (可选项)自定义群组ID

groupName:

  • 类型: 字符串类型
  • 描述: (必填项)群名称

callback

ret:

  • 类型: JSON对象
{
    status: true
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0      
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.cteateGroup({
    groupType: 'AVChatRoom',
    groupName: 'zhibo001'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

joinGroup

加入群组

工作群(Work): 不能主动入群,只能通过群成员调用 inviteUserToGroup() 接口邀请入群 公开群(Public): 申请入群后,需要管理员审批,管理员在收到onReceiveJoinApplication 回调后调用 getGroupApplicationList() 接口处理加群请求 其他群: 可以直接入群

joinGroup({params}, function(ret, err))

params

groupID:

  • 类型: 字符串类型
  • 描述: (必填项)要加入的群组ID

message:

  • 类型: 字符串类型
  • 描述: (必填项)加入群的信息

callback

ret:

  • 类型: JSON对象
{
    status: true
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0        
    msg: "发送失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.joinGroup({
    groupID: 'live001'
    message: '我想看直播'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

quitGroup

退出群组 在公开群(Public)、会议(Meeting)和直播群(AVChatRoom)中,群主是不可以退群的,群主只能调用 dismissGroup 解散群组

quitGroup({params}, function(ret, err))

params

groupID:

  • 类型: 字符串类型
  • 描述: (必填项)要退出的群组ID

callback

ret:

  • 类型: JSON对象
{
    status: true
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0        
    msg: "退出失败" 
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.quitGroup({
    groupID: 'AVChatroom'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

dismissGroup

解散群组 Work: 任何人都无法解散群组 其他群: 群主可以解散群组

dismissGroup({params}, function(ret,err))

params

groupID:

  • 类型: 字符串类型
  • 描述: (必填项)要解散的群组ID

callback

ret:

  • 类型: JSON对象
{
    status: true // 布尔类型, true; true表示操作成功
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0        
    msg: "解散失败"
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.dismissGroup:({
    groupID: 'AVChatroom01'
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

getUsersInfo

获取用户资料 获取自己的资料,传入自己的 ID 即可

getUsersInfo({param}, function(ret, err))

params

userIDList

  • 类型: JSONArray类型
  • 描述: (必填项), 需要获取资料的用户ID列表, userIDList 建议一次最大 100 个,因为数量过多可能会导致数据包太大被后台拒绝,后台限制数据包最大为 1M

callback

ret:

  • 类型: JSON对象
{
    status: true,
    infoList: [     
        userInfo,
        ...
    ]
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

      infoList: 类型: 数组类型 描述: 用户信息列表, 内部字段: 单个用户信息详细见userInfo

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0        
    msg: "获取失败" 
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.getUsersInfo({
    userIDList: [test001, test002]
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify);
    } else {
        alert(JSON.stringify);
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

setSelfInfo

修改个人资料

setSelfInfo({params}, function(ret, err))

params

selfSignature:

  • 类型: 字符串类型
  • 描述: (可选项)个性签名

gender:

  • 类型: 整数类型
  • 描述: (可选项)性别
  • 取值范围:
    • 0: 未知, 代表V2TIM_GENDER_UNKNOWN
    • 1: 男性, 代表V2TIM_GENDER_MALE
    • 2: 女性, 代表V2TIM_GENDER_FEMALE

allowType:

  • 类型: 整数类型
  • 描述: (可选项)设置好友验证方式,只能针对本人设置
  • 取值范围:
    • 0: 允许所有人, V2TIM_FRIEND_ALLOW_ANY
    • 1: 拒绝所有人, V2TIM_FRIEND_DENY_ANY
    • 2: 需要确认, V2TIM_FRIEND_NEED_CONFIRM

nickName:

  • 类型: 字符串类型
  • 描述: (可选项)用户昵称

faceUrl:

  • 类型: 字符串
  • 描述: (可选项)用户头像

callback

ret:

  • 类型: JSON对象
{
    status: true
}
  • 内部字段:

    status:

    • 类型: 布尔类型
    • 描述: 表示操作成功

err:

  • 类型: JSON对象
  • 内部字段:
{
    code: 0        
    msg: "发送失败" 
}
  • 内部字段

    code: 类型: 整数类型 描述: 表示错误码

    msg: 类型: 字符串类型 描述: 表示错误信息

示例代码

Im.setSelfInfo:({
    nickName: '我叫啥'
}, function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

iOS, Android系统

可提供的1.0.0及更高版本

数据结构

userInfo

用户信息

  • 类型: JSON对象
{
    userID: 
    nickName:
    faceUrl:
}

userID:

  • 类型: 字符串
  • 描述: 用户ID

nickName:

  • 类型: 字符串类型
  • 描述: 用户昵称

faceUrl:

  • 类型: 字符串类型
  • 描述: 用户头像

userFullInfo

用户详细信息

  • 类型: JSON对象
{
    userID: 
    nickName:
    faceUrl:
    selfSignature:
    gender:
    allowType:
}

userID:

  • 类型: 字符串
  • 描述: 用户ID

nickName:

  • 类型: 字符串类型
  • 描述: 用户昵称

faceUrl:

  • 类型: 字符串类型
  • 描述: 用户头像

selfSignature:

  • 类型: 字符串
  • 描述: 签名

gender:

  • 类型: 整数类型
  • 描述: 性别
  • 取值范围:
    • 0: V2TIM_GENDER_UNKNOWN:未知
    • 1: V2TIM_GENDER_MALE: 男
    • 2: V2TIM_GENDER_FEMALE: 女

allowType:

  • 类型: 整数类型
  • 描述: 好友验证方式
  • 取值范围:
    • 0: V2TIM_FRIEND_ALLOW_ANY 允许所有
    • 1: V2TIM_FRIEND_DENY_ANY 拒绝所有
    • 2: V2TIM_FRIEND_NEED_CONFIRM 需要确认

groupMemberInfo

群成员信息

  • 类型: JSON对象
{
    userID: 
    nickName: 
    friendRemark:
    nameCard:
    faceUrl:
}

userID:

  • 类型: 字符串
  • 描述: 用户ID

nickName:

  • 类型: 字符串类型
  • 描述: 用户昵称

friendRemark:

  • 类型: 字符串类型
  • 描述: 获取好友备注

nameCard:

  • 类型: 字符串类型
  • 描述: 群成员名片

faceUrl:

  • 类型: 字符串类型
  • 描述: 用户头像

groupMemberInfo

获取群成员基本资料

  • 类型: JSON对象
{
    userID:
    nickName:
    friendRemark:
    nameCard:
    faceUrl:
}

userID:

  • 类型: 字符串
  • 描述: 用户ID

nickName:

  • 类型: 字符串类型
  • 描述: 用户昵称

faceUrl:

  • 类型: 字符串类型
  • 描述: 用户头像

groupMemberChangeInfo

{
    userID:
    muteTime:
}

userID:

  • 类型: 字符串
  • 描述: 用户ID

muteTime:

  • 类型: 整数类型
  • 描述: 获取被禁言时间