chat_js_sdk_api

Creating an Instance

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

Related Parameter Description

Note: The following parameters only take effect when the container parameter is passed.

userId Generation Recommendations

userId is the unique identifier for users in the chat room. If two users with the same userId log into the chat room, the latter will kick the former out. Therefore, the userId of different chat room users must be unique. The generation recommendations are as follows:

1. If you have a user system, use the user ID from your user system as the userId for logging into the chat room.
2. If you do not have a user system, generate a highly random value on the backend as the userId for logging into the chat room, such as "timestamp + 5-digit random number", uuid, etc., and save this userId to a cookie or local storage (localStorage or sessionStorage) to avoid regenerating the userId after each page refresh.

Custom Menu Bar

tabData: An array of objects, each containing two properties: name and type. By default, it includes a chat tab.

name: Menu bar name

type: The type of menu bar. If it is not a built-in type, a div element with no content will be embedded into the page.

Already built-in types

Custom Message Colors

Note: Modify the message font/background color, can be adjusted for yourself/regular users/admins/instructors/assistants/guests.

Custom Domain

getChatRecordBySessionIdOptions Object Description

getChatRecordByTimeOptions Object Description

customMessageRender Object Description

Format: {[type]: function(data){/** 将要渲染的内容返回给sdk内部进行渲染 */}}
type is the rendered message type, with possible values: 'custom'|'flowers'|'other'|'own'|'redpack'|'redpackResult'|'reward'|'system'
data is the message data

Example

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

Instance Methods

Send a quoted reply message: reply(id, content)

Description: Reply to a specific message

Example

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

Parameters

id: String type, the ID of the message to reply to content: String type, the content of the reply

Return Value

Returns a Promise object

Kick Out a User: kickUser(userId, sign)

Description: Kicks a user out of the chat room.

Example

chatroom.kickUser('userId', sign);

Parameters

userId: String type, the userId of the user to be kicked out sign: String type, signature (rules)

Return Value

Returns a Promise object.

Unkick a User: unKickUser(userId, sign)

Description: Unkick a user

Example

chatroom.unKickUser('userId', sign);

Parameters

userId: String type, the userId of the user to be unkicked sign: String type, signature (rules)

Return Value

Returns a Promise object

Others

Get the chat object

var chat = chatroom.chat;

Get Socket Object

var socket = chat.socket;

Send Chat Message

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

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

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

Get Chat History

Get chat history based on options such as message index position.

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

Parameter Description

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

Get chat history by session ID (sessionId)

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

Get chat history based on start time

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

Parameter Description

Result Description

data is an array of objects, with the specific content as follows:

User Notes

Note:

1. clientIp defaults to empty; currently, returning a content value is not supported.

2. Possible values for userType include: empty, student, slice, teacher, manager, assistant, guest, viewer, etc.

Get Online List

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

Parameter Description

Result Description

data is an object with the following content:

userlist Description

For detailed explanation of the userlist object array elements, please refer to the user description in the "Get Chat History" method.

Retrieve Audience Question History

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

Parameter Description

• The input parameter can be an object or omitted; if omitted, it defaults to the parameters used during SDK initialization.
• When passed as an object, it can include the following fields:

Result Description

data is an object with the following content:

list Description

sendMessage

Note: This message is triggered after you speak. It will be returned in roomMessage and can also be monitored through the chat object.

Example:

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

Return Data

    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: ""
    }

Interactive Feature Socket Message Description

Login Message

LOGIN:

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

Callback data returned by the listener:

{
    "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": "" 
    }
}

Description

Logout Message

LOGOUT

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

Monitor callback returns data:

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

Receiving Messages from Others

SPEAK：

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

Send:

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

Field Description:

Callback data returned:

{
    "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"]
}

System Announcement

GONGGAO：

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

Data returned by the listener callback:

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

General Announcement

BULLETIN

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

Callback data returned:

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

Flower Sending Message

FLOWERS:

说明:送花

The number returned by the listener callback

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

Like Notification

LIKES:

说明: 点赞

Data returned by the listener callback:

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

Mute

SHIELD:

说明: 禁言

Data returned by the listener callback:

Note: Only one of userId or ip will be returned.

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

Unmute

REMOVE_SHIELD:

说明: 解除禁言

Callback data returned:

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

Kick User

KICK:

说明: 踢人

Callback return data:

{
    "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":"" 
    }
}

Unban/Kick Removal

UNKICK:

说明: 解除踢人

Callback data returned by the listener:

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

Delete a Chat Record

REMOVE_CONTENT:

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

Callback data returned:

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

Clear Chat History

REMOVE_HISTORY:

说明:清空聊天记录

Callback data returned:

{
    "EVENT":"REMOVE_HISTORY" 
}

Close Chat Room

CLOSEROOM:

说明:关闭聊天室

Callback data returned:

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

Close Danmaku

CLOSE_DANMU:

说明:关闭弹幕

Callback data returned:

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

Send Custom Message via Interface

Note: Send custom messages via the API interface Send Custom Message

Custom Message Reception Event

CUSTOMER_MESSAGE:

Note: Custom message receiving event

Callback data returned:

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

Answer Sheet

Note: The answer sheet includes two functions: "Quick Q&A" and "Answer Sheet".

GET_TEST_QUESTION_CONTENT

Description: Retrieve the content of answer sheet questions and options.

Response:

GET_TEST_QUESTION_RESULT

Description: Get the answer sheet results.

Response:

Answer Result Attribute Description:

ANSWER_TEST_QUESTION

Note: Send the answer.

Request:

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

Field Description:

Consultation Questions

S_QUESTION

Note: Content of student questions

Response:

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

Field Description:

User Information Description

T_ANSWER

Note: Teacher/Administrator/Teaching Assistant replies to questions

Response:

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

Field Description:

User Information Description

Survey

START_QUESTIONNAIRE

Note: Start the survey

Response:

Questionnaire Content Description

Problem Information Description

ANSWER_QUESTIONNAIRE

Description: Students submit questionnaire answers.

Request:

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'
        }
    ]
}));

Field Description:

Answer Field Description:

Supplement: More Question Types - Answer Format Please Refer to

STOP_QUESTIONNAIRE

Note: The teacher has stopped the survey.

Response:

QUESTIONNAIRE_ACHIEVEMENT

Note: When the instructor clicks the "Send Survey Results" button, if a student has responded to the survey, that student will receive a survey ranking result event on their viewing end.

Response:

Custom Messages

Note: Customers can define their own messages to broadcast based on their business needs.

Request

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

Field Description:

Response:

Check-in

SIGN_IN

Description: Initiate Check-in

Response:

STOP_SIGN_IN

Note: End check-in

Response:

TO_SIGN_IN

Description: Student Check-in

Response:

Lottery Draw

Note: The lottery is initiated via an HTTP interface. The following messages are broadcast from the server to the page.

LotteryStart

Note: Start the lottery

Response:

LotteryEnd

Note: End the lottery

Response:

Example:

{
    "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"
        }
    ]
}

Others

To submit winner information, you need to call the HTTP interface. For details, see Lottery - Submit Winner Information.

Tip

Note: Tipping must be triggered via an HTTP interface. For details, see Tipping - Send Tipping Message.

REWARD

Note: Tipping

Response:

Donation Content Description:

Signature Generation Rules

md5(key+roomId) For the value of key, please consult customer service.