Question

我想创建一个Rocket Chat客户端，使用Realtime API通过浏览器订阅频道。文档here不提供分步过程。请让我知道如何实现它。

任何文档的链接都会非常有用。

Answer 1

当我问这个问题时，我对websockets的了解不多。为了所有人的利益，提到我遵循的步骤。

打开websocket
var rocketChatSocket = new WebSocket("ws://locahost:3000/websocket");
连接

var connectRequest = { "msg": "connect", "version": "1", "support": ["1", "pre2", "pre1"] } rocketChatSocket.send(JSON.stringify(connectRequest));

连接后，请继续使用{"msg":"pong"}从{"msg":"ping"}回复服务器。

通过致电this API
收到authToken登录信息
var loginRequest = { "msg": "method", "method": "login", "id": "42", "params": [ { "resume": "authToken" } ] }

rocketChatSocket.send(JSON.stringify(loginRequest));
订阅房间

var subscribeRequest = { "msg": "sub", "id": "unique-id", "name": "stream-notify-room", "params":[ "room-id/event", false ] }

rocketChatSocket.send(JSON.stringify(subscribeRequest));
发送消息

var request={ "msg": "method", "method": "sendMessage", "id": "42", "params": [ { "_id": "message-id", "rid": "room-id", "msg": "Hello World!" } ] }

rocketChatSocket.send(JSON.stringify(request));

Answer 2

如果您要为此目的使用开放源代码库，请使用https://github.com/inf3cti0n95/Rocket.Chat.RealTime.API.RxJS

这是示例代码：

import { RealTimeAPI } from "rocket.chat.realtime.api.rxjs";

const realTimeAPI =  new RealTimeAPI("wss://demo.rocket.chat/websocket");

realTimeAPI.keepAlive();

const auth = realTimeApi.login(USERNAME, PASSWORD);

//Subscribe to messages and errors
    auth.subscribe(
    (data) => console.log(data),
    (err) => console.log(err),
    () => console.log('completed'));


//Subscribe to a specific channel, identified by roomId
realtimeAPI.sendMessage({
  msg: 'sub',
  id: '<a unique Id for subscription>',
  name: 'stream-room-messages',
  params: [roomId, false],
});

Answer 3

谢谢南丹先生，我们能够使用您的答案建立完全自定义的客户端，以与火箭聊天实时api进行交谈这是将来想要相同事物的人的链接 https://github.com/lalosh/rocketchat.realTimeAPI.customClient/blob/master/main.js

这是您要立即检查的代码

/*
Rocket Chat Real Time API Custom Client


even though this code works great I don't know what exactly each event we listen for is doing
you can go back to rocket chat real time api for further declarations

we were able to write this code after we test real normal use case of livechat in a web page
and we listen for WebSocket connection inside the browser Network tab(by filtering ws(WebSocket) connections)
*/


let socket = new WebSocket('ws://[rocketChatIP]:[rocketChatPort]/websocket');

//note messageCount is incremented with every message
//but it can works even if you didn't change it
let messagesCount = 1;

// the variables chatToken and chatRoomId are very important
// and they are the identifier to the room(the whole chat) you are using
// if you want to get access to the chat again you need these two variables tokens
let chatToken = generateHash(17);
let chatRoomId = generateHash(17);

let subId = generateHash(17);
let roomSubId = generateHash(17);
let streamLivechatchatRoomId = generateHash(17);
let steamNotifyRoomSubId = generateHash(17);

let name = 'user28';
let email = 'user28@gmail.com';
let guestName = 'guest';


// listen to messages passed to this socket
socket.onmessage = function(e) {

  let response = JSON.parse(e.data);
  console.log('response', response);

  // you have to pong back if you need to keep the connection alive
  // each ping from server need a 'pong' back
  if (response.msg == 'ping') {
    console.log('pong!');
    socket.send(JSON.stringify({
      msg: 'pong'
    }));
    return;
  }

  // here you receive messages from server //notive the event name is: 'stream-room-messages'
  if (response.msg === 'changed' && response.collection === 'stream-room-messages') {
    console.log('msg received ', response.fields.args[0].msg, 'timestamp ', response.fields.args[0].ts.$date, 'from ' + response.fields.args[0].u.name);
    return;
  }

  // receive all messages which will only succeed if you already have messages
  // in the room (or in case you send the first message immediately you can listen for history correctly)
  if (response.msg === 'result' && response.result) {
    if (response.result.messages) {
      let allMsgs = response.result.messages;
      console.log('-----previous msgs---------------');
      allMsgs.map(x => console.log(x))
      console.log('---------------------------------')
    }
  }
}

//////////////////////////////////////////////
// steps to achieve the connection to the rocket chat real time api through WebSocket


//1 connect
let connectObject = {
  msg: 'connect',
  version: '1',
  support: ['1', 'pre2', 'pre1']
}

setTimeout(() => {
  socket.send(JSON.stringify(connectObject));
}, 1000)

//////////////////////////////////////////////

//2 getInitialData
let getInitialDataObject = {
  msg: 'method',
  method: 'livechat:getInitialData',
  params: [String(chatToken), null],
  id: String(messagesCount++),
}

setTimeout(() => {
  socket.send(JSON.stringify(getInitialDataObject));
}, 2000)

//////////////////////////////////////////////

//3 loginByToken
let loginByToken = {
  msg: 'method',
  method: 'livechat:loginByToken',
  params: [String(chatToken)],
  id: String(messagesCount++),
}

setTimeout(() => {
  socket.send(JSON.stringify(loginByToken));
}, 3000)

//////////////////////////////////////////////

//4 subscribtion 
let subObj = {
  msg: 'sub',
  id: subId,
  name: 'meteor.loginServiceConfiguration',
  params: []
}

setTimeout(() => {
  socket.send(JSON.stringify(subObj));
}, 4000)

//////////////////////////////////////////////

//5 register // you may skip this if you alredy registered
// or you can re use it even though you are registered.. no problems
// the crucial part is the `chatToken` and later on the `chatRoomId`

let registerObj = {
  msg: 'method',
  method: 'livechat:registerGuest',
  params: [{
    token: chatToken,
    name: name,
    email: email,
    'department': null
  }],
  id: String(messagesCount++),
};


setTimeout(() => {
  socket.send(JSON.stringify(registerObj));
}, 5000)

//////////////////////////////////////////////////

//6 stream-notify-room

let streamNotifyObj = {
  msg: 'method',
  method: 'stream-notify-room',
  params: [
    'null/typing',
    guestName, true, {
      token: String(chatToken)
    }
  ],
  id: String(messagesCount++)
};

setTimeout(() => {
  socket.send(JSON.stringify(streamNotifyObj));
}, 6000)

//////////////////////////////////////////////////

//7 send a msg //use the same method to send your own messages again when you are all connected
let myMsg = {
  msg: 'method',
  method: 'sendMessageLivechat',
  params: [{
    _id: String(generateHash(17)),
    rid: chatRoomId,
    msg: 'first message',
    token: String(chatToken),
  }, null],
  id: String(messagesCount++),
}


setTimeout(() => {
  socket.send(JSON.stringify(myMsg));
}, 7000)

//////////////////////////////////////////////////

//8 send userPresence
let UserPresence = {
  msg: 'method',
  method: 'UserPresence:connect',
  params: [
    String(chatToken),
    {
      visitor: String(chatToken)
    }
  ],
  id: String(messagesCount++)
}

setTimeout(() => {
  socket.send(JSON.stringify(UserPresence));
}, 8000)

/////////////////////////////////////////////////

//9 loadHistory of old messages 

let loadHistory = {
  msg: 'method',
  method: 'livechat:loadHistory',
  params: [{
    token: String(chatToken),
    rid: String(chatRoomId),
    ts: {
      $date: new Date().getTime()
    }, //current point of time
    limit: 50
  }],
  id: String(messagesCount++)
};

setTimeout(() => {
  socket.send(JSON.stringify(loadHistory));
}, 9000)


/////////////////////////////////////////////////

// 10 stream-room-messages
// listen to all received messages

let roomMessagesSub = {
  msg: 'sub',
  id: String(roomSubId),
  name: 'stream-room-messages',
  params: [
    String(chatRoomId),
    {
      useCollection: false,
      args: [{
        visitorToken: String(chatToken)
      }]
    }
  ]
};

setTimeout(() => {
  socket.send(JSON.stringify(roomMessagesSub));
}, 10000)

/////////////////////////////////////////////////

// 11 getAgentData
let getAgentData = {
  msg: 'method',
  method: 'livechat:getAgentData',
  params: [{
    roomId: String(chatRoomId),
    token: String(chatToken),
  }],
  id: String(messagesCount++)
}

setTimeout(() => {
  socket.send(JSON.stringify(getAgentData));
}, 11000)

/////////////////////////////////////////////////

//12 stream-livechat-room
let streamLivechatRoom = {
  msg: 'sub',
  id: String(streamLivechatchatRoomId),
  name: 'stream-livechat-room',
  params: [
    String(chatRoomId),
    {
      useCollection: false,
      args: [{
        'visitorToken': String(chatToken)
      }]
    }
  ]
}

setTimeout(() => {
  socket.send(JSON.stringify(streamLivechatRoom));
}, 12000)

//////////////////////////////////////////

//13 stream-notify-room
let steamNotifyRoomSub = {
  msg: 'sub',
  id: String(steamNotifyRoomSubId),
  name: 'stream-notify-room',
  params: [
    `${String(chatRoomId)}/typing`,
    {
      useCollection: false,
      args: [{
        token: String(chatToken)
      }]
    }
  ]
}

setTimeout(() => {
  socket.send(JSON.stringify(steamNotifyRoomSub));
}, 13000)

//////////////////////////////////////

//14 userpresence 2
let UserPresence2 = {
  msg: 'method',
  method: 'UserPresence:online',
  params: [String(chatToken)],
  id: String(messagesCount++),
}

setTimeout(() => {
  socket.send(JSON.stringify(UserPresence2));
}, 14000)


//////////////////////////////////////


//use it to send new messages
function sendNewMsg(msg, messagesCount) {

  let myMsg = {
    msg: 'method',
    method: 'sendMessageLivechat',
    params: [{
      _id: String(generateHash(17)),
      rid: chatRoomId,
      msg: String(msg),
      token: String(chatToken),
    }, null],
    id: String(messagesCount++),
  }

  setTimeout(() => {
    socket.send(JSON.stringify(myMsg));
  }, 500);

}


function generateHash(targetLength) {
  var text = '';
  var possible = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';

  for (var i = 0; i < targetLength; i++)
    text += possible.charAt(Math.floor(Math.random() * possible.length));

  return text;
}

浏览器中的Rocket Chat Realtime API

3 个答案: