openapi-directory/api/zoom.us.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"developer@zoom.us","name":"Zoom Developers","url":"https://developer.zoom.us/","x-twitter":"zoom_us"},"description":"API Description","license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"title":"Zoom","version":"2.0.0","x-apisguru-categories":["telecom"],"x-logo":{"url":"https://twitter.com/zoom_us/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/zoom/api/master/openapi.v2.json","version":"2.0"}],"x-providerName":"zoom.us"},"externalDocs":{"description":"Zoom API Documentation","url":"https://zoom.github.io/api"},"security":[{"global":[]}],"tags":[{"description":"Account operations","name":"Accounts"},{"description":"Billing operations","name":"Billing"},{"description":"User operations","name":"Users"},{"description":"Meeting operations","name":"Meetings"},{"description":"Webinar operations","name":"Webinars"},{"description":"Group operations","name":"Groups"},{"description":"IM Group operations","name":"IM Groups"},{"description":"Cloud Recording operations","name":"Cloud Recording"},{"description":"Report operations","name":"Reports"},{"description":"Dashboard operations","name":"Dashboards"},{"description":"Webhook operations","name":"Webhooks"},{"description":"TSP operations","name":"TSP"}],"paths":{"/accounts":{"get":{"description":"List all the sub accounts under the master account.","operationId":"accounts","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"Account list returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountList"}}}}},"summary":"List sub accounts","tags":["Accounts"]},"post":{"description":"Create a sub account under the master account <aside>Your account must be a master account and have this privilege to create sub account. Zoom only assign this privilege to trusted partner. The created user will not receive the confirmation email.</aside>","operationId":"accountCreate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Account"}}},"description":"Account","required":true},"responses":{"201":{"description":"Account Created","headers":{"Content-Location":{"description":"Location of created Account","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"created_at":{"description":"Account created date time","type":"string"},"id":{"description":"Account ID","type":"string"},"owner_email":{"description":"Account owner email","type":"string"},"owner_id":{"description":"Account Owner ID","type":"string"}}}},"application/xml":{"schema":{"properties":{"created_at":{"description":"Account created date time","type":"string"},"id":{"description":"Account ID","type":"string"},"owner_email":{"description":"Account owner email","type":"string"},"owner_id":{"description":"Account Owner ID","type":"string"}}}}}},"409":{"description":"Account with that email already exists"}},"summary":"Create a sub account","tags":["Accounts"]}},"/accounts/{accountId}":{"delete":{"description":"Disassociate a sub account from the master account","operationId":"accountDisassociate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"responses":{"204":{"description":"Account deleted"},"404":{"description":"Account not found"}},"summary":"Disassociate an account","tags":["Accounts"]},"get":{"description":"Retrieve a sub account under the master account <aside>Your account must be a master account and have this privilege to get sub account. Zoom only assign this privilege to trusted partner</aside>","operationId":"account","parameters":[{"$ref":"#/components/parameters/AccountId"}],"responses":{"200":{"description":"Account object returned","content":{"application/json":{"schema":{"properties":{"created_at":{"description":"Account creation date/time","format":"date-time","type":"string"},"id":{"description":"Account ID","type":"string"},"options":{"$ref":"#/components/schemas/AccountOptions"},"owner_email":{"description":"Account Owner email","type":"string"},"owner_id":{"description":"Account Owner ID","type":"string"}}}},"application/xml":{"schema":{"properties":{"created_at":{"description":"Account creation date/time","format":"date-time","type":"string"},"id":{"description":"Account ID","type":"string"},"options":{"$ref":"#/components/schemas/AccountOptions"},"owner_email":{"description":"Account Owner email","type":"string"},"owner_id":{"description":"Account Owner ID","type":"string"}}}}}},"404":{"description":"User not found"}},"summary":"Retrieve a sub account","tags":["Accounts"]}},"/accounts/{accountId}/billing":{"get":{"description":"Retrieve billing information for a sub account under the master account","operationId":"accountBilling","parameters":[{"$ref":"#/components/parameters/AccountId"}],"responses":{"200":{"description":"Account billing contact information returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingContactRequired"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BillingContactRequired"}}}},"404":{"description":"Account not found"}},"summary":"Retrieve billing information for a sub account","tags":["Billing"]},"patch":{"description":"Update billing information for a sub account under the master account <aside>Only for the sub account which is a paid account and paid by master account</aside>","operationId":"accountBillingUpdate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BillingContact"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/BillingContact"}}},"required":true},"responses":{"204":{"description":"Account billing contact information updated"},"404":{"description":"Account not found"}},"summary":"Update billing information for a sub account","tags":["Billing"]}},"/accounts/{accountId}/options":{"patch":{"description":"Update a sub account's options under the master account","operationId":"accountOptionsUpdate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountOptions"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AccountOptions"}}},"required":true},"responses":{"204":{"description":"Account options updated"},"404":{"description":"Account not found"}},"summary":"Update a sub account's options","tags":["Accounts"]}},"/accounts/{accountId}/plans":{"get":{"description":"Retrieve plan information for a sub account under the master account  <aside>Only for the sub account which is paid by master account</aside>","operationId":"accountPlans","parameters":[{"$ref":"#/components/parameters/AccountId"}],"responses":{"200":{"description":"Account plans returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPlans"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountPlans"}}}},"404":{"description":"Account not fond"}},"summary":"Retrieve plan information for a sub account","tags":["Billing"]},"post":{"description":"Subscribe plans for a sub account of the master account <aside>Can only subscribe plans for the sub account which is a free account and paid by master account</aside>","operationId":"accountPlanCreate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"properties":{"contact":{"$ref":"#/components/schemas/BillingContactRequired"}},"type":"object"},{"$ref":"#/components/schemas/AccountPlans"}]}},"multipart/form-data":{"schema":{"allOf":[{"properties":{"contact":{"$ref":"#/components/schemas/BillingContactRequired"}},"type":"object"},{"$ref":"#/components/schemas/AccountPlans"}]}}},"required":true},"responses":{"201":{"description":"Account plans updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPlans"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountPlans"}}}}},"summary":"Subscribe plans for a sub account","tags":["Billing"]}},"/accounts/{accountId}/plans/addons":{"post":{"description":"Add an additional plan for sub account <aside>Can only add an Additional plan for the sub account which is a paid account and paid by master account</aside>","operationId":"accountPlanAddonCreate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"$ref":"#/components/requestBodies/AccountPlanRequired"},"responses":{"201":{"description":"Account plans updated"}},"summary":"Add an additional plan for sub account","tags":["Billing"]},"put":{"description":"Update an additional plan for sub account<aside>Can only update an Additional plan for the sub account which is a paid account and paid by master account</aside>","operationId":"accountPlanAddonUpdate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"$ref":"#/components/requestBodies/AccountPlanRequired"},"responses":{"204":{"description":"Account plans updated"}},"summary":"Update an additional plan for sub account","tags":["Billing"]}},"/accounts/{accountId}/plans/base":{"put":{"description":"Update a base plan for a sub account <aside>Can only update a base plan for the sub account which is a paid account and paid by master account</aside>","operationId":"accountPlanBaseUpdate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountPlanBaseRequired"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AccountPlanBaseRequired"}}},"required":true},"responses":{"204":{"description":"Account plans updated"}},"summary":"Update a base plan for a sub account","tags":["Billing"]}},"/accounts/{accountId}/settings":{"get":{"description":"Retrieve a sub account's settings under the master account","operationId":"accountSettings","parameters":[{"$ref":"#/components/parameters/AccountId"}],"responses":{"200":{"description":"Account settings returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettings"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountSettings"}}}},"404":{"description":"Account not found"}},"summary":"Retrieve a sub account's settings","tags":["Accounts"]},"patch":{"description":"Update a sub account's settings under the master account","operationId":"accountSettingsUpdate","parameters":[{"$ref":"#/components/parameters/AccountId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountSettings"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/AccountSettings"}}},"required":true},"responses":{"204":{"description":"Account settings updated"},"404":{"description":"Account not found"}},"summary":"Update a sub account's settings","tags":["Accounts"]}},"/groups":{"get":{"description":"List groups under your account","operationId":"groups","responses":{"200":{"description":"List of groups returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GroupList"}}}}},"summary":"List groups","tags":["Groups"]},"post":{"description":"Create a group under your account","operationId":"groupCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name.","type":"string"}}}},"multipart/form-data":{"schema":{"properties":{"name":{"description":"Group name.","type":"string"}}}}},"required":true},"responses":{"201":{"description":"Group created.","headers":{"Content-Location":{"description":"Location of created group","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"id":{"description":"Group ID","type":"string"},"name":{"description":"Group name","type":"string"},"total_members":{"description":"Group member count","type":"integer"}}}},"application/xml":{"schema":{"properties":{"id":{"description":"Group ID","type":"string"},"name":{"description":"Group name","type":"string"},"total_members":{"description":"Group member count","type":"integer"}}}}}}},"summary":"Create a group","tags":["Groups"]}},"/groups/{groupId}":{"delete":{"description":"Delete a group under your account","operationId":"groupDelete","parameters":[{"$ref":"#/components/parameters/GroupId"}],"responses":{"204":{"description":"Group deleted."},"404":{"description":"Group not found"}},"summary":"Delete a group","tags":["Groups"]},"get":{"description":"Retrieve a group under your account","operationId":"group","parameters":[{"$ref":"#/components/parameters/GroupId"}],"responses":{"200":{"description":"Group object returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"description":"Group ID","type":"string"}}},{"$ref":"#/components/schemas/Group"}]}},"application/xml":{"schema":{"allOf":[{"properties":{"id":{"description":"Group ID","type":"string"}}},{"$ref":"#/components/schemas/Group"}]}}}},"404":{"description":"Group not found"}},"summary":"Retrieve a group","tags":["Groups"]},"patch":{"description":"Update a group under your account","operationId":"groupUpdate","parameters":[{"$ref":"#/components/parameters/GroupId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name. Must be unique in one account. Character length is less than 128.","type":"string"}}}},"multipart/form-data":{"schema":{"properties":{"name":{"description":"Group name. Must be unique in one account. Character length is less than 128.","type":"string"}}}}},"required":true},"responses":{"204":{"description":"Group updated."},"404":{"description":"Group not found"}},"summary":"Update a group","tags":["Groups"]}},"/groups/{groupId}/members":{"get":{"description":"List a group's members under your account","operationId":"groupMembers","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"Group member list returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMemberList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GroupMemberList"}}}},"404":{"description":"Group not found"}},"summary":"List a group's members","tags":["Groups"]},"post":{"description":"Add members to a group under your account","operationId":"groupMembersCreate","parameters":[{"$ref":"#/components/parameters/GroupId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"members":{"description":"List of Group members","items":{"properties":{"email":{"description":"User email. If ID given, email is ignored.","type":"string"},"id":{"description":"User ID.","type":"string"}}},"maximum":30,"type":"array"}}}},"multipart/form-data":{"schema":{"properties":{"members":{"description":"List of Group members","items":{"properties":{"email":{"description":"User email. If ID given, email is ignored.","type":"string"},"id":{"description":"User ID.","type":"string"}}},"maximum":30,"type":"array"}}}}},"required":true},"responses":{"201":{"description":"Member added.","content":{"application/json":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string"},"ids":{"type":"string"}}}},"application/xml":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string"},"ids":{"type":"string"}}}}}},"404":{"description":"Group not found"}},"summary":"Add group members","tags":["Groups"]}},"/groups/{groupId}/members/{memberId}":{"delete":{"description":"Delete a member from a group under your account","operationId":"groupMembersDelete","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/MemberId"}],"responses":{"204":{"description":"Group member deleted."},"404":{"description":"Group or Group member not found"}},"summary":"Delete a group member","tags":["Groups"]}},"/im/groups":{"get":{"description":"List IM groups under your account","operationId":"imGroups","responses":{"200":{"description":"List of IM Groups returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IMGroupList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/IMGroupList"}}}}},"summary":"List IM Groups","tags":["IM Groups"]},"post":{"description":"Create a IM Group under your account","operationId":"imGroupCreate","requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name, must be unique in one account","maxLength":128,"type":"string"},"search_by_account":{"description":"Members can search others under same account","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts","type":"boolean"},"type":{"default":"normal","description":"IM Group type","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"]}}}},"multipart/form-data":{"schema":{"properties":{"name":{"description":"Group name, must be unique in one account","maxLength":128,"type":"string"},"search_by_account":{"description":"Members can search others under same account","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts","type":"boolean"},"type":{"default":"normal","description":"IM Group type","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"]}}}}},"required":true},"responses":{"201":{"description":"IM Group created.","headers":{"Content-Location":{"description":"Location of created IM Group","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"properties":{"id":{"description":"Group ID","type":"string"},"name":{"description":"Group name","type":"string"},"search_by_account":{"description":"Members can search others under same account.","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain.","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts.","type":"boolean"},"total_members":{"description":"Group member count","type":"integer"}}}},"application/xml":{"schema":{"properties":{"id":{"description":"Group ID","type":"string"},"name":{"description":"Group name","type":"string"},"search_by_account":{"description":"Members can search others under same account.","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain.","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts.","type":"boolean"},"total_members":{"description":"Group member count","type":"integer"}}}}}}},"summary":"Create an IM Group","tags":["IM Groups"]}},"/im/groups/{groupId}":{"delete":{"description":"Delete an IM Group under your account","operationId":"imGroupDelete","parameters":[{"$ref":"#/components/parameters/GroupId"}],"responses":{"204":{"description":"IM Group deleted."},"404":{"description":"IM Group not found"}},"summary":"Delete an IM Group","tags":["IM Groups"]},"get":{"description":"Retrieve an IM Group under your account","operationId":"imGroup","parameters":[{"$ref":"#/components/parameters/GroupId"}],"responses":{"200":{"description":"IM Group object returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"id":{"description":"Group ID","type":"string"}}},{"$ref":"#/components/schemas/IMGroup"}]}},"application/xml":{"schema":{"allOf":[{"properties":{"id":{"description":"Group ID","type":"string"}}},{"$ref":"#/components/schemas/IMGroup"}]}}}},"404":{"description":"IM Group not found"}},"summary":"Retrieve an IM Group","tags":["IM Groups"]},"patch":{"description":"Update an IM Group under your account","operationId":"imGroupUpdate","parameters":[{"$ref":"#/components/parameters/GroupId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"name":{"description":"Group name, must be unique in one account","maxLength":128,"type":"string"},"search_by_account":{"description":"Members can search others under same account","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts","type":"boolean"},"type":{"description":"IM Group type","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"]}}}},"multipart/form-data":{"schema":{"properties":{"name":{"description":"Group name, must be unique in one account","maxLength":128,"type":"string"},"search_by_account":{"description":"Members can search others under same account","type":"boolean"},"search_by_domain":{"description":"Members can search others in the same email domain","type":"boolean"},"search_by_ma_account":{"description":"Members can search others under same master account, including all sub accounts","type":"boolean"},"type":{"description":"IM Group type","enum":["normal","shared","restricted"],"type":"string","x-enum-descriptions":["Only members can see the group automatically. Other people can search members in the group","All people in the account can see the group and members automatically","Nobody can see the group or search members except the members in the group"]}}}}},"required":true},"responses":{"204":{"description":"IM Group updated."},"404":{"description":"IM Group not found"}},"summary":"Update an IM Group","tags":["IM Groups"]}},"/im/groups/{groupId}/members":{"get":{"description":"List an IM Group's members under your account","operationId":"imGroupMembers","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"IM Group member list returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMemberList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/GroupMemberList"}}}},"404":{"description":"IM Group not found"}},"summary":"List an IM Group's members","tags":["IM Groups"]},"post":{"description":"Add members to an IM Group under your account","operationId":"imGroupMembersCreate","parameters":[{"$ref":"#/components/parameters/GroupId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"members":{"description":"List of IM Group members","items":{"properties":{"email":{"description":"User email. If ID given, email is ignored.","type":"string"},"id":{"description":"User ID.","type":"string"}}},"maximum":10,"type":"array"}}}},"multipart/form-data":{"schema":{"properties":{"members":{"description":"List of IM Group members","items":{"properties":{"email":{"description":"User email. If ID given, email is ignored.","type":"string"},"id":{"description":"User ID.","type":"string"}}},"maximum":10,"type":"array"}}}}},"required":true},"responses":{"201":{"description":"Member added.","content":{"application/json":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string"},"ids":{"type":"string"}}}},"application/xml":{"schema":{"properties":{"added_at":{"format":"date-time","type":"string"},"ids":{"type":"string"}}}}}},"404":{"description":"IM Group not found"}},"summary":"Add IM Group members","tags":["IM Groups"]}},"/im/groups/{groupId}/members/{memberId}":{"delete":{"description":"Delete a member from an IM Group under your account","operationId":"imGroupMembersDelete","parameters":[{"$ref":"#/components/parameters/GroupId"},{"$ref":"#/components/parameters/MemberId"}],"responses":{"204":{"description":"IM Group member deleted."},"404":{"description":"IM Group or IM Group member not found"}},"summary":"Delete an IM Group member","tags":["IM Groups"]}},"/meetings/{meetingId}":{"delete":{"description":"Delete a meeting","operationId":"meetingDelete","parameters":[{"$ref":"#/components/parameters/MeetingId"},{"$ref":"#/components/parameters/OccurrenceId"}],"responses":{"204":{"description":"Meeting deleted"},"404":{"description":"Meeting not found"}},"summary":"Delete a meeting","tags":["Meetings"]},"get":{"description":"Retrieve a meeting's details","operationId":"meeting","parameters":[{"$ref":"#/components/parameters/MeetingId"}],"responses":{"200":{"description":"Meeting object returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"host_id":{"description":"ID of the user set as host of meeting","type":"string"},"id":{"description":"Meeting ID, also know as meeting number","type":"string"},"uuid":{"description":"Meeting unique ID","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/MeetingInfo"}]}},"application/xml":{"schema":{"allOf":[{"properties":{"host_id":{"description":"ID of the user set as host of meeting","type":"string"},"id":{"description":"Meeting ID, also know as meeting number","type":"string"},"uuid":{"description":"Meeting unique ID","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/MeetingInfo"}]}}}},"404":{"description":"Meeting not found"}},"summary":"Retrieve a meeting","tags":["Meetings"]},"patch":{"description":"Update a meeting's details","operationId":"meetingUpdate","parameters":[{"$ref":"#/components/parameters/MeetingId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingUpdate"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MeetingUpdate"}}},"description":"Meeting","required":true},"responses":{"204":{"description":"Meeting Updated"},"404":{"description":"Meeting not found"}},"summary":"Update a meeting","tags":["Meetings"]}},"/meetings/{meetingId}/recordings":{"delete":{"description":"Delete a meeting's recordings","operationId":"recordingDelete","parameters":[{"$ref":"#/components/parameters/MeetingId4Recording"},{"$ref":"#/components/parameters/RecordingDeleteAction"}],"responses":{"204":{"description":"Meeting recording deleted"},"404":{"description":"Meeting recording not found"}},"summary":"Delete a meeting's recordings","tags":["Cloud Recording"]},"get":{"description":"Retrieve a meeting’s all recordings","operationId":"recordingGet","parameters":[{"$ref":"#/components/parameters/MeetingId4Recording"}],"responses":{"200":{"description":"Recording object returned","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Recording"}]}},"application/xml":{"schema":{"allOf":[{"$ref":"#/components/schemas/Recording"}]}}}},"404":{"description":"Meeting recording not found"}},"summary":"Retrieve a meeting’s all recordings","tags":["Cloud Recording"]}},"/meetings/{meetingId}/recordings/status":{"put":{"description":"Recover a meeting's recordings","operationId":"recordingStatusUpdate","parameters":[{"$ref":"#/components/parameters/MeetingId4Recording"}],"requestBody":{"$ref":"#/components/requestBodies/recordingStatusUpdateBody"},"responses":{"204":{"description":"Meeting recording recover"},"404":{"description":"Meeting recording not found"}},"summary":"Recover a meeting's recordings","tags":["Cloud Recording"]}},"/meetings/{meetingId}/recordings/{recordingId}":{"delete":{"description":"Delete one meeting recording file","operationId":"recordingDeleteOne","parameters":[{"$ref":"#/components/parameters/MeetingId4Recording"},{"$ref":"#/components/parameters/RecordingId"},{"$ref":"#/components/parameters/RecordingDeleteAction"}],"responses":{"204":{"description":"Meeting recording file deleted"},"404":{"description":"Meeting recording file not found"}},"summary":"Delete one meeting recording file","tags":["Cloud Recording"]}},"/meetings/{meetingId}/recordings/{recordingId}/status":{"put":{"description":"Recover a meeting one recording","operationId":"recordingStatusUpdateOne","parameters":[{"$ref":"#/components/parameters/MeetingId4Recording"},{"$ref":"#/components/parameters/RecordingId"}],"requestBody":{"$ref":"#/components/requestBodies/recordingStatusUpdateBody"},"responses":{"204":{"description":"Meeting recording recover"},"404":{"description":"Meeting recording not found"}},"summary":"Recover a meeting one recording","tags":["Cloud Recording"]}},"/meetings/{meetingId}/registrants":{"get":{"description":"List registrants of a meeting","operationId":"meetingRegistrants","parameters":[{"$ref":"#/components/parameters/MeetingId"},{"$ref":"#/components/parameters/OccurrenceId"},{"$ref":"#/components/parameters/RegistrantStatus"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageNumber"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingRegistrantList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MeetingRegistrantList"}}}},"404":{"description":"Meeting not found"}},"summary":"List a meeting's registrants","tags":["Meetings"]},"post":{"description":"Register a participant for a meeting","operationId":"meetingRegistrantCreate","parameters":[{"$ref":"#/components/parameters/MeetingId"},{"description":"Occurrence IDs, could get this value from Meeting Get API. Multiple value separated by comma.","in":"query","name":"occurrence_ids","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingRegistrant"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/MeetingRegistrant"}}},"required":true},"responses":{"201":{"description":"Registration created","content":{"application/json":{"schema":{"properties":{"id":{"description":"Registrant ID","type":"string"},"join_url":{"description":"Join URL for this registrant","type":"string"},"registrant_id":{"description":"Registrant ID","type":"string"},"start_time":{"description":"Start time","format":"date-time","type":"string"},"topic":{"description":"Topic","type":"string"}},"type":"object"}},"application/xml":{"schema":{"properties":{"id":{"description":"Registrant ID","type":"string"},"join_url":{"description":"Join URL for this registrant","type":"string"},"registrant_id":{"description":"Registrant ID","type":"string"},"start_time":{"description":"Start time","format":"date-time","type":"string"},"topic":{"description":"Topic","type":"string"}},"type":"object"}}}},"404":{"description":"Meeting not found"}},"summary":"Add a meeting registrant","tags":["Meetings"]}},"/meetings/{meetingId}/registrants/status":{"put":{"description":"Update a meeting registrant's status","operationId":"meetingRegistrantStatus","parameters":[{"$ref":"#/components/parameters/MeetingId"},{"$ref":"#/components/parameters/OccurrenceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrantStatus"}},"multipart/form-data":{"schema":{"$ref":"#/components/schemas/RegistrantStatus"}}},"required":true},"responses":{"204":{"description":"Registrant status updated"},"404":{"description":"Meeting or Registrant not found"}},"summary":"Update a meeting registrant's status","tags":["Meetings"]}},"/meetings/{meetingId}/status":{"put":{"description":"Update a meeting's status","operationId":"meetingStatus","parameters":[{"$ref":"#/components/parameters/MeetingId"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"action":{"enum":["end"],"type":"string","x-enum-descriptions":["end a meeting"]}}}},"multipart/form-data":{"schema":{"properties":{"action":{"enum":["end"],"type":"string","x-enum-descriptions":["end a meeting"]}}}}},"required":true},"responses":{"204":{"description":"Meeting updated"},"404":{"description":"Meeting not found"}},"summary":"Update a meeting's status","tags":["Meetings"]}},"/metrics/crc":{"get":{"description":"Get CRC Port usage hour by hour for a specified time period <aside class='notice'>We will report a maximum of one month. For example, if \"from\" is set to \"2017-08-05\" and \"to\" is \"2017-10-10\" we will adjust \"from\" to \"2017-09-10\"</aside>","operationId":"dashboardCRC","parameters":[{"$ref":"#/components/parameters/FromDate"},{"$ref":"#/components/parameters/ToDate"}],"responses":{"200":{"description":"CRC Usage returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"properties":{"crc_ports_usage":{"items":{"properties":{"crc_ports_hour_usage":{"items":{"properties":{"hour":{"type":"string"},"max_usage":{"type":"integer"},"total_usage":{"type":"integer"}}},"type":"array"},"date_time":{"description":"Date and time","type":"string"}}},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"properties":{"crc_ports_usage":{"items":{"properties":{"crc_ports_hour_usage":{"items":{"properties":{"hour":{"type":"string"},"max_usage":{"type":"integer"},"total_usage":{"type":"integer"}}},"type":"array"},"date_time":{"description":"Date and time","type":"string"}}},"type":"array"}}}]}}}}},"summary":"Retrieve CRC Port Usage","tags":["Dashboards"]}},"/metrics/im":{"get":{"description":"Retrieve metrics of Zoom IM","operationId":"dashboardIM","parameters":[{"$ref":"#/components/parameters/FromDate"},{"$ref":"#/components/parameters/ToDate"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"IM setails returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"users":{"items":{"properties":{"calls_receive":{"type":"integer"},"calls_send":{"type":"integer"},"email":{"description":"User email","type":"string"},"emoji_receive":{"type":"integer"},"emoji_send":{"type":"integer"},"files_receive":{"type":"integer"},"files_send":{"type":"integer"},"group_receive":{"type":"integer"},"group_send":{"type":"integer"},"images_receive":{"type":"integer"},"images_send":{"type":"integer"},"total_receive":{"type":"integer"},"total_send":{"type":"integer"},"user_id":{"description":"User ID","type":"string"},"user_name":{"description":"User display name","type":"string"},"videos_receive":{"type":"integer"},"videos_send":{"type":"integer"},"voice_receive":{"type":"integer"},"voice_send":{"type":"integer"}}},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"users":{"items":{"properties":{"calls_receive":{"type":"integer"},"calls_send":{"type":"integer"},"email":{"description":"User email","type":"string"},"emoji_receive":{"type":"integer"},"emoji_send":{"type":"integer"},"files_receive":{"type":"integer"},"files_send":{"type":"integer"},"group_receive":{"type":"integer"},"group_send":{"type":"integer"},"images_receive":{"type":"integer"},"images_send":{"type":"integer"},"total_receive":{"type":"integer"},"total_send":{"type":"integer"},"user_id":{"description":"User ID","type":"string"},"user_name":{"description":"User display name","type":"string"},"videos_receive":{"type":"integer"},"videos_send":{"type":"integer"},"voice_receive":{"type":"integer"},"voice_send":{"type":"integer"}}},"type":"array"}}}]}}}}},"summary":"Retrieve IM","tags":["Dashboards"]}},"/metrics/meetings":{"get":{"description":"List live meetings or past meetings for a specified period","operationId":"dashboardMeetings","parameters":[{"$ref":"#/components/parameters/MeetingTypePast"},{"$ref":"#/components/parameters/FromDate"},{"$ref":"#/components/parameters/ToDate"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"Meetings Returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"meetings":{"description":"Array of meeting objects","items":{"$ref":"#/components/schemas/MeetingMetric"},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"meetings":{"description":"Array of meeting objects","items":{"$ref":"#/components/schemas/MeetingMetric"},"type":"array"}}}]}}}}},"summary":"List meetings","tags":["Dashboards"]}},"/metrics/meetings/{meetingId}":{"get":{"description":"Retrieve live or past meetings detail","operationId":"dashboardMeetingDetail","parameters":[{"$ref":"#/components/parameters/MeetingId4Metrics"},{"$ref":"#/components/parameters/MeetingTypePast3"}],"responses":{"200":{"description":"Meeting Returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeetingMetric"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MeetingMetric"}}}}},"summary":"Retrieve meeting detail","tags":["Dashboards"]}},"/metrics/meetings/{meetingId}/participants":{"get":{"description":"Retrieve live or past meetings participants","operationId":"dashboardMeetingParticipants","parameters":[{"$ref":"#/components/parameters/MeetingId4Metrics"},{"$ref":"#/components/parameters/MeetingTypePast3"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"Meeting Participants Returned","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of user objects","items":{"properties":{"device":{"description":"Participant device","type":"string"},"domain":{"description":"Participant domain","type":"string"},"harddisk_id":{"description":"Participant hard disk id","type":"string"},"id":{"description":"Participant UUID","format":"uuid","type":"string"},"ip_address":{"description":"Participant IP Address","type":"string"},"join_time":{"description":"Participant join time","format":"date-time","type":"string"},"leave_time":{"description":"Participant leave time","format":"date-time","type":"string"},"location":{"description":"Participant location","type":"string"},"mac_addr":{"description":"Participant MAC Address","type":"string"},"network_type":{"description":"Participant network type","type":"string"},"pc_name":{"description":"Participant PC name","type":"string"},"recording":{"description":"Participant record","type":"boolean"},"share_application":{"description":"Did participant share application","type":"boolean"},"share_desktop":{"description":"Did participant share desktop","type":"boolean"},"share_whiteboard":{"description":"Did participant share whiteboard","type":"boolean"},"user_id":{"description":"Participant ID","format":"uuid","type":"string"},"user_name":{"description":"Participant display name","type":"string"},"version":{"description":"Participant version","type":"string"}}},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of user objects","items":{"properties":{"device":{"description":"Participant device","type":"string"},"domain":{"description":"Participant domain","type":"string"},"harddisk_id":{"description":"Participant hard disk id","type":"string"},"id":{"description":"Participant UUID","format":"uuid","type":"string"},"ip_address":{"description":"Participant IP Address","type":"string"},"join_time":{"description":"Participant join time","format":"date-time","type":"string"},"leave_time":{"description":"Participant leave time","format":"date-time","type":"string"},"location":{"description":"Participant location","type":"string"},"mac_addr":{"description":"Participant MAC Address","type":"string"},"network_type":{"description":"Participant network type","type":"string"},"pc_name":{"description":"Participant PC name","type":"string"},"recording":{"description":"Participant record","type":"boolean"},"share_application":{"description":"Did participant share application","type":"boolean"},"share_desktop":{"description":"Did participant share desktop","type":"boolean"},"share_whiteboard":{"description":"Did participant share whiteboard","type":"boolean"},"user_id":{"description":"Participant ID","format":"uuid","type":"string"},"user_name":{"description":"Participant display name","type":"string"},"version":{"description":"Participant version","type":"string"}}},"type":"array"}}}]}}}}},"summary":"Retrieve meeting participants","tags":["Dashboards"]}},"/metrics/meetings/{meetingId}/participants/qos":{"get":{"description":"Retrieve list of live or past meetings participants quality of service","operationId":"dashboardMeetingParticipantsQOS","parameters":[{"$ref":"#/components/parameters/MeetingId4Metrics"},{"$ref":"#/components/parameters/MeetingTypePast2"},{"$ref":"#/components/parameters/PageSize4Qos"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"Meeting Participants Returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QOSParticipantList"}},"application/xml":{"schema":{"$ref":"#/components/schemas/QOSParticipantList"}}}}},"summary":"List meeting participants QOS","tags":["Dashboards"]}},"/metrics/meetings/{meetingId}/participants/sharing":{"get":{"description":"Retrieve sharing/recording details of live or past meetings participant","operationId":"dashboardMeetingParticipantShare","parameters":[{"$ref":"#/components/parameters/MeetingId4Metrics"},{"$ref":"#/components/parameters/MeetingTypePast2"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageToken"}],"responses":{"200":{"description":"Meeting Participants Returned","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of participants","items":{"properties":{"details":{"description":"Array of sharing and recording details","items":{"properties":{"content":{"description":"Type of content shared","type":"string"},"end_time":{"description":"End time of sharing","type":"string"},"start_time":{"description":"Start time of sharing","type":"string"}}},"type":"array"},"id":{"description":"Participant UUID","type":"string"},"user_id":{"description":"Participant ID","type":"string"},"user_name":{"description":"Participant display name","type":"string"}}},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of participants","items":{"properties":{"details":{"description":"Array of sharing and recording details","items":{"properties":{"content":{"description":"Type of content shared","type":"string"},"end_time":{"description":"End time of sharing","type":"string"},"start_time":{"description":"Start time of sharing","type":"string"}}},"type":"array"},"id":{"description":"Participant UUID","type":"string"},"user_id":{"description":"Participant ID","type":"string"},"user_name":{"description":"Participant display name","type":"string"}}},"type":"array"}}}]}}}}},"summary":"Retrieve sharing/recording details of meeting participant","tags":["Dashboards"]}},"/metrics/meetings/{meetingId}/participants/{participantId}/qos":{"get":{"description":"Retrieve live or past meetings participant quality of service","operationId":"dashboardMeetingParticipantQOS","parameters":[{"$ref":"#/components/parameters/MeetingId4Metrics"},{"$ref":"#/components/parameters/ParticipantId"},{"$ref":"#/components/parameters/MeetingTypePast2"}],"responses":{"200":{"description":"Meeting Participant QOS Returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QOSParticipant"}},"application/xml":{"schema":{"$ref":"#/components/schemas/QOSParticipant"}}}}},"summary":"Retrieve meeting participant QOS","tags":["Dashboards"]}},"/metrics/webinars":{"get":{"description":"List live webinars or past webinars for a specified period","operationId":"dashboardWebinars","parameters":[{"$ref":"#/components/parameters/WebinarTypePast"},{"$ref":"#/components/parameters/FromDate"},{"$ref":"#/components/parameters/ToDate"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"Meetings Returned","content":{"application/json":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"webinars":{"description":"Array of webinar objects","items":{"$ref":"#/components/schemas/WebinarMetric"},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"properties":{"from":{"description":"Start date for this report","format":"date","type":"string"},"to":{"description":"End date for this report","format":"date","type":"string"}}},{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"webinars":{"description":"Array of webinar objects","items":{"$ref":"#/components/schemas/WebinarMetric"},"type":"array"}}}]}}}}},"summary":"List webinars","tags":["Dashboards"]}},"/metrics/webinars/{webinarId}":{"get":{"description":"Retrieve live  or past webinars detail","operationId":"dashboardWebinarDetail","parameters":[{"$ref":"#/components/parameters/WebinarId4Metrics"},{"$ref":"#/components/parameters/WebinarTypePast2"}],"responses":{"200":{"description":"Webinar Returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebinarMetric"}},"application/xml":{"schema":{"$ref":"#/components/schemas/WebinarMetric"}}}}},"summary":"Retrieve webinar detail","tags":["Dashboards"]}},"/metrics/webinars/{webinarId}/participants":{"get":{"description":"Retrieve live or past webinar participants","operationId":"dashboardWebinarParticipants","parameters":[{"$ref":"#/components/parameters/WebinarId4Metrics"},{"$ref":"#/components/parameters/WebinarTypePast2"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/NextPageToken"}],"responses":{"200":{"description":"Webinar Participants Returned","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of user objects","items":{"properties":{"device":{"description":"Participant device","type":"string"},"domain":{"description":"Participant domain","type":"string"},"harddisk_id":{"description":"Participant hard disk id","type":"string"},"id":{"description":"Participant UUID","format":"uuid","type":"string"},"ip_address":{"description":"Participant IP Address","type":"string"},"join_time":{"description":"Participant join time","format":"date-time","type":"string"},"leave_time":{"description":"Participant leave time","format":"date-time","type":"string"},"location":{"description":"Participant location","type":"string"},"mac_addr":{"description":"Participant MAC Address","type":"string"},"network_type":{"description":"Participant network type","type":"string"},"pc_name":{"description":"Participant PC name","type":"string"},"recording":{"description":"Participant record","type":"boolean"},"share_application":{"description":"Did participant share application","type":"boolean"},"share_desktop":{"description":"Did participant share desktop","type":"boolean"},"share_whiteboard":{"description":"Did participant share whiteboard","type":"boolean"},"user_id":{"description":"Participant ID","format":"uuid","type":"string"},"user_name":{"description":"Participant display name","type":"string"},"version":{"description":"Participant version","type":"string"}}},"type":"array"}}}]}},"application/xml":{"schema":{"allOf":[{"$ref":"#/components/schemas/PaginationToken"},{"properties":{"participants":{"description":"Array of user objects","items":{"properties":{"device":{"description":"Participant device","type":"string"},"domain":{"description":"Participant domain","type":"string"},"harddisk_id":{"description":"Participant hard disk id","type":"string"},"id":{"description":"Participant UUID","format":"uuid","type":"string"},"ip_address":{"description":"Participant IP Address","type":"string"},"join_time":