聊天API文档

调用说明

所有接口通过VhallLive对象来调用,参数是一个对象,除了每个接口本身需要传的参数之外,还有以下通用参数:

  1. success:接口调用成功时执行的回调函数。
  2. fail:接口调用失败时执行的回调函数。
  3. complete:接口调用完成时执行的回调函数,无论成功或失败都会执行。

API接口

1.初始化接口

聊天对象初始化


    var chat = new VhallChat({
        
        token:'',//认证令牌,必填
        appId:'',//在微吼云申请的appId,必填
        channelId:''//频道Id,必填
            
    });

  1. token生成方式:通过API生成,生成accessToken接口说明
  2. appId获取方式:登陆微吼云>>进应用管理>>取得对应AppId
  3. channelId获取方式

2.监听聊天消息

注册消息监听事件,示例如下:

	//监听聊天消息
    chat.on(function(msg){
        //console.log(msg)
        //在此收到聊天消息,消息内容为msg
        //todo
    })

3.发送聊天消息

	//发送聊天消息
    chat.emit("要发送的聊天消息内容");