• Register

Start meetings

Endpoints

Start Ad Hoc Meeting

Generates a URL that the participants can open in order to launch an ad hoc meeting.

Endpoint URL
/v1/meetings/start
Method

POST

Parameters
Property Description Type Required?
startWithPersonalUrl If true, the meeting starts using the user's personal URL Boolean Yes
viewerMode Passing "headless" will remove the controls at the top of the viewer when opened in the browser for a more distraction free experience. To ensure all viewers experience the headless mode also pass viewerAppDetection=false
  • NULL
  • "default"
  • "headless"
 No. Omitting this parameter, passing NULL, or passing "default" will cause the viewer to appear exactly as it would when using join.me without the API
viewerAppDetection By default, the viewerLink will check to see if the user has the join.me app installed, and open the meeting within the app if available. If the user passes "false", the viewer link will keep the user in the browser (viewer) Boolean No. Defaults to true (i.e. launch the join.me app, if the viewer has it installed).
webhooks Allows your application to specify callback URLs that are notified when specific meeting lifecycle events occur (e.g. meeting started, meeting ended). See the webhooks documentation for more details. Object No.
Response

Return code: 201

Property Description Type
presenterLink The URL that the presenter can go to in order to launch the join.me meeting. Recommended window size: minimum 400x400 px.
Important: This is a secure link that allows one-time login for the presenter, and it will expire after 10 minutes 		string
viewerLink The URL that viewers can go to in order to launch the meeting string
audioConference
Property Description Type
conferenceId The 9-digit conference ID, needed to sign in to the teleconference string
conferenceCallNumbersUrl A URL that will list all the audio conference numbers for this meeting string
organizerCode The presenter's 4-digit PIN code, granting him/her moderator control over the audio conference. Important: This is sensitive presenter information, and should not be shared with the viewers. string
webhooksStatus Status information about your webhooks (if you supplied the "webhooks" parameter in the request). See webhooks documentation for more details. Object
Example Request JSON
{ "startWithPersonalUrl": true }
Example cURL Request
curl -H "Authorization: Bearer {accesstoken}" -H "Content-Type: application/json" -X POST -d '{ "startWithPersonalUrl": true }' https://api.join.me/v1/meetings/start
Example Response
{ 
    "presenterLink": "https://secure.join.me/API/Public/StartMeeting.aspx?token=123456789",
    "viewerLink": "https://secure.join.me/YourName",
    "audioConference": {
      "conferenceId": "{9-digit audio bridge ID}",
      "conferenceCallNumbersUrl": "https://secure.join.me/api/public/intphone.aspx?conferenceId={9-digit audio bridge ID}",
      "organizerCode": "{4-digit presenter PIN}"
    }
}

Start Scheduled Meeting

Generates a URL that the participants can open in order to launch a scheduled meeting.

Endpoint URL
/v1/meetings/{meetingId}/start
Method

POST

Parameters
Property Description Type Required?
meetingId The meetingId of the existing meeting to start
Important: This parameter is part of the URL 		integer Yes
viewerMode Passing "headless" will remove the controls at the top of the viewer when opened in the browser for a more distraction free experience. To ensure all viewers experience the headless mode also pass viewerAppDetection=false
  • NULL
  • "default"
  • "headless"
 No. Omitting this parameter, passing NULL, or passing "default" will cause the viewer to appear exactly as it would when using join.me without the API
viewerAppDetection By default, the viewerLink will check to see if the user has the join.me app installed, and open the meeting within the app if available. If the user passes "false", the viewer link will keep the user in the browser (viewer) Boolean No. Defaults to true (i.e. launch the join.me app, if the viewer has it installed).
webhooks Allows your application to specify callback URLs that are notified when specific meeting lifecycle events occur (e.g. meeting started, meeting ended). See the webhooks documentation for more details. Object No.
Response

Return code: 200

Property Description Type
presenterLink The URL that the presenter can go to in order to launch the join.me meeting. Recommended window size: minimum 400x400 px.
Important: This is a secure link that allows one-time login for the presenter, and it will expire after 10 minutes 		string
viewerLink The URL that viewers can go to in order to launch the meeting string
audioConference
Property Description Type
conferenceId The 9-digit conference ID, needed to sign in to the teleconference string
conferenceCallNumbersUrl A URL that will list all the audio conference numbers for this meeting string
organizerCode The presenter's 4-digit PIN code, granting him/her moderator control over the audio conference. Important: This is sensitive presenter information, and should not be shared with the viewers. string
webhooksStatus Status information about your webhooks (if you supplied the "webhooks" parameter in the request). See webhooks documentation for more details. Object
Example Request JSON
{}

Note: Include the meetingId in the URL of the request

Example cURL Request
curl -H "Authorization: Bearer {access_token}" -H "Content-Type: application/json" -X POST -d '{}' https://api.join.me/v1/meetings/{meetingId}/start
Example Response
{
    "presenterLink": "https://secure.join.me/API/Public/StartMeeting.aspx?token=123456789",
    "viewerLink": "https://secure.join.me/YourName",
    "audioConference": {
      "conferenceId": "{9-digit audio bridge ID}",
      "conferenceCallNumbersUrl": "https://secure.join.me/api/public/intphone.aspx?conferenceId={9-digit audio bridge ID}",
      "organizerCode": "{4-digit presenter PIN}"
    }
}

version 48 as of 8 years ago by join.kyle