meetings.joinflow

GET https://relay.bluejeans.com/api/meetings/:id/joinflow

Do a pre-join check to see if you can join directly into the meeting without the Endpoint getting stuck on the the interactive passcode prompt screen (IVR). Whether you get the IVR generally depends upon a number of factors for the way a meeting is configured and what parameters are supplied when attempting to join, including your passcode and whether or not the meeting is moderatorless. Using the response, a client can tell which parameters it should supply, or if parameters it has supplied are incorrect or insufficient to go directly into the meeting. Alternatively, a client can opt to land on the IVR if the correct parameters are not available.

GET /api/meetings/9036439807/joinflow HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

"GET_PASSCODE"

GET /api/meetings/9036439807/joinflow?passcode=1629 HTTP/1.1

HTTP/1.1 200 OK
Content-Type: application/json

"JOIN_NOW"

inputs

id

The numeric meeting ID of the meeting you plan to join

String PATH yes

passcode

Optionally the passcode for the meeting; defaults to an empty passcode if not supplied

String QUERY no

cluster

Optionally the Cluster where the meeting is hosted; defaults to PROD

Cluster QUERY no

meetingtype

Optionally the type of meeting you are trying to join (e.g., MEETME, PRIMETIME_ATTENDEE, PRIMETIME_PANELIST, or TEAMS). If omitted, attempts to make a good guess based on the meeting ID.

MeetingType QUERY no

outputs

A JSON-encoded String indicating what is currently required to go directly into the meeting. If the internal API for calculating the correct response fails or is unavailable, returns JOIN_NOW. Possible response values:

JOIN_NOW: joining with the supplied parameters should get you into a meeting.
GET_PASSCODE: a passcode is required to get into this meeting. Joining with the supplied parameters will get the IVR.
GET_GOOD_PASSCODE: a passcode is required and the supplied passcode was empty or invalid. Joining with this passcode will get the IVR.
GET_OTHER_PASSCODE: a valid passcode was supplied but it wasn't the moderator passcode, or no passcode was supplied to a passcodeless meeting, and the moderator passcode is needed to start the meeting. Joining with this passcode will get the meeting waiting room until the moderator joins.
LOGIN_REQUIRED_FOR_INVITEE_ONLY_SECURE_MEETING: valid user login or one time passcode is required to join this invitee-only secured meeting.
LOGIN_REQUIRED_FOR_ENTERPRISE_ONLY_SECURE_MEETING: valid user login or one time passcode is required to join this enterprise-members-only secured meeting.
USER_NOT_IN_LIST_FOR_INVITEE_ONLY_SECURE_MEETING: user is not invited to join this invitee-only secured meeting.
USER_NOT_IN_LIST_FOR_ENTERPRISE_ONLY_SECURE_MEETING: user is not allowed to join this enterprise-members-only secured meeting.
INVALID_PASSCODE_FOR_INVITEE_ONLY_SECURE_MEETING: provided passcode is either invalid or expired for this invitee-only secured meeting.
INVALID_PASSCODE_FOR_ENTERPRISE_ONLY_SECURE_MEETING: provided passcode is either invalid or expired for this enterprise-members-only secured meeting.
WAITING_ROOM_ENABLED: meeting can not be joined directly as meeting has waiting room enabled.

application/json JoinFlowAction