Meet

Meet is identified by {session_key} (or meet_id) which is the same for all recurrent meets. Meet can be identified by {binder_id} for each individual Meet instance. The relationship between {session_key} and {binder_id} is illustrated below:

  • single instance meet - one {session_key} is associated with one {binder_id}
  • recurrent meets -
    • same {session_key} for all recurrent meets
    • one {binder_id} is assoicated with one meet instance; there is no {binder_id} association for future scheduled meets except the current in-progress or the first unstarted scheduled meet instance
    • API operations via {session_key} would be handled on the current in-progress or the first unstarted scheduled meet instance. It also impacts on future scheduled meets, but it has no impacts on past ended meets
    • API operations via {binder_id} can be handled on past ended meets as well as the current in-progress or the first unstarted scheduled meet instance. The later would affect future scheduled meets as well.

A Meet object in Moxtra provides the following properties:

Name Description Example
topic The meeting topic or binder_name. Project Report
session_key The meeting Id. 497191750
agenda The meeting agenda. Schedule Plan
binder_id The binder Id of the meet. BGgkHVCJJ5CXrmHUByCTD90
original_binder_id The Id of the binder where the meet shows on the calendar and meet notification events triggered. BWzTpoV84WTFlKaicYvQ92L
status The meeting status.
  • Scheduled meet: SESSION_SCHEDULED
  • Meet in progress: SESSION_STARTED
  • Ended meet: SESSION_ENDED
SESSION_ENDED
starts The meeting start time in ISO-8601 format with UTC timezone for SESSION_STARTED & SESSION_ENDED. 2015-01-06T08:34:13Z
ends The meeting end time in ISO-8601 format with UTC timezone for SESSION_ENDED only. 2015-01-06T08:34:13Z
scheduled_starts The meeting scheduled start time in ISO-8601 format with UTC timezone for scheduled meet only. 2015-01-06T08:34:13Z
scheduled_ends The meeting scheduled end time in ISO-8601 format with UTC timezone for scheduled meet only. 2015-01-06T08:34:13Z
join_before_minutes The time allowed for attendee to join the meet before host. The maximum time is 30 minutes. 15
record_multiple_video_channel Whether to record the meet video using multiple channels. Default is false. false
auto_recording Whether to turn on auto recording when the meet starts. Default is false. Auto-recording is only available for a specific meet info (/meets/{session_key}); however, it is not available for listing all meets (/{user_id}/meets). true
total_participants The number of meeting participants for SESSION_STARTED & SESSION_ENDED. 3
total_invitees The number of meeting invitees for SESSION_SCHEDULED & SESSION_STARTED. 3
has_recording Indicate whether the meet has recording. Default is false. If a meet has recording, the recording is only available for a specific meet info (/meets/{session_key}); however, it is not available for listing all meets (/{user_id}/meets). false
timezone TZ database timezone of this meet. Please refer to http://en.wikipedia.org/wiki/List_of_tz_database_time_zones. Asia/Shanghai
dialin_numbers Array of the available call-in numbers. This information is only availabe on "Get Meet Info" for future and in-progress meets. [{ "phone_number": "1(408)533-0580",
"location": "United States"
}]
created_time Created time of the meet calculated in milliseconds since Jan 1, 1970. 1398824151995
updated_time Updated time of the meet calculated in milliseconds since Jan 1, 1970. 1398824151995
Name Description Example
frequency Meet frequency: DAILY, WEEKLY, or MONTHLY. Only one type of frequency object is available for the corresponding frequency. WEEKLY
end_time The end time of the recurrent meet in ISO-8601 format with UTC timezone if specified; otherwise, it is endless. 2017-01-01T22:40:47Z
daily The daily frequency.
  • interval - Integer; one daily interval between 1 and 30
Every 3 days
"daily": { "interval": 3 }
weekly The weekly frequency.
  • interval - Integer; one weekly interval between 1 and 30
  • week_days - array of case-insensitive week-day Strings; "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" up to seven week days.
On Tuesday and Thursday for every 4 weeks
"weekly": { "interval": 4, "week_days": ["Tuesday", "Thursday"] }
monthly The monthly frequency.
  • month_days - array of month-day Integers; 1 to 30 up to 30 days.
On the 5th, 15th, and 30th days of every month
"monthly": { "month_days": [5, 15, 30] }
Name Description Example
email The email address of the participant. john.doe@acme.com
name The name of the pariticipant or the team name if the participant is a team. John Doe
unique_id The unique_id of the participant. 123456
roster_id The Id for meeting participant. mxweb-3977b3b0-21fb-4c85-8fce-da087cf366f4
id The User Id. U25PKSV2Oce1mpegiV48W56
org_id The Org Id of the user. PZCuoBuYrnO4NHjCTmn4gP5
starts The participant's join time in ISO-8601 format with UTC timezone. 2015-01-01T22:40:47Z
host Whether the user is host. false
status Whether the user is still in the meeting for SESSION_STARTED only. LEFT indicates that the user has left already; otherwise, no indication. LEFT
participant_number The participant number of the participant. 8
picture_uri The participant's avatar. https://www.moxtra.com/service/themes/images/default/avatar-single-360.png
presenter Whether the user is a presenter. false
invisible Whether the user is invisible. false
Name Description Example
email The email address of the invitee. john.doe@acme.com
name The name of the invitee. John Doe
unique_id The unique_id of the invitee. 123456
id The User Id. U25PKSV2Oce1mpegiV48W56
host Whether the user is host. false
picture_uri The invitee's avatar. https://www.moxtra.com/service/themes/images/default/avatar-single-360.png
id (In team) The Team Id. PRTA3fRhzcxEPit77Dw063F
name (In team) The Team name. John's team
status Whether the invitee has accepted the invitation.
  • Accepted or added by host: ACCEPTED/ADDED
  • Rejected or removed by host: DENIED/REMOVED
  • Invited: INVITED
ACCEPTED/ADDED
Name Description Example
binder_id The binder Id of the meet. BGgkHVCJJ5CXrmHUByCTD90
original_binder_id The Id of the binder where the meet shows on the calendar and meet notification events triggered. BWzTpoV84WTFlKaicYvQ92L
content_type Media type. video/mp4
content_length The length of the video. 1636101
session_key The unique_id of the meet. 540334434
agenda The meet's agenda. Updated Project planning and review
topic The meet's topic or binder_name. Project Meeting
playback_url The URL to playback. https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458
download_url The URL to download. https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1
created_time Created time of the meet calculated in milliseconds since Jan 1, 1970. 1398824151995
Name Description Example
roster_id The Id for meeting participant. mxweb-3977b3b0-21fb-4c85-8fce-da087cf366f4
starts The desktop (screen) share start time in ISO-8601 format with UTC timezone. 2015-01-01T22:40:47Z
ends The desktop (screen) share end time in ISO-8601 format with UTC timezone. 2015-01-01T23:27:56Z

Get Meet List

Get meets list identified by {user_id}

GET /{user_id}/meets

URL Parameters
Name Type Description
starts String Optional: The meeting start and scheduled time in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. Default is current time.
days Number Optional: Number of Days for getting the meets from starts. If session_key is used Max is 90 days; otherwise, Max is 30 days. Likewise, default is 90 days for using session_key; otherwise, default is 30 days.
tags_include String Optional: List of meets including tags separated by "," for OR operation; for example, "Research,Show".
tags_exclude String Optional: List of meets excluding tags separated by "," for OR operation; for example, "Data,Show" If the same tag is used in tags_exclude and tags_include, tags_exclude takes priority.
session_key String Optional: List of recurrent meets for this session_key.

Sample Request
GET /me/meets?days=5
Sample Response for scheduled Meet
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "meets": [
            {
                "topic": "Scheduled Meet",
                "session_key": "226653428",
                "binder_id": "BGgkHVCJJ5CXrmHUByCTD90",
                "status": "SESSION_SCHEDULED",
                "starts": null,
                "ends": null,
                "scheduled_starts": "2015-03-23T19:30:00Z",
                "scheduled_ends": "2015-03-23T20:30:00Z",
                "agenda": "Schedule Plan",
                "join_before_minutes": 0,
                "record_multiple_video_channel": false,                
                "invitees": [
                    {
                        "email": "joe@test.com",
                        "name": "Joe Smith",
                        "host": true,
                        "id": "UYuSKm3Cux6H7dqmu92CGVC",
                        "unique_id": "",
                        "picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
                        "status": "INVITED",
                        "team": null
                    },
                    {
                        "email": "john@test.com",
                        "name": "John Doe",
                        "host": false,
                        "id": "U6Dr67f1ulsEKgbOLOVRla7"
                        "unique_id": "",
                        "picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
                        "status": "DENIED/REMOVED",
                        "team": null
                    },
                    {
                        "email": null,
                        "name": null,
                        "host": false,
                        "id": null,
                        "unique_id": null,
                        "picture_uri": "https://www.moxtra.com/service3/themes/images/default/avatar-team-300.png",
                        "status": "ACCEPTED/ADDED",
                        "team": {
                            "id": "PRTA3fRhzcxEPit77Dw063F",
                            "name": "John's team"
                        }
                    }
                ],
                "participants": null,
                "total_participants": 0,
                "total_invitees": 2,
                "desktopshares": [],
                "tags": null,
                "has_recording": false,
                "created_time": 1458769279727,
                "updated_time": 1458772884497,
                "timezone": "America/Los_Angeles",
                "recurrence": {
                    "frequency": "WEEKLY",
                    "weekly": {
                        "interval": 4,
                        "week_days": ["MONDAY"]
                    },
                    "end_time": "2016-11-29T07:59:59Z"
                }                
            }
        ]    
    }
}

Get Meet Info via session_key

Get a meet info identified by {session_key}. Since a meet might have multiple sessions, it only gets the latest one.
If a meet has recordings, please refer to Get Meet Recording via session_key to obtain recordings for all sessions.
For recurrent meets, it would be getting the current in-progress or the first unstarted scheduled meet. In order to obtain info from past ended meet, please use Get Meet Info via binder_id.

GET /meets/{session_key}

Sample Request
GET /meets/226653428
Sample Response for Meet in-progress
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "topic": "AA's Meet",
        "session_key": "598561162",
        "binder_id": "BGgkHVCJJ5CXrmHUByCTD90",
        "status": "SESSION_STARTED",
        "starts": "2015-08-28T22:50:32Z",
        "ends": null,
        "scheduled_starts": null,
        "scheduled_ends": null,
        "agenda": "Schedule Plan",
        "join_before_minutes": 0,
        "record_multiple_video_channel": false,         
	"invitees": [
	    {
		"email": "joe@test.com",
		"name": "Joe Smith",
		"host": false,
		"id": "UYuSKm3Cux6H7dqmu92CGVC",
		"unique_id": "",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "INVITED",
		"team": null
	    },
	    {
		"email": "",
		"name": "AA BB",
		"host": true,
		"id": "UYuS8jsCux6H7dqmu352CGVC",
		"unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "ACCEPTED/ADDED",
		"team": null		
	    }
	],
        "participants": [
            {
                "name": "AA BB",
                "email": "",
                "starts": "2015-08-28T22:50:32Z",
                "host": true,
                "id": "UYuS8jsCux6H7dqmu352CGVC",
		"participant_number": 2,                
                "unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
                "roster_id": "mxweb-95352c64-2024-4c62-9414-fcab7a08f773",
                "org_id": "PgwZr6vSyLI9FskIIK9FDgF",
                "status": "",
                "presenter": true,
                "invisible": false
            },
            {
                "name": "Test33",
                "email": "",
                "starts": "2015-08-28T23:08:36Z",
                "host": false,
                "id": "U39FIOFW1ulsEKgbOKs8SAA",
		"participant_number": 3,                
                "unique_id": "tester2",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
                "roster_id": "mxweb-3fe1eec0-7f57-4f00-a923-25534a2ea658",
                "org_id": "PgwZr6vSyLI9FskIIK9FDgF",
                "status": "LEFT"
                "presenter": false,
                "invisible": false
            }
        ],
        "total_participants": 2,
        "total_invitees": 2,
        "desktopshares": [],
        "tags": null,
        "auto_recording": false,
        "has_recording": false,
        "recording": null,
        "dialin_numbers": [
            {
                "phone_number": "1(408)533-0580",
                "location": "United States"
            }
        ],
        "created_time": 1458769279727,
        "updated_time": 1458772884497,
        "timezone": "America/Los_Angeles",
        "recurrence": null
     }
}
Sample Response for ended Meet
{
    "code": "RESPONSE_SUCCESS",
    "data": {
	"topic": "Meet",
	"session_key": "627792853",
	"binder_id": "BOOE6hA90Yk7QdtihJl3zUB",
	"status": "SESSION_ENDED",
	"starts": "2015-12-05T02:30:32Z",
	"ends": "2015-12-05T02:33:24Z",
	"scheduled_starts": null,
	"scheduled_ends": null,
        "agenda": "Schedule Plan",
        "join_before_minutes": 0,
        "record_multiple_video_channel": false,
	"invitees": [
	    {
		"email": "joe@test.com",
		"name": "Joe Smith",
		"host": false,
		"id": "UYuSKm3Cux6H7dqmu92CGVC",
		"unique_id": "",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "INVITED",
		"team": null
	    },
	    {
		"email": "",
		"name": "aaa bbb",
		"host": true,
		"id": "U047zBEssu8LWsawrqjJpR2",
		"unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "ACCEPTED/ADDED",
		"team": null		
	    }
	],
	"participants": [
	    {
		"name": "aaa bbb",
		"email": "",
		"starts": "2015-12-05T02:30:32Z",
		"host": true,
		"id": "U047zBEssu8LWsawrqjJpR2",
		"participant_number": 2,
		"unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"roster_id": "mxweb-8c560f22-8636-4b67-b3ef-5501b4476898",
		"org_id": "PgwZr6vSyLI9FskIIK9FDgF",
		"status": "",
                "presenter": false,
                "invisible": false
	    }
	],
	"total_participants": 1,
	"total_invitees": 0,
	"desktopshares": [
	    {
		"roster_id": "mxweb-8c560f22-8636-4b67-b3ef-5501b4476898",
		"starts": "2015-12-05T02:32:04Z",
		"ends": "2015-12-05T02:32:43Z"
	    }
	],
        "tags": null,
        "auto_recording": false,
        "has_recording": true,
        "recording": {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "session_key": "540334434",
            "agenda": "Updated Project planning and review",
            "topic": "Project Meeting",            
            "playback_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        },
        "created_time": 1458769279727,
        "updated_time": 1458772884497,
        "timezone": "America/Los_Angeles",
        "recurrence": null        
     }
}

Get Meet Info via binder_id

Get a meet info identified by {binder_id}. Since a meet might have multiple sessions, it only gets the latest one. If a meet has recording, please refer to Get Meet Recording via binder_id to obtain recordings for all sessions.
For a recurrent meet, it would be getting the specific meet instance. If the meet is still in schedule, it would show the first unstarted scheduled meet.

GET /meets/{binder_id}

Sample Request
GET /meets/BOOE6hA90Yk7QdtihJl3zUB
Sample Response for ended Meet
{
    "code": "RESPONSE_SUCCESS",
    "data": {
	"topic": "Meet",
	"session_key": "627792853",
	"binder_id": "BOOE6hA90Yk7QdtihJl3zUB",
	"status": "SESSION_ENDED",
	"starts": "2015-12-05T02:30:32Z",
	"ends": "2015-12-05T02:33:24Z",
	"scheduled_starts": null,
	"scheduled_ends": null,
        "agenda": "Schedule Plan",
        "join_before_minutes": 0,
        "record_multiple_video_channel": false,
	"invitees": [
	    {
		"email": "joe@test.com",
		"name": "Joe Smith",
		"host": false,
		"id": "UYuSKm3Cux6H7dqmu92CGVC",
		"unique_id": "",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "INVITED",
		"team": null
	    },
	    {
		"email": "",
		"name": "aaa bbb",
		"host": true,
		"id": "U047zBEssu8LWsawrqjJpR2",
		"unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"status": "ACCEPTED/ADDED",
		"team": null		
	    }
	],
	"participants": [
	    {
		"name": "aaa bbb",
		"email": "",
		"starts": "2015-12-05T02:30:32Z",
		"host": true,
		"id": "U047zBEssu8LWsawrqjJpR2",
		"participant_number": 2,
		"unique_id": "test",
		"picture_uri": "https://www.moxtra.com/service/themes/images/default/avatar-single-360.png",
		"roster_id": "mxweb-8c560f22-8636-4b67-b3ef-5501b4476898",
		"org_id": "PgwZr6vSyLI9FskIIK9FDgF",
		"status": "",
                "presenter": false,
                "invisible": false
	    }
	],
	"total_participants": 1,
	"total_invitees": 0,
	"desktopshares": [
	    {
		"roster_id": "mxweb-8c560f22-8636-4b67-b3ef-5501b4476898",
		"starts": "2015-12-05T02:32:04Z",
		"ends": "2015-12-05T02:32:43Z"
	    }
	],
        "tags": null,
        "auto_recording": false,
        "has_recording": true,
        "recording": {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "session_key": "540334434",
            "agenda": "Updated Project planning and review",
            "topic": "Project Meeting",            
            "playback_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        },
        "created_time": 1458769279727,
        "updated_time": 1458772884497,
        "timezone": "America/Los_Angeles",
        "recurrence": {
            "frequency": "WEEKLY",
            "weekly": {
		"interval": 4,
		"week_days": ["MONDAY"]
            },
            "end_time": "2016-11-29T07:59:59Z"
        }  
     }
}

Invite Users to Meet

Invite users to join meet via email or unique_id. Either session_key or binder_id can be used to identify the meet. For recurrent meets, the invitation would take effect for the current in-progress meet or the first unstarted scheduled meet and future meets. For past ended meets, please use binder_id for inviting users to get the meet recordings.

POST /meets/inviteuser

JSON Parameters
Name Type Description
binder_id String Binder Id for the meet, obtained using the call back event from start meet SDK to get binder_id or from Schedule Meet API to get schedule_binder_id. For recurrent meets, using Get Meet List to find out the binder_id of the up-coming meet.
session_key String Session key or Meet Id for the meet, obtained using the call back event from start meet SDK or the Schedule Meet API.
session_id String Optional: Session Id for the meet, obtained using the call back event from start meet SDK.
email (In user of users array) String Email address of the user to send the meeting invitation.
unique_id (In user of users array) String Unique_id to be invited.
org_id (In user of users array) String Optional: org_id + unique_id for another org user to be invited.
id (In user of users array) String User id to be invited.
message String Optional: Optional message to be sent in the email invitation.
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.
id (In teams array for a particular team) String Optional: All the team members from the team id would get added.
Sample Request
POST /meets/inviteuser
{
    "session_key": "441363470",
    "users": [
    {
        "user": {
            "email": "test@gmail.com"
        }
    },
    {
        "user": {
            "unique_id": "xa12233425343"
        }
    },
    {
        "user": {
            "unique_id": "A453224",
            "org_id": "PTHpzIJ4jGx1upvgjWZa4S1"
        }
    }
    ],
    "teams": [
    {
        "id": "PJGHAHJi423kjh4c8Ew84HG"
    }
    ]
    "message" : "Please join the Meet"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Accept Invite to Join Meet

Accept the invitation to join the meet identified by {binder_id}; on the other hand, to reject the invitation using Remove Me from Binder.

POST /{binder_id}/acceptinvite

JSON Parameters
Name Type Description
suppress_feed Boolean Optional: Whether to turn off feed for this operation. Default is false.
Sample Request
POST /B7V4ze37oO08PYO70973lX6/acceptinvite
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Remove User from scheduled Meet

Remove a user from a scheduled meet.

POST /meets/removeuser

JSON Parameters
Name Type Description
binder_id String Binder Id for the meet, obtained using the call back event from start meet SDK to get binder_id or from Schedule Meet API to get schedule_binder_id. For recurrent meets, using Get Meet List to find out the binder_id of the up-coming meet.
session_key String Session key or Meet Id for the meet, obtained using the call back event from start meet SDK or the Schedule Meet API.
email String Email address of an existing user in the meet.
unique_id String Unique_id of an existing user in the meet.
org_id String Optional: org_id + unique_id for another org user to be removed.
id String User id of an existing user in the meet.
team_id String Team id of an existing team in the meet.
suppress_feed Boolean Optional: Whether to turn off feed for this operation. Default is false.
Sample Request using email
POST /meets/removeuser
{
    "session_key": "441363470",
    "email": "joe@test.com"
}
Sample Request using unique_id
POST /meets/removeuser
{
    "session_key": "441363470",
    "unique_id": "fhas211nsjkaswd"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Schedule Meet

Schedule a meet for future time

POST /meets/schedule

JSON Parameters
Name Type Description
name String Meet topic.
starts String Starting time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. If choose this, do not need to set "start_time" and "end_time".
ends String Optional: End time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. It must be greater than starts. If not set, default is one hour.
start_time Number Starting time of the meet calculated in milliseconds since Jan 1, 1970. If choose this, do not need to set "starts" and "ends".
end_time Number Optional: End time of the meet calculated in milliseconds since Jan 1, 1970, must be greater than start_time. If not set, default is one hour.
agenda String Optional: Agenda for this meet.
original_binder_id String Optional: The Id of the binder where the meet shows on the calendar and meet notification events triggered.
auto_recording Boolean Optional: When meet starts, recording will get started as well. Default is false.
join_before_minutes Number Optional: Attendee is allowed to join the meet before host by the speicifed minutes. Max is 30 minutes.
record_multiple_video_channel Boolean Optional: Video is recorded in multiple channels while recording meet. Default is false.
name (In tags array; Optional: tags array) String Tag name.
value (In tags array; Optional: tags array) String Tag value.
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.
recurrence Meet recurrence object Optional: To schedule a recurrent meet.
  • end_time - the end time of the recurrent meet in ISO-8601 format with UTC timezone if specified; otherwise, it is endless.
  • daily - daily frequency
    • interval - Integer; one daily interval between 1 and 30
    For example, every 3 days
    "daily": { "interval": 3 }
  • weekly - weekly frequency
    • interval - Integer; one weekly interval between 1 and 30
    • week_days - array of case-insensitive week-day Strings; "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" up to seven week days.
    For example, on Tuesday and Thursday for every 4 weeks
    "weekly": { "interval": 4, "week_days": ["Tuesday", "Thursday"] }
  • monthly - monthly frequency
    • month_days - array of month-day Integers; 1 to 30 up to 30 days.
    For example, on the 5th, 15th, and 30th days of every month
    "monthly": { "month_days": [5, 15, 30] }
Sample Request
POST /meets/schedule
{
    "name": "Project Meeting",
    "start_time": 1340839882787,
    "end_time": 1342813061602,
    "agenda" : "Project planning and review",
    "tags": [
    {
        "name": "Research",
        "value": "Communicate"
    }
    ]    
}
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Project Meeting",
        "revision": 3,
        "session_key": "540334434",
        "startmeet_url": "https://www.moxtra.com/540334434",
        "scheduled_starts": "2014-03-21T09:30:00Z",
        "scheduled_ends": "2014-03-21T10:30:00Z",
        "created_time": 1355782091405,
        "updated_time": 1355782091405,
        "timezone": "America/Los_Angeles"
    }
}
Sample Request for recurrent meet
POST /meets/schedule
{
    "name": "Project Review",
    "starts": "2016-10-21T09:30:00Z",
    "agenda" : "Recurrent Project Review",
    "original_binder_id": "B9rArkzRe094lPPiMH4UpS8",
    "recurrence": {
        "end_time": "2017-11-21T09:30:00Z",
        "weekly": {
            "interval": 4,
            "week_days": ["Monday", "Thursday"]
        }
    }
}
Sample Response for recurrent meet
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Project Review",
        "revision": 5,
        "session_key": "540334435",
        "startmeet_url": "https://www.moxtra.com/540334435",
        "scheduled_starts": "2016-10-21T09:30:00Z",
        "scheduled_ends": "2016-10-21T10:30:00Z",
        "created_time": 1455782091405,
        "updated_time": 1455782091405,
        "timezone": "America/Los_Angeles",
        "recurrence": [
        {
            "frequency": "WEEKLY",        
            "end_time": "2017-11-21T09:30:00Z",
            "weekly": {
		"interval": 4,
		"week_days": ["MONDAY", "THURSDAY"]
            }
        }
        ]    
    }
}

Update Meet via session_key

Update a scheduled meet identified by {session_key}. For recurrent meets, the update would take effect for the first unstarted scheduled meet and future scheduled meets. Past meets would not be changed.

POST /meets/{session_key}

JSON Parameters
Name Type Description
name String Optional: Meet topic.
starts String Optional: Starting time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. If choose this, do not need to set "start_time" and "end_time".
ends String Optional: End time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. It must be greater than starts. If not set, default is one hour.
start_time Number Optional: Starting time of the meet calculated in milliseconds since Jan 1, 1970. If choose this, do not need to set "starts" and "ends".
end_time Number Optional: End time of the meet calculated in milliseconds since Jan 1, 1970, must be greater than start_time. If not set, default is one hour.
agenda String Optional: Agenda for this meet.
auto_recording Boolean Optional: When meet starts, recording will get started as well. Default is false.
join_before_minutes Number Optional: Attendee is allowed to join the meet before host by the speicifed minutes. Max is 30 minutes.
record_multiple_video_channel Boolean Optional: Video is recorded in multiple channels while recording meet. Default is false.
name (In tags array; Optional: tags array) String Tag name.
value (In tags array; Optional: tags array) String Tag value. If setting value as "", the tag will get deleted.
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.
recurrence Meet recurrence object Optional: To schedule a recurrent meet.
  • end_time - the end time of the recurrent meet in ISO-8601 format with UTC timezone if specified; otherwise, it is endless.
  • daily - daily frequency
    • interval - Integer; one daily interval between 1 and 30
    For example, every 3 days
    "daily": { "interval": 3 }
  • weekly - weekly frequency
    • interval - Integer; one weekly interval between 1 and 30
    • week_days - array of case-insensitive week-day Strings; "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" up to seven week days.
    For example, on Tuesday and Thursday for every 4 weeks
    "weekly": { "interval": 4, "week_days": ["Tuesday", "Thursday"] }
  • monthly - monthly frequency
    • month_days - array of month-day Integers; 1 to 30 up to 30 days.
    For example, on the 5th, 15th, and 30th days of every month
    "monthly": { "month_days": [5, 15, 30] }
Sample Request
POST /meets/540334434
{
    "name": "Updated Project Meeting",
    "starts": "2014-03-21T09:30:00Z",
    "ends": "2014-03-21T10:30:00Z",
    "agenda": "Updated Project planning and review"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Updated Project Meeting",
        "revision": 7,
        "session_key": "540334434",
        "startmeet_url": "https://www.moxtra.com/540334434",
        "scheduled_starts": "2014-03-21T09:30:00Z",
        "scheduled_ends": "2014-03-21T10:30:00Z",
        "created_time": 1355782091405,
        "updated_time": 1355782091405,
        "timezone": "America/Los_Angeles",
        "recurrence": null
    }
}

Update Meet via binder_id

Update a meet identified by {binder_id}. For recurrent meets,

  • past ended meets - the update would take effect only for that particular meet instance. To find out the binder_id of the past meet using Get Meet List
  • first unstarted scheduled meet - the update would take effect for the whole series of future scheduled meets. (same as via session_key)

POST /meets/{binder_id}

JSON Parameters
Name Type Description
name String Optional: Meet topic.
starts String Optional: Starting time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. If choose this, do not need to set "start_time" and "end_time".
ends String Optional: End time of the meet in ISO-8601 format "YYYY-MM-DDThh:mm:ssZ" with UTC timezone. It must be greater than starts. If not set, default is one hour.
start_time Number Optional: Starting time of the meet calculated in milliseconds since Jan 1, 1970. If choose this, do not need to set "starts" and "ends".
end_time Number Optional: End time of the meet calculated in milliseconds since Jan 1, 1970, must be greater than start_time. If not set, default is one hour.
agenda String Optional: Agenda for this meet.
auto_recording Boolean Optional: When meet starts, recording will get started as well. Default is false.
join_before_minutes Number Optional: Attendee is allowed to join the meet before host by the speicifed minutes. Max is 30 minutes.
record_multiple_video_channel Boolean Optional: Video is recorded in multiple channels while recording meet. Default is false.
name (In tags array; Optional: tags array) String Tag name.
value (In tags array; Optional: tags array) String Tag value. If setting value as "", the tag will get deleted.
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.
recurrence Meet recurrence object Optional: To schedule a recurrent meet.
  • end_time - the end time of the recurrent meet in ISO-8601 format with UTC timezone if specified; otherwise, it is endless.
  • daily - daily frequency
    • interval - Integer; one daily interval between 1 and 30
    For example, every 3 days
    "daily": { "interval": 3 }
  • weekly - weekly frequency
    • interval - Integer; one weekly interval between 1 and 30
    • week_days - array of case-insensitive week-day Strings; "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" up to seven week days.
    For example, on Tuesday and Thursday for every 4 weeks
    "weekly": { "interval": 4, "week_days": ["Tuesday", "Thursday"] }
  • monthly - monthly frequency
    • month_days - array of month-day Integers; 1 to 30 up to 30 days.
    For example, on the 5th, 15th, and 30th days of every month
    "monthly": { "month_days": [5, 15, 30] }
Sample Request
POST /meets/B7U3ze39oO08PYO70973lX6
{
    "name": "Updated Project Meeting",
    "starts": "2014-03-21T09:30:00Z",
    "ends": "2014-03-21T10:30:00Z",
    "agenda": "Updated Project planning and review"
}
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "schedule_binder_id": "B7U3ze39oO08PYO70973lX6",
        "binder_name": "Updated Project Meeting",
        "revision": 7,
        "session_key": "540334434",
        "startmeet_url": "https://www.moxtra.com/540334434",
        "scheduled_starts": "2014-03-21T09:30:00Z",
        "scheduled_ends": "2014-03-21T10:30:00Z",
        "created_time": 1355782091405,
        "updated_time": 1355782091405,
        "timezone": "America/Los_Angeles",
        "recurrence": null        
    }
}

Delete Meet via session_key

Delete a meet identified by {session_key}. For recurrent meets, this would delete the whole series of future scheduled meets. There is no impacts on all past meets.

DELETE /meets/{session_key}

URL Parameters
Name Type Description
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.

Sample Request
DELETE /meets/540334434
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Delete Meet via binder_id

Delete a meet identified by {binder_id}. For recurrent meets,

  • past ended meets - only delete that particular meet instance. To find out the binder_id of the past meet using Get Meet List
  • first unstarted scheduled meet - this would delete the whole series of future scheduled meets

DELETE /meets/{binder_id}

URL Parameters
Name Type Description
email_off Boolean Optional: Whether to turn off sending email. Default is false.
notification_off Boolean Optional: Whether to turn off push notification. Default is false.

Sample Request
DELETE /meets/B7U3ze39oO08PYO70973lX6
Sample Response
{
    "code": "RESPONSE_SUCCESS"
}

Get Meet Recording List

Get the meet recording list identified by {user_id} who is the host or an attendee via invitation of those meets.
If the same meet has multiple recordings, this request only shows the last one. In order to obtain multiple recordings for the same meet please use Get Meet Recording via session_key or Get Meet Recording via binder_id.

GET /{user_id}/meets/recordings

URL Parameters
Name Type Description
session_key String Optional: List of recordings from recurrent meets on this session_key.

Sample Request
GET /me/meets/recordings
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "counts": 1,
        "recordings": [
        {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "session_key": "540334434",
            "binder_id": "BWzTpoV84WTFlKaicYvQ92L",
            "original_binder_id": "B9rArkzRe094lPPiMH4UpS8",
            "agenda": "Updated Project planning and review",
            "topic": "Project Meeting",
            "playback_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        }
        ]
    }
}

Get Meet Recording via session_key

Get the meet recording details after the meet is ended, use this to download the meet recording identified by {session_key}.
This API is not suitable for recurrent meets. For recurrent meets, please use either Get Meet Recording List with session_key or Get Meet Recording via binder_id instead.
Note: Meet recording will only be available if it is recorded and it will be available for download approximately 15 mins after the meeting is ended. For longer meetings it might take more time before the recording is available for download. This API can only be used through the user who hosted the meet.

GET /meets/recordings/{session_key}

Sample Request
GET /meets/recordings/540334434
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "counts": 1,
        "recordings": [
        {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "session_key": "540334434",
            "binder_id": "BWzTpoV84WTFlKaicYvQ92L", 
            "original_binder_id": "B9rArkzRe094lPPiMH4UpS8",
            "agenda": "Updated Project planning and review",
            "topic": "Project Meeting",            
            "playback_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        }
        ]
    }
}

Get Meet Recording via binder_id

Get the meet recording details after the meet is ended, use this to download the meet recording identified by {binder_id}.
Note: Meet recording will only be available if it is recorded and it will be available for download approximately 15 mins after the meeting is ended. For longer meetings it might take more time before the recording is available for download. This API can only be used through the user who hosted the meet.

GET /meets/recordings/{binder_id}

Sample Request
GET /meets/recordings/BWzTpoV84WTFlKaicYvQ92L
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "counts": 1,
        "recordings": [
        {
            "content_type": "video/mp4",
            "content_length": 1636101,
            "session_key": "540334434",
            "binder_id": "BWzTpoV84WTFlKaicYvQ92L",
            "original_binder_id": "B9rArkzRe094lPPiMH4UpS8",            
            "agenda": "Updated Project planning and review",
            "topic": "Project Meeting",            
            "playback_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458",
            "download_url": "https://www.moxtra.com/board/BWzTpoV84WTFlKaicYvQ92L/458?d=1",
            "created_time": 1398824151995
        }
        ]
    }
}

Get Meet Status via session_key

Get the meet status identified by {session_key}. The status values are SESSION_STARTED, SESSION_SCHEDULED, SESSION_ENDED, or SESSION_DELETED.
For recurrent meets, it would indicate a current in-pregress or the first unstarted scheduled meet.

GET /meets/status/{session_key}

Sample Request
GET /meets/status/540334434
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "status": "SESSION_STARTED"
    }
}

Get Meet Status via binder_id

Get the meet status identified by {binder_id}. The status values are SESSION_STARTED, SESSION_SCHEDULED, SESSION_ENDED, or SESSION_DELETED.
The binder_id can be obtained using the call back event from start meet SDK to get binder_id or from Schedule Meet API to get schedule_binder_id.
For recurrent meets, using Get Meet List to find out the binder_id of the past or up-coming meet.

GET /meets/status/{binder_id}

Sample Request
GET /meets/status/BWzTpoV84WTFlKaicYvQ92L
Sample Response
{
    "code": "RESPONSE_SUCCESS",
    "data": {
        "status": "SESSION_STARTED"
    }
}

Download Meet Calendar ICS file

Download the Calendar ICS file for scheduled meeting identified by {session_key}.

GET /meets/downloadICS/{session_key}

Sample Request
GET /meets/downloadICS/540334434
Sample Response
#ICS file