Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Zoom Meeting #11

Open
nonocast opened this issue Mar 3, 2020 · 0 comments
Open

Zoom Meeting #11

nonocast opened this issue Mar 3, 2020 · 0 comments

Comments

@nonocast
Copy link
Owner

nonocast commented Mar 3, 2020

{
  "Meeting": {
    "description": "Meeting object.",
    "allOf": [
      {
        "type": "object",
        "description": "Base object for sessions.",
        "properties": {
          "topic": {
            "type": "string",
            "description": "Meeting topic."
          },
          "type": {
            "type": "integer",
            "description": "Meeting Type:<br>`1` - Instant meeting.<br>`2` - Scheduled meeting.<br>`3` - Recurring meeting with no fixed time.<br>`8` - Recurring meeting with fixed time.",
            "default": 2,
            "enum": [1, 2, 3, 8],
            "x-enum-descriptions": [
              "Instant Meeting",
              "Scheduled Meeting",
              "Recurring Meeting with no fixed time",
              "Recurring Meeting with fixed time"
            ]
          },
          "start_time": {
            "type": "string",
            "format": "date-time",
            "description": "Meeting start time. When using a format like \"yyyy-MM-dd'T'HH:mm:ss'Z'\", always use GMT time. When using a format like \"yyyy-MM-dd'T'HH:mm:ss\", you should use local time and specify the time zone. This is only used for scheduled meetings and recurring meetings with a fixed time."
          },
          "duration": {
            "type": "integer",
            "description": "Meeting duration (minutes). Used for scheduled meetings only."
          },
          "timezone": {
            "type": "string",
            "description": "Time zone to format start_time. For example, \"America/Los_Angeles\". For scheduled meetings only. Please reference our [time zone](https://marketplace.zoom.us/docs/api-reference/other-references/abbreviation-lists#timezones) list for supported time zones and their formats."
          },
          "password": {
            "type": "string",
            "description": "Password to join the meeting. Password may only contain the following characters: [a-z A-Z 0-9 @ - _ *]. Max of 10 characters."
          },
          "agenda": {
            "type": "string",
            "description": "Meeting description."
          },
          "tracking_fields": {
            "type": "array",
            "description": "Tracking fields",
            "items": {
              "properties": {
                "field": {
                  "type": "string",
                  "description": "Tracking fields type"
                },
                "value": {
                  "type": "string",
                  "description": "Tracking fields value"
                }
              }
            }
          },
          "recurrence": {
            "type": "object",
            "description": "Recurrence object.",
            "properties": {
              "type": {
                "type": "integer",
                "description": "Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.",
                "enum": [1, 2, 3],
                "x-enum-descriptions": ["Daily", "Weekly", "Monthly"]
              },
              "repeat_interval": {
                "type": "integer",
                "description": "At which interval should the meeting repeat? For a daily meeting there's a maximum of 90 days. For a weekly meeting there is a maximum of 12 weeks. For a monthly meeting there is a maximum of 3 months."
              },
              "weekly_days": {
                "type": "string",
                "description": "Days of the week the meeting should repeat. \nNote: Multiple values should be separated by a comma. <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.",
                "enum": [1, 2, 3, 4, 5, 6, 7],
                "x-enum-descriptions": [
                  "Sunday",
                  "Monday",
                  "Tuesday",
                  "Wednesday",
                  "Thursday",
                  "Friday",
                  "Saturday"
                ]
              },
              "monthly_day": {
                "type": "integer",
                "description": "Day in the month the meeting is to be scheduled. The value range is from 1 to 31."
              },
              "monthly_week": {
                "type": "integer",
                "description": "The week a meeting will recur each month.<br>`-1` - Last week.<br>`1` - First week.<br>`2` - Second week.<br>`3` - Third week.<br>`4` - Fourth week.",
                "enum": [-1, 1, 2, 3, 4],
                "x-enum-descriptions": [
                  "Last week",
                  "First week",
                  "Second week",
                  "Third week",
                  "Fourth week"
                ]
              },
              "monthly_week_day": {
                "type": "integer",
                "description": "The weekday a meeting should recur each month.<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.",
                "enum": [1, 2, 3, 4, 5, 6, 7],
                "x-enum-descriptions": [
                  "Sunday",
                  "Monday",
                  "Tuesday",
                  "Wednesday",
                  "Thursday",
                  "Friday",
                  "Saturday"
                ]
              },
              "end_times": {
                "type": "integer",
                "description": "Select how many times the meeting will recur before it is canceled. (Cannot be used with \"end_date_time\".)",
                "default": 1,
                "maximum": 50
              },
              "end_date_time": {
                "type": "string",
                "description": "Select a date the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)",
                "format": "date-time"
              }
            }
          },
          "settings": {
            "type": "object",
            "description": "Meeting settings.",
            "properties": {
              "host_video": {
                "type": "boolean",
                "description": "Start video when the host joins the meeting."
              },
              "participant_video": {
                "type": "boolean",
                "description": "Start video when participants join the meeting."
              },
              "cn_meeting": {
                "type": "boolean",
                "description": "Host meeting in China.",
                "default": false
              },
              "in_meeting": {
                "type": "boolean",
                "description": "Host meeting in India.",
                "default": false
              },
              "join_before_host": {
                "type": "boolean",
                "description": "Allow participants to join the meeting before the host starts the meeting. Only used for scheduled or recurring meetings.",
                "default": false
              },
              "mute_upon_entry": {
                "type": "boolean",
                "description": "Mute participants upon entry.",
                "default": false
              },
              "watermark": {
                "type": "boolean",
                "description": "Add watermark when viewing a shared screen.",
                "default": false
              },
              "use_pmi": {
                "type": "boolean",
                "description": "Use a personal meeting ID. Only used for scheduled meetings and recurring meetings with no fixed time.",
                "default": false
              },
              "approval_type": {
                "type": "integer",
                "default": 2,
                "description": "`0` - Automatically approve.<br>`1` - Manually approve.<br>`2` - No registration required.",
                "enum": [0, 1, 2],
                "x-enum-descriptions": [
                  "Automatically Approve",
                  "Manually Approve",
                  "No Registration Required"
                ]
              },
              "registration_type": {
                "type": "integer",
                "description": "Registration type. Used for recurring meeting with fixed time only. <br>`1` Attendees register once and can attend any of the occurrences.<br>`2` Attendees need to register for each occurrence to attend.<br>`3` Attendees register once and can choose one or more occurrences to attend.",
                "default": 1,
                "enum": [1, 2, 3],
                "x-enum-descriptions": [
                  "Attendees register once and can attend any of the occurrences",
                  "Attendees need to register for each occurrence to attend",
                  "Attendees register once and can choose one or more occurrences to attend"
                ]
              },
              "audio": {
                "type": "string",
                "description": "Determine how participants can join the audio portion of the meeting.<br>`both` - Both Telephony and VoIP.<br>`telephony` - Telephony only.<br>`voip` - VoIP only.",
                "default": "both",
                "enum": ["both", "telephony", "voip"],
                "x-enum-descriptions": [
                  "Both Telephony and VoIP",
                  "Telephony only",
                  "VoIP only"
                ]
              },
              "auto_recording": {
                "type": "string",
                "description": "Automatic recording:<br>`local` - Record on local.<br>`cloud` -  Record on cloud.<br>`none` - Disabled.",
                "default": "none",
                "enum": ["local", "cloud", "none"],
                "x-enum-descriptions": [
                  "Record to local device",
                  "Record to cloud",
                  "No Recording"
                ]
              },
              "enforce_login": {
                "type": "boolean",
                "description": "Only signed in users can join this meeting."
              },
              "enforce_login_domains": {
                "type": "string",
                "description": "Only signed in users with specified domains can join meetings."
              },
              "alternative_hosts": {
                "type": "string",
                "description": "Alternative host's emails or IDs: multiple values separated by a comma."
              },
              "close_registration": {
                "type": "boolean",
                "description": "Close registration after event date",
                "default": false
              },
              "waiting_room": {
                "type": "boolean",
                "description": "Enable waiting room",
                "default": false
              },
              "global_dial_in_countries": {
                "type": "array",
                "description": "List of global dial-in countries",
                "items": {
                  "type": "string"
                }
              },
              "global_dial_in_numbers": {
                "type": "array",
                "description": "Global Dial-in Countries/Regions",
                "items": {
                  "type": "object",
                  "properties": {
                    "country": {
                      "type": "string",
                      "description": "Country code. For example, BR."
                    },
                    "country_name": {
                      "type": "string",
                      "description": "Full name of country. For example, Brazil."
                    },
                    "city": {
                      "type": "string",
                      "description": "City of the number, if any. For example, Chicago."
                    },
                    "number": {
                      "type": "string",
                      "description": "Phone number. For example, +1 2332357613."
                    },
                    "type": {
                      "type": "string",
                      "description": "Type of number. ",
                      "enum": ["toll", "tollfree"]
                    }
                  }
                }
              },
              "contact_name": {
                "type": "string",
                "description": "Contact name for registration"
              },
              "contact_email": {
                "type": "string",
                "description": "Contact email for registration"
              },
              "registrants_confirmation_email": {
                "type": "boolean",
                "description": "Send confirmation email to registrants"
              },
              "registrants_email_notification": {
                "type": "string",
                "description": "registrants email notification"
              },
              "meeting_authentication": {
                "type": "boolean",
                "description": "Only authenticated users can join meetings"
              },
              "authentication_option": {
                "type": "string",
                "description": "Meeting authentication option id"
              },
              "authentication_domains": {
                "type": "string",
                "description": "Meeting authentication_domains"
              }
            }
          }
        }
      }
    ],
    "type": "object"
  }
}

重点观察如何实现周期性会议,

{
  "recurrence": {
    "type": "object",
    "description": "Recurrence object.",
    "properties": {
      "type": {
        "type": "integer",
        "description": "Recurrence meeting types:<br>`1` - Daily.<br>`2` - Weekly.<br>`3` - Monthly.",
        "enum": [1, 2, 3],
        "x-enum-descriptions": ["Daily", "Weekly", "Monthly"]
      },
      "repeat_interval": {
        "type": "integer",
        "description": "At which interval should the meeting repeat? For a daily meeting there's a maximum of 90 days. For a weekly meeting there is a maximum of 12 weeks. For a monthly meeting there is a maximum of 3 months."
      },
      "weekly_days": {
        "type": "string",
        "description": "Days of the week the meeting should repeat. \nNote: Multiple values should be separated by a comma. <br>`1`  - Sunday. <br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` -  Thursday.<br>`6` - Friday.<br>`7` - Saturday.",
        "enum": [1, 2, 3, 4, 5, 6, 7],
        "x-enum-descriptions": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
      },
      "monthly_day": {
        "type": "integer",
        "description": "Day in the month the meeting is to be scheduled. The value range is from 1 to 31."
      },
      "monthly_week": {
        "type": "integer",
        "description": "The week a meeting will recur each month.<br>`-1` - Last week.<br>`1` - First week.<br>`2` - Second week.<br>`3` - Third week.<br>`4` - Fourth week.",
        "enum": [-1, 1, 2, 3, 4],
        "x-enum-descriptions": [ "Last week", "First week", "Second week", "Third week", "Fourth week" ]
      },
      "monthly_week_day": {
        "type": "integer",
        "description": "The weekday a meeting should recur each month.<br>`1` - Sunday.<br>`2` - Monday.<br>`3` - Tuesday.<br>`4` -  Wednesday.<br>`5` - Thursday.<br>`6` - Friday.<br>`7` - Saturday.",
        "enum": [1, 2, 3, 4, 5, 6, 7],
        "x-enum-descriptions": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ]
      },
      "end_times": {
        "type": "integer",
        "description": "Select how many times the meeting will recur before it is canceled. (Cannot be used with \"end_date_time\".)",
        "default": 1,
        "maximum": 50
      },
      "end_date_time": {
        "type": "string",
        "description": "Select a date the meeting will recur before it is canceled. Should be in UTC time, such as 2017-11-25T12:00:00Z. (Cannot be used with \"end_times\".)",
        "format": "date-time"
      }
    }
  }
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant