Zoom Rooms API

The Zoom Rooms APIs let you control Zoom Rooms. The APIs let your app return information such as your account's Zoom Rooms and manage meetings and contacts.

Zoom Rooms APIs

Authentication

Use JWT for authentication to access this API.

Restart

Use this API to restart the Zoom Room client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/zrclient

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "restart"
}
ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringrestartRequired
Restart the Zoom Rooms client.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

List

Use this API to return information about a Zoom Room.

Endpoint:

POST

https://api.zoom.us/v2/rooms/zrlist

Request Body example

{
"jsonrpc": "2.0",
"method": "list",
"params": {
"zr_name": "My Zoom Room"
}
}
ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringlistRequired
Return Zoom Rooms information.
params.zr_namestringThe name of a Zoom Room.

If you do not call this parameter, the API will return all of the account's Zoom Rooms.
params.pageintegerSimilar to pagination, the number of pages returned for the API request, between a value of 1 and up to 10.
params.page_sizeintegerThe number of records returned per page, between a value of 1 and up to 100.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"send_at": "2017-09-26T05:50:29Z",
"data": [
{
"zr_name": "My Zoom Room1",
"zr_id": "63UtYMhSQZaBRPCNRXrD8A"
},
{
"zr_name": "My Zoom Room2",
"zr_id": "295bUg9STYaK-7NKz6KB1g"
}
]
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Leave

Use this API to leave a meeting in progress via the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "leave"
}
ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringleaveRequired
Leave a meeting in progress from Zoom Rooms.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Join a Meeting

Use this API to join a Zoom meeting from the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "join",
"params": {
"meeting_number": 2011092323,
"password": "Aa123",
"force_accept": false,
"callback_url": "https://api.test.zoom.us/callback?token=123"
}
}

Password requirements for meetings:

By default, a meeting password:

  • May only contain the following characters: [a-z, A-Z, 0-9, @, -, _, and *]
  • Have a maximum of 10 characters.
However, if the account owner or the administrator has configured the minimum password requirement settings, the password value provided here must meet those requirements. To view custom password requirements, use the use the Get user settings or Get account settings APIs.

ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringjoinRequired
Join a meeting from Zoom Rooms:
  • If a meeting_number value is provided, join the meeting.
  • If a meeting_number is not provided, start an instant meeting.
params.meeting_numberintegerThe meeting's number.
params.passwordstringThe password to join the meeting.
params.force_acceptBooleanfalseWhether to force a user to immediately join the meeting. If true, this forces the user to leave any current meetings and immediately join the meeting passed in the meeting_number value.
params.callback_urlstringCreate a POST request with a JSON payload once the Zoom Rooms client sends a request with the corresponding response.

For example, the CallbackUrl field would contain the https://api.test.zoom.us/callback?token=test123 URL, the Context-Type field would return the application/json value, and the payload response would contain the {"request_id";: 123, "meeting_number":"1234567890"} value.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Invite

Use this API to invite a contact to use the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "invite",
"params": {
"callee": ["kYAJ5yMfTCe0npL2_w3agw", "jAXKRO6yRZWkdkZxbUuI_Q"]
}
}
ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringmeetingCallRequired
Invite a user via Zoom Rooms client. If the user is currently in a meeting, the contact will receive a prompt to accept the invitation. Otherwise the contact receives an email invitation.
params.calleestringRequired
A comma-separated list of callee user IDs, up to a maximum of 10 callees.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Schedule

Use this API to schedule a meeting using the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "schedule",
"params": {
"password": "Aa123",
"callback_url": "https://api.test.zoom.us/callback?token=123",
"meeting_info": {
"topic": "my meeting",
"start_time": "2017-11-25T12:00:00",
"timezone": "America/Los_Angeles",
"duration": "10",
"settings": {
"join_before_host": false
}
}
}
}

Password requirements for meetings:

By default, a meeting password:

  • May only contain the following characters: [a-z, A-Z, 0-9, @, -, _, and *]
  • Have a maximum of 10 characters.
However, if the account owner or the administrator has configured the minimum password requirement settings, the password value provided here must meet those requirements. To view custom password requirements, use the Get user settings or Get account settings APIs.

ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringmeetingScheduleRequired
Schedule a meeting.
params.meeting_info.topicstringRequired
The meeting's topic, up to 200 characters.
params.passwordstringThe password to join the meeting.
params.callback_urlstringCreate a POST request with a JSON payload once the Zoom Rooms client sends a request with the corresponding response.

For example, the CallbackUrl field would contain the https://api.test.zoom.us/callback?token=test123 URL, the Context-Type field would return the application/json value, and the payload response would contain the {"request_id";: 123, "meeting_number":"1234567890"} value.
params.meeting_info.start_timestringRequired
The meeting's start time, in ISO date-time format. A timezone offset is required unless you pass a timezone value.
params.meeting_info.timezonestringThe meeting's timezone. This parameter is optional if the start_time value includes a timezone offset.
params.meeting_info.durationintegerRequired
The scheduled meeting duration, in minutes. This parameter is only used to schedule meetings.
params.meeting_info.settings.join_before_hostBooleanfalseWhether to allow meeting participants to join before the meeting's host. This parameter is only used for scheduled or recurring meetings.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Cancel

Use this API to cancel a meeting via the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Request Body example

{
"jsonrpc": "2.0",
"method": "cancel",
"params": {
"meeting_info": {
"topic": "my meeting",
"start_time": "2017-11-25T12:00:00Z",
"duration": "10"
}
}
}
ParameterTypeRequiredDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringmeetingCancelRequired
Cancel a meeting.
params.meeting_numberintegerThe meeting's number.
params.meeting_info.topicstringRequired
The meeting's topic, up to 200 characters.
params.meeting_info.start_timestringRequired
The meeting's start time, in ISO date-time format. A timezone offset is required unless you pass a timezone value.
params.meeting_info.timezonestringThe meeting's timezone. This parameter is optional if the start_time value includes a timezone offset.
params.meeting_info.durationintegerRequired
The scheduled meeting duration, in minutes.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

End

Use this API to end a meeting in progress hosted by the Zoom Rooms client.

Endpoint:

POST

https://api.zoom.us/v2/rooms/{roomId}/meetings

Parameters:

ParameterTypeDefault valueDescription
roomIdstringRequired
The Zoom Room ID.

Request Body example

{
"jsonrpc": "2.0",
"method": "end"
}
ParameterTypeDefault valueDescription
jsonrpcstring2.0The JSON-RPC protocol version.
methodstringendRequired
End a meeting.

Response XML:

<?xml version="1.0" encoding="UTF-8"?>

Response JSON

{
"jsonrpc": "2.0",
"result": {
"room_id": "63UtYMhSQZaBRPCNRXrD8A",
"send_at": "2017-09-15T01:26:05Z"
},
"id": "49cf01a4-517e-4a49-b4d6-07237c38b749"
}

Back to Zoom Rooms API list.

Need help?

If you're looking for help, try Developer Support or our Developer Forum. Priority support is also available with Premier Developer Support plans.