Logo
Zoom Public API Documentation

Use in-meeting controls

PATCH {{baseUrl}}/live_meetings/:meetingId/events

Control in-meeting features. In-meeting controls include starting and stopping a recording, pausing and resuming a recording, and inviting participants.

Note: This API's recording control only works for cloud recordings. It does not work for local recordings.

Prerequisites: * The meeting must be a live meeting except inviting participants to the meeting through [call out (phone)/(room system)]. * Recording control: Cloud recording must be enabled on the account. * The user calling this API must be the host or an alternative meeting host.

Scopes: meeting:write,meeting:write:admin,meeting:master

Rate Limit Label: Medium

 

Body PARAM

Key Datatype Required Description 



HEADERS

Key Datatype Required Description 
Content-Type
string




RESPONSES

status





Curl
curl -X PATCH 'https://api.zoom.us/v2/live_meetings/:meetingId/events' -H 'Content-Type: application/json' -d '{"method":"\u003cstring\u003e","params":{"contacts":[{"email":"\u003cstring\u003e","id":"\u003cstring\u003e"},{"email":"\u003cstring\u003e","id":"\u003cstring\u003e"}],"invitee_name":"\u003cstring\u003e","phone_number":"\u003cstring\u003e","invite_options":{"require_greeting":true,"require_pressing_one":true},"call_type":"\u003cstring\u003e","device_ip":"\u003cstring\u003e","h323_headers":{"from_display_name":"\u003cstring\u003e","to_display_name":"\u003cstring\u003e"},"sip_headers":{"from_display_name":"\u003cstring\u003e","to_display_name":"\u003cstring\u003e","from_uri":"\u003cstring\u003e","additional_headers":[{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"key":"\u003cstring\u003e","value":"\u003cstring\u003e"}]}}}'

ENDPOINTS