README.md

node-bigbluebutton

Integration between BigBlueButton server and Node.js Applications. Read the Wiki to learn more (https://code.google.com/p/bigbluebutton/wiki/API)

###Install

npm install bigbluebutton

###Usage

First, you have to setup the server configuration. Run bbb-conf --salt on server to get the salt and url, then put in your node.js application

  var bbb = require('bigbluebutton');
  bbb.url = 'http://localhost/bigbluebutton';
  bbb.salt = '99999999999999999999999';

Now you can access the BigBlueButton API easely. You can see some example bellow.

###Examples

Generate a join link:

data = {
  action: 'join',
  params: {
    fullName: 'Test Meeting',
    meetingID: 'exampleaew',
    password: 'WWoon2G8'
  }
}

var link = bbb.link(data);

GET meeting list request:

data = {
  action: 'getMeetings',
}

bbb.request(data, function (err, data) {
  console(err, data);
});

POST meeting creation request with a presentation. If you're not a callback fan, node-bigbluebutton also returns promises:

data = {
  action: 'create',
  params: { 
    meetingID: 'exampleaew',
    meetingName: 'Example Aew',
    moderatorPW: 'exemplo123asd'
  },
  body: {
    modules: {
      module: [
        {
          name:'presentation',
          document:{url:'http://www.samplepdf.com/sample.pdf'}
        }
      ]
    }
  }
}

bbb.request(data)
  .then(function (response) { console.log(response); })
  .fail(function (err) { console.log(err); });

POST or GET response example:

{
  "response":
  {
    "returncode":"SUCCESS",
    "meetings":{},
    "messageKey":"noMeetings",
    "message":"no meetings were found on this server"
  }
}

###Other BigBlueButton API methods https://code.google.com/p/bigbluebutton/wiki/API#API_Calls

###Contributors

• Paulo César ([email protected])
• Sávio Lucena ([email protected])

###Thanks

• https://github.com/buglabs/node-xml2json

https://github.com/kriskowal/q

• http://docs.nodejitsu.com/articles/HTTP/clients/how-to-create-a-HTTP-request