chat_js_sdk_api

创建实列

var chatroom = new PolyvChatRoom({
    roomId: '268682',
    ...
});

相关参数说明

注：以下参数只有在传了container参数时才生效

userId 生成建议

userId 是聊天室中的用户唯一标识，两个相同的 userId 登入聊天室后，后者会将前者踢出聊天室，因此不同的聊天室用户的 userId 需要具有唯一性，生成建议如下：

1. 如果您有用户系统，则使用用户系统中的用户 id 作为登入聊天室的 userId。
2. 如果您没有用户系统，则在后端生成高度随机的值作为登入聊天室的 userId，如：「时间戳 +5 位随机数」、uuid 等，并将该 userId 保存到 cookie 或本地存储（localStorage 或 sessionStorage）中，避免每次刷新页面后重新生成 userId。

自定义菜单栏

tabData: 对象数组，每个对象包含两个属性name,type，默认包含聊天tab

name: 菜单栏名称

type: 菜单栏类型，若不是已有内置类型，会嵌入一个不包含任何内容的div元素到页面

已有内置类型

自定义消息颜色

说明：修改消息字体/背景颜色，可针对自己/普通用户/管理员/讲师/助教/嘉宾修改

自定义域名

getChatRecordBySessionIdOptions对象说明

getChatRecordByTimeOptions对象说明

customMessageRender对象说明

格式：{[type]: function(data){/** 将要渲染的内容返回给sdk内部进行渲染 */}}
type为渲染的消息类型，取值有：'custom'|'flowers'|'other'|'own'|'redpack'|'redpackResult'|'reward'|'system'
data为消息数据

例子

...
customMessageRender: {
    custom: function(data) {
        return '<div>' + data + '</div>';
    }
}
...

实例方法

发送引用回复消息：reply(id, content)

说明：回复某一条消息

例子

// chatroom为此sdk实例对象
chatroom.reply('msg_id', '回复内容');

参数

id: String类型，要回复的消息id content：String类型, 回复的内容

返回值

返回一个Promise对象

踢出某人：kickUser(userId, sign)

说明：将某个人踢出聊天室

例子

chatroom.kickUser('userId', sign);

参数

userId: String类型，要踢出的用户的userId sign：String类型, 签名（规则）

返回值

返回一个Promise对象

取消踢出某人：unKickUser(userId, sign)

说明：取消踢出某人

例子

chatroom.unKickUser('userId', sign);

参数

userId: String类型，要取消踢出的用户的userId sign：String类型, 签名（规则）

返回值

返回一个Promise对象

其他

获取chat对象

var chat = chatroom.chat;

获取socket对象

var socket = chat.socket;

发送聊天消息

// 发送文本消息
chat.send('hello');

// 回复消息
chat.send(
  '回复的消息内容',
  {
    id: '被回复的消息 id',
    content: '被回复的消息内容',
    nick: '被回复的发言者昵称'
  },
);

// 发言成功后回调
chat.send('hellow', null, (id) => {
  console.log('发送成功，消息 id：', id);
});

获取聊天历史记录

根据消息索引位置等选项获取聊天历史记录

chat.getChatHistory({
  start: 0,
  end: 10,
})
.then(function (data) {
    // TODO:
    console.log(data);
});

参数说明

// 原有获取历史消息记录接口已废弃
chat.getHistoryMessage(start, end)
.then(function (data) {
    // TODO:
    console.log(data);
});

根据场次ID（sessionId）获取聊天历史记录

chat.getHistoryMessageBySessionId({ sessionId, page , size })
.then(function(data) {
    // TODO:
    console.log(data);
});

根据起始时间获取聊天历史记录

chat.getHistoryMessageByTime({ startTime, endTime, page , size })
.then(function(data) {
    // TODO:
    console.log(data);
});

参数说明

结果说明

data为一个对象数组，具体内容如下

user说明

注：

1、clientIp默认为空，暂不支持返回内容值；

2、userType包含值可能有：空/student/slice/teacher/manager/assistant/guest/viewer等；

获取在线列表

chat.getUserList(page, len)
.then(function (data) {
    // TODO
    console.log(data);
});

参数说明

结果说明

data为一个对象，具体内容如下

userlist说明

userlist对象数组元素具体说明请参考“获取聊天历史记录”方法user说明

获取观众的提问历史记录

chatroom.chatApi.getAskHistoryByUserId()
.then(function (data) {
  // TODO
  console.log(data);
});

参数说明

• 入参可以是一个对象，也可以不传，默认会获取初始化 sdk 时的入参
• 作为对象入参时可以包含以下字段

结果说明

data为一个对象，具体内容如下

list说明

sendMessage

说明：自己发言之后会触发此消息，会在roomMessage返回，也可以通过chat对象监听 例如：

    chat.on(chat.events.SEND_MESSAGE, (event, data) => {
        // TODO
    });

返回数据：

    EVENT: "sendMessage"
    content: "自己发言"
    currentUser: true
    custom: false
    formatTime: "2019-04-25 18:06"
    imgchat: false
    mySelfSend: true
    reward: false
    time: 1556186781080
    user: {
        nick: "polyv",
        pic: "http://livestatic.videocc.net/assets/wimages/missing_face.png",
        userId: "1530756023116",
        roomId: "",
        channelId: ""
    }

互动功能socket消息说明

登入消息

LOGIN:

登录消息，登录房间的时候服务器会广播这一消息

监听回调返回的数据：

{
    "EVENT":"LOGIN",
    "onlineUserNumber":3,
    "user": {
        "clientIp":"59.42.43.28",
        "nick":"广州观众/32199",
        "pic":"//livestatic.videocc.net/v_60/assets/wimages/missing_face.png",
        "roomId":"100781",
        "uid":"CxJj8Ap3C9jN1UHKAJ_V",    
        "userId":"1499917692338" 
        "userType": "" 
    }
}

说明

登出消息

LOGOUT

说明:登出消息，有人离开房间（包括刷新页面）时服务器会广播这一消息

监听回调返回数据：

EVENT: "LOGOUT",
onlineUserNumber: 3,
uid: "I_o3f4sHDzAHM4LVAJTX"

接收别人发言消息

SPEAK：

说明:发言,接收别人的发言消息(不包括自己)

发送：

socket.emit('message', JSON.stringify({
    EVENT: 'SPEAK',
    values: [value],                //发言内容
    roomId: roomId                //当前房间号
}));

字段说明：

监听回调返回的数据：

{
    "EVENT": "SPEAK",
    "id": "f1e4a960-6abc-11e7-ac0a-379e251bb30e",
    "time": 1500274540278,
    "user": {
        "clientIp": "59.42.40.89",
        "nick": "rururu",
        "pic":"//livestatic.videocc.net/v_60/assets/wimages/missing_face.png",
        "roomId": "100781",
        "uid": "yP-HnXTEZyToxP0TAGCS",
        "userId": "1500274526077",
        "userType": "" 
    },
    "values": ["sadasd"]
}

系统公告

GONGGAO：

说明:当管理员发言时，服务器会将管理员的消息做为公告处理，当重新进入页面时，如有公告，服务器会广播这一消息。

监听回调返回的数据：

{
    "EVENT": "GONGGAO",
    "content": "POLYV保利威视" 
}

普通公告

BULLETIN

说明：后台设置的公告消息，当重新进入页面时，如有公告，服务器会广播这一消息。

监听回调返回的数据：

EVENT: "BULLETIN",
content: "???/",
roomId: "105240"

送花消息

FLOWERS:

说明:送花

监听回调返回的数

{
    "EVENT":"FLOWERS",
    "nick":"广州观众/81366",
    "uimg":"//livestatic.videocc.net/v_60/assets/wimages/missing_face.png" 
}

点赞消息

LIKES:

说明: 点赞

监听回调返回的数据：

{
    "EVENT":"LIKES",
    "count":160,
    "nick":"广州观众/81366" 
}

禁言

SHIELD:

说明: 禁言

监听回调返回的数据:

注：userId或ip只会返回一个

{
    EVENT: 'ADD_SHIELD',
    value:  '', // 被禁言用户userId值或ip值
    data: {
        banType: 'userId/ip', // 禁言类型 userId/ip
        userId: '', // 被禁言用户userId值
        ip:'', // 被禁言用户ip值
    }
}

解除禁言

REMOVE_SHIELD:

说明: 解除禁言

监听回调返回的数据:

解除userId
{
    EVENT: 'REMOVE_SHIELD',
    value: '', // 被禁言用户userId值
    data: {
        banType: 'userId', // 禁言类型
        userId: '' // 被禁言用户userId值
    }
}
解除ip
{
    EVENT: 'REMOVE_SHIELD',
    value: '',// 被禁言用户ip值
    data: {
        banType 'ip', // 禁言类型
        ip: '' // 被禁言用户ip值
    }
}

踢人

KICK:

说明: 踢人

监听回调返回的数据:

{
    "EVENT":"KICK",
    "user": {
        "clientIp":"59.42.40.89",
        "nick":"林林林",
        "pic":"//livestatic.videocc.net/v_60/assets/wimages/missing_face.png",
        "roomId":"100781",
        "uid":"118GWVRA24PR14coA3bz",
        "userId":"1500275476199",
        "userType":"" 
    }
}

解除踢人

UNKICK:

说明: 解除踢人

监听回调返回的数据:

解除userId
{
    "EVENT":"UNKICK",
    "kickType": "userId"
    "userId": "1500275476199" //踢出值
}
解除ip
{
    "EVENT":"UNKICK",
    "kickType": "ip"
    "ip": "127.0.0.1" //踢出值
}

删除某条聊天记录

REMOVE_CONTENT:

说明:删除某条聊天记录，需要通过HTTP接口调用

监听回调返回的数据:

{
    "EVENT":"REMOVE_CONTENT",
    "content":"asd",
    "id":"54b04e90-6acd-11e7-abcd-a985dda00975",
    "roomId":"100781" 
}

清空聊天记录

REMOVE_HISTORY:

说明:清空聊天记录

监听回调返回的数据:

{
    "EVENT":"REMOVE_HISTORY" 
}

关闭聊天室

CLOSEROOM:

说明:关闭聊天室

监听回调返回的数据:

{
    "EVENT":"CLOSEROOM",
    "value": {
      "closed":true,    
      "roomId":"100781" 
    }
}

关闭弹幕

CLOSE_DANMU:

说明:关闭弹幕

监听回调返回的数据:

{
    "EVENT": "CLOSE_DANMU",
    "isClose": true
}

接口发送自定义消息

说明：通过api接口 发送自定义消息

自定义消息接收事件

CUSTOMER_MESSAGE:

说明：自定义消息接收事件

监听回调返回的数据:

{
    "EVENT" : "CUSTOMER_MESSAGE",
    "id":"30764b70-33cb-11ed-b2d4-85c1d25442a0",
    "roomId" : 100781,
    "image":"http://livestatic.videocc.net/assets/wimages/pc_images/logo.png",
    "content" : "这是一条自定义消息" ,
    "user" : {}
}

答题卡

说明：答题卡包含”快速问答“和”答题卡“两个功能

GET_TEST_QUESTION_CONTENT

说明：获取答题卡题目和选项内容

响应：

GET_TEST_QUESTION_RESULT

说明：获取答题卡答题结果

响应：

答题结果属性说明：

ANSWER_TEST_QUESTION

说明：发送答案

请求：

socket.emit('message', JSON.stringify({
    EVENT: 'ANSWER_TEST_QUESTION',
    roomId: channelId,
    nick: nick,
    userId: userId,
    option: result,
    questionId: questionId
}));

字段说明：

咨询提问

S_QUESTION

说明：学生提问内容

响应：

{
    EVENT: 'S_QUESTION',
    roomId: roomId,
    user: {
        nick: nick,
        pic: pic,
        userId: userId,
        userType: 'student'
    },
    content: value
}

字段说明：

用户信息说明：

T_ANSWER

说明：老师/管理员/助教回复提问

响应：

{
    EVENT: 'T_ANSWER',
    roomId: roomId,
    user: {
        nick: nick,
        pic: pic,
        userId: userId,
        userType: 'teacher',
        actor: actor
    },
    s_userId: s_userId
    content: value
}

字段说明：

用户信息说明：

问卷

START_QUESTIONNAIRE

说明：开始问卷调查

响应：

问卷内容说明：

问题信息说明：

ANSWER_QUESTIONNAIRE

说明：学生提交问卷答案

请求：

socket.emit('message', JSON.stringify({
    EVENT: 'ANSWER_QUESTIONNAIRE',
    roomId: roomId,
    nick: nick,
    userId: userId,
    questionnaireId: questionnaireId,
    answer: [
        {
            questionId: 'f8bbo3rhrq',
            answer: 'A'
        },
        {
            questionId: 'f8bbo3rhlw',
            answer: "BC"
        },
        {
            questionId: 'f8bbo3rhht',
            answer: 'polyv'
        }
    ]
}));

字段说明：

答案字段说明：

补充：更多题目类型-答案格式请请参考

STOP_QUESTIONNAIRE

说明：老师停止问卷

响应：

QUESTIONNAIRE_ACHIEVEMENT

说明：讲师点击发送问卷结果按钮，如果学员有回答问卷，则该学员在观看端会收到问卷排名结果事件。

响应：

自定义消息

说明：客户可以根据自己的业务需求，自己定义想要的消息去广播。

请求

socket.emit('customMessage', JSON.stringify({
    EVENT: 'myMessage',
    version: '1.0',
    emitMode: 1,
    roomId: roomId,
    data: {
        company: 'polyv'
    },
    tip: '我的自定义消息',
}));

字段说明：

响应：

签到

SIGN_IN

说明：发起签到

响应：

STOP_SIGN_IN

说明：结束签到

响应：

TO_SIGN_IN

说明：学员签到

响应：

抽奖

说明：抽奖是通过http接口发起的，以下消息是服务器广播给页面的

LotteryStart

说明：开始抽奖

响应：

LotteryEnd

说明：结束抽奖

响应：

示例：

{
    "EVENT":"LotteryEnd",
    "channelId":"",
    "sessionId":"fajrsh0uqj",
    "lotteryId":"fapcpw06l2",
    "prize":"耳机",
    "data":[
        {
            "banned":false,
            "channelId":"",
            "clientIp":"",
            "nick":"广州观众/97375",
            "pic":"//livestatic.videocc.net/v_268/assets/wimages/missing_face.png",
            "roomId":"",
            "uid":"lbcCDoikWTniMk1pAMkI",
            "userId":"1553597220784",
            "userType":"student",
            "winnerCode":"xXYMNZJR"
        }
    ]
}

其他

提交中奖者信息需要调用http接口，详见抽奖-提交中奖者信息

打赏

注：打赏需通过http接口触发，详见打赏-发送打赏消息

REWARD

说明：打赏

响应：

打赏内容说明：

签名生成规则

md5(key+roomId) key的取值请咨询客服