{
"swagger": "2.0",
"info": {
"title": "Zoom REST API",
"description": "API Description",
"contact": {
"name": "Zoom Developers",
"url": "https://zoom.us/developer",
"email": "developer@zoom.us"
},
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
},
"version": "1.0.0"
},
"host": "api.zoom.us",
"basePath": "/v1",
"schemes": [
"https"
],
"consumes": [
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml"
],
"paths": {
"/chat/get": {
"post": {
"description": "Get chat messages for a specified period.\n\n",
"tags": [
"Chat"
],
"operationId": "chatGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "access_token",
"required": true,
"description": "Archived chat messages access token. Admin who has the view privilege of Archived chat messages will get it."
},
{
"in": "formData",
"type": "string",
"name": "session_id",
"required": true,
"description": "Session Id of chat messages."
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 30 records."
},
{
"in": "formData",
"type": "string",
"name": "next_page_token",
"description": "Used to paginate through large result sets. A next page token will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"session_id": "unique_id",
"group_name": "zoom",
"from": "2016-01-16",
"to": "2016-01-22",
"page_size": 30,
"page_count": 1,
"next_page_token": "",
"chat_messages": [
{
"message": "test1",
"sender": "",
"date_time": "2016-01-18T06:40:56Z"
}
]
}
}
}
}
}
},
"/chat/list": {
"post": {
"description": "Get chat history list for a specified time period.\n\n",
"tags": [
"Chat"
],
"operationId": "chatList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "access_token",
"required": true,
"description": "Archived chat messages access token. Admin who has the view privilege of Archived chat messages will get it."
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 30 records."
},
{
"in": "formData",
"type": "string",
"name": "email",
"description": "Email query condition."
},
{
"in": "formData",
"type": "string",
"name": "next_page_token",
"description": "Used to paginate through large result sets. A next page token will be returned whenever the set of available chat history list exceeds 100. The expiration period is 30 minutes."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2016-01-16",
"to": "2016-01-22",
"page_size": 30,
"page_count": 1,
"next_page_token": "",
"chat_list": [
{
"session_id": "unique_id",
"type": "Group",
"participants": "",
"group_name": "zoom test1",
"last_message_send_time": "2016-01-18T06:40:56Z"
}
]
}
}
}
}
}
},
"/group/create": {
"post": {
"description": "Create a group on Zoom, return the new group info.\n\n",
"tags": [
"Group"
],
"operationId": "groupCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "name",
"required": true,
"description": "Group name, must be unique in one account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "New Group Test",
"total_members": 0
}
}
}
}
}
},
"/group/delete": {
"post": {
"description": "Delete a group on Zoom, return the deleted group ID.\n\n",
"tags": [
"Group"
],
"operationId": "groupDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2015-08-20T08:41:58Z",
"deleted_count": 1
}
}
}
}
}
},
"/group/edit": {
"post": {
"description": "Edit a group on Zoom, return the new group info.\n\n",
"tags": [
"Group"
],
"operationId": "groupEdit",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "name",
"description": "Group name, must be unique in one account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "New Group Test",
"total_members": 0
}
}
}
}
}
},
"/group/get": {
"post": {
"description": "Get a group on Zoom via ID, return the group info.\n\n",
"tags": [
"Group"
],
"operationId": "groupGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "Group Test",
"total_members": 2
}
}
}
}
}
},
"/group/list": {
"post": {
"description": "List all groups on your Zoom account.\n\n",
"tags": [
"Group"
],
"operationId": "groupList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "api_key",
"required": true,
"description": "Your API Key"
},
{
"in": "formData",
"type": "string",
"name": "api_secret",
"required": true,
"description": "Your API Secret"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"total_records": 1,
"groups": [
{
"group_id": "unique_id",
"account_id": "unique_id",
"name": "Group Test1",
"total_members": 40
}
]
}
}
}
}
}
},
"/group/member/add": {
"post": {
"description": "Add members to a group on Zoom.\n\n",
"tags": [
"Group"
],
"operationId": "groupMemberAdd",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "member_ids",
"required": true,
"description": "The member IDs, separated by comma"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"add_at": "2015-08-20T08:57:38Z",
"add_count": 2
}
}
}
}
}
},
"/group/member/delete": {
"post": {
"description": "Delete members of a group on Zoom.\n\n",
"tags": [
"Group"
],
"operationId": "groupMemberDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "member_ids",
"required": true,
"description": "The member IDs, separated by comma"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2015-08-20T08:57:38Z",
"deleted_count": 2
}
}
}
}
}
},
"/group/member/list": {
"post": {
"description": "Lists the members of a group on Zoom.\n\n",
"tags": [
"Group"
],
"operationId": "groupMemberList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"members": [
{
"id": "unique_id",
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton",
"pic_url": "https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569"
}
]
}
}
}
}
}
},
"/h323/device/create": {
"post": {
"description": "Create a H.323/SIP Device on your Zoom account.\n\n",
"tags": [
"Device"
],
"operationId": "deviceDeviceCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "name",
"required": true,
"description": "Display Name."
},
{
"in": "formData",
"type": "string",
"name": "ip",
"required": true,
"description": "IP Address or H.323 Extension."
},
{
"in": "formData",
"type": "string",
"name": "protocol_type",
"default": "1",
"description": "Protocol type. 1 means H.323, 2 means SIP."
},
{
"in": "formData",
"type": "string",
"name": "encryption_type",
"default": "2",
"description": "Encryption type. 0 means No, 1 means Yes, 2 means Auto."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"name": "New Device",
"ip": "192.168.1.10",
"protocol_type": 1,
"encryption_type": 2
}
}
}
}
}
},
"/h323/device/delete": {
"post": {
"description": "Delete a H.323/SIP Device on your Zoom account.\n\n",
"tags": [
"Device"
],
"operationId": "deviceDeviceDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Device ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2017-03-14T09:27:15Z"
}
}
}
}
}
},
"/h323/device/list": {
"post": {
"description": "List H.323/SIP Devices on your Zoom account.\n\n",
"tags": [
"Device"
],
"operationId": "deviceDeviceList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"devices": [
{
"id": "unique_id",
"name": "New Device",
"ip": "192.168.1.10",
"protocol_type": 1,
"encryption_type": 2
}
]
}
}
}
}
}
},
"/h323/device/update": {
"post": {
"description": "Update a H.323/SIP Device on your Zoom account.\n\n",
"tags": [
"Device"
],
"operationId": "deviceDeviceUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Device ID."
},
{
"in": "formData",
"type": "string",
"name": "name",
"description": "Display Name."
},
{
"in": "formData",
"type": "string",
"name": "ip",
"description": "IP Address or H.323 Extension."
},
{
"in": "formData",
"type": "string",
"name": "protocol_type",
"default": "1",
"description": "Protocol type. 1 means H.323, 2 means SIP."
},
{
"in": "formData",
"type": "string",
"name": "encryption_type",
"default": "2",
"description": "Encryption type. 0 means No, 1 means Yes, 2 means Auto."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2017-03-14T09:27:03Z"
}
}
}
}
}
},
"/im/group/create": {
"post": {
"description": "Create a IM group on Zoom, return the new group info.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "name",
"required": true,
"description": "Group name, must be unique in one account."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "Normal",
"description": "Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_domain",
"default": false,
"description": "Others in the same email domain can search members."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_account",
"default": false,
"description": "Others under same account can search members."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_ma",
"default": false,
"description": "Others under same master account, including all sub accounts can search members."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "New Group Test",
"total_members": 0,
"option_search_by_domain": false,
"option_search_by_account": false,
"option_search_by_ma_account": false
}
}
}
}
}
},
"/im/group/delete": {
"post": {
"description": "Delete a IM group on Zoom, return the deleted group ID.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2015-08-20T08:41:58Z",
"deleted_count": 1
}
}
}
}
}
},
"/im/group/edit": {
"post": {
"description": "Edit a IM group on Zoom, return the new group info.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupEdit",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "name",
"description": "Group name, must be unique in one account."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "Normal",
"description": "Group type, Normal: normal group, Restricted: Restricted group, Shared: Shared group."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_domain",
"default": false,
"description": "Others in the same email domain can search members."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_account",
"default": false,
"description": "Others under same account can search members."
},
{
"in": "formData",
"type": "boolean",
"name": "option_search_by_ma",
"default": false,
"description": "Others under same master account, including all sub accounts can search members."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "New Group Test",
"total_members": 0,
"option_search_by_domain": false,
"option_search_by_account": true,
"option_search_by_ma_account": false
}
}
}
}
}
},
"/im/group/get": {
"post": {
"description": "Get a IM group on Zoom via ID, return the group info.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"group_id": "unique_id",
"account_id": "unique_id",
"name": "Group Test",
"total_members": 2,
"option_search_by_domain": false,
"option_search_by_account": true,
"option_search_by_ma_account": false
}
}
}
}
}
},
"/im/group/list": {
"post": {
"description": "List all IM groups on your Zoom account.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "api_key",
"required": true,
"description": "Your API Key"
},
{
"in": "formData",
"type": "string",
"name": "api_secret",
"required": true,
"description": "Your API Secret"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"total_records": 1,
"groups": [
{
"group_id": "unique_id",
"account_id": "unique_id",
"name": "Group Test1",
"total_members": 40,
"option_search_by_domain": false,
"option_search_by_account": true,
"option_search_by_ma_account": false,
"last_modified_time": "2016-04-16T07:45:41Z"
}
]
}
}
}
}
}
},
"/im/group/member/delete": {
"post": {
"description": "Delete members of a IM group on Zoom.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupMemberDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "member_ids",
"required": true,
"description": "The member IDs, separated by comma"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2015-08-20T08:57:38Z",
"deleted_count": 2
}
}
}
}
}
},
"/im/group/member/list": {
"post": {
"description": "Lists the members of a IM group on Zoom.\n\n",
"tags": [
"IM Group"
],
"operationId": "imGroupGroupMemberList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Group ID."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"members": [
{
"id": "unique_id",
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton",
"pic_url": "https://ssotest.zoom.us/p/6EoubcvJR7eF2grNXJkrHA/f2003a9c-3095-4865-8536-03cc6f211e86-9569"
}
]
}
}
}
}
}
},
"/ma/account/billing/update": {
"post": {
"description": "Update Billing Information for a sub account of the master account on Zoom.\n\n",
"tags": [
"Account"
],
"operationId": "accountBillingUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "Sold To Contact’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "Sold To Contact’s last name."
},
{
"in": "formData",
"type": "string",
"name": "phone_number",
"description": "Sold To Contact’s phone number."
},
{
"in": "formData",
"type": "string",
"name": "address",
"description": "Sold To Contact’s address."
},
{
"in": "formData",
"type": "string",
"name": "apt",
"description": "Sold To Contact’s Apt/Suite."
},
{
"in": "formData",
"type": "string",
"name": "city",
"description": "Sold To Contact’s city."
},
{
"in": "formData",
"type": "string",
"name": "country",
"description": "Sold To Contact’s country. For this parameter value please refer to the id value in country list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "state",
"description": "Sold To Contact’s state. If country value is \"US\" or \"CA\", for this parameter value please refer to the id value in state list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "zip",
"description": "Sold To Contact’s zip/postal."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id ",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/create": {
"post": {
"description": "Create a sub account of the master account on Zoom, return the created sub account id and owner id.\n\n\n\n\n\n",
"tags": [
"Account"
],
"operationId": "accountCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"required": true,
"description": "User’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"required": true,
"description": "User’s last name."
},
{
"in": "formData",
"type": "string",
"name": "password",
"required": true,
"description": "User’s password."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_rc",
"default": false,
"description": "Enable Share Virtual Room Connector."
},
{
"in": "formData",
"type": "string",
"name": "share_rc",
"description": "Virtual Room Connector, multiple value separated by comma."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_mc",
"default": false,
"description": "Enable Share Meeting Connector."
},
{
"in": "formData",
"type": "string",
"name": "share_mc",
"description": "Meeting Connector, multiple value separated by comma."
},
{
"in": "formData",
"type": "string",
"name": "pay_mode",
"default": "1",
"description": "Who will pay for this account? 0 means Sub Account Holders Pays, 1 means Master Account Holder Pays."
},
{
"in": "formData",
"type": "string",
"name": "collection_method",
"default": "1",
"description": "Collection Method? 0 means Automatic (billing online), 1 means Manual (send invoice)."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_pstn",
"default": true,
"description": "The value should be true or false, by default is true."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enforce_login",
"default": false,
"description": "Only signed-in users can join this meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enforce_login_sd",
"default": false,
"description": "Only signed-in users with specified domains can join meetings."
},
{
"in": "formData",
"type": "string",
"name": "enforce_login_domains",
"description": "Domains of signed-in users."
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"description": "Account’ meeting capacity, max of 100."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cmr_reminder",
"default": false,
"description": "Disable cloud recording reminder."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_only_host_download_cmr",
"default": false,
"description": "Enable Only the host can download cloud recordings."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_same_account_access_cmr",
"default": false,
"description": "Enable Only users on my account can access cloud recordings."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"owner_id": "unique_id",
"owner_email": "email_address",
"created_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/delete": {
"post": {
"description": "Delete the sub account.\n\n",
"tags": [
"Account"
],
"operationId": "accountDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/get": {
"post": {
"description": "Get a sub account of the master account on Zoom, return the created sub account id and owner id.\n\n\n\n\n\n",
"tags": [
"Account"
],
"operationId": "accountGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"owner_id": "unique_id",
"owner_email": "email_address",
"created_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/list": {
"post": {
"description": "List all the sub account under the master account.\n\n",
"tags": [
"Account"
],
"operationId": "accountList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "api_key",
"required": true,
"description": "Your API Key"
},
{
"in": "formData",
"type": "string",
"name": "api_secret",
"required": true,
"description": "Your API Secret"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 3,
"subAccounts": [
{
"id": "unique_id",
"owner_email": "email_address",
"created_at": "2015-01-27T140508Z"
}
]
}
}
}
}
}
},
"/ma/account/plan/add": {
"post": {
"description": "Add a plan for a sub account of the master account on Zoom.\n\n\n\n\n\n",
"tags": [
"Account"
],
"operationId": "accountPlanAdd",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
},
{
"in": "formData",
"type": "string",
"name": "plan",
"required": true,
"description": "Additional Plan. See [Plans](#plans) for more details"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/plan/get": {
"post": {
"description": "Get plans information for a sub account of the master account on Zoom.\n\n",
"tags": [
"Account"
],
"operationId": "accountPlanGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton",
"phone_number": "123456789",
"address": "address",
"apt": "apt",
"city": "city",
"state": "state",
"zip": "12345",
"country": "country",
"plan_base": {
"type": "monthly",
"hosts": 9
},
"plan_zoom_rooms": {
"type": "zroom_monthly",
"hosts": 9
},
"plan_room_connector": {
"type": "roomconnector_yearly",
"hosts": 9
},
"plan_large_meeting": [
{
"type": "large100_monthly",
"hosts": 9
},
{
"type": "large200_monthly",
"hosts": 9
},
{
"type": "large300_yearly",
"hosts": 9
},
{
"type": "large500_yearly",
"hosts": 9
}
],
"plan_webinar": [
{
"type": "webinar100_monthly",
"hosts": 9
},
{
"type": "webinar500_yearly",
"hosts": 9
},
{
"type": "webinar1000_yearly",
"hosts": 9
},
{
"type": "webinar3000_monthly",
"hosts": 9
},
{
"type": "webinar5000_monthly",
"hosts": 9
},
{
"type": "webinar10000_monthly",
"hosts": 9
}
],
"plan_recording": "cmr_monthly_commitment_500",
"plan_audio": {
"type": "tollfree_monthly_commitment_100",
"tollfree_country": "AT",
"premium_country": "TW",
"callout": 1,
"ddi_numbers": 66
}
}
}
}
}
}
},
"/ma/account/plan/subscribe": {
"post": {
"description": "Subscribe plans for a sub account of the master account on Zoom.\n\n",
"tags": [
"Account"
],
"operationId": "accountPlanSubscribe",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"required": true,
"description": "Sold To Contact’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"required": true,
"description": "Sold To Contact’s last name."
},
{
"in": "formData",
"type": "string",
"name": "phone_number",
"required": true,
"description": "Sold To Contact’s phone number."
},
{
"in": "formData",
"type": "string",
"name": "address",
"required": true,
"description": "Sold To Contact’s address."
},
{
"in": "formData",
"type": "string",
"name": "apt",
"description": "Sold To Contact’s Apt/Suite."
},
{
"in": "formData",
"type": "string",
"name": "city",
"required": true,
"description": "Sold To Contact’s city."
},
{
"in": "formData",
"type": "string",
"name": "country",
"required": true,
"description": "Sold To Contact’s country. For this parameter value please refer to the id value in country list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "state",
"required": true,
"description": "Sold To Contact’s state. If country value is \"US\" or \"CA\", for this parameter value please refer to the id value in state list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "zip",
"required": true,
"description": "Sold To Contact’s zip/postal."
},
{
"in": "formData",
"type": "string",
"name": "plan_base",
"required": true,
"description": "Base Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_zoom_rooms",
"description": "Additional Zoom Rooms Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_room_connector",
"description": "Additional H.323/SIP Room Connector Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_large_meeting",
"description": "Additional Large Meeting Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_webinar",
"description": "Additional Webinar Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_recording",
"description": "Additional Cloud Recording Plan. See [Plans](#plans) for more details"
},
{
"in": "formData",
"type": "string",
"name": "plan_audio",
"description": "Additional Audio Conferencing Plan. See [Plans](#plans) for more details"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton",
"phone_number": "123456789",
"address": "address",
"apt": "apt",
"city": "city",
"state": "state",
"zip": "12345",
"country": "country",
"plan_base": {
"type": "monthly",
"hosts": 9
},
"plan_zoom_rooms": {
"type": "zroom_monthly",
"hosts": 9
},
"plan_room_connector": {
"type": "roomconnector_yearly",
"hosts": 9
},
"plan_large_meeting": [
{
"type": "large200_monthly",
"hosts": 9
},
{
"type": "large300_yearly",
"hosts": 9
},
{
"type": "large500_yearly",
"hosts": 9
}
],
"plan_webinar": [
{
"type": "webinar100_monthly",
"hosts": 9
},
{
"type": "webinar500_yearly",
"hosts": 9
},
{
"type": "webinar1000_yearly",
"hosts": 9
},
{
"type": "webinar3000_monthly",
"hosts": 9
},
{
"type": "webinar5000_monthly",
"hosts": 9
},
{
"type": "webinar10000_monthly",
"hosts": 9
}
],
"plan_recording": "cmr_monthly_commitment_500",
"plan_audio": {
"type": "tollfree_monthly_commitment_100",
"tollfree_country": "AT",
"premium_country": "TW",
"callout": 1,
"ddi_numbers": 66
}
}
}
}
}
}
},
"/ma/account/plan/update": {
"post": {
"description": "Update a plan for a sub account of the master account on Zoom.\n\n\n\n\n\n",
"tags": [
"Account"
],
"operationId": "accountPlanUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "1",
"description": "Plan Type. 1 means Base Plan, 2 means Additional Plan."
},
{
"in": "formData",
"type": "string",
"name": "plan",
"required": true,
"description": "A Base Plan or an Additional Plan. See [Plans](#plans) for more details"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "w40hUJRpRmmkx4uPXczdHg",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/ma/account/update": {
"post": {
"description": "Update a sub account of the master account on Zoom, return the updated sub account id.\n\n",
"tags": [
"Account"
],
"operationId": "accountUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "account_id",
"required": true,
"description": "The sub account ID."
},
{
"in": "formData",
"type": "string",
"name": "enable_share_rc",
"description": "Enable Share Virtual Room Connector."
},
{
"in": "formData",
"type": "string",
"name": "share_rc",
"description": "Virtual Room Connector, multiple value separated by comma."
},
{
"in": "formData",
"type": "string",
"name": "enable_share_mc",
"description": "Enable Share Meeting Connector."
},
{
"in": "formData",
"type": "string",
"name": "share_mc",
"description": "Meeting Connector, multiple value separated by comma."
},
{
"in": "formData",
"type": "string",
"name": "pay_mode",
"description": "Who will pay for this account? 0 means Sub Account Holders Pays, 1 means Master Account Holder Pays."
},
{
"in": "formData",
"type": "string",
"name": "collection_method",
"description": "Collection Method? 0 means Automatic (billing online), 1 means Manual (send invoice)."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_pstn",
"default": true,
"description": "The value should be true or false, by default is true."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_call_out",
"default": false,
"description": "The value should be true or false. If it is true, the user under this account will follow MA call out type."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enforce_login",
"default": false,
"description": "Only signed-in users can join this meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enforce_login_sd",
"default": false,
"description": "Only signed-in users with specified domains can join meetings."
},
{
"in": "formData",
"type": "string",
"name": "enforce_login_domains",
"description": "Domains of signed-in users."
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"description": "Account’ meeting capacity, max of 100."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cmr_reminder",
"default": false,
"description": "Disable cloud recording reminder."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_only_host_download_cmr",
"default": false,
"description": "Enable Only the host can download cloud recordings."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_same_account_access_cmr",
"default": false,
"description": "Enable Only users on my account can access cloud recordings."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/mc/recording/list": {
"post": {
"description": "Lists all the cloud recordings meetings on a Meeting Connector\n\n",
"tags": [
"Cloud Recording"
],
"operationId": "mcRecordingList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
},
{
"in": "formData",
"type": "string",
"name": "meeting_number",
"description": "The meeting number."
},
{
"in": "formData",
"type": "string",
"name": "from",
"description": "The meeting start time after this date, MM/dd/yyyy hh:mm a. For example: 11/05/2014 09:05 pm. Use the host’s time zone, if host has not set time zone, will use GMT."
},
{
"in": "formData",
"type": "string",
"name": "to",
"description": "The meeting start time before this date, MM/dd/yyyy hh:mm a."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 15,
"total_records": 1,
"meetings": [
{
"uuid": "unique_id",
"meeting_number": "123456789",
"host_id": "unique_id",
"account_id": "unique_id",
"topic": "Meeting Topic",
"start_time": "2014-11-06T04:10:10Z",
"timezone": "America/Los_Angeles",
"duration": 999,
"total_size": 4324324324,
"recording_count": 1,
"recording_files": [
{
"id": "unique_id",
"meeting_id": "unique_id",
"recording_start": "2014-11-06T04:14:10Z",
"recording_end": "2014-11-06T04:24:10Z",
"file_type": "M4A",
"file_size": 432432,
"play_url": "https://brand.zoom.us/recording/play/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2",
"download_url": "https://brand.zoom.us/recording/download/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2"
}
]
}
]
}
}
}
}
}
},
"/meeting/create": {
"post": {
"description": "Create a meeting on Zoom, return the created meeting URL\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account. Cannot be updated after creation."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "2",
"description": "Meeting type: 1 means instant meeting (Only used for host to start it as soon as created). 2 means normal scheduled meeting. 3 means a recurring meeting with no fixed time. 8 means a recurring meeting with fixed time."
},
{
"in": "formData",
"type": "string",
"name": "topic",
"required": true,
"description": "Meeting topic. Max of 300 characters."
},
{
"in": "formData",
"type": "string",
"name": "start_time",
"description": "Meeting start time in ISO datetime format. For scheduled meeting and recurring meeting with fixed time. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "duration",
"description": "Meeting duration (minutes). For scheduled meeting only."
},
{
"in": "formData",
"type": "string",
"name": "timezone",
"description": "Timezone to format start_time, like \"America/Los_Angeles\". For scheduled meeting only. For this parameter value please refer to the id value in timezone list JSON file."
},
{
"in": "formData",
"type": "string",
"name": "password",
"default": " 10 characters",
"description": "Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _"
},
{
"in": "formData",
"type": "string",
"name": "recurrence",
"description": "Recurrence Meeting Settings. For recurring meeting with fixed time only. See [Recurrence Object](#recurrence-object) for more details."
},
{
"in": "formData",
"type": "boolean",
"name": "option_registration",
"default": false,
"description": "Registration required."
},
{
"in": "formData",
"type": "string",
"name": "registration_type",
"default": "1",
"description": "Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only."
},
{
"in": "formData",
"type": "boolean",
"name": "option_jbh",
"default": false,
"description": "Join meeting before host start the meeting. Only for scheduled or recurring meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_start_type",
"default": "video",
"description": "Meeting start type. Can be \"video\" or \"screen_share\". (deprecated)"
},
{
"in": "formData",
"type": "boolean",
"name": "option_host_video",
"default": true,
"description": "Start video when host join meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "option_participants_video",
"default": true,
"description": "Start video when participants join meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "option_cn_meeting",
"default": false,
"description": "Host meeting in China."
},
{
"in": "formData",
"type": "boolean",
"name": "option_in_meeting",
"default": false,
"description": "Host meeting in India."
},
{
"in": "formData",
"type": "string",
"name": "option_audio",
"default": "both",
"description": "Meeting audio options. Can be \"both\", \"telephony\", \"voip\"."
},
{
"in": "formData",
"type": "boolean",
"name": "option_enforce_login",
"default": false,
"description": "Only signed-in users can join this meeting."
},
{
"in": "formData",
"type": "string",
"name": "option_enforce_login_domains",
"description": "Only signed-in users with specified domains can join meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_hosts",
"description": "Alternative hosts."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_host_ids",
"description": "Alternative hosts IDs."
},
{
"in": "formData",
"type": "boolean",
"name": "option_use_pmi",
"default": false,
"description": "Use Personal Meeting ID. Only for scheduled meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_auto_record_type",
"default": "local",
"description": "Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this meeting",
"type": 2,
"option_jbh": false,
"option_start_type": "video",
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"password": "123",
"h323_password": "123456",
"option_host_video": false,
"option_participants_video": false,
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": "",
"status": 0
}
}
}
}
}
},
"/meeting/delete": {
"post": {
"description": "Delete a meeting on Zoom, return the deleted meeting ID.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_id",
"description": "Occurrence ID, could get this value from Meeting Get API."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"deleted_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/meeting/end": {
"post": {
"description": "End a meeting on Zoom, return the deleted meeting ID.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingEnd",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"ended_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/meeting/get": {
"post": {
"description": "Get a meeting on Zoom via meeting ID, return the meeting info.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"host_id": "unique_id",
"topic": "Zoom Meeting",
"password": "",
"h323_password": "",
"status": 0,
"option_jbh": false,
"option_start_type": "video",
"option_host_video": true,
"option_participants_video": true,
"option_cn_meeting": false,
"option_enforce_login": false,
"option_enforce_login_domains": "",
"option_in_meeting": false,
"option_audio": "both",
"option_alternative_hosts": "",
"option_use_pmi": false,
"type": 8,
"start_time": "",
"duration": 0,
"timezone": "Asia/Hong_Kong",
"start_url": "https://www.zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://www.zoom.us/j/123456789",
"created_at": "2016-12-20T02:51:42Z",
"occurrences": [
{
"occurrence_id": "1483210260000",
"start_time": "2017-01-01T02:51:00Z",
"duration": 60
}
]
}
}
}
}
}
},
"/meeting/list": {
"post": {
"description": "List all the scheduled meetings on Zoom.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"meetings": [
{
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this meeting",
"type": 2,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"password": "123",
"h323_password": "123456",
"option_jbh": false,
"option_start_type": "video",
"option_host_video": false,
"option_participants_video": false,
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": "",
"status": 0
}
]
}
}
}
}
}
},
"/meeting/live": {
"post": {
"description": "Lists the live meetings on Zoom.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingLive",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "api_key",
"required": true,
"description": "Your API Key"
},
{
"in": "formData",
"type": "string",
"name": "api_secret",
"required": true,
"description": "Your API Secret"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"meetings": [
{
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this meeting",
"type": 2,
"status": 0,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"password": "123",
"h323_password": "123456",
"option_jbh": false,
"option_start_type": "video",
"option_host_video": false,
"option_participants_video": false,
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": ""
}
]
}
}
}
}
}
},
"/meeting/register": {
"post": {
"description": "Register for a meeting.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingRegister",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"required": true,
"description": "User’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"required": true,
"description": "User’s last name."
},
{
"in": "formData",
"type": "string",
"name": "address",
"description": "Address."
},
{
"in": "formData",
"type": "string",
"name": "city",
"description": "City."
},
{
"in": "formData",
"type": "string",
"name": "country",
"description": "Country. For this parameter value please refer to the id value in country list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "zip",
"description": "Zip/Postal Code."
},
{
"in": "formData",
"type": "string",
"name": "state",
"description": "State/Province."
},
{
"in": "formData",
"type": "string",
"name": "phone",
"description": "Phone."
},
{
"in": "formData",
"type": "string",
"name": "industry",
"description": "Industry."
},
{
"in": "formData",
"type": "string",
"name": "org",
"description": "Organization."
},
{
"in": "formData",
"type": "string",
"name": "job_title",
"description": "Job Title."
},
{
"in": "formData",
"type": "string",
"name": "purchasing_time_frame",
"description": "Purchasing Time Frame, should be \"Within a month\", \"1-3 months\", \"4-6 months\", \"More than 6 months\", \"No timeframe\"."
},
{
"in": "formData",
"type": "string",
"name": "role_in_purchase_process",
"description": "Role in Purchase Process, should be \"Decision Maker\", \"Evaluator/Recommender\", \"Influencer\", \"Not involved\"."
},
{
"in": "formData",
"type": "string",
"name": "no_of_employees",
"description": "Number of Employees, should be \"1-20\", \"21-50\", \"51-100\", \"101-250\", \"251-500\", \"501-1,000\", \"1,001-5,000\", \"5,001-10,000\", \"More than 10,000\"."
},
{
"in": "formData",
"type": "string",
"name": "comments",
"description": "Questions & Comments."
},
{
"in": "formData",
"type": "string",
"name": "custom_questions",
"description": "Custom Questions, should be JSON format: [{\"title\":\"field_name1\",\"value\":\"xxx\"},{\"title\":\"field_name2\",\"value\":\"xxx\"}]."
},
{
"in": "formData",
"type": "string",
"name": "language",
"description": "Language setting of email. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_ids",
"description": "Occurrence IDs, could get this value from Meeting Get API."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"registrant_id": "unique_id",
"id": "123456789",
"topic": "meeting registration",
"start_time": "2016-02-21T04:00:00Z",
"join_url": "https://www.zoom.us/w/869275230?tk=2DsQiu6nZVsZVATrPLvXgqPvw8mmKyxgAGaDMizLv34.DQEAAAAAM9AWXhZ2Nm5vRjIyMlRoUzE3ZktWM3l4cHVRAA"
}
}
}
}
}
},
"/meeting/update": {
"post": {
"description": "Update meeting info on Zoom via meeting ID.\n\n",
"tags": [
"Meeting"
],
"operationId": "meetingUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account. Used to retrieve a meeting, cannot be updated."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "2",
"description": "Meeting type: 1 means instant meeting (Only used for host to start it as soon as created). 2 means normal scheduled meeting. 3 means a recurring meeting with no fixed time. 8 means a recurring meeting with fixed time."
},
{
"in": "formData",
"type": "string",
"name": "topic",
"description": "Meeting topic. Max of 300 characters."
},
{
"in": "formData",
"type": "string",
"name": "start_time",
"description": "Meeting start time in ISO datetime format. For scheduled meeting only. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "duration",
"description": "Meeting duration (minutes). For scheduled meeting only."
},
{
"in": "formData",
"type": "string",
"name": "timezone",
"description": "Timezone to format start_time, like \"America/Los_Angeles\". For scheduled meeting only. For this parameter value please refer to the id value in timezone list JSON file."
},
{
"in": "formData",
"type": "string",
"name": "password",
"default": " 10 characters",
"description": "Meeting password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _"
},
{
"in": "formData",
"type": "string",
"name": "recurrence",
"description": "Recurrence Meeting Settings. For recurring meeting with fixed time only. See [Recurrence Object](#recurrence-object) for more details."
},
{
"in": "formData",
"type": "boolean",
"name": "option_registration",
"default": false,
"description": "Registration required."
},
{
"in": "formData",
"type": "string",
"name": "registration_type",
"default": "1",
"description": "Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only."
},
{
"in": "formData",
"type": "boolean",
"name": "option_jbh",
"default": false,
"description": "Join meeting before host start the meeting. Only for scheduled or recurring meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_start_type",
"default": "video",
"description": "Meeting start type. Can be \"video\" or \"screen_share\". (deprecated)"
},
{
"in": "formData",
"type": "boolean",
"name": "option_host_video",
"default": true,
"description": "Start video when host join meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "option_participants_video",
"default": true,
"description": "Start video when participants join meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "option_cn_meeting",
"default": false,
"description": "Host meeting in China."
},
{
"in": "formData",
"type": "boolean",
"name": "option_in_meeting",
"default": false,
"description": "Host meeting in India."
},
{
"in": "formData",
"type": "string",
"name": "option_audio",
"default": "both",
"description": "Meeting audio options. Can be \"both\", \"telephony\", \"voip\"."
},
{
"in": "formData",
"type": "boolean",
"name": "option_enforce_login",
"default": false,
"description": "Only signed-in users can join this meeting."
},
{
"in": "formData",
"type": "string",
"name": "option_enforce_login_domains",
"description": "Only signed-in users with specified domains can join meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_hosts",
"description": "Alternative hosts."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_host_ids",
"description": "Alternative hosts IDs."
},
{
"in": "formData",
"type": "boolean",
"name": "option_use_pmi",
"default": false,
"description": "Use Personal Meeting ID. Only for scheduled meetings."
},
{
"in": "formData",
"type": "string",
"name": "option_auto_record_type",
"default": "local",
"description": "Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/metrics/crc": {
"post": {
"description": "Get CRC Port usage hour by hour for a specified time period.\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardCrc",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2015-03-12",
"to": "2015-03-12",
"crc_ports_usage": [
{
"date_time": "2015-03-12",
"crc_ports_hour_usage": [
{
"hour": "00",
"max_usage": 1,
"total_usage": 3
}
]
}
]
}
}
}
}
}
},
"/metrics/im": {
"post": {
"description": "Get statistics of Zoom IM\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardIm",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 30 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2016-04-12",
"to": "2016-04-13",
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 10,
"users": [
{
"user_id": "unique_id",
"user_name": "Zoomie Userton",
"email": "email_address",
"total_send": 0,
"total_receive": 0,
"group_send": 0,
"group_receive": 0,
"calls_send": 0,
"calls_receive": 0,
"files_send": 0,
"files_receive": 0,
"images_send": 0,
"images_receive": 0,
"voice_send": 0,
"voice_receive": 0,
"videos_send": 0,
"videos_receive": 0,
"emoji_send": 0,
"emoji_receive": 0
}
]
}
}
}
}
}
},
"/metrics/meetingdetail": {
"post": {
"description": "Get live and past meeting details\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardMeetingdetail",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "meeting_id",
"required": true,
"description": "The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03"
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "Meeting type. 1 means live meeting. 2 means past meeting."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 100 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"type": "Past Meeting",
"host": "Zoomie Userton",
"email": "email_address",
"user_type": "Pro",
"start_time": "2015-08-30T05:36:56Z",
"end_time": "2015-08-30T06:36:56Z",
"duration": "4 mins",
"has_pstn": false,
"has_voip": true,
"has_3rd_party_audio": false,
"has_video": true,
"has_screen_share": false,
"recording": 0,
"participants_count": 2,
"page_count": 1,
"page_number": 1,
"page_size": 30,
"participants": [
{
"id": "unique_id",
"user_id": "unique_id",
"user_name": "Zoomie Userton",
"device": "Mac",
"ip_address": "117.83.222.228",
"cn": "CN",
"city": "Nanjing",
"network_type": "Wifi",
"join_time": "2017-02-18T01:44:47Z",
"leave_time": "2017-02-18T01:45:58Z",
"share_application": true,
"share_desktop": true,
"share_whiteboard": true,
"recording": true
}
]
}
}
}
}
}
},
"/metrics/meetings": {
"post": {
"description": "Get Live Meetings and past meetings for a specified period\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardMeetings",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "1",
"description": "Meeting list type. 1 means live meetings. 2 means past meetings."
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date. Only for past meetings."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date. Only for past meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 100 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2015-08-02",
"to": "2015-09-02",
"page_count": 2,
"page_number": 1,
"page_size": 30,
"total_records": 49,
"type": "Past Meetings",
"meetings": [
{
"uuid": "unique_id",
"id": "123456789",
"host": "Zoomie Userton",
"email": "email_address",
"user_type": "Pro",
"start_time": "2015-08-29T05:36:56Z",
"end_time": "2015-08-29T06:36:56Z",
"duration": "4 mins",
"participants": 2,
"has_pstn": false,
"has_voip": true,
"has_3rd_party_audio": false,
"has_video": true,
"has_screen_share": false,
"recording": 0
}
]
}
}
}
}
}
},
"/metrics/qos": {
"post": {
"description": "Get the users quality of service in a Zoom Meeting\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardQos",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "meeting_id",
"required": true,
"description": "The meeting ID."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "Meeting type. 1 means live meeting. 2 means past meeting."
},
{
"in": "formData",
"type": "string",
"name": "user_id",
"description": "The user ID to get user qos."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "10",
"description": "The amount of records returns within a single API call. Defaults to 10. Max of 10 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"meeting_id": "unique_id",
"user_id": "unique_id",
"type": "Past Meeting",
"device": "Mac",
"ip_address": "112.80.63.6",
"cn": "CN",
"city": "Nanjing",
"version": "3.5.35288.1217",
"user_qos": [
{
"dateTime": "2015-08-30T06:40:56Z",
"audio_input": {
"bitrate": "29 kbps",
"latency": "39 ms",
"jitter": "11 ms",
"avg_loss": "2.5%",
"max_loss": "5.0%"
},
"audio_output": {
"bitrate": "",
"latency": "",
"jitter": "",
"avg_loss": "",
"max_loss": ""
},
"video_input": {
"bitrate": "77 kbps",
"latency": "84 ms",
"jitter": "4 ms",
"avg_loss": "28.3%",
"max_loss": "28.3%",
"resolution": "480*270",
"frame_rate": "3 fps"
},
"video_output": {
"bitrate": "",
"latency": "",
"jitter": "",
"avg_loss": "",
"max_loss": "",
"resolution": "",
"frame_rate": ""
},
"as_input": {
"bitrate": "",
"latency": "",
"jitter": "",
"avg_loss": "",
"max_loss": "",
"resolution": "",
"frame_rate": ""
},
"as_output": {
"bitrate": "",
"latency": "",
"jitter": "",
"avg_loss": "",
"max_loss": "",
"resolution": "",
"frame_rate": ""
},
"cpu_usage": {
"zoom_min_cpu_usage": "1%",
"zoom_avg_cpu_usage": "3%",
"zoom_max_cpu_usage": "5%",
"system_max_cpu_usage": "20%"
}
}
]
}
}
}
}
}
},
"/metrics/webinardetail": {
"post": {
"description": "Get live and past webinar details\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardWebinardetail",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "meeting_id",
"required": true,
"description": "The meeting ID Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03"
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "Meeting type. 1 means live webinar. 2 means past webinar."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 100 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"type": "Past Webinar",
"host": "Zoomie Userton",
"email": "email_address",
"user_type": "Pro",
"start_time": "2015-08-30T05:36:56Z",
"end_time": "2015-08-30T06:36:56Z",
"duration": "4 mins",
"has_pstn": false,
"has_voip": true,
"has_3rd_party_audio": false,
"has_video": true,
"has_screen_share": false,
"recording": 0,
"participants_count": 2,
"page_count": 1,
"page_number": 1,
"page_size": 30,
"participants": [
{
"id": "unique_id",
"user_id": "unique_id",
"user_name": "Zoomie Userton",
"device": "Mac",
"ip_address": "117.83.222.228",
"cn": "CN",
"city": "Nanjing",
"network_type": "Wifi",
"join_time": "2017-02-18T01:44:47Z",
"leave_time": "2017-02-18T01:45:58Z",
"share_application": true,
"share_desktop": true,
"share_whiteboard": true,
"recording": true
}
]
}
}
}
}
}
},
"/metrics/webinars": {
"post": {
"description": "Get live webinars and past webinars for a specified period.\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardWebinars",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "1",
"description": "Webinar list type. 1 means live webinars. 2 means past webinars."
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date. Only for past webinars."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date. Only for past webinars."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 100 webinars."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2015-08-02",
"to": "2015-09-02",
"page_count": 2,
"page_number": 1,
"page_size": 30,
"total_records": 49,
"type": "Past Webinars",
"meetings": [
{
"uuid": "unique_id",
"id": "123456789",
"host": "Zoomie Userton",
"email": "email_address",
"user_type": "Pro",
"start_time": "2015-08-29T05:36:56Z",
"end_time": "2015-08-29T06:36:56Z",
"duration": "4 mins",
"participants": 2,
"has_pstn": false,
"has_voip": true,
"has_3rd_party_audio": false,
"has_video": true,
"has_screen_share": false,
"recording": 0
}
]
}
}
}
}
}
},
"/metrics/zoomroomdetail": {
"post": {
"description": "Get a Zoom Room on Zoom via Zoom ID, return the Zoom Room info.\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardZoomroomdetail",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "The zoom room ID. Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03"
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 30 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2016-04-12",
"to": "2016-04-13",
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"zoom_room": {
"id": "unique_id",
"room_name": "zoom room",
"email": "zoomroom@zoom.us",
"account_type": "Work Email",
"passcode": "123",
"status": "Available",
"messages": {
"last_started_time": "",
"running_time": "",
"selected_microphone": "",
"selected_speaker": "",
"selected_camera": ""
},
"meeting_id": ""
},
"live_meeting": {
"uuid": "",
"id": 0,
"host": "",
"email": "",
"user_type": "",
"start_time": "",
"end_time": "",
"duration": "",
"participants": 0,
"has_pstn": false,
"has_voip": false,
"has_3rd_party_audio": false,
"has_video": false,
"has_screen_share": false,
"recording": 0
},
"past_meetings": [
{
"uuid": "unique_id",
"id": "123456789",
"host": "Zoomie Userton",
"email": "email_address",
"user_type": "",
"start_time": "",
"end_time": "",
"duration": "",
"participants": 1,
"has_pstn": false,
"has_voip": false,
"has_3rd_party_audio": false,
"has_video": false,
"has_screen_share": false,
"recording": 0
}
]
}
}
}
}
}
},
"/metrics/zoomrooms": {
"post": {
"description": "List all Zoom Rooms on Zoom.\n\n",
"tags": [
"Dashboard"
],
"operationId": "dashboardZoomrooms",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 30 records."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 2,
"zoom_rooms": [
{
"id": "unique_id",
"room_name": "zoom room1",
"email": "zoomroom1@zoom.us",
"account_type": "Work Email",
"passcode": "123",
"status": "Available",
"messages": {
"last_started_time": "",
"running_time": "",
"selected_microphone": "",
"selected_speaker": "",
"selected_camera": ""
},
"meeting_id": ""
}
]
}
}
}
}
}
},
"/recording/delete": {
"post": {
"description": "Delete recorded meeting either on Zoom cloud or on-premise.\n\n",
"tags": [
"Cloud Recording"
],
"operationId": "recordingDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "meeting_id",
"required": true,
"description": "The meeting ID. Example: ucc69C82Q5mTNyCRWE29Aw== Or B9C73AF4-2F36-4399-9337-2091584DBD03"
},
{
"in": "formData",
"type": "string",
"name": "file_id",
"description": "The file ID, if given this, will only delete this one file, if not given this, will delete all files of the meeting"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deleted_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/recording/get": {
"post": {
"description": "Get the recorded meeting on either Zoom cloud or on-prem.\n\n",
"tags": [
"Cloud Recording"
],
"operationId": "recordingGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "meeting_id",
"required": true,
"description": "The meeting ID."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"meeting_number": "123456789",
"host_id": "unique_id",
"account_id": "unique_id",
"topic": "Meeting Topic",
"start_time": "2015-04-13T01:06:04Z",
"timezone": "UTC",
"duration": 1,
"total_size": 686496,
"recording_count": 3,
"recording_files": [
{
"id": "unique_id",
"meeting_id": "unique_id",
"recording_start": "2015-04-13T01:06:36Z",
"recording_end": "2015-04-13T01:06:47Z",
"file_type": "MP4",
"file_size": 438482,
"play_url": "https://brand.zoom.us/recording/play/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2",
"download_url": "https://brand.zoom.us/recording/download/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2"
}
]
}
}
}
}
}
},
"/recording/list": {
"post": {
"description": "List all the cloud recording meetings on Zoom.\n\n",
"tags": [
"Cloud Recording"
],
"operationId": "recordingList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Meeting host user ID. Can be any user under this account."
},
{
"in": "formData",
"type": "string",
"name": "meeting_number",
"description": "The meeting number."
},
{
"in": "formData",
"type": "string",
"name": "from",
"description": "The meeting start time after this date, MM/dd/yyyy hh:mm a. For example: 11/05/2014 09:05 pm. Use the host’s time zone, if host has not set time zone, will use GMT."
},
{
"in": "formData",
"type": "string",
"name": "to",
"description": "The meeting start time before this date, MM/dd/yyyy hh:mm a."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 15,
"total_records": 1,
"meetings": [
{
"uuid": "unique_id",
"meeting_number": "123456789",
"host_id": "unique_id",
"account_id": "unique_id",
"topic": "Meeting Topic",
"start_time": "2014-11-06T04:10:10Z",
"timezone": "America/Los_Angeles",
"duration": 999,
"total_size": 4324324324,
"recording_count": 1,
"recording_files": [
{
"id": "unique_id",
"meeting_id": "unique_id",
"recording_start": "2014-11-06T04:14:10Z",
"recording_end": "2014-11-06T04:24:10Z",
"file_type": "M4A",
"file_size": 432432,
"status" : "completed",
"play_url": "https://brand.zoom.us/recording/play/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2",
"download_url": "https://brand.zoom.us/recording/download/HzMyuI23bqxlJLVJLrww3L9ZuFeZEvYtG0vQ6pHhp6Twr6GPjX4Qks_CJak7jrU2"
}
]
}
]
}
}
}
}
}
},
"/report/getaccountreport": {
"post": {
"description": "Get account report for a specified period.\n\n",
"tags": [
"Report"
],
"operationId": "reportGetaccountreport",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 5,
"from": "2013-5-19",
"to": "2013-5-20",
"total_meetings": 50,
"total_participants": 100,
"total_meeting_minutes": 100,
"users": [
{
"user_id": "bNsPi5hCQ-qOzWn2EeCXJA",
"email": "john@sample.com",
"type": 2,
"meetings": 10,
"participants": 56,
"meeting_minutes": 300,
"last_client_version": "1.0.18584.0225",
"last_login_time": "2013-02-11T08:18:09Z"
}
]
}
}
}
}
}
},
"/report/getaudioreport": {
"post": {
"description": "Get user report for a specified period.\n\n\n\n\n\n",
"tags": [
"Report"
],
"operationId": "reportGetaudioreport",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "1",
"description": "Audio type: 1 means Toll-free Call-in & Call-out. 2 means Toll."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"from": "2016-01-08",
"to": "2016-01-21",
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"telephony_usage": [
{
"meeting_id": 2932547621,
"phone_number": "+86 8208",
"type": "call-out",
"host_name": "test",
"host_email": "zoom.test@zoom.us",
"department": "",
"start_time": "2016-01-12T02:25:34Z",
"end_time": "2016-01-12T02:26:48Z",
"duration": 2,
"total": 0.12
}
]
}
}
}
}
}
},
"/report/getdailyreport": {
"post": {
"description": "Get daily report for one month, can only get daily report for recent 3 months.\n\n",
"tags": [
"Report"
],
"operationId": "reportGetdailyreport",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "year",
"required": true,
"description": "Year for this report."
},
{
"in": "formData",
"type": "string",
"name": "month",
"required": true,
"description": "Month for this report."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"year": 2013,
"month": 5,
"dates": [
{
"meetings": 0,
"date": "2013-05-01",
"new_user": 0,
"participants": 0,
"meeting_minutes": 0
}
]
}
}
}
}
}
},
"/report/getuserreport": {
"post": {
"description": "Get user report for a specified period.\n\n",
"tags": [
"Report"
],
"operationId": "reportGetuserreport",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "user_id",
"required": true,
"description": "The user to generate the report."
},
{
"in": "formData",
"type": "string",
"name": "from",
"required": true,
"description": "Start date."
},
{
"in": "formData",
"type": "string",
"name": "to",
"required": true,
"description": "End date."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 5,
"from": "2013-5-19",
"to": "2013-5-20",
"meetings": [
{
"number": 111111111,
"topic": "Meeting Topic",
"start_time": "2013-02-11T08:18:09Z",
"end_time": "2013-02-11T09:18:09Z",
"duration": 60,
"participants": [
{
"name": "John",
"join_time": "2013-02-11T08:30:09Z",
"leave_time": "2013-02-11T08:50:09Z"
}
]
}
]
}
}
}
}
}
},
"/user/assistant/delete": {
"post": {
"description": "Delete a user's assistant.\n\n",
"tags": [
"User"
],
"operationId": "userAssistantDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"description": "The host’s user id."
},
{
"in": "formData",
"type": "string",
"name": "host_email",
"description": "The host’s email address."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"host_email": "email_address",
"updated_at": "2013-09-02T12:00:00Z"
}
}
}
}
}
},
"/user/assistant/set": {
"post": {
"description": "Set a user's assistant which can schedule meeting for him.\n\n",
"tags": [
"User"
],
"operationId": "userAssistantSet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"description": "The host’s user id."
},
{
"in": "formData",
"type": "string",
"name": "host_email",
"description": "The host’s email address. "
},
{
"in": "formData",
"type": "string",
"name": "assistant_email",
"required": true,
"description": "The assistant’s email address."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"host_email": "email_address",
"updated_at": "2013-09-02T12:00:00Z"
}
}
}
}
}
},
"/user/autocreate": {
"post": {
"description": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n",
"tags": [
"User"
],
"operationId": "userAutocreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return"
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "User’s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting"
},
{
"in": "formData",
"type": "string",
"name": "password",
"required": true,
"description": "User's password"
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "User's first name"
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "User's last name"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_chat",
"default": false,
"description": "Disable in-meeting chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_e2e_encryption",
"default": false,
"description": "Enable end-to-end encryption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_silent_mode",
"default": false,
"description": "Enable attendee on-hold"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_group_hd",
"default": false,
"description": "Disable Group HD"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_recording",
"default": false,
"description": "Disable recording"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cmr",
"default": false,
"description": "Enable cloud meeting record"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_recording",
"default": false,
"description": "Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cloud_auto_recording",
"default": false,
"description": "Enable cloud automatic recording"
},
{
"in": "formData",
"type": "string",
"name": "track_id",
"description": "Referral partner track ID"
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"default": "0",
"description": "User’s meeting capacity, 0 means following account’s meeting capacity"
},
{
"in": "formData",
"type": "string",
"name": "enable_webinar",
"description": "Enable webinar feature"
},
{
"in": "formData",
"type": "string",
"name": "webinar_capacity",
"default": "0",
"description": "Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "string",
"name": "enable_large",
"description": "Enable large meting feature"
},
{
"in": "formData",
"type": "string",
"name": "large_capacity",
"default": "0",
"description": "Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_feedback",
"default": false,
"description": "Disable feedback"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_jbh_reminder",
"default": false,
"description": "Disable jbh email reminder"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_breakout_room",
"default": false,
"description": "Enable breakout room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_polling",
"default": false,
"description": "Enable polling for meeting"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_annotation",
"default": true,
"description": "Enable Annotation"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_dual_camera",
"default": false,
"description": "Enable Share dual camera"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_far_end_camera_control",
"default": false,
"description": "Enable Far end camera control"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_private_chat",
"default": false,
"description": "Disable Private chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enter_exit_chime",
"default": false,
"description": "Enable Enter/exit chime"
},
{
"in": "formData",
"type": "string",
"name": "option_enter_exit_chime_type",
"default": "0",
"description": "Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cancel_meeting_notification",
"default": false,
"description": "Disable email notification when a meeting is cancelled"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_remote_support",
"default": false,
"description": "Enable Remote support"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_file_transfer",
"default": false,
"description": "Enable File transfer"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_virtual_background",
"default": false,
"description": "Enable Virtual background"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_attention_tracking",
"default": false,
"description": "Enable Attention tracking"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_waiting_room",
"default": false,
"description": "Enable Waiting room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_closed_caption",
"default": false,
"description": "Enable Closed caption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_co_host",
"default": false,
"description": "Enable Co-host"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_saving_chats",
"default": false,
"description": "Enable Auto saving chats"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_phone_participants_password",
"default": false,
"description": "Enable Generate and require password for participants joining by phone"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_delete_cmr",
"default": false,
"description": "Enable Auto delete cloud recordings"
},
{
"in": "formData",
"type": "string",
"name": "auto_delete_cmr_days",
"description": "Auto delete cloud recordings after days"
},
{
"in": "formData",
"type": "string",
"name": "dept",
"description": "Department for user profile, use for repor"
},
{
"in": "formData",
"type": "string",
"name": "group_id",
"description": "User Group ID. If set default user group, the parameter’s default value is the default user group"
},
{
"in": "formData",
"type": "string",
"name": "imgroup_id",
"description": "IM Group ID. If set default im group, the parameter’s default value is the default im group"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"pic_url": "",
"type": 1,
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 1,
"pmi": 2035134243,
"meeting_capacity": 0,
"enable_webinar": false,
"webinar_capacity": 0,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"enable_share_dual_camera": false,
"enable_far_end_camera_control": false,
"disable_private_chat": false,
"enable_enter_exit_chime": false,
"disable_cancel_meeting_notification": false,
"enable_remote_support": false,
"enable_file_transfer": false,
"enable_virtual_background": false,
"enable_attention_tracking": false,
"enable_waiting_room": false,
"enable_closed_caption": false,
"enable_co_host": false,
"enable_auto_saving_chats": false,
"enable_phone_participants_password": false,
"enable_auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"dept": "Engineer",
"lastClientVersion": "",
"lastLoginTime": "",
"token": "",
"zpk": "",
"zak": ""
}
}
}
}
}
},
"/user/checkemail": {
"post": {
"description": "Check if the user email exists.\n\n",
"tags": [
"User"
],
"operationId": "userCheckemail",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "User email."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"existed_email": true
}
}
}
}
}
},
"/user/checkzpk": {
"post": {
"description": "Check if the zpk is expired. The zpk is used to authenticate a user.\n\n",
"tags": [
"User"
],
"operationId": "userCheckzpk",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "zpk",
"required": true,
"description": "User zpk."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"expire_in": 7187
}
}
}
}
}
},
"/user/create": {
"post": {
"description": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n",
"tags": [
"User"
],
"operationId": "userCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return"
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "User’s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting"
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "User's first name"
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "User's last name"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_chat",
"default": false,
"description": "Disable in-meeting chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_e2e_encryption",
"default": false,
"description": "Enable end-to-end encryption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_silent_mode",
"default": false,
"description": "Enable attendee on-hold"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_group_hd",
"default": false,
"description": "Disable Group HD"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_recording",
"default": false,
"description": "Disable recording"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cmr",
"default": false,
"description": "Enable cloud meeting record"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_recording",
"default": false,
"description": "Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cloud_auto_recording",
"default": false,
"description": "Enable cloud automatic recording"
},
{
"in": "formData",
"type": "string",
"name": "track_id",
"description": "Referral partner track ID"
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"default": "0",
"description": "User’s meeting capacity, passing 0 will inherit account’s meeting capacity"
},
{
"in": "formData",
"type": "string",
"name": "enable_webinar",
"description": "Enable webinar feature"
},
{
"in": "formData",
"type": "string",
"name": "webinar_capacity",
"default": "0",
"description": "Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "string",
"name": "enable_large",
"description": "Enable large meting feature"
},
{
"in": "formData",
"type": "string",
"name": "large_capacity",
"default": "0",
"description": "Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_feedback",
"default": false,
"description": "Disable feedback"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_jbh_reminder",
"default": false,
"description": "Disable jbh email reminder"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_breakout_room",
"default": false,
"description": "Enable breakout room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_polling",
"default": false,
"description": "Enable polling for meeting"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_annotation",
"default": true,
"description": "Enable Annotation"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_dual_camera",
"default": false,
"description": "Enable Share dual camera"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_far_end_camera_control",
"default": false,
"description": "Enable Far end camera control"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_private_chat",
"default": false,
"description": "Disable Private chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enter_exit_chime",
"default": false,
"description": "Enable Enter/exit chime"
},
{
"in": "formData",
"type": "string",
"name": "option_enter_exit_chime_type",
"default": "0",
"description": "Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cancel_meeting_notification",
"default": false,
"description": "Disable email notification when a meeting is cancelled"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_remote_support",
"default": false,
"description": "Enable Remote support"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_file_transfer",
"default": false,
"description": "Enable File transfer"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_virtual_background",
"default": false,
"description": "Enable Virtual background"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_attention_tracking",
"default": false,
"description": "Enable Attention tracking"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_waiting_room",
"default": false,
"description": "Enable Waiting room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_closed_caption",
"default": false,
"description": "Enable Closed caption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_co_host",
"default": false,
"description": "Enable Co-host"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_saving_chats",
"default": false,
"description": "Enable Auto saving chats"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_phone_participants_password",
"default": false,
"description": "Enable Generate and require password for participants joining by phone"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_delete_cmr",
"default": false,
"description": "Enable Auto delete cloud recordings"
},
{
"in": "formData",
"type": "string",
"name": "auto_delete_cmr_days",
"description": "Auto delete cloud recordings after days"
},
{
"in": "formData",
"type": "string",
"name": "dept",
"description": "Department for user profile, use for repor"
},
{
"in": "formData",
"type": "string",
"name": "group_id",
"description": "User Group ID. If set default user group, the parameter’s default value is the default user group"
},
{
"in": "formData",
"type": "string",
"name": "imgroup_id",
"description": "IM Group ID. If set default im group, the parameter’s default value is the default im group"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoom",
"last_name": "User",
"pic_url": "",
"type": 1,
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 1,
"pmi": 2035134243,
"meeting_capacity": 0,
"enable_webinar": false,
"webinar_capacity": 0,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"enable_share_dual_camera": false,
"enable_far_end_camera_control": false,
"disable_private_chat": false,
"enable_enter_exit_chime": false,
"disable_cancel_meeting_notification": false,
"enable_remote_support": false,
"enable_file_transfer": false,
"enable_virtual_background": false,
"enable_attention_tracking": false,
"enable_waiting_room": false,
"enable_closed_caption": false,
"enable_co_host": false,
"enable_auto_saving_chats": false,
"enable_phone_participants_password": false,
"enable_auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"dept": "Engineer",
"lastClientVersion": "",
"lastLoginTime": "",
"token": "",
"zpk": "",
"zak": ""
}
}
}
}
}
},
"/user/custcreate": {
"post": {
"description": "Create a user on Zoom, returns the created user ID.\n\n\n\n\n\n",
"tags": [
"User"
],
"operationId": "userCustcreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address. It must be unique in Zoom service. If an email address is existed, a \"user existing\" error message will be return"
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "User’s type. 1 for basic user, 2 for pro user, 3 for corp user. Basic user can host up to 40 minutes meeting"
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "User's first name"
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "User's last name"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_chat",
"default": false,
"description": "Disable in-meeting chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_e2e_encryption",
"default": false,
"description": "Enable end-to-end encryption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_silent_mode",
"default": false,
"description": "Enable attendee on-hold"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_group_hd",
"default": false,
"description": "Disable Group HD"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_recording",
"default": false,
"description": "Disable recording"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cmr",
"default": false,
"description": "Enable cloud meeting record"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_recording",
"default": false,
"description": "Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cloud_auto_recording",
"default": false,
"description": "Enable cloud automatic recording"
},
{
"in": "formData",
"type": "string",
"name": "track_id",
"description": "Referral partner track ID"
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"default": "0",
"description": "User’s meeting capacity, 0 means following account’s meeting capacity"
},
{
"in": "formData",
"type": "string",
"name": "enable_webinar",
"description": "Enable webinar feature"
},
{
"in": "formData",
"type": "string",
"name": "webinar_capacity",
"default": "0",
"description": "Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "string",
"name": "enable_large",
"description": "Enable large meting feature"
},
{
"in": "formData",
"type": "string",
"name": "large_capacity",
"default": "0",
"description": "Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_feedback",
"default": false,
"description": "Disable feedback"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_jbh_reminder",
"default": false,
"description": "Disable jbh email reminder"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_breakout_room",
"default": false,
"description": "Enable breakout room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_polling",
"default": false,
"description": "Enable polling for meeting"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_annotation",
"default": true,
"description": "Enable Annotation"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_dual_camera",
"default": false,
"description": "Enable Share dual camera"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_far_end_camera_control",
"default": false,
"description": "Enable Far end camera control"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_private_chat",
"default": false,
"description": "Disable Private chat"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enter_exit_chime",
"default": false,
"description": "Enable Enter/exit chime"
},
{
"in": "formData",
"type": "string",
"name": "option_enter_exit_chime_type",
"default": "0",
"description": "Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only"
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cancel_meeting_notification",
"default": false,
"description": "Disable email notification when a meeting is cancelled"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_remote_support",
"default": false,
"description": "Enable Remote support"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_file_transfer",
"default": false,
"description": "Enable File transfer"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_virtual_background",
"default": false,
"description": "Enable Virtual background"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_attention_tracking",
"default": false,
"description": "Enable Attention tracking"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_waiting_room",
"default": false,
"description": "Enable Waiting room"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_closed_caption",
"default": false,
"description": "Enable Closed caption"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_co_host",
"default": false,
"description": "Enable Co-host"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_saving_chats",
"default": false,
"description": "Enable Auto saving chats"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_phone_participants_password",
"default": false,
"description": "Enable Generate and require password for participants joining by phone"
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_delete_cmr",
"default": false,
"description": "Enable Auto delete cloud recordings"
},
{
"in": "formData",
"type": "string",
"name": "auto_delete_cmr_days",
"description": "Auto delete cloud recordings after days"
},
{
"in": "formData",
"type": "string",
"name": "dept",
"description": "Department for user profile, use for repor"
},
{
"in": "formData",
"type": "string",
"name": "group_id",
"description": "User Group ID. If set default user group, the parameter’s default value is the default user group"
},
{
"in": "formData",
"type": "string",
"name": "imgroup_id",
"description": "IM Group ID. If set default im group, the parameter’s default value is the default im group"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"pic_url": "",
"type": 1,
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 1,
"pmi": 2035134243,
"meeting_capacity": 0,
"enable_webinar": false,
"webinar_capacity": 0,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"enable_share_dual_camera": false,
"enable_far_end_camera_control": false,
"disable_private_chat": false,
"enable_enter_exit_chime": false,
"disable_cancel_meeting_notification": false,
"enable_remote_support": false,
"enable_file_transfer": false,
"enable_virtual_background": false,
"enable_attention_tracking": false,
"enable_waiting_room": false,
"enable_closed_caption": false,
"enable_co_host": false,
"enable_auto_saving_chats": false,
"enable_phone_participants_password": false,
"enable_auto_delete_cmr": true,
"auto_delete_cmr_days": 30,
"dept": "Engineer",
"lastClientVersion": "",
"lastLoginTime": "",
"token": "",
"zpk": "",
"zak": ""
}
}
}
}
}
},
"/user/activate": {
"post": {
"description": "Activate a user on Zoom, return the user ID.\n\n",
"tags": [
"User"
],
"operationId": "userActivate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User id."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"activated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/user/deactivate": {
"post": {
"description": "Deactivate a user on Zoom, return the user ID.\n\n",
"tags": [
"User"
],
"operationId": "userDeactivate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User id."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"deactivated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/user/delete": {
"post": {
"description": "Delete a user on Zoom, return the deleted user ID.\n\n",
"tags": [
"User"
],
"operationId": "userDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User id."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "0",
"description": "0 means existing user, 1 means pending user."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"account_id": " unique_id",
"deleted_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/user/get": {
"post": {
"description": "Get a user info on Zoom via user ID\n\n",
"tags": [
"User"
],
"operationId": "userGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "api_key",
"required": true,
"description": "API Key"
},
{
"in": "formData",
"type": "string",
"name": "api_secret",
"required": true,
"description": "API Secret"
},
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User ID"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"id": "unique_id",
"account_id": "8af3444232345",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"type": 1,
"token": "adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf",
"pic_url": "https://www.zoom.us/p/bNsPi",
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_record_speaker_view": false,
"enable_record_gallery_view": false,
"enable_record_audio_file": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 1,
"pmi": 2035134243,
"vanity_url": "https://zoom.us/my/test",
"meeting_capacity": 0,
"enable_webinar": true,
"webinar_capacity": 100,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"dept": "Engineer",
"timezone": "America/Los_Angeles",
"lastClientVersion": "3.5.44664.0321(mac)",
"lastLoginTime": "2016-03-23T09:54:41Z",
"status": 0,
"zpk": "ABzyF_DKLzVcPd-5Wu6zCwlZ3978jn7ZcTHONHrP7Vs.BwYAAAFTY-4XnwAAHCAkMTRlMzRjYzUtMjJmZC00MTQ1LTg2MzUtZmVmYjk3ZDI0NGMyFlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE",
"zak": "eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjbGllbnQiLCJ1aWQiOiJXWGpRbkRNRVFzdWNVNXYxWXlIV0lBIiwiaXNzIjoid2ViIiwic3R5IjoxMDAsImNsdCI6MCwic3RrIjoiUGpuNXItSEJVb0tXd2lBQVFOR1FndnFKNWVLY19zV1l3VHBHNjdJQm00SS5CZ1FnVDI5S1RtSkdWMkozU1ZwQ2QxcFJaV292YWpodU1FMHdlVVZFWlN0MkwzQkFaVEkzWm1SbVpETTRaakpoWWpZeU16UTJPV1U1TjJFME9UTXlZVGt5T1dVMk5UZzJOak5tTldKa09EVXpOVEZoTUdZeVkyTm1aVE01TVdFek0yWm1NUUFnZFVvemNIQndjRnA1WTBaSFYybEZjbTFoYlZwSEt6VTRkMFprY2pWS1VXOEEiLCJleHAiOjE1MjYyNzQ1NzUsImlhdCI6MTUyNjI2NzM3NSwiYWlkIjoiWG1XeGlnZFVSZWVnTW9ibHY3d3FUQSIsImNpZCI6IiJ9.oMMmw50xEfD2IVaSfxap1OlSbczto-KAM"
}
}
}
}
}
},
"/user/getbyemail": {
"post": {
"description": "Get a user on Zoom via user email address and login type, return the user info.\n\n",
"tags": [
"User"
],
"operationId": "userGetbyemail",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "Email, String"
},
{
"in": "formData",
"type": "string",
"name": "login_type",
"required": true,
"description": "Login type of the email, int SNS_FACEBOOK = 0; SNS_GOOGLE = 1; SNS_API = 99; SNS_ZOOM = 100; SNS_SSO = 101;"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"type": 1,
"token": "adlfjadslfkjasdkljfkjalkadfskjdsafkjdfsajkllajsdfaljsdf",
"pic_url": "https://www.zoom.us/p/bNsPi",
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_record_speaker_view": false,
"enable_record_gallery_view": false,
"enable_record_audio_file": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 1,
"pmi": 2035134243,
"vanity_url": "https://zoom.us/my/test",
"meeting_capacity": 0,
"enable_webinar": true,
"webinar_capacity": 100,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"dept": "Engineer",
"lastClientVersion": "3.5.44664.0321(mac)",
"lastLoginTime": "2016-03-23T09:54:41Z",
"status": 0,
"zpk": "ABzyF_DKLzVcPd-5Wu6zCwlZ3978jn7ZcTHONHrP7Vs.BwYAAAFTY-4XnwAAHCAkMTRlMzRjYzUtMjJmZC00MTQ1LTg2MzUtZmVmYjk3ZDI0NGMyFlYydzlQTzgxUl8yS1pmREtvTWVybVEWVjJ3OVBPODFSXzJLWmZES29NZXJtUQxzb3BoaWUgc3VuNjZkALM0VUVtMTFHTmh3cGFTWlJNMGkxYjhXSXNIZEIzbXZ0VlZwOGg0Q1Jhb1B3LkJnSWdUMjlLVG1KR1YySjNTVnBDZDFwUlpXb3Zhamh1TUUwd2VVVkVaU3QyTDNCQVpUSTNabVJtWkRNNFpqSmhZall5TXpRMk9XVTVOMkUwT1RNeVlUa3lPV1UyTlRnMk5qTm1OV0prT0RVek5URmhNR1l5WTJObVpUTTVNV0V6TTJabU1RQQAAFi1YZ0gzWVg2VDNTZmRqVEI5dEJLMXcAAgE",
"zak": "eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJjbGllbnQiLCJ1aWQiOiJXWGpRbkRNRVFzdWNVNXYxWXlIV0lBIiwiaXNzIjoid2ViIiwic3R5IjoxMDAsImNsdCI6MCwic3RrIjoiUGpuNXItSEJVb0tXd2lBQVFOR1FndnFKNWVLY19zV1l3VHBHNjdJQm00SS5CZ1FnVDI5S1RtSkdWMkozU1ZwQ2QxcFJaV292YWpodU1FMHdlVVZFWlN0MkwzQkFaVEkzWm1SbVpETTRaakpoWWpZeU16UTJPV1U1TjJFME9UTXlZVGt5T1dVMk5UZzJOak5tTldKa09EVXpOVEZoTUdZeVkyTm1aVE01TVdFek0yWm1NUUFnZFVvemNIQndjRnA1WTBaSFYybEZjbTFoYlZwSEt6VTRkMFprY2pWS1VXOEEiLCJleHAiOjE1MjYyNzQ1NzUsImlhdCI6MTUyNjI2NzM3NSwiYWlkIjoiWG1XeGlnZFVSZWVnTW9ibHY3d3FUQSIsImNpZCI6IiJ9.oMMmw50xEfD2IVaSfxap1OlSbczto-KAM"
}
}
}
}
}
},
"/user/list": {
"post": {
"description": "List all the users on Zoom\n\n",
"tags": [
"User"
],
"operationId": "userList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Max of 300 users."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"users": [
{
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"type": 1,
"pic_url": "https://www.zoom.us/p/bNsPi",
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 0,
"pmi": 2035134243,
"meeting_capacity": 0,
"enable_webinar": true,
"webinar_capacity": 100,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": false,
"dept": "Engineer",
"timezone": "America/Los_Angeles",
"lastClientVersion": "3.5.44664.0321(mac)",
"lastLoginTime": "2016-03-23T09:54:41Z",
"status": 0,
"token": "",
"zpk": "",
"zak": ""
}
]
}
}
}
}
}
},
"/user/pending": {
"post": {
"description": "List all the pending users on Zoom\n\n",
"tags": [
"User"
],
"operationId": "userPending",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Max of 300 users."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"users": [
{
"email": "email_address",
"id": "unique_id",
"created_at": "2012-11-25T12:00:00Z",
"first_name": "Zoomie",
"last_name": "Userton",
"type": 1,
"pic_url": "https://www.zoom.us/p/bNsPi",
"disable_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": false,
"enable_cmr": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 0,
"pmi": 2035134243,
"meeting_capacity": 0,
"enable_webinar": true,
"webinar_capacity": 100,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": true,
"enable_breakout_room": false,
"dept": "Engineer",
"timezone": "America/Los_Angeles",
"lastClientVersion": "3.5.44664.0321(mac)",
"lastLoginTime": "2016-03-23T09:54:41Z",
"status": 0,
"token": "",
"zpk": "",
"zak": ""
}
]
}
}
}
}
}
},
"/user/permanentdelete": {
"post": {
"description": "Delete a user from Zoom system permanently.\n\n",
"tags": [
"User"
],
"operationId": "userPermanentdelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"description": "The user’s user id."
},
{
"in": "formData",
"type": "string",
"name": "email",
"description": "The user’s email address. Must have id or email, if given id, the email is ignored."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"email": "email_address",
"deleted_at": "2013-09-02T12:00:00Z"
}
}
}
}
}
},
"/user/revoketoken": {
"post": {
"description": "Revoke a user's SSO token.\n\n",
"tags": [
"User"
],
"operationId": "userRevoketoken",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"description": "The SSO user’s user id."
},
{
"in": "formData",
"type": "string",
"name": "email",
"description": "The SSO user’s email address."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"email": "email_address",
"updated_at": "2013-09-02T12:00:00Z"
}
}
}
}
}
},
"/user/scheduleforhost/list": {
"post": {
"description": "List assigned schedule privilege for host users.\n\n",
"tags": [
"User"
],
"operationId": "userScheduleforhostList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"description": "The host’s user id."
},
{
"in": "formData",
"type": "string",
"name": "host_email",
"description": "The host’s email address."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"total_records": 1,
"users": [
{
"id": "unique_id",
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton"
}
]
}
}
}
}
}
},
"/user/ssocreate": {
"post": {
"description": "Create a SSO user on Zoom, return the created user ID.\n\n\n\n",
"tags": [
"User"
],
"operationId": "userSsocreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address. It must be unique in Zoom service."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"description": "User’s type. 1 means it is a basic user. 2 means a pro user, 3 means a corp user. Basic user can host up to 40 minutes meeting."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "User’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "User’s last name."
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"default": "0",
"description": "User’s meeting capacity, 0 means following account’s meeting capacity."
},
{
"in": "formData",
"type": "string",
"name": "enable_webinar",
"description": "Enable webinar feature true or false."
},
{
"in": "formData",
"type": "string",
"name": "webinar_capacity",
"default": "0",
"description": "Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not."
},
{
"in": "formData",
"type": "string",
"name": "enable_large",
"description": "Enable large meting feature true or false."
},
{
"in": "formData",
"type": "string",
"name": "large_capacity",
"default": "0",
"description": "Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not."
},
{
"in": "formData",
"type": "string",
"name": "pmi",
"description": "Personal Meeting ID, long, length must be 10."
},
{
"in": "formData",
"type": "string",
"name": "group_id",
"description": "User Group ID. If set default user group, the parameter’s default value is the default user group."
},
{
"in": "formData",
"type": "string",
"name": "imgroup_id",
"description": "IM Group ID. If set default im group, the parameter’s default value is the default im group."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"email": "email_address",
"first_name": "Zoomie",
"last_name": "Userton",
"pic_url": "",
"type": 2,
"disable_chat": true,
"disable_private_chat": false,
"enable_e2e_encryption": false,
"enable_silent_mode": true,
"disable_group_hd": false,
"disable_recording": true,
"enable_cmr": false,
"enable_record_speaker_view": false,
"enable_record_gallery_view": false,
"enable_record_audio_file": false,
"enable_auto_recording": false,
"enable_cloud_auto_recording": false,
"verified": 0,
"pmi": 0,
"vanity_url": "https://abc.zoom.us/my/test126",
"meeting_capacity": 0,
"enable_webinar": true,
"webinar_capacity": 100,
"enable_large": false,
"large_capacity": 0,
"disable_feedback": false,
"disable_jbh_reminder": false,
"enable_breakout_room": true,
"enable_polling": false,
"enable_annotation": false,
"dept": "Engineer",
"timezone": "",
"created_at": "2015-03-12T05:45:45Z",
"lastClientVersion": "",
"lastLoginTime": "",
"token": "",
"zpk": "",
"zak": ""
}
}
}
}
}
},
"/user/update": {
"post": {
"description": "Update user info on Zoom via user ID.\n\n",
"tags": [
"User"
],
"operationId": "userUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User id."
},
{
"in": "formData",
"type": "string",
"name": "type",
"description": "User’s type. 1 means it is a basic user. 2 means a pro user, 3 means a corp user. Basic user can host up to 40 minutes meeting."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"description": "User’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"description": "User’s last name."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_chat",
"default": false,
"description": "Disable in-meeting chat."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_e2e_encryption",
"default": false,
"description": "Enable end-to-end encryption."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_silent_mode",
"default": false,
"description": "Enable attendee on-hold."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_group_hd",
"default": false,
"description": "Disable Group HD."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_recording",
"default": false,
"description": "Disable recording."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cmr",
"default": false,
"description": "Enable cloud meeting record."
},
{
"in": "formData",
"type": "string",
"name": "enable_record_speaker_view",
"description": "Enable record the active speaker view."
},
{
"in": "formData",
"type": "string",
"name": "enable_record_gallery_view",
"description": "Enable record the gallery view."
},
{
"in": "formData",
"type": "string",
"name": "enable_record_audio_file",
"description": "Enable record an audio only file."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_recording",
"default": false,
"description": "Enable automatic recording. By default, if \"enable_cloud_auto_recording\" is true, it will become true."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_cloud_auto_recording",
"default": false,
"description": "Enable cloud automatic recording."
},
{
"in": "formData",
"type": "string",
"name": "track_id",
"description": "Referral partner track ID."
},
{
"in": "formData",
"type": "string",
"name": "meeting_capacity",
"default": "0",
"description": "User’s meeting capacity, passing 0 will inherit account’s meeting capacity"
},
{
"in": "formData",
"type": "string",
"name": "enable_webinar",
"description": "Enable webinar feature true or false."
},
{
"in": "formData",
"type": "string",
"name": "webinar_capacity",
"default": "0",
"description": "Enable webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not."
},
{
"in": "formData",
"type": "string",
"name": "enable_large",
"description": "Enable large meting feature true or false."
},
{
"in": "formData",
"type": "string",
"name": "large_capacity",
"default": "0",
"description": "Enable large meeting capacity, can be 100, 200, 300 or 500, depends on if having related webinar capacity plan subscription or not."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_feedback",
"default": false,
"description": "Disable feedback."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_jbh_reminder",
"default": false,
"description": "Disable jbh email reminder."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_breakout_room",
"default": false,
"description": "Enable breakout room."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_polling",
"default": false,
"description": "Enable polling for meeting."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_annotation",
"default": true,
"description": "Enable Annotation."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_share_dual_camera",
"default": false,
"description": "Enable Share dual camera."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_far_end_camera_control",
"default": false,
"description": "Enable Far end camera control."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_private_chat",
"default": false,
"description": "Disable Private chat."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_enter_exit_chime",
"default": false,
"description": "Enable Enter/exit chime."
},
{
"in": "formData",
"type": "string",
"name": "option_enter_exit_chime_type",
"default": "0",
"description": "Enter/exit chime type. 0 means Heard by all including host and attendees, 1 means Heard by host only."
},
{
"in": "formData",
"type": "boolean",
"name": "disable_cancel_meeting_notification",
"default": false,
"description": "Disable email notification when a meeting is cancelled."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_remote_support",
"default": false,
"description": "Enable Remote support."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_file_transfer",
"default": false,
"description": "Enable File transfer."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_virtual_background",
"default": false,
"description": "Enable Virtual background."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_attention_tracking",
"default": false,
"description": "Enable Attention tracking."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_waiting_room",
"default": false,
"description": "Enable Waiting room."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_use_pmi",
"default": false,
"description": "Enable Use Personal Meeting ID for instant meetings."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_closed_caption",
"default": false,
"description": "Enable Closed caption."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_co_host",
"default": false,
"description": "Enable Co-host."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_saving_chats",
"default": false,
"description": "Enable Auto saving chats."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_phone_participants_password",
"default": false,
"description": "Enable Generate and require password for participants joining by phone."
},
{
"in": "formData",
"type": "boolean",
"name": "enable_auto_delete_cmr",
"default": false,
"description": "Enable Auto delete cloud recordings."
},
{
"in": "formData",
"type": "string",
"name": "auto_delete_cmr_days",
"description": "Auto delete cloud recordings after days."
},
{
"in": "formData",
"type": "string",
"name": "pmi",
"description": "Personal Meeting ID, long, length must be 10."
},
{
"in": "formData",
"type": "string",
"name": "dept",
"description": "Department for user profile, use for report."
},
{
"in": "formData",
"type": "string",
"name": "timezone",
"description": "The time zone id for user profile."
},
{
"in": "formData",
"type": "string",
"name": "vanity_name",
"description": "Personal meeting room name."
},
{
"in": "formData",
"type": "string",
"name": "host_key",
"description": "Host Key should be 6-digit number."
},
{
"in": "formData",
"type": "string",
"name": "group_id",
"description": "User Group ID. If set default user group, the parameter’s default value is the default user group."
},
{
"in": "formData",
"type": "string",
"name": "imgroup_id",
"description": "IM Group ID. If set default im group, the parameter’s default value is the default im group."
},
{
"in": "formData",
"type": "string",
"name": "cms_user_id",
"description": "User ID on external CMS"
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/user/updatepassword": {
"post": {
"description": "Upload and update user's profile picture on Zoom via user ID.\n\n",
"tags": [
"User"
],
"operationId": "userUpdatepassword",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "User id."
},
{
"in": "formData",
"type": "string",
"name": "pic_file",
"required": true,
"description": "User picture file, must be a jpg/jpeg file."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "unique_id",
"updated_at": "2013-09-02T12:00:00Z"
}
}
}
}
}
},
"/webinar/attendees/list": {
"post": {
"description": "Get ended webinar attendees\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarAttendeesList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "uuid",
"description": "Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"attendees": [
{
"first_name": "Zoomie",
"last_name": "Userton",
"email": "email_address",
"join_time": "2015-09-18T09:41:39Z",
"leave_time": "2015-09-18T09:42:12Z",
"time_in_session": "8",
"attended": "Yes",
"custom_questions": {
"ssssss": " sssss",
"which one do you like?": "sss"
},
"questions": {
"country": "US",
"address": "1234 Some Street",
"city": "Zoomville"
}
}
]
}
}
}
}
}
},
"/webinar/create": {
"post": {
"description": "Create a webinar on Zoom, return the created webinar start and join URL.\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarCreate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user under this account. Cannot be updated after creation."
},
{
"in": "formData",
"type": "string",
"name": "topic",
"required": true,
"description": "Webinar topic. Max of 300 characters."
},
{
"in": "formData",
"type": "string",
"name": "type",
"required": true,
"default": "5",
"description": "5 webinar, 6 recurrence webinar, 9 recurring webinar(With Fixed Time)"
},
{
"in": "formData",
"type": "string",
"name": "start_time",
"description": "Webinar start time in ISO datetime format. For scheduled webinar only. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "duration",
"description": "Webinar duration (minutes). For scheduled webinar only."
},
{
"in": "formData",
"type": "string",
"name": "timezone",
"description": "Timezone to format start_time, like \"America/Los_Angeles\". For scheduled Webinar only. For this parameter value please refer to the id value in timezone list JSON file."
},
{
"in": "formData",
"type": "string",
"name": "password",
"default": " 10 characters",
"description": "Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _"
},
{
"in": "formData",
"type": "string",
"name": "recurrence",
"description": "Recurrence Webinar Settings. For recurring webinar with fixed time only.
\"type\": Recurrence Webinar Type. 1 means Daily, 2 means Weekly, 3 means Monthly.
\"repeat_interval\": Recurrence Webinar Repeat Interval. Defaults to 1. For a Daily Webinar, max of 90. For a Weekly Webinar, max of 12. For a Monthly Webinar, max of 3.
\"weekly_days\": Recurrence Webinar Occurs on week days, multiple value separated by comma. 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday.
\"monthly_day\": Recurrence Webinar Occurs on a month day. The value range is from 1 to 31.
\"monthly_week\": Recurrence Webinar Occurs on the week of a month. -1 means Last week, 1 means First week, 2 means Second week, 3 means Third week, 4 means Fourth week.
\"monthly_week_day\": Recurrence Webinar Occurs on the week day of a month. A single value: 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday.
\"end_times\": Recurrence Webinar End occurrences times. Defaults to 1. Max of 50.
\"end_date_time\": Recurrence Webinar End Date. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "approval_type",
"default": "2",
"description": "Approval type. 0 means Automatically Approve. 1 means Manually Approve. 2 means No Registration Required."
},
{
"in": "formData",
"type": "string",
"name": "registration_type",
"default": "1",
"description": "Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only."
},
{
"in": "formData",
"type": "string",
"name": "agenda",
"description": "Webinar description."
},
{
"in": "formData",
"type": "string",
"name": "option_audio",
"default": "both",
"description": "Webinar audio options. Can be \"both\", \"telephony\", \"voip\"."
},
{
"in": "formData",
"type": "boolean",
"name": "option_host_video",
"default": true,
"description": "Start video when host join Webinar."
},
{
"in": "formData",
"type": "boolean",
"name": "option_panelist_video",
"default": true,
"description": "Start video when panelist join Webinar."
},
{
"in": "formData",
"type": "boolean",
"name": "option_practice_session",
"default": false,
"description": "Enable Practice Session."
},
{
"in": "formData",
"type": "boolean",
"name": "option_enforce_login",
"default": false,
"description": "Only signed-in users can join this Webinar."
},
{
"in": "formData",
"type": "string",
"name": "option_enforce_login_domains",
"description": "Only signed-in users with specified domains can join Webinar."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_hosts",
"description": "Alternative hosts."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_host_ids",
"description": "Alternative hosts IDs."
},
{
"in": "formData",
"type": "string",
"name": "option_auto_record_type",
"default": "local",
"description": "Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
},
{
"in": "formData",
"type": "string",
"name": "panelists",
"description": "Webinar Panelists, should be JSON format: [{\"name\":\"xxx\",\"email\":\"test1@zoom.us\"}, {\"name\":\"xxx\",\"email\":\"test2@zoom.us\"}]."
},
{
"in": "formData",
"type": "string",
"name": "language",
"description": "Language setting of email to panelists. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"host_id": "unique_id",
"topic": "create webinar via rest api",
"agenda": "",
"status": 0,
"option_start_type": "video",
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": "",
"type": 5,
"start_time": " 2015-02-08T12:50:30Z",
"duration": 0,
"timezone": "America/Los_Angeles",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"registration_url": "",
"created_at": "2015-01-22T07:09:49Z"
}
}
}
}
}
},
"/webinar/delete": {
"post": {
"description": "Delete a webinar on Zoom, return the deleted webinar ID.\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarDelete",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_id",
"description": "Occurrence ID, could get this value from Webinar Get API."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"deleted_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/webinar/end": {
"post": {
"description": "End a Webinar on Zoom, return the deleted Webinar ID\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarEnd",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"ended_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/webinar/get": {
"post": {
"description": "Get a Webinar on Zoom via Webinar ID, return the Webinar info\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarGet",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"registration_url": "",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this meeting",
"type": 5,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"agenda": "",
"option_start_type": "video",
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": "",
"status": 0,
"occurrences": [
{
"occurrence_id": "1483210260000",
"start_time": "2017-01-01T02:51:00Z",
"duration": 60
}
]
}
}
}
}
}
},
"/webinar/list": {
"post": {
"description": "List all registrationless Webinars on Zoom\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"webinars": [
{
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this meeting",
"type": 5,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"agenda": "",
"option_start_type": "video",
"option_audio": "both",
"option_enforce_login": false,
"option_enforce_login_domains ": "",
"option_alternative_hosts": "",
"status": 0
}
]
}
}
}
}
}
},
"/webinar/list/registration": {
"post": {
"description": "List all the upcoming registration-based Webinars on Zoom\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarListRegistration",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30. Max of 300 meetings."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 5,
"total_records": 235,
"page_number": 1,
"page_size": 50,
"webinars": [
{
"uuid": "unique_id",
"id": "123456789",
"start_url": "https://zoom.us/s/123456789?zak=xxxxxx",
"join_url": "https://zoom.us/j/123456789",
"created_at": "2012-11-25T12:00:00Z",
"host_id": "unique_id",
"topic": "Topic for this Webinar",
"type": 5,
"start_time": "2012-11-25T12:00:00Z",
"duration": 30,
"timezone": "America/Los_Angeles",
"agenda": "",
"option_start_type": "video",
"option_audio": "both",
"status": 0
}
]
}
}
}
}
}
},
"/webinar/panelists": {
"post": {
"description": "Get all the Webinar Panelists on Zoom\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarPanelists",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"total_records": 1,
"panelists": [
{
"name": "Zoomie Userton",
"email": "email_address",
"join_url": "https://www.zoom.us/w/552681828?tk=TMnju_IjiU7Fx3eSkrajn2irvyMBNQ4XCW6cutSPntg.DQEAAAAAIPFBZBYwbzhKUUlXVVN3bW9Ed05QUmdvU2hBAA"
}
]
}
}
}
}
}
},
"/webinar/polls": {
"post": {
"description": "Get Ended Webinar Polls\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarPolls",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "uuid",
"description": "Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"uuid": "unique_id",
"start_time": "2017-02-09T07:15:48Z",
"questions": [
{
"name": "Zoomie Userton",
"email": "email_address",
"question_details": [
{
"question": "question?",
"answer": "answer"
}
]
}
]
}
}
}
}
}
},
"/webinar/questions": {
"post": {
"description": "Get Ended Webinar Q&A\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarQuestions",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "uuid",
"description": "Webinar uuid. It can be fetched by /v1/webinar/uuid/list."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"uuid": "unique_id",
"start_time": "2017-02-09T07:15:48Z",
"questions": [
{
"name": "Zoomie Userton",
"email": "email_address",
"question_details": [
{
"question": "question?",
"answer": "answer"
}
]
}
]
}
}
}
}
}
},
"/webinar/register": {
"post": {
"description": "Register for a webinar\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarRegister",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "email",
"required": true,
"description": "A valid email address."
},
{
"in": "formData",
"type": "string",
"name": "first_name",
"required": true,
"description": "User’s first name."
},
{
"in": "formData",
"type": "string",
"name": "last_name",
"required": true,
"description": "User’s last name."
},
{
"in": "formData",
"type": "string",
"name": "address",
"description": "Address."
},
{
"in": "formData",
"type": "string",
"name": "city",
"description": "City."
},
{
"in": "formData",
"type": "string",
"name": "country",
"description": "Country. For this parameter value please refer to the id value in country list JSON file"
},
{
"in": "formData",
"type": "string",
"name": "zip",
"description": "Zip/Postal Code."
},
{
"in": "formData",
"type": "string",
"name": "state",
"description": "State/Province."
},
{
"in": "formData",
"type": "string",
"name": "phone",
"description": "Phone."
},
{
"in": "formData",
"type": "string",
"name": "industry",
"description": "Industry."
},
{
"in": "formData",
"type": "string",
"name": "org",
"description": "Organization."
},
{
"in": "formData",
"type": "string",
"name": "job_title",
"description": "Job Title."
},
{
"in": "formData",
"type": "string",
"name": "purchasing_time_frame",
"description": "Purchasing Time Frame, should be \"Within a month\", \"1-3 months\", \"4-6 months\", \"More than 6 months\", \"No timeframe\"."
},
{
"in": "formData",
"type": "string",
"name": "role_in_purchase_process",
"description": "Role in Purchase Process, should be \"Decision Maker\", \"Evaluator/Recommender\", \"Influencer\", \"Not involved\"."
},
{
"in": "formData",
"type": "string",
"name": "no_of_employees",
"description": "Number of Employees, should be \"1-20\", \"21-50\", \"51-100\", \"101-250\", \"251-500\", \"501-1,000\", \"1,001-5,000\", \"5,001-10,000\", \"More than 10,000\"."
},
{
"in": "formData",
"type": "string",
"name": "comments",
"description": "Questions & Comments."
},
{
"in": "formData",
"type": "string",
"name": "custom_questions",
"description": "Custom Questions, should be JSON format: [{\"title\":\"field_name1\",\"value\":\"xxx\"},{\"title\":\"field_name2\",\"value\":\"xxx\"}]."
},
{
"in": "formData",
"type": "string",
"name": "language",
"description": "Language setting of email. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_ids",
"description": "Occurrence IDs, could get this value from Webinar Get API."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"registrant_id": "unique_id",
"id": "123456789",
"topic": "webinar registration",
"start_time": "2016-02-21T04:00:00Z",
"join_url": "https://www.zoom.us/w/123456789?tk=2DsQiu6nZVsZVATrPLvXgqPvw8mmKyxgAGaDMizLv34.DQEAAAAAM9AWXhZ2Nm5vRjIyMlRoUzE3ZktWM3l4cHVRAA"
}
}
}
}
}
},
"/webinar/registrants/approve": {
"post": {
"description": "Approve pending registrants on Zoom Webinar.\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarRegistrantsApprove",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "registrant_ids",
"required": true,
"description": "Pending approval registrant ids."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "421431292",
"updated_at": "2016-08-18T02:11:40Z"
}
}
}
}
}
},
"/webinar/registrants/list": {
"post": {
"description": "List webinar registrants on Zoom, include pending approval registrants and approved registrants.\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarRegistrantsList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "0",
"description": "0 means pending approval registrants, 1 means approved registrants."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"type": 0,
"users": [
{
"id": "unique_id",
"first_name": "Zoomie",
"last_name": "Userton",
"email": "email_address",
"registration_time": "2016-08-18T01:45:26Z"
}
]
}
}
}
}
}
},
"/webinar/registration": {
"post": {
"description": "Gather Webinar registrants info\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarRegistration",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_id",
"description": "Occurrence ID, could get this value from Webinar Get API."
},
{
"in": "formData",
"type": "string",
"name": "page_size",
"default": "30",
"description": "The amount of records returns within a single API call. Defaults to 30."
},
{
"in": "formData",
"type": "string",
"name": "page_number",
"default": "1",
"description": "Current page number of returned records. Default to 1."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"page_count": 1,
"page_number": 1,
"page_size": 30,
"total_records": 1,
"attendees": [
{
"id": "unique_id",
"first_name": "Zoomie",
"last_name": "Userton",
"create_time": "2015-08-23T03:03:48Z",
"approval": "approved",
"email": "email_address",
"registration_url": "https://api.zoom.us/w/206388466?tk=n8-qbK4ocC73mPjIRlheMksYPxeWAhnktoUZq_xAqg8.DQEAAAAADE088hZKTXcxTllpelFjZXNfNDg0NlNKQ3lRAA"
}
]
}
}
}
}
}
},
"/webinar/registration/cancel": {
"post": {
"description": "Cancel Webinar Registration\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarRegistrationCancel",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
},
{
"in": "formData",
"type": "string",
"name": "occurrence_id",
"description": "Occurrence ID, could get this value from Webinar Get API."
},
{
"in": "formData",
"type": "string",
"name": "registrant_ids",
"required": true,
"description": "Webinar registrant IDs, separated by comma. Max of 15 registrants."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "844495467",
"updated_at": "2016-11-29T01:26:43Z"
}
}
}
}
}
},
"/webinar/update": {
"post": {
"description": "Update Webinar info on Zoom via Webinar ID\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarUpdate",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user under this account. Cannot be updated after creation."
},
{
"in": "formData",
"type": "string",
"name": "topic",
"description": "Webinar topic. Max of 300 characters."
},
{
"in": "formData",
"type": "string",
"name": "type",
"default": "5",
"description": "5 webinar, 6 recurrence webinar, 9 recurring webinar(With Fixed Time)"
},
{
"in": "formData",
"type": "string",
"name": "start_time",
"description": "Webinar start time in ISO datetime format. For scheduled webinar only. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "duration",
"description": "Webinar duration (minutes). For scheduled webinar only."
},
{
"in": "formData",
"type": "string",
"name": "timezone",
"description": "Timezone to format start_time, like \"America/Los_Angeles\". For scheduled Webinar only. For this parameter value please refer to the id value in timezone list JSON file."
},
{
"in": "formData",
"type": "string",
"name": "password",
"default": " 10 characters",
"description": "Webinar password. Password may only contain the following characters: [a-z A-Z 0-9 @ - _"
},
{
"in": "formData",
"type": "string",
"name": "recurrence",
"description": "Recurrence Webinar Settings. For recurring webinar with fixed time only.
\"type\": Recurrence Webinar Type. 1 means Daily, 2 means Weekly, 3 means Monthly.
\"repeat_interval\": Recurrence Webinar Repeat Interval. Defaults to 1. For a Daily Webinar, max of 90. For a Weekly Webinar, max of 12. For a Monthly Webinar, max of 3.
\"weekly_days\": Recurrence Webinar Occurs on week days, multiple value separated by comma. 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday.
\"monthly_day\": Recurrence Webinar Occurs on a month day. The value range is from 1 to 31.
\"monthly_week\": Recurrence Webinar Occurs on the week of a month. -1 means Last week, 1 means First week, 2 means Second week, 3 means Third week, 4 means Fourth week.
\"monthly_week_day\": Recurrence Webinar Occurs on the week day of a month. A single value: 1 means Sunday, 2 means Monday, 3 means Tuesday, 4 means Wednesday, 5 means Thursday, 6 means Friday, 7 means Saturday.
\"end_times\": Recurrence Webinar End occurrences times. Defaults to 1. Max of 50.
\"end_date_time\": Recurrence Webinar End Date. Should be UTC time, such as 2012-11-25T12:00:00Z."
},
{
"in": "formData",
"type": "string",
"name": "approval_type",
"default": "2",
"description": "Approval type. 0 means Automatically Approve. 1 means Manually Approve. 2 means No Registration Required."
},
{
"in": "formData",
"type": "string",
"name": "registration_type",
"default": "1",
"description": "Registration type. 1 means Attendees register once and can attend any of the occurrences, 2 means Attendees need to register for each occurrence to attend, 3 means Attendees register once and can choose one or more occurrences to attend. For recurring meeting with fixed time only."
},
{
"in": "formData",
"type": "string",
"name": "agenda",
"description": "Webinar description."
},
{
"in": "formData",
"type": "string",
"name": "option_audio",
"default": "both",
"description": "Webinar audio options. Can be \"both\", \"telephony\", \"voip\"."
},
{
"in": "formData",
"type": "boolean",
"name": "option_host_video",
"default": true,
"description": "Start video when host join Webinar."
},
{
"in": "formData",
"type": "boolean",
"name": "option_panelist_video",
"default": true,
"description": "Start video when panelist join Webinar."
},
{
"in": "formData",
"type": "string",
"name": "option_practice_session",
"description": "Enable Practice Session."
},
{
"in": "formData",
"type": "boolean",
"name": "option_enforce_login",
"default": false,
"description": "Only signed-in users can join this Webinar."
},
{
"in": "formData",
"type": "string",
"name": "option_enforce_login_domains",
"description": "Only signed-in users with specified domains can join Webinar."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_hosts",
"description": "Alternative hosts."
},
{
"in": "formData",
"type": "string",
"name": "option_alternative_host_ids",
"description": "Alternative hosts IDs."
},
{
"in": "formData",
"type": "string",
"name": "option_auto_record_type",
"default": "local",
"description": "Automatically record type. Can be \"local\", \"cloud\" or \"none\"."
},
{
"in": "formData",
"type": "string",
"name": "panelists",
"description": "Webinar Panelists, should be JSON format: [{\"name\":\"xxx\",\"email\":\"test1@zoom.us\"}, {\"name\":\"xxx\",\"email\":\"test2@zoom.us\"}]."
},
{
"in": "formData",
"type": "string",
"name": "language",
"description": "Language setting of email to panelists. This value should be \"en-US\", \"en\", \"zh-CN\", \"zh\", \"en-ES\", \"es\", \"fr-FR\" or \"fr\"."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"id": "123456789",
"updated_at": "2012-11-25T12:00:00Z"
}
}
}
}
}
},
"/webinar/uuid/list": {
"post": {
"description": "Get ended webinar UUID.\n\n",
"tags": [
"Webinar"
],
"operationId": "webinarUuidList",
"parameters": [
{
"in": "formData",
"type": "string",
"name": "id",
"required": true,
"description": "Webinar ID."
},
{
"in": "formData",
"type": "string",
"name": "host_id",
"required": true,
"description": "Webinar host user ID. Can be any user who enabled webinar under this account."
}
],
"responses": {
"200": {
"description": "Success",
"examples": {
"application/json": {
"webinars": [
{
"uuid": "unique_id",
"start_time": "2015-08-23T03:03:48Z"
}
]
}
}
}
}
}
}
},
"tags": [
{
"name": "User",
"description": "User operations"
},
{
"name": "Meeting",
"description": "Meeting operations"
},
{
"name": "Report",
"description": "Report operations"
},
{
"name": "Group",
"description": "Group operations"
},
{
"name": "IM Group",
"description": "IM Group operations"
},
{
"name": "Webinar",
"description": "Webinar operations"
},
{
"name": "Dashboard",
"description": "Dashboard operations"
},
{
"name": "Cloud Recording",
"description": "Cloud Recording operations"
},
{
"name": "Archived Chat",
"description": "Archived Chat operations"
},
{
"name": "Account",
"description": "Account operations"
},
{
"name": "Device",
"description": "Device operations"
}
],
"externalDocs": {
"description": "Zoom REST API Documentation",
"url": "https://zoom.github.io/api"
},
"securityDefinitions": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "query"
},
"api_secret": {
"type": "apiKey",
"name": "api_secret",
"in": "query"
}
},
"security": [
{
"api_key": []
},
{
"api_secret": []
}
]
}