CINXE.COM

<!DOCTYPE html><html lang="en-US"><head><meta charSet="utf-8"/><title>Zoom Meeting SDK - Zoom Developers</title><meta name="viewport" content="width=device-width, height=device-height, initial-scale=1"/><meta name="description" content="The Zoom Developer Platform is an open platform that allows third-party developers to build applications and integrations upon Zoom鈥檚 video-first unified communications platform."/><meta name="keywords" content="zoom, marketplace.zoom.us, api, sdk, jwt, oauth, rest, develop, developer, zoom developer, video conferencing, video conference, online meetings, web meeting, video meeting, cloud meeting, cloud video, group video call, group video chat, screen share, application share"/><link rel="icon" href="/svgs/favicon.svg"/><meta property="og:image" content="https://developers.zoom.us/img/logos/ogimage_primary.png"/><meta property="og:site_name" content="Zoom"/><meta property="og:locale" content="en_US"/><meta property="og:type" content="website"/><meta property="og:title" content="Zoom Meeting SDK - Zoom Developers"/><meta property="og:description" content="The Zoom Developer Platform is an open platform that allows third-party developers to build applications and integrations upon Zoom鈥檚 video-first unified communications platform."/><meta property="og:url" content="https://developers.zoom.us/docs/meeting-sdk/"/><link rel="canonical" href="https://developers.zoom.us/docs/meeting-sdk/"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:site" content="@zoom"/><meta name="twitter:title" content="Zoom Meeting SDK - Zoom Developers"/><meta name="twitter:description" content="The Zoom Developer Platform is an open platform that allows third-party developers to build applications and integrations upon Zoom鈥檚 video-first unified communications platform."/><meta name="twitter:creator" content="@zoom"/><meta name="twitter:image" content="https://developers.zoom.us/img/logos/ogimage_primary.png"/><script type="application/ld+json">{"@context":"https://schema.org","@type":"WebPage","url":"https://developers.zoom.us","inLanguage":"en","mainEntityOfPage":"https://developers.zoom.us","description":"The Zoom Developer Platform is an open platform that allows third-party developers to build applications and integrations upon Zoom鈥檚 video-first unified communications platform.","name":"Zoom Developer Docs","publisher":{"@type":"Organization","name":"Zoom","legalName":"Zoom Video Communications LLC","url":"https://zoom.us"},"copyrightHolder":{"@type":"Organization","name":"Zoom","legalName":"Zoom Video Communications LLC","url":"https://zoom.us"},"copyrightYear":"2024"}</script><script type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","description":"Breadcrumbs","name":"Breadcrumbs","itemListElement":[{"@type":"ListItem","item":{"@id":"https://developers.zoom.us","name":"Docs"},"position":1},{"@type":"ListItem","item":{"@id":"https://developers.zoom.us/docs","name":"docs"},"position":2},{"@type":"ListItem","item":{"@id":"https://developers.zoom.us/meeting-sdk/","name":""},"position":3}]}</script><meta name="next-head-count" content="22"/><link rel="preload" href="/_next/static/media/bd6032b1b40f0a94-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/af073f67ef00f79b-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/d7bb3f33f2a2c6c3-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/16b6856090fc2493-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/1f8417796774370d-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/c9b3cfca7ff374b5-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/15adc2398e9c1f2c-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/d4676da4caa387c7-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/45e87576965bc150-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/ea53a1bc12a0c88a-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/8e6e8d6c13eb004a-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/e31544f452c551d7-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/a20cb60d2c11d6e5-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/9946c3afdd2d21f1-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/media/d1aaf2a6a913fa31-s.p.woff2" as="font" type="font/woff2" crossorigin="anonymous" data-next-font="size-adjust"/><link rel="preload" href="/_next/static/css/50f280535a45a865.css" as="style" crossorigin=""/><link rel="stylesheet" href="/_next/static/css/50f280535a45a865.css" crossorigin="" data-n-g=""/><link rel="preload" href="/_next/static/css/a38a0563e1fe1485.css" as="style" crossorigin=""/><link rel="stylesheet" href="/_next/static/css/a38a0563e1fe1485.css" crossorigin="" data-n-p=""/><noscript data-n-css=""></noscript><script defer="" crossorigin="" nomodule="" src="/_next/static/chunks/polyfills-c67a75d1b6f99dc8.js"></script><script src="https://cdn.cookielaw.org/scripttemplates/otSDKStub.js" type="text/javascript" charSet="UTF-8" data-domain-script="b0bfa2ae-4058-4aef-8632-a5281ce4464a" defer="" data-nscript="beforeInteractive" crossorigin=""></script><script src="/_next/static/chunks/webpack-b7d487242207e7c2.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/framework-ca706bf673a13738.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/main-61ded8d942661fc0.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/pages/_app-d361ba633938b508.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/11e07bb4-65f3c1cbff722f6c.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/584-343cd2faad3a57a9.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/718-ad49a62636f00526.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/451-99c02290390e5165.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/2476-7fafc63cc04fb715.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/3817-d6d568a8dda7ffcb.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/8234-d72877bdaf02566f.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/302-cb5695a08df80245.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/5578-77de19e78d022a48.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/9095-81a120684ed3cf9b.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/6577-4ada4cb4c53af17c.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/5150-5f396cd5ecac43f5.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/4710-2f0eb6b2928195f8.js" defer="" crossorigin=""></script><script src="/_next/static/chunks/pages/docs/%5B...slug%5D-ff8ad9e097289a89.js" defer="" crossorigin=""></script><script src="/_next/static/2024-11-21%20T%2021-05-22/_buildManifest.js" defer="" crossorigin=""></script><script src="/_next/static/2024-11-21%20T%2021-05-22/_ssgManifest.js" defer="" crossorigin=""></script></head><body><div id="__next"><div class="__variable_b9f6b0 __variable_9ef0d0"><noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NQHCZ9Z" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript><div></div></div></div><script id="__NEXT_DATA__" type="application/json" crossorigin="">{"props":{"pageProps":{"mainContent":{"code":"var Component=(()=\u003e{var w=Object.create;var a=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var k=Object.getPrototypeOf,v=Object.prototype.hasOwnProperty;var x=(i,e)=\u003e()=\u003e(e||i((e={exports:{}}).exports,e),e.exports),y=(i,e)=\u003e{for(var o in e)a(i,o,{get:e[o],enumerable:!0})},h=(i,e,o,s)=\u003e{if(e\u0026\u0026typeof e==\"object\"||typeof e==\"function\")for(let n of b(e))!v.call(i,n)\u0026\u0026n!==o\u0026\u0026a(i,n,{get:()=\u003ee[n],enumerable:!(s=f(e,n))||s.enumerable});return i};var S=(i,e,o)=\u003e(o=i!=null?w(k(i)):{},h(e||!i||!i.__esModule?a(o,\"default\",{value:i,enumerable:!0}):o,i)),D=i=\u003eh(a({},\"__esModule\",{value:!0}),i);var p=x((_,u)=\u003e{u.exports=_jsx_runtime});var I={};y(I,{default:()=\u003eK,frontmatter:()=\u003eM});var t=S(p());var{useMDXComponents:d}=MdxJsReact;var M={title:\"Zoom Meeting SDK\",hideTitle:!0};function g(i){let e=Object.assign({p:\"p\",h2:\"h2\",a:\"a\",i:\"i\",strong:\"strong\",ul:\"ul\",li:\"li\",hr:\"hr\"},d(),i.components),{PageTitleIcon:o,MdxCarousel:s,Image:n,SupportedPlatformGrid:c,RecentBlogs:l,NextSteps:m}=e;return n||r(\"Image\",!0),s||r(\"MdxCarousel\",!0),m||r(\"NextSteps\",!0),o||r(\"PageTitleIcon\",!0),l||r(\"RecentBlogs\",!0),c||r(\"SupportedPlatformGrid\",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o,{title:\"Meeting SDK\",svgname:\"_meetings\"}),`\n`,(0,t.jsx)(e.p,{children:\"Embed the Zoom meeting and webinar experience in an app or website.\"}),`\n`,(0,t.jsx)(e.p,{children:\"The Zoom Meeting SDK lets you display the familiar Zoom meeting and webinar experience in your app or website. The Meeting SDK interface resembles the Zoom client, except that it lives inside your own app or website.\"}),`\n`,(0,t.jsx)(s,{items:[(0,t.jsx)(n,{src:\"/img/msdk-web-client-view-gallery.png\"}),(0,t.jsx)(n,{src:\"/img/msdk-web-client-view-share.png\"}),(0,t.jsx)(n,{src:\"/img/msdk-web-client-view-speaker.png\"}),(0,t.jsx)(n,{src:\"/img/msdk-web-component-view-gallery.png\"}),(0,t.jsx)(n,{src:\"/img/msdk-web-component-view-ribbon.png\"}),(0,t.jsx)(n,{src:\"/img/msdk-web-component-view-share.png\"})]}),`\n`,(0,t.jsxs)(e.h2,{id:\"platforms\",children:[\"Platforms\",(0,t.jsx)(e.a,{\"aria-hidden\":\"true\",tabIndex:\"-1\",href:\"#platforms\",children:(0,t.jsx)(e.i,{className:\"bi-link-45deg\",\"aria-hidden\":\"true\"})})]}),`\n`,(0,t.jsx)(c,{platforms:[{title:\"Android\",to:\"/docs/meeting-sdk/android\"},{title:\"iOS\",to:\"/docs/meeting-sdk/ios\"},{title:\"macOS\",to:\"/docs/meeting-sdk/macos\"},{title:\"Windows\",to:\"/docs/meeting-sdk/windows\"},{title:\"Web\",to:\"/docs/meeting-sdk/web\"},{title:\"Electron\",to:\"/docs/meeting-sdk/electron\"},{title:\"Linux\",to:\"/docs/meeting-sdk/linux\"},{title:\"Unreal\",to:\"/docs/meeting-sdk/unreal\"},{title:\"React Native\",to:\"/docs/meeting-sdk/react-native\"}]}),`\n`,(0,t.jsxs)(e.h2,{id:\"enhance-the-users-experience\",children:[\"Enhance the users' experience\",(0,t.jsx)(e.a,{\"aria-hidden\":\"true\",tabIndex:\"-1\",href:\"#enhance-the-users-experience\",children:(0,t.jsx)(e.i,{className:\"bi-link-45deg\",\"aria-hidden\":\"true\"})})]}),`\n`,(0,t.jsxs)(e.p,{children:[\"Native platforms for mobile and desktop offer a \",(0,t.jsx)(e.strong,{children:\"default UI\"}),\", which looks similar to the Zoom client, and a \",(0,t.jsx)(e.strong,{children:\"custom UI\"}),\", which offers the ability to completely customize the user interface.\"]}),`\n`,(0,t.jsxs)(e.p,{children:[\"The web SDK offers a \",(0,t.jsx)(e.a,{href:\"/docs/meeting-sdk/web/client-view/\",children:\"client view\"}),\", which looks similar to the Zoom client, and a modular \",(0,t.jsx)(e.a,{href:\"/docs/meeting-sdk/web/component-view/\",children:\"component view\"}),\", which displays the Meeting SDK in components on your website.\"]}),`\n`,(0,t.jsxs)(e.h2,{id:\"meeting-and-webinar-authorization\",children:[\"Meeting and webinar authorization\",(0,t.jsx)(e.a,{\"aria-hidden\":\"true\",tabIndex:\"-1\",href:\"#meeting-and-webinar-authorization\",children:(0,t.jsx)(e.i,{className:\"bi-link-45deg\",\"aria-hidden\":\"true\"})})]}),`\n`,(0,t.jsxs)(e.p,{children:[\"Each time you use the SDK to join a meeting or webinar, \",(0,t.jsx)(e.a,{href:\"/docs/meeting-sdk/auth/#generate-a-meeting-sdk-jwt\",children:\"generate an SDK JWT\"}),` to let you securely transmit your SDK credentials to Zoom's auth servers.\nStart meetings on behalf of other users using a `,(0,t.jsx)(e.a,{href:\"/docs/meeting-sdk/auth/#start-meetings-and-webinars-with-a-zoom-users-zak-token\",children:\"ZAK (Zoom Access Key) token\"}),\".\"]}),`\n`,(0,t.jsxs)(e.p,{children:[\"The Meeting SDK is also compatible with \",(0,t.jsx)(e.a,{href:\"/docs/integrations/oauth/\",children:\"Zoom OAuth\"}),`, allowing existing Zoom\nusers to `,(0,t.jsx)(e.a,{href:\"/docs/integrations/oauth/\",children:\"connect their accounts to your Meeting SDK\"}),\".\"]}),`\n`,(0,t.jsxs)(e.h2,{id:\"access-to-raw-data\",children:[\"Access to raw data\",(0,t.jsx)(e.a,{\"aria-hidden\":\"true\",tabIndex:\"-1\",href:\"#access-to-raw-data\",children:(0,t.jsx)(e.i,{className:\"bi-link-45deg\",\"aria-hidden\":\"true\"})})]}),`\n`,(0,t.jsxs)(e.p,{children:[\"Direct access to raw video and audio data on native platforms enables improved interaction between users and the app video stream. Imagine a gaming video streaming app with direct interaction between the player and viewers based on in-game events or prompts from the community. Or an AR streaming platform with direct viewer access to on-screen video. Raw data is also useful for building custom live transcription, video or audio analysis, and integrates well with \",(0,t.jsx)(e.a,{href:\"/docs/zoom-apps/data-access/\",children:\"Zoom Apps\"}),\".\"]}),`\n`,(0,t.jsxs)(e.h2,{id:\"implementation-requirements\",children:[\"Implementation requirements\",(0,t.jsx)(e.a,{\"aria-hidden\":\"true\",tabIndex:\"-1\",href:\"#implementation-requirements\",children:(0,t.jsx)(e.i,{className:\"bi-link-45deg\",\"aria-hidden\":\"true\"})})]}),`\n`,(0,t.jsxs)(e.ul,{children:[`\n`,(0,t.jsxs)(e.li,{children:[\"We enforce a required minimum version of the Meeting SDK. See our \",(0,t.jsx)(e.a,{href:\"/docs/meeting-sdk/minimum-version\",children:\"SDK minimum version policy\"}),\" for details.\"]}),`\n`,(0,t.jsxs)(e.li,{children:[\"The Meeting SDK follows the Zoom license model. See \",(0,t.jsx)(e.a,{href:\"https://www.zoom.com/en/products/virtual-meetings/\",children:\"Zoom Meetings\"}),\", \",(0,t.jsx)(e.a,{href:\"https://www.zoom.com/en/products/webinars/\",children:\"Zoom Webinars\"}),\", and the \",(0,t.jsx)(e.a,{href:\"https://www.zoom.com/en/isv/\",children:\"Zoom ISV Partner Program\"}),\" for details.\"]}),`\n`,(0,t.jsxs)(e.li,{children:[\"The Meeting SDK uses the same global infrastructure as other Zoom products. If you experience connection issues, be sure your products follow the Zoom network firewall and proxy server settings connection requirements. See \",(0,t.jsx)(e.a,{href:\"https://support.zoom.com/hc/en/article?id=zm_kb\u0026sysparm_article=KB0060548\",children:\"Zoom network firewall or proxy server settings\"}),\" for details.\"]}),`\n`]}),`\n`,(0,t.jsx)(e.hr,{}),`\n`,(0,t.jsx)(l,{title:\"From the developer blog:\",categoryId:\"meeting-sdk\"}),`\n`,(0,t.jsx)(m,{steps:[{title:\"Developer accounts\",to:\"/docs/meeting-sdk/developer-accounts\"}]})]})}function Z(i={}){let{wrapper:e}=Object.assign({},d(),i.components);return e?(0,t.jsx)(e,Object.assign({},i,{children:(0,t.jsx)(g,i)})):g(i)}var K=Z;function r(i,e){throw new Error(\"Expected \"+(e?\"component\":\"object\")+\" `\"+i+\"` to be defined: you likely forgot to import, pass, or provide it.\")}return D(I);})();\n;return Component;","frontmatter":{"title":"Zoom Meeting SDK","hideTitle":true},"errors":[],"matter":{"content":"\n\u003cPageTitleIcon\n title=\"Meeting SDK\"\n svgname=\"_meetings\"\n/\u003e\n\nEmbed the Zoom meeting and webinar experience in an app or website.\n\nThe Zoom Meeting SDK lets you display the familiar Zoom meeting and webinar experience in your app or website. The Meeting SDK interface resembles the Zoom client, except that it lives inside your own app or website.\n\n\u003cMdxCarousel\n items={[\n \u003cImage src=\"/img/msdk-web-client-view-gallery.png\" /\u003e,\n \u003cImage src=\"/img/msdk-web-client-view-share.png\" /\u003e,\n \u003cImage src=\"/img/msdk-web-client-view-speaker.png\" /\u003e,\n \u003cImage src=\"/img/msdk-web-component-view-gallery.png\" /\u003e,\n \u003cImage src=\"/img/msdk-web-component-view-ribbon.png\" /\u003e,\n \u003cImage src=\"/img/msdk-web-component-view-share.png\" /\u003e,\n ]}\n/\u003e\n\n## Platforms\n\n\u003cSupportedPlatformGrid\n platforms={[\n { title: \"Android\", to: \"/docs/meeting-sdk/android\"},\n { title: \"iOS\", to: \"/docs/meeting-sdk/ios\" },\n { title: \"macOS\", to: \"/docs/meeting-sdk/macos\" },\n { title: \"Windows\", to: \"/docs/meeting-sdk/windows\" },\n { title: \"Web\", to: \"/docs/meeting-sdk/web\" },\n { title: \"Electron\", to: \"/docs/meeting-sdk/electron\" },\n { title: \"Linux\", to: \"/docs/meeting-sdk/linux\" },\n { title: 'Unreal', to: \"/docs/meeting-sdk/unreal\" },\n { title: \"React Native\", to: \"/docs/meeting-sdk/react-native\" },\n ]}\n/\u003e\n\n## Enhance the users' experience\n\nNative platforms for mobile and desktop offer a **default UI**, which looks similar to the Zoom client, and a **custom UI**, which offers the ability to completely customize the user interface.\n\nThe web SDK offers a [client view](/docs/meeting-sdk/web/client-view/), which looks similar to the Zoom client, and a modular [component view](/docs/meeting-sdk/web/component-view/), which displays the Meeting SDK in components on your website.\n\n## Meeting and webinar authorization\n\nEach time you use the SDK to join a meeting or webinar, [generate an SDK JWT](/docs/meeting-sdk/auth/#generate-a-meeting-sdk-jwt) to let you securely transmit your SDK credentials to Zoom's auth servers.\nStart meetings on behalf of other users using a [ZAK (Zoom Access Key) token](/docs/meeting-sdk/auth/#start-meetings-and-webinars-with-a-zoom-users-zak-token).\n\nThe Meeting SDK is also compatible with [Zoom OAuth](/docs/integrations/oauth/), allowing existing Zoom\nusers to [connect their accounts to your Meeting SDK](/docs/integrations/oauth/).\n\n## Access to raw data\n\nDirect access to raw video and audio data on native platforms enables improved interaction between users and the app video stream. Imagine a gaming video streaming app with direct interaction between the player and viewers based on in-game events or prompts from the community. Or an AR streaming platform with direct viewer access to on-screen video. Raw data is also useful for building custom live transcription, video or audio analysis, and integrates well with [Zoom Apps](/docs/zoom-apps/data-access/).\n\n## Implementation requirements\n\n* We enforce a required minimum version of the Meeting SDK. See our [SDK minimum version policy](/docs/meeting-sdk/minimum-version) for details.\n* The Meeting SDK follows the Zoom license model. See [Zoom Meetings](https://www.zoom.com/en/products/virtual-meetings/), [Zoom Webinars](https://www.zoom.com/en/products/webinars/), and the [Zoom ISV Partner Program](https://www.zoom.com/en/isv/) for details.\n* The Meeting SDK uses the same global infrastructure as other Zoom products. If you experience connection issues, be sure your products follow the Zoom network firewall and proxy server settings connection requirements. See [Zoom network firewall or proxy server settings](https://support.zoom.com/hc/en/article?id=zm_kb\u0026sysparm_article=KB0060548) for details.\n\n---\n\n\u003cRecentBlogs\n title=\"From the developer blog:\"\n categoryId=\"meeting-sdk\"\n/\u003e\n\n\u003cNextSteps\n steps={[\n {\n title: 'Developer accounts',\n to: '/docs/meeting-sdk/developer-accounts'\n }\n ]}\n/\u003e\n","data":{"title":"Zoom Meeting SDK","hideTitle":true},"isEmpty":false,"excerpt":"","path":"./content/docs/meeting-sdk/index.mdx"}},"sidebarName":"meeting-sdk"},"__N_SSG":true},"page":"/docs/[...slug]","query":{"slug":["meeting-sdk"]},"buildId":"2024-11-21 T 21-05-22","isFallback":false,"gsp":true,"scriptLoader":[]}</script></body></html>