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，預設包含聊天分頁。

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 為一個物件陣列，具體內容如下

使用者說明

注意：

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

說明：獲取答題卡題目和選項內容

好的，請提供您需要翻譯的簡體中文 Markdown 內容。

GET_TEST_QUESTION_RESULT

說明：獲取答題卡答題結果

好的，請提供您要翻譯的簡體中文 Markdown 內容。

答題結果屬性說明：

ANSWER_TEST_QUESTION

說明：傳送答案

好的，请提供您需要翻译的简体中文 Markdown 内容。

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

欄位說明：

諮詢提問

S_QUESTION

說明：學生提問內容

好的，請提供您要翻譯的簡體中文 Markdown 內容。

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

欄位說明：

使用者資訊說明

T_ANSWER

說明：老師/管理員/助教回覆提問

好的，請提供您要翻譯的簡體中文 Markdown 內容。

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

欄位說明：

使用者資訊說明

問卷

START_QUESTIONNAIRE

說明：開始問卷調查

好的，請提供您要翻譯的簡體中文 Markdown 內容。

問卷內容說明：

問題資訊說明：

ANSWER_QUESTIONNAIRE

說明：學生提交問卷答案

好的，请提供您需要翻译的简体中文 Markdown 内容。

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

說明：老師停止問卷

好的，請提供您要翻譯的簡體中文 Markdown 內容。

QUESTIONNAIRE_ACHIEVEMENT

說明：講師點擊發送問卷結果按鈕，如果學員有回答問卷，則該學員在觀看端會收到問卷排名結果事件。

好的，請提供您要翻譯的簡體中文 Markdown 內容。

自訂訊息

說明：客戶可以根據自己的業務需求，自行定義想要廣播的消息。

好的，请提供您需要翻译的简体中文 Markdown 内容。

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

欄位說明：

好的，請提供您要翻譯的簡體中文 Markdown 內容。

簽到

SIGN_IN

說明：發起簽到

好的，請提供您要翻譯的簡體中文 Markdown 內容。

STOP_SIGN_IN

說明：結束簽到

好的，請提供您要翻譯的簡體中文 Markdown 內容。

TO_SIGN_IN

說明：學員簽到

好的，請提供您要翻譯的簡體中文 Markdown 內容。

抽獎

說明：抽獎是透過 HTTP 介面發起的，以下訊息是伺服器廣播給頁面的

LotteryStart

說明：開始抽獎

好的，請提供您要翻譯的簡體中文 Markdown 內容。

LotteryEnd

說明：結束抽獎

好的，請提供您要翻譯的簡體中文 Markdown 內容。

範例：

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

說明：贊助

好的，請提供您要翻譯的簡體中文 Markdown 內容。

打賞內容說明：

簽名生成規則

md5(key+roomId) key 的取值請諮詢客服