{"info":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","description":"

All requests to this API require the API key \"3CX-ApiKey\" in the header

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"17439253","collectionId":"9d53c167-22b7-46b6-a7da-3af2c102704d","publishedId":"UUxzBnmk","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"333","highlight":"0596d4"},"publishDate":"2021-09-28T14:35:23.000Z"},"item":[{"name":"Adhoc Meetings","item":[{"name":"/adhoc","id":"b32e3875-ef30-4bbf-8e7c-67df7991524b","request":{"method":"POST","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/adhoc?extension=100&subject=My Quick Meeting","description":"

Generates a meeting URL on the fly for the user defined.

Identifies extension by email address, if multiple extensions have the same, first match will be used

\n","type":"text/plain"},"key":"email","value":"johndoe@example.com"},{"description":{"content":"

Identifies extension by extension number. If both extension/email are defined in the request, the email precedes.

\n","type":"text/plain"},"key":"extension","value":"100"},{"description":{"content":"

Name of the meeting

\n","type":"text/plain"},"key":"subject","value":"My Quick Meeting"}],"variable":[{"description":{"content":"

Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name

\n","type":"text/plain"},"type":"any","value":"3cx.contoso.com","key":"FQDN"},{"description":{"content":"

(This can only be one of 443,5001)

\n","type":"text/plain"},"type":"any","value":"443","key":"port"},{"description":{"content":"

(This is currently v1)

\n","type":"text/plain"},"type":"any","value":"v1","key":"apiVersion"}]}},"response":[{"id":"355c6667-d5ce-43b8-be41-9edc5ccac50a","name":"success","originalRequest":{"method":"POST","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"},{"key":"Content-Length","value":"0","type":"text"}],"url":{"raw":"https://3cx.contoso.com:443/webmeeting/api/v1/adhoc?extension=100&subject=My Quick Meeting","host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"path":["adhoc"],"query":[{"key":"email","value":"johndoe@example.com","description":"Identifies extension by email address, if multiple extensions have the same, first match will be used","disabled":true},{"key":"extension","value":"100","description":"Identifies extension by extension number. If both extension/email are defined in the request, the email precedes."},{"key":"subject","value":"My Quick Meeting","description":"Name of the meeting"}],"variable":[{"key":"FQDN","value":"3cx.contoso.com","description":"Taken from 3CX Settings &gt; Network &gt; FQDN &gt; Fully Qualified Domain Name"},{"key":"port","value":"443","description":" (This can only be one of 443,5001)"},{"key":"apiVersion","value":"v1","description":" (This can only be one of v1)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:21:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"244"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"meetingid\": \"202109290621488029d3950c40bf660622e1e587c1d771\",\n \"title\": \"My Quick Meeting\",\n \"url\": \"https://3cx.contoso.com/meet/9803d5337a0835224b971ae242980ae02g4a9ea9\",\n \"owner\": \"John Doe\"\n },\n \"errorInformation\": \"\"\n}"}],"_postman_id":"b32e3875-ef30-4bbf-8e7c-67df7991524b"}],"id":"b9244f84-54f8-4e20-b1b2-c579c250a015","description":"

Ability to create meeting URLs quickly to be used on the fly by a 3rd party application to let users join a meeting.

\n","_postman_id":"b9244f84-54f8-4e20-b1b2-c579c250a015","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}}},{"name":"Scheduled - List Meetings","item":[{"name":"/meetings/list","id":"5ba45704-900d-4ad3-b2fb-f7923916f84c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/meetings/list","description":"

Available since V18 U2
Get gets all meetings and meeting IDs of the system.

Available since V18 U1
Call instead /meetings

(Optional) Allows to filter meetings by text contained in a meeting's subject

\n","type":"text/plain"},"key":"subjectContains","value":"Sales"},{"disabled":true,"description":{"content":"

(Optional) Allows to filter meetings by the day they are scheduled for. Filter is today plus X days ahead

\n","type":"text/plain"},"key":"daysLimit","value":"7"},{"disabled":true,"description":{"content":"

(Optional) Ability to filter by the extension hosting the meeting

\n","type":"text/plain"},"key":"extension","value":"100"}],"variable":[]}},"response":[{"id":"8e57201c-a651-42e9-a508-ed332e8eae4c","name":"success","originalRequest":{"method":"GET","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"url":{"raw":"https://3cx.contoso.com:443/webmeeting/api/v1/meetings?extension=100","host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"path":["meetings"],"query":[{"key":"subjectContains","value":"Sales","description":"(Optional) Allows to filter meetings by text contained in a meetings&#39; subject","disabled":true},{"key":"daysLimit","value":"7","description":"(Optional) Allows to filter meetings by the day they are scheduled for. Filter is today plus X days ahead","disabled":true},{"key":"extension","value":"100","description":"(Optional) Ability to filter by the extension hosting the meeting"}],"variable":[{"key":"FQDN","value":"3cx.contoso.com","description":"Taken from 3CX Settings &gt; Network &gt; FQDN &gt; Fully Qualified Domain Name"},{"key":"port","value":"443","description":" (This can only be one of 443,5001)"},{"key":"apiVersion","value":"v1","description":" (This can only be one of v1)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:30:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"2179"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"scheduledMeetings\": [\n {\n \"extension\": \"100\",\n \"name\": \"John Doe\",\n \"meetingid\": \"202109290921488129d3950c40bf660622e1e587c1d771\",\n \"subject\": \"My Quick Meeting\",\n \"datetime\": \"2021-09-29T06:21\",\n \"duration\": 30,\n \"participants\": 0,\n \"type\": \"Webmeeting\"\n },\n {\n \"extension\": \"100\",\n \"name\": \"John Doe\",\n \"meetingid\": \"20210929060348e467711c1565e6f69a3107c61bcd8e6c\",\n \"subject\": \"3CX Video Conferencing\",\n \"datetime\": \"2022-09-27T16:30\",\n \"duration\": 30,\n \"participants\": 2,\n \"type\": \"Webinar\"\n }\n ]\n },\n \"errorInformation\": \"\"\n}"}],"_postman_id":"5ba45704-900d-4ad3-b2fb-f7923916f84c"},{"name":"/meetings/active","id":"6b7aa7d9-4f49-4322-851b-1e8418bd5fe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/meetings/active","description":"

Available since v18 U2

Get all currently active meetings of the system and participant count connected.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}},"urlObject":{"path":["meetings","active"],"host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"query":[],"variable":[]}},"response":[{"id":"63c9fec6-e7f6-40a1-8d8f-5a8f2516916d","name":"success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://3cx.contoso.com:443/webmeeting/api/v1/meetings/active","host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"path":["meetings","active"],"query":[{"key":"subjectContains","value":"Sales","description":"(Optional) Allows to filter meetings by text contained in a meeting's subject","disabled":true},{"key":"daysLimit","value":"7","description":"(Optional) Allows to filter meetings by the day they are scheduled for. Filter is today plus X days ahead","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Fri, 05 Nov 2021 09:27:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"155"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net youtube.com www.youtube.com; worker-src blob:; frame-src 'self' *.3cx.net www.youtube.com tcxwmrc:; connect-src *; img-src 'self' *.3cx.net img.youtube.com data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"count\": 1,\n \"Click2Meet\": [\n {\n \"extension\": \"100\",\n \"host\": \"Jon Doe\",\n \"participants\": 1\n }\n ],\n \"Scheduled\": []\n },\n \"errorInformation\": \"\"\n}"}],"_postman_id":"6b7aa7d9-4f49-4322-851b-1e8418bd5fe4"},{"name":"/countparticipants/:meetingId","id":"75175b90-da2b-4e7e-9dd6-eea4cf3983a3","request":{"method":"GET","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/countparticipants/20210924012703593154261bbe1756d9de0ff748f27a60","description":"

Counts participants within this meeting (Including Host)

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}},"urlObject":{"path":["countparticipants","20210924012703593154261bbe1756d9de0ff748f27a60"],"host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"query":[],"variable":[]}},"response":[{"id":"0e298771-b88e-41de-a429-bca5683eecee","name":"success","originalRequest":{"method":"GET","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/countparticipants/20210924012703591154261bbe1856d9de0ff748f27a60"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:36:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"meetingid\": \"20210924012703591154261bbe1856d9de0ff748f27a60\",\n \"participants\": 1\n },\n \"errorInformation\": \"\"\n}"}],"_postman_id":"75175b90-da2b-4e7e-9dd6-eea4cf3983a3"}],"id":"2611f944-7b46-4e75-a0c8-7d9110e46e37","description":"

Basic management of meetings. Good for publishing information on websites easily for users to able to subscribe.

\n","_postman_id":"2611f944-7b46-4e75-a0c8-7d9110e46e37","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}}},{"name":"Scheduled - Manage Meetings","item":[{"name":"/scheduled","id":"1dd84aa5-2c26-447d-a682-f67fd53b7463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"hostJoinFirst\": true,\n \"hideParticipants\": false,\n \"selfModeration\": true,\n \"audioOnStart\": true,\n \"videoOnStart\": true,\n \"chatOnStart\": true,\n \"dateTime\": \"2022-09-27T19:30:00Z\",\n \"duration\": 30,\n \"subject\": \"3CX Video Conferencing\",\n \"description\": \"Meeting Description\",\n \"extension\": \"100\",\n \"type\": \"Webinar\",\n \"participants\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"role\": \"CoHost\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"role\": \"CoHost\"\n }\n ]\n}"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled","description":"

Create a new scheduled meeting

\n","urlObject":{"path":["scheduled"],"host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"query":[],"variable":[{"id":"e638c59f-e1db-4bfe-a60d-0a58d464c171","description":{"content":"

Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name

\n","type":"text/plain"},"type":"any","value":"3cx.contoso.com","key":"FQDN"},{"id":"012bfdb3-78d3-4d2a-94d7-7a0918b52eab","description":{"content":"

(This can only be one of 443,5001)

\n","type":"text/plain"},"type":"any","value":"443","key":"port"},{"id":"4ba432d4-3177-4081-b872-bb1d1e7e42cc","description":{"content":"

(This can only be one of v1)

\n","type":"text/plain"},"type":"any","value":"v1","key":"apiVersion"}]}},"response":[{"id":"66598cda-c4fd-4242-8705-20d8f2ed3ea2","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key"},{"key":"Content-Length","value":"0"}],"body":{"mode":"raw","raw":"{\n \"hostJoinFirst\": true,\n \"hideParticipants\": false,\n \"selfModeration\": true,\n \"audioOnStart\": true,\n \"videoOnStart\": true,\n \"chatOnStart\": true,\n \"dateTime\": \"2022-09-27T19:30:00Z\",\n \"duration\": 30,\n \"subject\": \"3CX Video Conferencing\",\n \"description\": \"Meeting Description\",\n \"extension\": \"100\",\n \"type\": \"Webinar\",\n \"participants\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"role\": \"CoHost\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"role\": \"CoHost\"\n }\n ]\n}"},"url":{"raw":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled","protocol":"https","host":["3cx","contoso","com"],"port":"443","path":["webmeeting","api","v1","scheduled"],"variable":[{"key":"FQDN","value":"3cx.contoso.com","description":"Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name"},{"key":"port","value":"443","description":" (This can only be one of 443,5001)"},{"key":"apiVersion","value":"v1","description":" (This can only be one of v1)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:08:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"403"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"meetingid\": \"20210929060816af80f615517852e9dac1282133dba358\",\n \"organizer\": {\n \"name\": \"Joe Bloggs\",\n \"email\": \"organizer@example.com\",\n \"join\": \"https://3cx.contoso.com:443/meet/XngQp06UzA2vTf-D0rmGd9Lq\",\n \"extension\": \"100\"\n }, \n \"participants\": [\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"join\": \"https://3cx.contoso.com:443/meet/cD8tPa3H7YHxm43Odq4f3K1E\",\n \"role\": \"Participant\"\n },\n {\n \"name\": \"Jane Doe\",\n \"email\": \"janedoe@example.com\",\n \"join\": \"https://3cx.contoso.com:443/meet/YdL08YlgZVSnajJM7iMPVBhG\",\n \"role\": \"CoHost\"\n }\n ]\n },\n \"errorInformation\": \"\"\n}"}],"variable":[{"id":"e638c59f-e1db-4bfe-a60d-0a58d464c171","key":"FQDN","value":"3cx.contoso.com","type":"any","description":"Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name"},{"id":"012bfdb3-78d3-4d2a-94d7-7a0918b52eab","key":"port","value":"443","type":"any","description":" (This can only be one of 443,5001)"},{"id":"4ba432d4-3177-4081-b872-bb1d1e7e42cc","key":"apiVersion","value":"v1","type":"any","description":" (This can only be one of v1)"}],"_postman_id":"1dd84aa5-2c26-447d-a682-f67fd53b7463"},{"name":"/scheduled/:meetingId","id":"12cd8d4c-3c76-4fa2-a20b-e78df5397572","request":{"method":"DELETE","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/20210924012703593154261bbe1756d9de0ff748f27a60","description":"

Deletes the scheduled meeting

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}},"urlObject":{"path":["scheduled","20210924012703593154261bbe1756d9de0ff748f27a60"],"host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"query":[],"variable":[]}},"response":[{"id":"9248735b-d49d-492d-b281-82ef1fb34bd8","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/20210924012703593154261bbe1756d9de0ff748f27a60"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:47:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errorInformation\": \"\"\n}"}],"_postman_id":"12cd8d4c-3c76-4fa2-a20b-e78df5397572"},{"name":"/scheduled/:meetingId","id":"1ad8c055-04ca-4dc9-a872-e914d8046ec4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"hostJoinFirst\": true,\r\n \"hideParticipants\": false,\r\n \"selfModeration\": true,\r\n \"audioOnStart\": true,\r\n \"videoOnStart\": true,\r\n \"chatOnStart\": true,\r\n \"dateTime\": \"2022-10-17T18:30:00Z\",\r\n \"duration\": 30,\r\n \"subject\": \"3CX Video Conferencing\",\r\n \"description\": \"Meeting Description\"\r\n}"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/202109240127029c11bd718b9d8b08a17d2a806e957ehc","description":"

Updates properties of the scheduled meeting

(Required)

\n","type":"text/plain"},"type":"any","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","key":"meetingId"}]}},"response":[{"id":"799e5bb2-6d1e-4032-a423-0e4ffba305dd","name":"success","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"hostJoinFirst\": true,\r\n \"hideParticipants\": false,\r\n \"selfModeration\": true,\r\n \"audioOnStart\": true,\r\n \"videoOnStart\": true,\r\n \"chatOnStart\": true,\r\n \"dateTime\": \"2022-10-17T18:30:00Z\",\r\n \"duration\": 30,\r\n \"subject\": \"3CX Video Conferencing\",\r\n \"description\": \"Meeting Description\"\r\n}"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/202109240127029c11bd718b9d8b08a17d2a806e957ehc"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 07:10:56 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errorInformation\": \"\"\n}"}],"variable":[{"id":"80d96bca-5b07-4d1c-b7d0-683045396053","key":"meetingId","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","type":"any","description":"(Required) "}],"_postman_id":"1ad8c055-04ca-4dc9-a872-e914d8046ec4"},{"name":"/scheduled/:meetingId","id":"4764bd2e-09b4-4e0e-8dfa-d7a94ff57d96","request":{"method":"GET","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/202109240127029c11bd718b9d8b68a17d2a806e957efc","description":"

Get detailed information about the scheduled meeting

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}},"urlObject":{"path":["scheduled","202109240127029c11bd718b9d8b68a17d2a806e957efc"],"host":["https://3cx.contoso.com:443/webmeeting/api/v1"],"query":[],"variable":[]}},"response":[{"id":"a713a198-0410-48c7-b3ab-be26c5d3bac1","name":"success","originalRequest":{"method":"GET","header":[{"key":"3CX-Api-Key","value":"Settings - Conference - Video - API Key"}],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/scheduled/202109240127029c11bd71859d8b68a17d2a806e957eaf"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:58:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"568"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"meetingid\": \"202109240127029c11bd71859d8b68a17d2a806e957eaf\",\n \"type\": \"webmeeting\",\n \"openlink\": \"https://3cx.contoso.com:443/meet/4517252942451a8179b0d182f34a1a8e5750cf31\",\n \"pin\": \"3573518\",\n \"dialIn\": \"1111111\",\n \"hostJoinFirst\": false,\n \"selfModeration\": true,\n \"hideParticipants\": false,\n \"audioOnStart\": true,\n \"videoOnStart\": true,\n \"chatOnStart\": true,\n \"datetime\": \"2021-09-24T13:27\",\n \"duration\": 30,\n \"subject\": \"My ClickUp Meeting\",\n \"description\": \"\",\n \"organizer\": {\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"join\": \"https://3cx.contoso.com:443/meet/jUF5wLf7or3EfuX79bvqYvZ-\",\n \"extension\": \"100\"\n },\n \"participants\": []\n },\n \"errorInformation\": \"\"\n}"}],"_postman_id":"4764bd2e-09b4-4e0e-8dfa-d7a94ff57d96"}],"id":"f0fdc186-26d5-48c8-b2b1-feec0134c5b4","description":"

Core management of meetings. Allows to create, modify or delete existing meetings in the system.

\n","_postman_id":"f0fdc186-26d5-48c8-b2b1-feec0134c5b4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}}},{"name":"Scheduled - Manage Participants","item":[{"name":"/participants/:meetingId","id":"01068743-be6e-4bc2-8ac2-b9ee1cb4cdfc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"John Doe\",\n \"email\": \"jdoez@example.com\",\n \"role\": \"Participant\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe2@example.com\",\n \"role\": \"CoHost\"\n }\n]"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/participants/20210924012703593154261bbe1756d9de0ff748f27a60","description":"

Adding Participant to a scheduled meeting

Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name

\n","type":"text/plain"},"type":"any","value":"3cx.contoso.com","key":"FQDN"},{"id":"421665b1-b661-4b77-a7e0-dbad5c339513","description":{"content":"

(This can only be one of 443,5001)

\n","type":"text/plain"},"type":"any","value":"443","key":"port"},{"id":"bd37e581-2b37-4db1-badb-9c847420f0ab","description":{"content":"

(This can only be one of v1)

\n","type":"text/plain"},"type":"any","value":"v1","key":"apiVersion"},{"id":"28a42acb-1240-4df8-93df-54f7b79a966c","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","key":"meetingId"}]}},"response":[{"id":"93ae18d8-1f92-4527-be63-1e3097950c34","name":"success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"},{"key":"Content-Length","value":"0","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"John Doe\",\n \"email\": \"jdoez@example.com\",\n \"role\": \"Participant\"\n },\n {\n \"name\": \"John Doe\",\n \"email\": \"johndoe2@example.com\",\n \"role\": \"CoHost\"\n }\n]"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/participants/20210924012703593154261bbe1756d9de0ff748f27a60"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:42:07 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errorInformation\": \"\"\n}"}],"variable":[{"id":"ee909dfb-7663-4ee5-8db8-8c67f1e95d8c","key":"FQDN","value":"3cx.contoso.com","type":"any","description":"Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name"},{"id":"421665b1-b661-4b77-a7e0-dbad5c339513","key":"port","value":"443","type":"any","description":" (This can only be one of 443,5001)"},{"id":"bd37e581-2b37-4db1-badb-9c847420f0ab","key":"apiVersion","value":"v1","type":"any","description":" (This can only be one of v1)"},{"id":"28a42acb-1240-4df8-93df-54f7b79a966c","key":"meetingId","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","type":"any","description":"(Required) "}],"_postman_id":"01068743-be6e-4bc2-8ac2-b9ee1cb4cdfc"},{"name":"/participants/:meetingId","id":"7d3a91ba-9d35-466a-94ba-1df9ef148ab3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"email\": \"johndoe2@example.com\"\n },\n {\n \"email\": \"jdoez@example.com\"\n }\n]"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/participants/20210924012703593154261bbe1756d9de0ff748f27a60","description":"

Removes Participant from a scheduled meeting

(Optional) Define how many participants can be added to a meeting on post request. (Req. v18 U2)

\n","type":"text/plain"},"key":"maxparticipants","value":"20"}],"variable":[{"id":"2628b6b7-8660-4e47-a979-6927bdd670a8","description":{"content":"

Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name

\n","type":"text/plain"},"type":"any","value":"3cx.contoso.com","key":"FQDN"},{"id":"ab2666af-dc88-4043-ba0c-d192c2e589be","description":{"content":"

(This can only be one of 443,5001)

\n","type":"text/plain"},"type":"any","value":"443","key":"port"},{"id":"52fc5e72-ad7a-4052-ad38-0d34e41890df","description":{"content":"

(This can only be one of v1)

\n","type":"text/plain"},"type":"any","value":"v1","key":"apiVersion"},{"id":"e8aed909-96bd-4e19-8637-2f94534fbd2e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","key":"meetingId"}]}},"response":[{"id":"b0fa94e6-29be-420f-887e-11e26d0da6f0","name":"success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"email\": \"johndoe2@example.com\"\n },\n {\n \"email\": \"jdoez@example.com\"\n }\n]"},"url":"https://3cx.contoso.com:443/webmeeting/api/v1/participants/20210924012703593154261bbe1756d9de0ff748f27a60"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:43:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"42"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"errorInformation\": \"\"\n}"}],"variable":[{"id":"2628b6b7-8660-4e47-a979-6927bdd670a8","key":"FQDN","value":"3cx.contoso.com","type":"any","description":"Taken from 3CX Settings > Network > FQDN > Fully Qualified Domain Name"},{"id":"ab2666af-dc88-4043-ba0c-d192c2e589be","key":"port","value":"443","type":"any","description":" (This can only be one of 443,5001)"},{"id":"52fc5e72-ad7a-4052-ad38-0d34e41890df","key":"apiVersion","value":"v1","type":"any","description":" (This can only be one of v1)"},{"id":"e8aed909-96bd-4e19-8637-2f94534fbd2e","key":"meetingId","value":"20220916073704047bcccccca79e1c5fb6d72ef5a7d2c1","type":"any","description":"(Required) "}],"_postman_id":"7d3a91ba-9d35-466a-94ba-1df9ef148ab3"}],"id":"d0cd5526-7fde-45c3-bc71-527187517931","description":"

Core management of participants within the meeting.

\n","_postman_id":"d0cd5526-7fde-45c3-bc71-527187517931","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}}},{"name":"Reports","item":[{"name":"/reports/:extension","id":"7ebf95bf-28b3-407c-8515-9b2fd9df805b","request":{"method":"GET","header":[],"url":"https://3cx.contoso.com:443/webmeeting/api/v1/reports/:extension?startDate=2022-05-20T10:50&endDate=2022-05-22&csv=true","description":"

Return reports for finished meetings, including recording urls and detailed join/quit events, eventually in CSV format. Available since v18 U4.

(Optional) Get reports after startDate

\n","type":"text/plain"},"key":"startDate","value":"2022-05-20T10:50"},{"description":{"content":"

(Optional) Get reports before endDate

\n","type":"text/plain"},"key":"endDate","value":"2022-05-22"},{"description":{"content":"

(Optional) Returns CSV with join/quit details instead of JSON

\n","type":"text/plain"},"key":"csv","value":"true"}],"variable":[{"description":{"content":"

PBX Extension organizer of meetings

\n","type":"text/plain"},"type":"any","value":"100","key":"extension"}]}},"response":[{"id":"c3dfaf79-65b9-42d5-aba8-7cd06e703ced","name":"success","originalRequest":{"method":"GET","header":[{"key":"3CX-ApiKey","value":"Settings - Conference - Video - API Key","type":"text"}],"url":{"raw":"https://3cx.contoso.com:443/webmeeting/api/v1/reports/100?startDate=2022-05-20T10:50&endDate=2022-05-22","protocol":"https","host":["3cx","contoso","com"],"port":"443","path":["webmeeting","api","v1","reports","100"],"query":[{"key":"startDate","value":"2022-05-20T10:50"},{"key":"endDate","value":"2022-05-22"},{"key":"csv","value":"true","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Date","value":"Wed, 29 Sep 2021 06:36:30 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"131"},{"key":"Connection","value":"keep-alive"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1;mode=block"},{"key":"Content-Security-Policy","value":"default-src 'self' *.3cx.net; style-src 'self' 'unsafe-inline' *.3cx.net; script-src 'self' 'unsafe-eval' *.3cx.net; worker-src blob:; frame-src 'self' *.3cx.net tcxwmrc:; connect-src *; img-src 'self' *.3cx.net data:;"},{"key":"Strict-Transport-Security","value":"max-age=15768000"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"result\": {\n \"20220527104043f8c2e5310486221907154708b1217b8a\": {\n \"organizer_name\": \"John Doe\",\n \"organizer_email\": \"johndoe@example.com\",\n \"meeting_start\": \"2022-05-27T10:40:43Z\",\n \"meeting_end\": \"2022-05-27T10:40:53Z\",\n \"meetingtitle\": \"3CX Video Conferencing\",\n \"duration\": 10,\n \"recording_url\": \"\",\n \"participants\": [{\n \"name\": \"Jane Doe\",\n \"email\": \"janedoe@example.com\"\n }\n ],\n \"summary\": [{\n \"joins\": 1,\n \"duration\": 10,\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"anonymous\": false\n }\n ],\n \"details\": [{\n \"join\": \"2022-05-27T10:40:43Z\",\n \"duration\": 10,\n \"name\": \"John Doe\",\n \"email\": \"johndoe@example.com\",\n \"key\": \"Ji4U2bgLSshSw32PILDdqbxG\",\n \"useragent\": \"chrome-101.0.0.0-windows\",\n \"ip\": \"1.2.3.4\",\n \"anonymous\": false\n }\n ]\n }\n },\n \"errorInformation\": \"\"\n}\n"}],"_postman_id":"7ebf95bf-28b3-407c-8515-9b2fd9df805b"}],"id":"6c3c8624-215a-4714-bd18-b8993a81e34f","_postman_id":"6c3c8624-215a-4714-bd18-b8993a81e34f","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]},"isInherited":true,"source":{"_postman_id":"9d53c167-22b7-46b6-a7da-3af2c102704d","id":"9d53c167-22b7-46b6-a7da-3af2c102704d","name":"3CX Video Conference API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"3CX-ApiKey"},{"key":"value","value":"Settings - Conference - Video - API Key"}]}},"event":[{"listen":"prerequest","script":{"id":"6b132af7-b613-4610-98d8-60f6c1ea1916","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d4493275-27c4-4f84-b81a-a598463dafb5","type":"text/javascript","exec":[""]}}],"variable":[{"key":"authHeader","value":"3CX-ApiKey"},{"key":"apiKey","value":"Settings - Conference - Video - API Key"},{"key":"FQDN","value":"3cx.contoso.com"},{"key":"port","value":"443"},{"key":"apiVersion","value":"v1"},{"key":"baseUrl","value":"https://3cx.contoso.com:443/webmeeting/api/v1"},{"key":"extension","value":"100"},{"key":"email","value":"johndoe@example.com"}]}