Skip to content

Latest commit

 

History

History
675 lines (494 loc) · 13.8 KB

openapi.md

File metadata and controls

675 lines (494 loc) · 13.8 KB
Raw
title language_tabs language_clients toc_footers includes search highlight_theme headingLevel
Video Conferencing Service v1.0.0
'javascript
JavaScript
'javascript--nodejs
Node.JS'
'javascript
request'
'javascript--nodejs
false
darkula
2

Video Conferencing Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

A Video conferencing service example

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

VideoChatArchiveController

VideoChatArchiveController.setUploadTarget

Code samples

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/plain'
};

fetch('http://localhost:3000/archives/storage-target',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /archives/storage-target

Body parameter

{}

Parameters

Name In Type Required Description
body body object false none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none text
This operation does not require authentication

VideoChatArchiveController.getArchive

Code samples

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:3000/archives/{archiveId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /archives/{archiveId}

Parameters

Name In Type Required Description
archiveId path string true none

Example responses

200 Response

{}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

This operation does not require authentication

VideoChatArchiveController.deleteArchive

Code samples

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'
};

fetch('http://localhost:3000/archives/{archiveId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /archives/{archiveId}

Parameters

Name In Type Required Description
archiveId path string true none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none text
This operation does not require authentication

VideoChatArchiveController.getArchives

Code samples

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('http://localhost:3000/archives',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /archives

Example responses

200 Response

{}

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

This operation does not require authentication

VideoChatSessionController

VideoChatSessionController.getAttendeesList

Code samples

const fetch = require('node-fetch');

const headers = {
  'Accept':'text/plain'
};

fetch('http://localhost:3000/session/{meetingLinkId}/attendees',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /session/{meetingLinkId}/attendees

Parameters

Name In Type Required Description
meetingLinkId path string true none
active query string false none

Example responses

200 Response

[]

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

This operation does not require authentication

VideoChatSessionController.endSession

Code samples

const fetch = require('node-fetch');

fetch('http://localhost:3000/session/{meetingLinkId}/end',
{
  method: 'PATCH'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /session/{meetingLinkId}/end

Parameters

Name In Type Required Description
meetingLinkId path string true none

Responses

Status Meaning Description Schema
204 No Content MessageRecipient PATCH success None
This operation does not require authentication

VideoChatSessionController.getMeetingToken

Code samples

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('http://localhost:3000/session/{meetingLinkId}/token',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /session/{meetingLinkId}/token

Body parameter

{}

Parameters

Name In Type Required Description
meetingLinkId path string true none
body body object false none

Example responses

200 Response

null

Responses

Status Meaning Description Schema
200 OK none Inline

Response Schema

This operation does not require authentication

VideoChatSessionController.editMeeting

Code samples

const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": 0,
  "sessionId": "string",
  "meetingLink": "string",
  "isScheduled": true,
  "scheduleTime": "2019-08-24T14:15:22Z",
  "isArchived": true,
  "archiveId": "string",
  "uploadTarget": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "extId": "string",
  "extMetadata": {}
};
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:3000/session/{meetingLinkId}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /session/{meetingLinkId}

Body parameter

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": 0,
  "sessionId": "string",
  "meetingLink": "string",
  "isScheduled": true,
  "scheduleTime": "2019-08-24T14:15:22Z",
  "isArchived": true,
  "archiveId": "string",
  "uploadTarget": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "extId": "string",
  "extMetadata": {}
}

Parameters

Name In Type Required Description
meetingLinkId path string true none
body body VideoChatSessionPartial false none

Responses

Status Meaning Description Schema
204 No Content Session details PATCH success None
This operation does not require authentication

VideoChatSessionController.getMeetingLink

Code samples

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json',
  'Accept':'text/plain'
};

fetch('http://localhost:3000/session',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /session

Body parameter

{}

Parameters

Name In Type Required Description
body body object false none

Example responses

200 Response

"string"

Responses

Status Meaning Description Schema
200 OK none string
This operation does not require authentication

VideoChatSessionController.checkWebhookPayload

Code samples

const fetch = require('node-fetch');
const inputBody = {};
const headers = {
  'Content-Type':'application/json'
};

fetch('http://localhost:3000/webhooks/session',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /webhooks/session

Body parameter

{}

Parameters

Name In Type Required Description
body body object false none

Responses

Status Meaning Description Schema
204 No Content POST /webhooks/session Success None
This operation does not require authentication

Schemas

VideoChatSessionPartial

{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": 0,
  "sessionId": "string",
  "meetingLink": "string",
  "isScheduled": true,
  "scheduleTime": "2019-08-24T14:15:22Z",
  "isArchived": true,
  "archiveId": "string",
  "uploadTarget": "string",
  "startTime": "2019-08-24T14:15:22Z",
  "endTime": "2019-08-24T14:15:22Z",
  "extId": "string",
  "extMetadata": {}
}

VideoChatSessionPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id number false none none
sessionId string false none none
meetingLink string false none none
isScheduled boolean false none none
scheduleTime string(date-time) false none none
isArchived boolean false none none
archiveId string false none none
uploadTarget string false none none
startTime string(date-time) false none none
endTime string(date-time) false none none
extId string false none none
extMetadata object false none none