Moxtra Meet Widget for Web

Embed the Moxtra Meet module into your web application using the simple JavaScript calls mentioned in this document.

Start Meet

Optional parameters to include in Moxtra.meet() API request
Name Value Description
schedule_binder_id The schedule_binder_id value from REST API Schedule Meet request The meet is started from the scheduled meeting. Please refer to Schedule Meet REST API.
binder_id The binder_id value The binder_id is used for auto inviting all binder members while invite_members is set to "true".
invite_members "true" or "false" Default is false. Specify to auto invite all binder members from the binder_id when starting a Meet.
produce_feeds "true" or "false" Default is false. Specify to produce meet recording feeds in the binder_id in a Meet recording.
unique_id The list of unique_id(s) separated by comma (,) Optional: the initial members that are to be invited into the Meet.
email The list of email(s) separated by comma (,) Optional: the initial members that are to be invited into the Meet.
topic Meet topic Optional: the meet topic.
iframe "true" or "false" Default is false. Specify to start a meet in iframe or in a new window.
tagid4iframe iFrame ID Specify the ID of iframe container - applicable only if iframe in option is set to "true".
border "true" or "false" Default is true. Specify "false" if using iframe inside a tag without border around the iframe.
scroll "true" or "false" Default is false. Specify "true" if using iframe inside a tag adding scroll bar around the iframe.
iframewidth iFrame Width Width of the meet iFrame - applicable only if iframe in option is set to "true". Default is set to 1024px. If container controls the width, please set to 100%.
iframeheight iFrame Height Height of the meet iFrame - applicable only if iframe in option is set to "true". Default is set to 768px. If container controls the height, please set to 100%.
no_refresh "true" or "false" Default is false. Specify "true" for caller to handle Meet refresh during browser page refresh. During page refresh please set refresh_binder_id as shown below.
refresh_binder_id The binder_id value of the Meet before page refresh The binder_id is used when no_refresh is "true" to handle Meet refresh during browser page refresh. This binder_id is obtained from start_meet event.
video "true" or "false" Default is false. Specify "true" if your application will require video conference in Meet.
extension - Here are the extension options that can be used with the start Meet API:

To show or hide the invite member dialog. Default is false.

{ 
    "show_dialogs": { "meet_invite": true/false } 
}

To auto save the content shared in the meet into a binder, and to not show "Save & End" button. Default is false. "auto_record" is depricated and replaced with "START_WITH_RECORDING" in options to start recording.

{ 
    "save_meet": { 
        "auto_save": true/false, 
        "hide_save": true/false
    }
}

To add your own CMS or repository into the add file option.

{ 
    "menus":[{"add_page":[
        {
            "menu_name":"My CMS",
            "position":"bottom"
        }]
    }]
}

Listener to handle the callback on custom add page option.

add_page: function(event) {
    if (event.action == "My CMS") {
     alert ("Clicked on My CMS for Binder Id: " + event.binder_id);
    }
}

options - Here are the additional meeting level options to use with the start Meet API:

Based on the options mentioned in this code snippet you will be able to control the behavior of certain Meet features. By default all these options are set to "false":

options: {
// Set to true with recording on when meet starts for more than 2 persons in a meet. This is to replace "auto_record" in "save_meet".
"START_WITH_RECORDING": true,

// Set to true will hide the invite option for Meet
"MEET_WITHOUT_INVITE": true, 

// Set to true will hide the invite option only to the attendees and not the host or presenter
"MEET_ATTENDEE_WITHOUT_INVITE": true,

// Set to true will hide the particpant panel for Meet
"MEET_WITHOUT_PARTICIPANT":true, 

// Set to true will hide the particpant panel only to the attendees and not the host or presenter
"MEET_ATTENDEE_WITHOUT_PARTICIPANT":true

// Set to true will hide annotation options to the the participants
"MEET_ATTENDEE_WITHOUT_ANNOTATE":true  

// Set to true will hide audio option for Meet
"MEET_WITHOUT_AUDIO": true, 

// Applicable only if MEET_WITHOUT_AUDIO is false. Set to true will hide VoIP audio option for Meet
"MEET_WITHOUT_AUDIO_VOIP": true,

// Applicable only if MEET_WITHOUT_AUDIO is false. Set to true will hide Dial-in audio option for Meet
"MEET_WITHOUT_AUDIO_DIALIN": true,

// Set to true will disallow change host. Default is false.
"MEET_WITHOUT_CHANGE_HOST": true,

// Set to true will set the page sharing to full screen view
"SHOW_PAGE_AS_FULLSCREEN":true
}

tags name - value pairs in JSON array Format:
tags: [
   {
	"name": "TAG_NAME",
	"value": "TAG_VALUE"
   }
]

Moxtra start meet callback events handled through a listener
Event Description Attributes
start_meet (success for legacy use) Triggered on successful start of meet. session_key, session_id, binder_id
error Triggered in the event of an error. error_code, error_message
save_meet Triggered when the meet is saved. session_key, session_id, binder_id
invite_meet Triggered when the invite button is clicked. session_key, session_id, binder_id
end_meet Triggered when the meet is ended by the host. session_key, session_id, binder_id
resume_meet Triggered when the meet is reloaded due to a page refresh. session_key, session_id, binder_id
start_meet_sharing Triggered when the screen share is activated by the host. session_key, session_id
end_meet_sharing Triggered when the screen share is ended by the host. session_key, session_id
reach_limit Triggered on reaching org or user limitations. session_id, error_code, type, and additional attributes depending on "type":
  • meet_duration_max: reached max meeting time; attributes: value, remaining, session_key, binder_id

Sample code to start meet inside a DIV tag:

<div id="container" style="position:absolute; top:100px; left:150px;">
    DIV tag
</div>
<h3><a href="javascript:start();">Start Meet</a> within DIV</h3>

<script type="text/javascript">function start() {
    var options = {
        iframe: true,
        extension: { "show_dialogs": { "meet_invite": true } },
        tagid4iframe: "container",
        iframewidth: "1000px",
        iframeheight: "750px",
        start_meet: function(event) {
            alert("session key: " + event.session_key + " session id: " + event.session_id + " binder id: " + event.binder_id);
        },
        error: function(event) {
            alert("error code: " + event.error_code + " message: " + event.error_message);
        },
        resume_meet: function(event) {
            alert("session key: " + event.session_key + " session id: " + event.session_id + " binder id: " + event.binder_id);
        },
        end_meet: function(event) {
            alert("Meet end event");
        }
    };
    Moxtra.meet(options);
}</script>

Join Meet using API

Parameters to include in Join Meet API request
Name Value Description
session_key The session_key value returned from start meet event Key to join a Moxtra Meet session.
user_name Name of the user If the user is logged into Moxtra, the name will be automatically retrieved from his Moxtra profile. If this value is not set user will be shown as "Guest" in the Meet participant list.
extension - Here are the extension options that can be used with the start Meet API:

To show or hide the invite member dialog. Default is false.

{ 
    "show_dialogs": { "member_invite": true/false } 
}

iframe "true" or "false" Default is false. Specify to join the meet in iframe or in a new window.
tagid4iframe iFrame ID Specify the ID of iframe container - applicable only if iframe in option is set to "true".
border "true" or "false" Default is true. Specify "false" if using iframe inside a tag without border around the iframe.
scroll "true" or "false" Default is false. Specify "true" if using iframe inside a tag adding scroll bar around the iframe.
iframewidth iFrame Width Width of the meet iFrame - applicable only if iframe in option is set to "true". Default is set to 1024px. If container controls the width, please set to 100%.
iframeheight iFrame Height Height of the meet iFrame - applicable only if iframe in option is set to "true". Default is set to 768px. If container controls the height, please set to 100%.
video "true" or "false" Default is false. Specify "true" if your application will require video conference in Meet.

Moxtra join meet callback events handled through a listener
Event Description Attributes
start_meet (success for legacy use) Triggered on successful start of meet. session_key, session_id, binder_id
error Triggered in the event of an error. error_code, error_message
save_meet Triggered when the meet is saved. session_key, session_id, binder_id
invite_meet Triggered when the invite button is clicked. session_key, session_id, binder_id
end_meet Triggered when the meet is ended by the host. session_key, session_id, binder_id
exit_meet Triggered when the attendee leaves the meet. session_key, session_id, binder_id
reach_limit Triggered on reaching org or user limitations. session_id, error_code, type, and additional attributes depending on "type":
  • session_users_max: reached max allowance of meeting participants; attributes: value, session_key

Sample code to join meet without joinURL :

var options = {
    session_key: key.value,
    user_name: "Joe Smith",
    iframe: true,
    extension: { "show_dialogs": { "meet_invite": true } },
    start_meet: function(event) {
        alert("session key: " + event.session_key + " session id: " + event.session_id);
    },
    error: function(event) {
        alert("error code: " + event.error_code + " message: " + event.error_message);
    },
    end_meet: function(event) {
        alert("Meet ended by host event");
    },
    exit_meet: function(event) {
        alert("Meet exit event");
    }
};
Moxtra.joinMeet(options);

Leave Meet API for the attendee to leave the current Meet session

Leave Meet API callback events handled through join Meet handler
Event Description Attributes
error Triggered in the event of an error. error_code, error_message
exit_meet Triggered when the attendee leaves the meet. session_key, session_id, binder_id

Sample code to leave meet for an attendee :

Moxtra.leaveMeet();

End Meet API for the host to end the current Meet session

End Meet API callback events handled through start Meet handler
Event Description Attributes
error Triggered in the event of an error. error_code, error_message
end_meet Triggered when the meet is ended by the host. session_key, session_id, binder_id

Sample code to end meet for the host :

Moxtra.endMeet();

Upload File to Meet

Using the session id and session key parameters returned on the successful start of Meet you can upload the files to the in-progress session. To implement this your application will POST the file to https://www.moxtra.com (for production) or https://sandbox.moxtra.com (for sandbox) using the following API:

POST /board/upload?type=original&sessionid=SESSION_ID&key=SESSION_KEY&name=FILE_NAME

Header Content-Type: application/octet-stream
File Content Sent as the body