huanxin

来自于:开发者立即使用

概述

环信将基于移动互联网的即时通讯能力,如单聊、群聊、发语音、发图片、发位置、实时音频、实时视频等,通过云端开放的 Rest API 和客户端 SDK包的方式提供给开sendImageMessage发者和企业。让App内置聊天功能和以前网页中嵌入分享功能一样简单。

环信全面支持Android、iOS、Web等多种平台,在流量、电量、长连接、语音、位置、安全等能力做了极致的优化,让移动开发者摆脱繁重的移动IM通讯底层开发,极大限度地缩短产品开发周期,极短的时间内让App拥有移动IM能力。

使用huanxin模块之前,请先注册注册环信的开发者帐号并申请创建 App,创建 App 后,可以在开发者后台获取 AppKey 和 client_secret 用于开发。

开发前请先认真阅读相关的环信开发文档和视频。

    var uzmoduledemo = null;
    apiready = function(){

        uzmoduledemo = api.require('huanxin');
    }

init

初次化操作,在使用其它功能前,请先调用该方法进行初始化

params

appkey:

  • 类型:字符串
  • 默认值:无
  • 描述:环信appkey

示例代码

var param = {appkey:"xxxxx"};
uzmoduledemo.init(param);

补充说明

在使用其它功能前,请先调用该方法进行初始化

可用性

android系统

可提供的1.0.0及更高版本

register

注册

register({params}, callback(ret, err))

params

username:

  • 类型:字符串
  • 默认值:无
  • 描述:用户名

pwd:

  • 类型:字符串
  • 默认值:0
  • 描述:密码

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码:true / false,
    result: "成功"//文本信息
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码:true / false,
    result: "失败"//文本信息
}

示例代码

var param = { username: "so123456", pwd: "123456" };
var resultCallback = function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
}
uzmoduledemo.register(param, resultCallback);

补充说明

注册

可用性

android系统

可提供的1.0.0及更高版本

login

登录

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

params

username:

  • 类型:字符串
  • 默认值:无
  • 描述:用户名

pwd:

  • 类型:字符串
  • 默认值:0
  • 描述:密码

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码:true / false,
    result: "登录成功"//文本信息
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码:true / false,
    result: "登录失败"//文本信息
}

示例代码

var param = { username: "so123456", pwd: "123456" };
var resultCallback = function(ret, err) {
    if (ret) {
        alert(JSON.stringify(ret));
    } else {
        alert(JSON.stringify(err));
    }
}
uzmoduledemo.login(param, resultCallback);

补充说明

可用性

android系统

可提供的1.0.0及更高版本

logout

登出

logout (callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

onSuccess

{
    status: 'onSuccess'
}

onError

{
    status: 'onError', // 状态码
    code : 
    message:
}

onProgress

{
    status: 'onProgress', // 状态码
    progress : 
    status:
}

示例代码

var resultCallback = function(ret, err) {
    if (ret.status == "onSuccess") {
        alert(JSON.stringify(ret));
    } else if (ret.status == "onError") {
        alert(JSON.stringify(err));
    }
}
uzmoduledemo.logout(resultCallback);

补充说明

可用性

android系统

可提供的1.0.0及更高版本

setAppInited

通知sdk,UI 已经初始化完毕,注册了相应的receiver和listener, 可以接受广播了 在registerReceiverAndListener和界面完成后使用

setAppInited()

params

callback(ret, err)

示例代码

uzmoduledemo.setAppInited();

补充说明

可用性

android系统

可提供的1.0.0及更高版本

registerReceiver

#

注册主要的广播

registerReceiver()

params

callback(ret, err)

示例代码

uzmoduledemo.registerReceiver();

补充说明

可用性

android系统

可提供的1.0.0及更高版本

registerNewMessageBroadcastReceiver

添加一个接收消息的广播

registerNewMessageBroadcastReceiver()

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'onReceive',
    from:
    msgId:
}

示例代码

uzmoduledemo.registerNewMessageBroadcastReceiver(function(ret, err) {
    if (ret.status == 'onReceive') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

registerAckMessageBroadcastReceiver

添加一个消息回执的广播

registerAckMessageBroadcastReceiver()

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'onReceive',
    from:
    msgId:
}

示例代码

uzmoduledemo.registerAckMessageBroadcastReceiver(function(ret, err) {
    if (ret.status == 'onReceive') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

registerDeliveryAckMessageBroadcastReceiver

添加一个消息送达的广播

registerDeliveryAckMessageBroadcastReceiver()

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'onReceive',
    from:
    msgId:
}

示例代码

uzmoduledemo.registerDeliveryAckMessageBroadcastReceiver(function(ret, err) {
    if (ret.status == 'onReceive') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendTextMessage

发送文本信息

sendTextMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

content:

  • 类型:字符串
  • 默认值:0
  • 描述:发送内容

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendTextMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    content: '我是环信'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendImageMessage

发送图片信息

sendImageMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

imagePath:

  • 类型:字符串
  • 默认值:0
  • 描述:图片的路径

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendImageMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    imagePath: 'xxxxx'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendVoiceMessage

发送语音信息

sendVoiceMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

voicePath:

  • 类型:字符串
  • 默认值:0
  • 描述:语音文件的路径

duration:

  • 类型:数字
  • 默认值:0
  • 描述:语音消息的时长,单位为秒

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendVoiceMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    duration: 5000,
    voicePath: 'xxxxx'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendFileMessage

发送文件信息

sendFileMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

filePath:

  • 类型:字符串
  • 默认值:0
  • 描述:文件的路径

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendFileMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    filePath: 'xxxxx'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendLocationMessage

发送位置信息

sendLocationMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

latitude:

  • 类型:数字
  • 默认值:无
  • 描述:纬度

longitude:

  • 类型:数字
  • 默认值:无
  • 描述:经度

locationAddress:

  • 类型:字符串
  • 默认值:无
  • 描述:地址文字内容

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendLocationMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    latitude: 'xxxx',
    longitude: 'xxxx',
    locationAddress: 'xxxxx'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

sendVideoMessage

发送视频信息

sendVideoMessage({params}, callback(ret, err))

params

chatType:

  • 类型:字符串
  • 默认值:无
  • 描述:类型,单聊类型值为"CHAT",群聊类型值为"GROUPCHAT",默认是单聊

toUser:

  • 类型:字符串
  • 默认值:0
  • 描述:接收对象,单聊类型值为"userid",群聊类型值为"groupid"

videoPath:

  • 类型:字符串
  • 默认值:0
  • 描述:视频文件的路径

duration:

  • 类型:数字
  • 默认值:0
  • 描述:视频消息的时长,单位为秒

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: 'success', // 状态码:success / progress
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        progress: 'xxx' // 进度,当状态码为progress是才有
        status: 'xxx' // 消息的状态,当状态码为progress是才有
    }
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: "error", // 状态码
    result:
    {
        msgId: 'xxx' // 当前消息ID,
        errormsg: 'xxx' // 错误原因
    }
}

示例代码

uzmoduledemo.sendVideoMessage({
    chatType: 'CHAT',
    toUser: 'xxxx',
    duration: 5000,
    voicePath: 'xxxxx'
}, function(ret, err) {
    if (ret.status == 'progress') {

    } else if (ret.status == 'success') {

    }
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

getUnreadMsgCount

获取未读消息数

getUnreadMsgCount({params}, callback(ret, err))

params

conversation:

  • 类型:字符串
  • 默认值:无
  • 描述:当前的会话,单聊类型值为"userid",群聊类型值为"groupid"

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码
    result: 5 //返回的未读消息数
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: false // 状态码
}

示例代码

uzmoduledemo.getUnreadMsgCount({
    conversation: 'xxxx'
}, function(ret, err) {
    alert(JSON.stringify(ret));
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

resetUnreadMsgCount

未读消息数清零

resetUnreadMsgCount({params}, callback(ret, err))

params

conversation:

  • 类型:字符串
  • 默认值:无
  • 描述:当前的会话,单聊类型值为"userid",群聊类型值为"groupid"

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: false // 状态码
}

示例代码

uzmoduledemo.resetUnreadMsgCount({
    conversation: 'xxxx'
}, function(ret, err) {
    alert(JSON.stringify(ret));
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

resetAllUnreadMsgCount

所有未读消息数清零

resetAllUnreadMsgCount (callback(ret, err))

params

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: true, // 状态码
}

err:

  • 类型:JSON 对象
  • 描述:返回参数

内部字段:

{
    status: false // 状态码
}

示例代码

uzmoduledemo.resetAllUnreadMsgCount(function(ret, err) {
    alert(JSON.stringify(ret));
});

补充说明

可用性

android系统

可提供的1.0.0及更高版本

getMsgCount

获取消息总数

getMsgCount({params}, callback(ret, err))

params