NAV
cURL

Welcome to BigMarker Integration API Doc

The BigMarker API allows you to manage your your channel and conferences of your channel. With the BigMarker API you can:

The BigMarker API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and HTTP response codes that indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support cross-origin resource sharing to allow you to interact securely with our API from a client-side web application. JSON will be returned in all responses from the API, including errors.

Authentication

Login

To make any BigMarker API call, you must first get your BigMarker API-KEY. Go to your user’s settings page to request an API key. You can then use this login API call to retrieve your API-KEY. After authentication is complete, please store the returned api_token for future requests as your API-KEY. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Login example

curl -i -X POST --data "email=youremail@email.com&password=yourpassword" https://www.bigmarker.com/api/v1/members/login

The above command returns JSON structured like this:

[{"api_token":"xxxxxx"}]

Make sure to replace youremail@email.com and yourpassword with your email and password.

Routing

https://www.bigmarker.com/api/v1/members/login

Method

POST

Parameters

Parameter Type Required? Description
email String Required Email address you used to create your BigMarker account
password String Required Your password used with your email to log into BigMarker.com

Response

Status Type Message
401 authentication_error Authentication failed. Invalid email and/or password.
401 no_api_token_avilable You do not have a valid API token. Please request one by contacting support@bigmarker.com
Status Message
201 {“api_token”:“xxxxxx”}

Once you obtain your api_token, your api_token will be your API-KEY as authentication for all API calls by including it in the header. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such GitHub, client-side code, and so forth.

Manage Conferences

List Conferences

You can use this API call to get all future conferences from all of your channels.

To get all conferences belonging to all of your channels.

 curl -i -H "API-KEY:xxxxxx"  https://www.bigmarker.com/api/v1/conferences/

The above command returns JSON structured like this:

[
  {
    "id": "xxxxxx1",
    "title": "Conference 1 Title",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
    "purpose": "To be great"
  },
  {
      "id": "xxxxxx2",
      "title": "Conference 2 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_2_url",
      "purpose": "To be great"
    }
]

Routing

https://www.bigmarker.com/api/v1/conferences/

Method

GET

Required Parameter

Parameter Type Description
API-KEY String Put api_token in the header

Return Data

JSON

Response

Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
URL Error 404 {“error”:“Not Found!”}
Status Message
201

List Channel Conferences

You can use this API call to get all future conferences from one of your channels.

To get all conferences belonging to a channel

 curl -i -H "API-KEY:xxxxxx" 'https://www.bigmarker.com/api/v1/conferences/:channel_url'

The above command returns JSON structured like this:

[
  {
    "id": "xxxxxx1",
    "title": "Conference 1 Title",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
    "purpose": "To be great"
  },
  {
      "id": "xxxxxx2",
      "title": "Conference 2 Title",
      "conference_address": "https://www.bigmarker.com/channel_url/conference_2_url",
      "purpose": "To be great"
    }
]

Routing

https://www.bigmarker.com/api/v1/conferences/channel_url

Method

GET

Required Parameter

Parameter Type Required Description Values
channel_url String Required Your channel URL.
timing String Optional The time frame the list of conferences should be in future (default), all, past
page Integer Optional The page number of the list Defaults to 1
per_page Integer Optional How many conferences per page to fetch Defaults to 25

Return Data

JSON

Response

Status Message
201
Type Status Message
Unauthorized 401 {“error”:“Missing or invalid API key.”}
You do not have rights to get conferences for channel 403 {“error”:“You don’t have access to this Channel”}
URL Error 404 {“error”:“Channel Not Found!”}

Creating a Conference

To create a new conference for channel.


 curl 'https://www.bigmarker.com/api/v1/conferences' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json" -d '{"channel_id": "your_channel_id","title": "This is your conference title"}'

The above command returns JSON structured like this:


  {
    "id": "xxxxxx",
    "title": "Conference 1 Title",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_1_url",
    "max_attendance": 100,
    "purpose": "To be great"
  }

You can use this API call to create a new conference for your channel.

Routing

https://www.bigmarker.com/api/v1/conferences/channel_url

Method

GET

Required Parameter

Parameter Type Required Description
channel_id String Required The channel ID that you want to create this conference for.
title String Required The title of your conference, maximum length 100 characters.
start_time String Required The start time of your conference
time_zone String Optional The time zone of your start time. Please visit the Time Zones section for a list of acceptable values. Defaults to ‘Central Time (US & Canada)’
purpose Integer Optional A description of your conference

Return Data

JSON

Response

Status Message
201
Status Type Message
401 channel_permission_denied You do not have permission to access this channel.
404 channel_not_found The channel you are requesting is not found.

Update a Conference

To update a conference from your channel.


 curl 'https://www.bigmarker.com/api/v1/conferences/{conference_id}' -i -X PUT -H "API-KEY:xxxxxx"
 -H "Content-Type:application/json"
 -d '{"title": "Lead Generation 101", "purpose":"How to generate leads with great content"}'

The above command returns JSON structured like this:

  {
    "id": "xxxxxx",
    "title": "Conference Title",
    "purpose": "Conference description and purpose",
    "start_time": "2015-11-01 14:00",
    "conference_address": "https://www.bigmarker.com/channel_url/conference_url"
  }

You can use this API call to update a conference for your channel.

Routing

https://www.bigmarker.com/api/v1/{:conference_id}

Method

GET

Request Parameter

Parameter Type Required Description
conference_id String Required The ID of the conference you are updating. You can get this ID from list conferences API call
title String Required The title of your conference, maximum length 100 characters.
start_time String Required The start time of your conference
time_zone String Optional The time zone of your start time. Please visit the Time Zones section for a list of acceptable values. Defaults to ‘Central Time (US & Canada)’
purpose String Optional A description of your conference

Return Data

JSON

Response

Status Message
201
Type Status Message
You do not have permission to retrieve conferences from this channel 403 {“error”:“You do not have access to this Channel”}

Delete a Conference

You can use this API call to delete a conference in your channel.

Delete conference example

curl -i -X DELETE -H "API-KEY:xxxxxx"  /api/v1/conferences/:conference_id

Routing

https://www.bigmarker.com/api/v1/conferences/:conference_id

Method

DELETE

Request Parameters

Parameter Type Description
id String The ID of the conference you like to delete
API-KEY String put in request head

Return Data

JSON

Response

Status Type Message
401 channel_permission_denied You do not have permission to access this channel.
404 conference_not_found The conference you are requesting is not found.
Status Message
204

Entering a Conference

To create a new conference for channel.


 curl 'https://www.bigmarker.com/api/v1/conferences/enter' -i -X POST -H "API-KEY:xxxxxx" -H "Content-Type:application/json"
 -d '{"id": "your_conference_id","attendee_name": "John Doe", "attendee_email":"email@email.com", "role":"attendee", "exit_uri":"https://www.yourwebsite.com"}'

The above command returns JSON structured like this:


  {
    "enter_token": "xxxxxx",
    "enter_uri": "https://www.bigmarker.com/enter_url"    
  }

You can use this API call to enter a conference. This will allow you to by pass the BigMarker conference landing page and enter the conference room directly. When used with custom branding feature, this API call is very powerful as you can integrate the BigMarker conference room directly into your website as your own conferencing platform.

Routing

https://www.bigmarker.com/api/v1/conferences/enter

Method

POST

Required Parameters

Parameter Type Required Description Values
id String Required The ID of the conference you are trying to enter
attendee_name String Required The name of the attendee that would show up in the conference room.
attendee_email String Required The email of the attendee. Providing email will allow the attendee to receive emails when the conference recording is posted.
role String Optional Acceptable values: attendee (default), presenter. Passing the presenter value will give the person presenter rights and access to the admin control panel within the conference.
exit_uri String Optional A description of your conference

Return Data

JSON

Response

Status Message
201 {“enter_token”: “xxxxxx”,“enter_uri”: “https://www.bigmarker.com/enter_url”} use enter_uri as the link for the member to enter the conference.
Status Type Message
401 channel_permission_denied You do not have permission to access this channel.
404 channel_not_found The channel you are requesting is not found.
401 premium_channel_required This channel does not allow entering of the conference via API, please use the conference page or upgrade your account.
400 conference_setting_up The server for this conference is setting up. Please wait a few minutes and try again.
400 conference_ended This conference has ended
400 conference_not_open_for_presenter This conference is currently not open. Presenters can enter the conference 30 minutes prior to the conference start time.
400 conference_not_open_for_attendee This conference is currently not open. Attendees can enter the conference 15 minutes prior to the conference start time.

Conference Registrations

Register a User to a Conference

You can use this API call to register a person to your existing conferences in your channel.

curl https://www.bigmarker.com/api/v1/conferences/register -i -X PUT -H "API-KEY:xxxxxx"
--data "id=xxxxxx&email=emailaddress@email.com&first_name=John&last_name=Doe"

The above command returns JSON structure that contains the URL the registered user can use to enter the conference


  {
    "conference_url": "https://www.bigmarker.com/your_channel_id/your_conference_id"
  }

Routing

https://www.bigmarker.com/api/v1/conferences/register

Method

PUT

Request Parameters

Parameter Type Required? Description
id String Required Conference ID of the conference to register
email String Required Registrant’s email
first_name String Required Registrant’s first name
last_name String Required Registrant’s last name

Return Data

JSON

Response

Status Message
201 After the API call is successfully completed, a conference URL will be returned that can be used for the registrant to enter the conference.
Status Type Message
401 conference_permission_denied You do not have permission to access or modify this conference.
404 conference_not_found The conference you are requesting is not found.

Unregister a User From a Conference

curl https://www.bigmarker.com/api/v1/conferences/register
-i -X DELETE  -H "API-KEY:xxxxxx"
--data "id=xxxxxx&email=email@email.com"

Routing

https://www.bigmarker.com/api/v1/conferences/register

Method

DELETE

Request Parameters

Parameter Type Required? Description
id String Required The conference ID that you like to unregister the user from
email String Required The email address of the user that you like to unregister from the conference

Return Data

JSON

Response

Status Type Message
401 conference_permission_denied You do not have permission to access or modify this conference.
404 conference_not_found The conference you are requesting is not found.
Status Message
204

Time Zones

Please use the following time zones values in creating and editing conferences.

Time zone
International Date Line West
Midway Island
American Samoa
Hawaii
Alaska
Pacific Time (US & Canada)
Tijuana
Mountain Time (US & Canada)
Arizona
Chihuahua
Mazatlan
Central Time (US & Canada)
Saskatchewan
Guadalajara
Mexico City
Monterrey
Central America
Eastern Time (US & Canada)
Indiana (East)
Bogota
Lima
Quito
Atlantic Time (Canada)
Caracas
La Paz
Santiago
Newfoundland
Brasilia
Buenos Aires
Georgetown
Greenland
Mid-Atlantic
Azores
Cape Verde Is.
Dublin
Edinburgh
Lisbon
London
Casablanca
Monrovia
UTC
Belgrade
Bratislava
Budapest
Ljubljana
Prague
Sarajevo
Skopje
Warsaw
Zagreb
Brussels
Copenhagen
Madrid
Paris
Amsterdam
Berlin
Bern
Rome
Stockholm
Vienna
West Central Africa
Bucharest
Cairo
Helsinki
Kyiv
Riga
Sofia
Tallinn
Vilnius
Athens
Istanbul
Midway Island
American Samoa
Hawaii
Alaska
Pacific Time (US & Canada)
Tijuana
Mountain Time (US & Canada)
Arizona
Chihuahua
Mazatlan
Central Time (US & Canada)
Saskatchewan
Guadalajara
Mexico City
Monterrey
Central America
Eastern Time (US & Canada)
Indiana (East)
Bogota
Lima
Quito
Atlantic Time (Canada)
Caracas
La Paz
Midway Island
American Samoa
Hawaii
Alaska
Pacific Time (US & Canada)
Tijuana
Mountain Time (US & Canada)
Arizona
Chihuahua
Mazatlan
Central Time (US & Canada)
Saskatchewan
Guadalajara
Mexico City
Monterrey
Central America
Eastern Time (US & Canada)
Indiana (East)
Bogota
Lima
Quito
Atlantic Time (Canada)
Caracas
La Paz
Santiago
Newfoundland
Brasilia
Buenos Aires
Georgetown
Greenland
Mid-Atlantic
Azores
Cape Verde Is.
Dublin
Edinburgh
Lisbon
London
Casablanca
Monrovia
UTC
Belgrade
Bratislava
Budapest
Ljubljana
Prague
Sarajevo
Skopje
Warsaw
Zagreb
Brussels
Copenhagen
Madrid
Santiago
Newfoundland
Brasilia
Buenos Aires
Georgetown
Greenland
Mid-Atlantic
Azores
Cape Verde Is.
Dublin
Edinburgh
Lisbon
London
Casablanca
Monrovia
UTC
Belgrade
Bratislava
Budapest
Ljubljana
Prague
Sarajevo
Skopje
Warsaw
Zagreb
Brussels
Copenhagen
Madrid
Minsk
Jerusalem
Harare
Pretoria
Moscow
St. Petersburg
Volgograd
Kuwait
Riyadh
Nairobi
Baghdad
Tehran
Abu Dhabi
Muscat
Baku
Tbilisi
Yerevan
Kabul
Ekaterinburg
Islamabad
Karachi
Tashkent
Chennai
Kolkata
Mumbai
New Delhi
Kathmandu
Astana
Dhaka
Sri Jayawardenepura
Almaty
Novosibirsk
Rangoon
Bangkok
Hanoi
Jakarta
Krasnoyarsk
Beijing
Chongqing
Hong Kong
Urumqi
Kuala Lumpur
Singapore
Taipei
Perth
Irkutsk
Ulaan Bataar
Seoul
Osaka
Sapporo
Tokyo
Yakutsk
Darwin
Adelaide
Canberra
Melbourne
Sydney
Brisbane
Hobart
Vladivostok
Guam
Port Moresby
Magadan
Solomon Is.
New Caledonia
Fiji
Kamchatka
Marshall Is.
Auckland
Wellington
Nuku'alofa
Tokelau Is.
Samoa

Errors

Error Code Meaning
400 Bad Request – The format of your request is not acceptable
401 Unauthorized – Your API key is invalid
403 Forbidden – The channel you are trying to access is not accessible to you
406 Not Acceptable – You requested a format that isn’t json
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarily offline for maintenance. Please try again later.