JoinMeetingObject

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/JoinMeetingObject",
  "title": "JoinMeetingObject",
  "type": "object",
  "properties": {
    "meetingId": {
      "type": "string",
      "example": "98d8c2212c9d62b162b9565932735e59",
      "description": "Unique identifier for the meeting. This parameter applies to meeting series and scheduled meetings. It doesn't apply to ended or in-progress meeting instances. Please note that currently meeting ID of a scheduled [personal room](https://help.webex.com/en-us/article/nul0wut/Webex-Personal-Rooms-in-Webex-Meetings) meeting is also supported for this API."
    },
    "meetingNumber": {
      "type": "string",
      "example": "123456789",
      "description": "Meeting number. Applies to meeting series, scheduled meeting, and meeting instances, but not to meeting instances which have ended."
    },
    "webLink": {
      "type": "string",
      "example": "https://site4-example.webex.com/site4/j.php?MTID=md41817da6a55b0925530cb88b3577b1e",
      "description": "Link to a meeting information page where the meeting client is launched if the meeting is ready to start or join."
    },
    "joinDirectly": {
      "type": "boolean",
      "description": "Whether or not to redirect to `joinLink`. It is an optional field and default value is true."
    },
    "email": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address of meeting participant. If `email` is specified, the link is generated for the user of `email`; otherwise, the API returns the link for the user calling the API. `email` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer)."
    },
    "displayName": {
      "type": "string",
      "example": "Brenda Song",
      "description": "Display name of meeting participant. If `displayName` is specified, `email` must be specified as well. If `email` is specified and `displayName` is not, display name is the same as `email`. If neither `displayName` nor `email` is specified, the API returns the link for the user calling the API. The maximum length of `displayName` is 128 characters. `displayName` is required for a [guest issuer](https://developer.webex.com/docs/guest-issuer)."
    },
    "password": {
      "type": "string",
      "example": "BgJep@43",
      "description": "Required when the meeting is protected by a password and the current user is not privileged to view it if they are not a host, cohost, or invitee."
    },
    "expirationMinutes": {
      "type": "number",
      "example": 5,
      "description": "Expiration duration of `joinLink` in minutes. Must be between 1 and 60."
    },
    "registrationId": {
      "type": "string",
      "example": "1111",
      "description": "Required when the meeting is webinar-enabled and enabled registration ID."
    },
    "hostEmail": {
      "type": "string",
      "example": "[email protected]",
      "description": "Email address for the meeting host. This attribute should be set if the user or application calling the API has the admin on-behalf-of scopes. This parameter is required for a [Service App](/docs/service-apps). It only applies to meetings, not webinars."
    },
    "createJoinLinkAsWebLink": {
      "type": "boolean",
      "description": "When `createJoinLinkAsWebLink` is true, the returned `joinLink` is the webLink of the meeting, otherwise, the normal `joinLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot join the meeting by the link directly and must go through the login flow."
    },
    "createStartLinkAsWebLink": {
      "type": "boolean",
      "description": "When `createStartLinkAsWebLink` is true, the returned `startLink` is the webLink of the meeting, otherwise, the normal `startLink` is returned. This parameter is applicable when the option to force the user to log in is set in Control Hub. When true, a user cannot start the meeting using the link and must go through the login flow."
    }
  }
}