Zoom Public API Documentation
Use in-Session events controls
PATCH {{baseUrl}}/videosdk/sessions/:sessionId/events
Use this API to control in-Session events such as the recording controls to start a recording, stop a recording, pause a recording, and resume a recording, and invitation control to invite participants. The recording controls only work for Cloud Recordings and not for local recordings. Prerequisite:
* The session must be a live session.
* Cloud Recording must be enabled for recording controls.
* The user using this API must either be the host or alternative host of the session.
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/videosdk/sessions/:sessionId/events' -H 'Content-Type: application/json' -d '{"method":"recording.start","params":{"invitee_name":"Jill Chill","phone_number":"5550100","invite_options":{"require_greeting":true,"require_pressing_one":true},"call_type":"h323","device_ip":"10.100.111.237","sip_headers":{"from_display_name":"display name","to_display_name":"display name","from_uri":"sip:username@domain.company.org","additional_headers":[{"key":"X-Header1","value":"X-body1"},{"key":"X-Header1","value":"X-body1"}]}}}'
ENDPOINTS