API Reference

Explore the details of the MeetingBurner® API routes.

meetings

Retrieve and add meetings.


GET /rest/1/meetings

Retrieve a list of user's meetings

Parameters:
Name Type Data Type Required Description
Authorization header string Yes Access_key:signature
page_size query integer Number of meetings to load per page
page query integer Page to load
short_cut query string Search parameters to control the list of Meetings you get back. Right now you can use: all, past or future

Returns a list of your meetings.

curl https://www.meetingburner.com/rest/1/meetings?page_size=15&page=1&short_cut=future
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"


{
  "http_status": 200,
  "status": "success",
  "meetings": {
    "page": 1,
    "page_size": 15,
    "total_pages": 2,
    "total_results": 21,
    "meetings": [
      {
        "meeting_id": "12345",
        "user_id": "56789",
        "display_name": "Meet Now Meeting",
        "description": "",
        "date_created": "2014-02-28 03:15:22",
        "audio_type": "0",
        "dialin_number": "9492294400",
        "moderator_pin": "1234321",
        "attendee_pin": "11223344",
        "meeting_password": "",
        "registration": "1",
        "sms_reminders": "0",
        "send_registration_notification": "1",
        "send_reminder_notification": "1",
        "send_attended_notification": "1",
        "registration_notification_text": "",
        "reminder_notification_text": "",
        "attended_notification_text": "",
        "noshow_notification_text": "",
        "show_participant_list": "1",
        "share_only_mode": "0",
        "allow_chat": "1",
        "meeting_profile_id": "0",
        "meet_thermometer": "0",
        "good_word": "Hot",
        "bad_word": "Cold",
        "paypal_email": "",
        "use_facebook": "1",
        "form_fields": "",
        "required_fields": "",
        "meeting_instance_id": "375099",
        "date_scheduled": "2014-09-12 12:00:00",
        "date_started": "0000-00-00 00:00:00",
        "date_ended": "0000-00-00 00:00:00",
        "time_zone": "America/New_York",
        "duration": "3600",
        "identifier": "KDP4W1BJ",
        "random_id": null,
        "started": "0",
        "cancel": "0",
        "is_autopilot": "0",
        "aweber_list_id": null,
        "registration_link": "http://example.enterourmeeting.com/m/KDP4W1BJ"
      },
      ... (14 more results)
    ]
  }
}

        
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings?page_size=15&page=1&short_cut=future" \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$meeting = $data->meetings->meetings[0];
print "Name: {$meeting->display_name}\n";
        
↑ Top

POST /rest/1/meetings

Create a meeting

Parameters:
Name Type Data Type Required Description
Authorization header string Yes Access_key:signature
title form string Yes Meeting title
description form string Yes Meeting description
start form dateTime Yes Meeting start date & time (Format: 2008-08-27 18:30)
start_timezone form dateTime Yes Specific Timezone for meeting start date & time
duration form integer Meeting duration (in minutes)
custom_audio form boolean Use your own conference line? (default: false, use MeetingBurner Conference Line)
dialin form string Dial-in Number
moderator_pin form integer Moderator PIN
attendee_pin form integer Attendee PIN
facebook_registration form boolean Allow Facebook Registration?
facebook_registration_public form boolean Display meeting information on Facebook walls?
registration form boolean Require attendees to register
meeting_password form string Password protect your meeting
meeting_thermometer form boolean Enable to take the virtual temperature of your meeting using our Meeting Thermometer
show_participant_list form boolean Do you want to show the participant list to the other participants?
send_registration_notification form boolean
send_reminder_notification form boolean
send_attended_notification form boolean
allow_chat form boolean
meeting_profile_id form integer The ID of the profile you want to use for this meeting.

curl -X POST https://www.meetingburner.com/rest/1/meetings \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -H "Content-Type: application/json" \

        -d '{
                "title":"Demo Meeting",
                "description":"This is a demo meeting for the API",
                "start":"2014-12-25 18:00",
                "start_timezone":"America\/New_York",
                "duration":"60",
                "custom_audio":"true",
                "dialin":"5555551234",
                "moderator_pin":"12345",
                "attendee_pin":"0000",
                "facebook_registration":"true",
                "facebook_registration_public":"true",
                "registration":"true",
                "meeting_password":"12345",
                "meeting_thermometer":"true",
                "show_participant_list":"true",
                "send_registration_notification":"true",
                "send_reminder_notification":"true",
                "send_attended_notification":"true",
                "allow_chat":"true"
            }'



    {
      "http_status": 201,
      "status": "success",
      "meetings": {
        "meetings": {
          "meeting_id": 999999,
          "user_id": "888888",
          "display_name": "Demo Meeting",
          "description": "This is a demo meeting for the API",
          "date_created": "2014-09-15 09:41:51",
          "audio_type": "1",
          "dialin_number": "5555551234",
          "moderator_pin": "12345",
          "attendee_pin": "0000",
          "meeting_password": "12345",
          "registration": "1",
          "sms_reminders": "0",
          "send_registration_notification": "1",
          "send_reminder_notification": "1",
          "send_attended_notification": "1",
          "registration_notification_text": "",
          "reminder_notification_text": "",
          "attended_notification_text": "",
          "noshow_notification_text": "",
          "show_participant_list": "1",
          "share_only_mode": "0",
          "allow_chat": "1",
          "meeting_profile_id": "1",
          "meet_thermometer": "1",
          "good_word": "Hot",
          "bad_word": "Cold",
          "paypal_email": "",
          "use_facebook": "2",
          "form_fields": "",
          "required_fields": "",
          "meeting_instance_id": 375112,
          "date_scheduled": "2014-12-25 18:00:00",
          "date_started": null,
          "date_ended": null,
          "time_zone": "America/New_York",
          "duration": 3600,
          "identifier": "ZZAJBEEE",
          "random_id": 31210,
          "started": null,
          "cancel": null,
          "is_autopilot": null,
          "aweber_list_id": null,
          "registration_link": "http://example.enterourmeeting.com/m/ZZP4W1BJ"
        },
        "total_results": 1,
        "page": 1,
        "page_size": 1,
        "total_pages": 1
      }
    }

        
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings" \
                -H 'Content-Type: application/x-www-form-urlencoded' \
                --data 'title=Demo%20Meeting&description=This%20is%20a%20demo%20meeting%20for%20the%20API&start=2014-12-25%2018%3A00&start_timezone=America%2FNew_York&duration=60&custom_audio=true&dialin=5555551234&moderator_pin=12345&attendee_pin=0000&facebook_registration=true&facebook_registration_public=true®istration=true&meeting_password=12345&meeting_thermometer=true&show_participant_list=true&send_registration_notification=true&send_reminder_notification=true&send_attended_notification=true&allow_chat=true'
                -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$meeting = $data->meetings->meetings[0];
print "Name: {$meeting->display_name}\n";
        
↑ Top

GET /rest/1/meetings/{meeting_instance_id}

Retrieve an individual meeting

Parameters:
Name Type Data Type Required Description
meeting_instance_id path integer Yes Id of the meeting instance you wish to retrieve
Authorization header string Yes Access_key:signature

Returns the details of a single instance of a meeting.

$ curl https://www.meetingburner.com/rest/1/members/ \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"

{
  "http_status": 200,
  "status": "success",
  "meetings": {
    "meetings": {
      "meeting_id": "123456",
      "user_id": "56789",
      "display_name": "Meet Now Meeting",
      "description": "",
      "date_created": "2014-02-28 03:15:22",
      "audio_type": "0",
      "dialin_number": "5555551234",
      "moderator_pin": "1234",
      "attendee_pin": "4321",
      "meeting_password": "",
      "registration": "1",
      "sms_reminders": "0",
      "send_registration_notification": "1",
      "send_reminder_notification": "1",
      "send_attended_notification": "1",
      "registration_notification_text": "",
      "reminder_notification_text": "",
      "attended_notification_text": "",
      "noshow_notification_text": "",
      "show_participant_list": "1",
      "share_only_mode": "0",
      "allow_chat": "1",
      "meeting_profile_id": "0",
      "meet_thermometer": "0",
      "good_word": "Hot",
      "bad_word": "Cold",
      "paypal_email": "",
      "use_facebook": "1",
      "form_fields": "",
      "required_fields": "",
      "meeting_instance_id": "567890",
      "date_scheduled": "2014-09-12 12:00:00",
      "date_started": "0000-00-00 00:00:00",
      "date_ended": "0000-00-00 00:00:00",
      "time_zone": "America/New_York",
      "duration": "3600",
      "identifier": "ZZP4W1BJ",
      "random_id": "66675",
      "started": "0",
      "cancel": "0",
      "is_autopilot": "0",
      "aweber_list_id": "",
      "registration_link": "http://example.enterourmeeting.com/m/ZZP4W1BJ"
    },
    "total_results": 1,
    "page": 1,
    "page_size": 1,
    "total_pages": 1
  }
}
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings/375099" \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$meeting = $data->meetings->meetings[0];
print "Name: {$meeting->display_name}\n";

↑ Top

POST /rest/1/meetings/{meeting_instance_id}/attendees

Add an attendee to an individual meeting

Parameters:
Name Type Data Type Required Description
meeting_instance_id path integer Yes Id of the meeting instance you wish to add an attendee
first_name form string Yes First name of the attendee
last_name form string Yes Last name of the attendee
email form string Yes email address of the attendee
phone form string Phone number of the attendee
address1 form string Address of the attendee (1)
address2 form string Address of the attendee (2)
city form string City of the attendee
state form string State of the attendee
Zip form string Zip/Postal Code of the attendee
country form string Country of the attendee
send_notification form boolean Should we send the email notifications?
Authorization header string Yes Access_key:signature

curl -X POST https://www.meetingburner.com/rest/1/meetings/375099/attendees \
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd" \
        -H "Content-Type: application/json" \

        -d '{
                "first_name": "Jane",
                "last_name": "Doe",
                "email": "janedoe@example.com",
                "phone": "5555551234",
                "address1": "2020 Some Street",
                "city": "Some City",
                "state": "Some State",
                "Zip": "10001",
                "country": "United States",
                "send_notification": "true"
            }'


    {
        "http_status": 201,
        "status": "success",
        "meetings_attendees": {
            "meetings_attendees": {
                "first_name": "Jane",
                "last_name": "Doe",
                "email_address": "janedoe@example.com",
                "date_registered": "2014-09-12 12:00:22",
                "date_joined": "0000-00-00 00:00:00",
                "attendee_id": "25380925",
                "join_link": "http://example.enterourmeeting.com/m/TT11XX11/BB22Z22Z"
            },
            "total_results": 1,
            "page": 1,
            "page_size": 1,
            "total_pages": 1
        }
    }

        
#! /usr/bin/php
<?php

            curl 'http://marc-dev.meetingfreezer.com/rest/1/meetings/375099/attendees'
            -H 'Content-Type: application/x-www-form-urlencoded'
            -H 'Accept: application/json'
            --data 'first_name=Jane&last_name=Doe&email=email%2Bjanedoe%40mchamplain.com&phone=5555551234&address1=2020%20Some%20Street&city=SomeCity&state=SomeState&Zip=10001&country=United-States&send_notification=true'
            --compressed


$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings/999999/attendees" \
                -H 'Content-Type: application/x-www-form-urlencoded' \
                --data 'first_name=Jane&last_name=Doe&email=janedoe%40example.com&phone=5555551234&address1=2020%20Some%20Street&city=SomeCity&state=SomeState&Zip=10001&country=United-States&send_notification=true'
                -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$attendee = $data->meetings_attendees->meetings_attendees[0];
print "First Name: {$attendee->first_name}\n";
        
↑ Top

GET /rest/1/meetings/{meeting_instance_id}/attendees

Retrieve the list of attendees for an individual meeting

Parameters:
Name Type Data Type Required Description
meeting_instance_id path integer Yes Id of the meeting instance you wish to retrieve
Authorization header string Yes Access_key:signature

curl https://www.meetingburner.com/rest/1/meetings/999999/attendees
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"


{
  "http_status": 200,
  "status": "success",
  "meetings_attendees": {
    "meetings_attendees": [
      {
        "first_name": "John",
        "last_name": "Doe",
        "email_address": "johndoe@example.com",
        "phone": "(202) 244 5511",
        "date_registered": "2014-09-11 15:13:04",
        "date_joined": "0000-00-00 00:00:00",
        "attendee_id": "123454321",
        "join_link": "http://example.enterourmeeting.com/m/XX11XX11/ZZ22Z22Z"
      },
      {
        "first_name": "Jane",
        "last_name": "Doe",
        "email_address": "janedoe@example.com",
        "phone": "(202) 777 1111",
        "date_registered": "2014-09-11 18:31:21",
        "date_joined": "0000-00-00 00:00:00",
        "attendee_id": "123454322",
        "join_link": "http://example.enterourmeeting.com/m/TT11XX11/BB22Z22Z"
      },
      ... 3 more
    ],
    "total_results": 5,
    "page": 1,
    "page_size": 5,
    "total_pages": 1
  }
}

        
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings/999999/attendees \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$attendee = $data->meetings_attendees->meetings_attendees[0];
print "First Name: {$attendee->first_name}\n";
        
↑ Top

GET /rest/1/meetings/{meeting_instance_id}/chatlog

Retrieve the chat and Q&A log for an individual meeting

Parameters:
Name Type Data Type Required Description
meeting_instance_id path integer Yes Id of the meeting instance you wish to retrieve
Authorization header string Yes Access_key:signature
curl https://www.meetingburner.com/rest/1/meetings/999999/chatlog
        -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"


{
  "http_status": 200,
  "status": "success",
  "meetings_chatlog": {
    "meetings_chatlog": [
      {
        "meeting_id": "123456",
        "participant_name": "John Doe",
        "content": "Hello!",
        "timestamp": "2013-12-19 01:09:57 am",
        "message_type": "chat",
        "attendee_id": "123456"
      },
      {
        "meeting_id": "123456",
        "participant_name": "Jane Doe",
        "content": "Hi John",
        "timestamp": "2013-12-19 01:10:08 am",
        "message_type": "chat",
        "attendee_id": "123457"
      },
      ... 3 more
    ],
    "total_results": 5,
    "page": 1,
    "page_size": 5,
    "total_pages": 1
  }
}

        
#! /usr/bin/php
<?php
$results = `curl -s -k "https://www.meetingburner.com/rest/1/meetings/999999/chatlog \
                 -H "Authorization: Bearer m8gZnWNplpHFAHFK79CLfSlBpqwCZ4THA9axa7dd"`;
$data = json_decode($results);
$chatlog = $data->meetings_chatlog->meetings_chatlog[0];
print "Message: {$chatlog->content}\n";
        
↑ Top