API Documentation

Get Vcons

GET/vcon

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    "text"
  ]
}

Post Vcon

POST/vcon

Body

vcon*Vcon

uuid*Uuid

created_atCreated At

subjectSubject

redactedRedacted

appendedAppended

groupGroup

partiesParties

dialogDialog

analysisAnalysis

attachmentsAttachments

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "vcon": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Get Vcon

GET/vcon/{vcon_uuid}

Path parameters

vcon_uuid*Vcon Uuid

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/{vcon_uuid}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Put Vcon

PUT/vcon/{vcon_uuid}

Path parameters

vcon_uuid*Vcon Uuid

Body

vcon*Vcon

uuid*Uuid

created_atCreated At

subjectSubject

redactedRedacted

appendedAppended

groupGroup

partiesParties

dialogDialog

analysisAnalysis

attachmentsAttachments

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/{vcon_uuid}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "vcon": "text",
      "uuid": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Delete Vcon

DELETE/vcon/{vcon_uuid}

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/{vcon_uuid}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Patch Vcon

PATCH/vcon/{vcon_uuid}

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

vcon*Vcon

uuid*Uuid

created_atCreated At

subjectSubject

redactedRedacted

appendedAppended

groupGroup

partiesParties

dialogDialog

analysisAnalysis

attachmentsAttachments

Request

const response = await fetch('/vcon/{vcon_uuid}', {
    method: 'PATCH',
    headers: {},
});
const data = await response.json();

Response

{
  "vcon": "text",
  "uuid": "123e4567-e89b-12d3-a456-426614174000",
  "subject": "text",
  "group": [
    {
      "uuid": "123e4567-e89b-12d3-a456-426614174000",
      "body": "text",
      "encoding": "text",
      "url": "text",
      "alg": "text",
      "signature": "text"
    }
  ],
  "parties": [
    {
      "tel": "text",
      "stir": "text",
      "mailto": "text",
      "name": "text",
      "validation": "text",
      "jcard": "text",
      "gmlpos": "text",
      "civicaddress": "text",
      "timezone": "text"
    }
  ],
  "dialog": [
    {
      "type": "recording",
      "duration": 0,
      "mimetype": "text",
      "filename": "text",
      "body": "text",
      "url": "text",
      "encoding": "text",
      "alg": "text",
      "signature": "text"
    }
  ],
  "analysis": [
    {
      "type": "text",
      "mimetype": "text",
      "filename": "text",
      "vendor": "text",
      "body": "text",
      "encoding": "text",
      "url": "text",
      "alg": "text",
      "signature": "text"
    }
  ],
  "attachments": [
    {
      "type": "text",
      "mimetype": "text",
      "filename": "text",
      "body": "text",
      "encoding": "text",
      "url": "text",
      "alg": "text",
      "signature": "text"
    }
  ]
}

Get Vcon Jq Transform

GET/vcon/{vcon_uuid}/jq

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/{vcon_uuid}/jq', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Vcon Json Path

GET/vcon/{vcon_uuid}/JSONPath

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon/{vcon_uuid}/JSONPath', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "tel": "text",
      "stir": "text",
      "mailto": "text",
      "name": "text",
      "validation": "text",
      "jcard": "text",
      "gmlpos": "text",
      "civicaddress": "text",
      "timezone": "text"
    }
  ]
}

Get Parties

GET/vcon/{vcon_uuid}/party

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon/{vcon_uuid}/party', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "tel": "text",
      "stir": "text",
      "mailto": "text",
      "name": "text",
      "validation": "text",
      "jcard": "text",
      "gmlpos": "text",
      "civicaddress": "text",
      "timezone": "text"
    }
  ]
}

Get Dialogs

GET/vcon/{vcon_uuid}/dialog

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon/{vcon_uuid}/dialog', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "recording",
      "duration": 0,
      "mimetype": "text",
      "filename": "text",
      "body": "text",
      "url": "text",
      "encoding": "text",
      "alg": "text",
      "signature": "text"
    }
  ]
}

Get Analyses

GET/vcon/{vcon_uuid}/analysis

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon/{vcon_uuid}/analysis', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "text",
      "mimetype": "text",
      "filename": "text",
      "vendor": "text",
      "body": "text",
      "encoding": "text",
      "url": "text",
      "alg": "text",
      "signature": "text"
    }
  ]
}

Get Attachments

GET/vcon/{vcon_uuid}/attachment

Path parameters

vcon_uuid*Vcon Uuid

Query parameters

Response

Successful Response

Body

items*Items

total*Total

page*Page

size*Size

Request

const response = await fetch('/vcon/{vcon_uuid}/attachment', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "items": [
    {
      "type": "text",
      "mimetype": "text",
      "filename": "text",
      "body": "text",
      "encoding": "text",
      "url": "text",
      "alg": "text",
      "signature": "text"
    }
  ]
}

Get Chains

GET/chain

Response

Successful Response

Body

any

Request

const response = await fetch('/chain', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Post Chain

POST/chain

Body

linksLinks

ingress_listsIngress Lists

storageStorage

egress_listsEgress Lists

enabledEnabled

Response

Successful Response

Body

any

Request

const response = await fetch('/chain', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get Chain

GET/chain/{chain_name}

Path parameters

chain_name*Chain Name

Response

Successful Response

Body

any

Request

const response = await fetch('/chain/{chain_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Put Chain

PUT/chain/{chain_name}

Path parameters

chain_name*Chain Name

Body

linksLinks

ingress_listsIngress Lists

storageStorage

egress_listsEgress Lists

enabledEnabled

Response

Successful Response

Body

any

Request

const response = await fetch('/chain/{chain_name}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete Chain

DELETE/chain/{chain_name}

Path parameters

chain_name*Chain Name

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/chain/{chain_name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Links

GET/link

Response

Successful Response

Body

any

Request

const response = await fetch('/link', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Post Link

POST/link

Body

module*Module

optionsOptions

ingress_listsIngress Lists

egress_listsEgress Lists

Response

Successful Response

Body

any

Request

const response = await fetch('/link', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "module": "text"
    }),
});
const data = await response.json();

Get Link

GET/link/{link_name}

Path parameters

link_name*Link Name

Response

Successful Response

Body

any

Request

const response = await fetch('/link/{link_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Put Link

PUT/link/{link_name}

Path parameters

link_name*Link Name

Body

module*Module

optionsOptions

ingress_listsIngress Lists

egress_listsEgress Lists

Response

Successful Response

Body

any

Request

const response = await fetch('/link/{link_name}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "module": "text"
    }),
});
const data = await response.json();

Delete Link

DELETE/link/{link_name}

Path parameters

link_name*Link Name

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/link/{link_name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Storages

GET/storage

Response

Successful Response

Body

any

Request

const response = await fetch('/storage', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Post Storage

POST/storage

Body

module*Module

optionsOptions

Response

Successful Response

Body

any

Request

const response = await fetch('/storage', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "module": "text"
    }),
});
const data = await response.json();

Get Storage

GET/storage/{storage_name}

Path parameters

storage_name*Storage Name

Response

Successful Response

Body

any

Request

const response = await fetch('/storage/{storage_name}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Put Storage

PUT/storage/{storage_name}

Path parameters

storage_name*Storage Name

Body

module*Module

optionsOptions

Response

Successful Response

Body

any

Request

const response = await fetch('/storage/{storage_name}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "module": "text"
    }),
});
const data = await response.json();

Delete Storage

DELETE/storage/{storage_name}

Path parameters

storage_name*Storage Name

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/storage/{storage_name}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Post Vcon Ingress

POST/vcon/ingress

Query parameters

Body

itemsstring

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/ingress', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      "text"
    ]),
});
const data = await response.json();

Get Vcon Engress

GET/vcon/egress

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/egress', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Vcon Count

GET/vcon/count

Query parameters

Response

Successful Response

Body

any

Request

const response = await fetch('/vcon/count', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create Vcon

POST/create_vcon

Body

name1*Name1

name2*Name2

tel1*Tel1

tel2*Tel2

ingress_list*Ingress List

filename*Filename

Response

Successful Response

Body

any

Request

const response = await fetch('/create_vcon', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({
      "name1": "text",
      "name2": "text",
      "tel1": "text",
      "tel2": "text",
      "ingress_list": "text",
      "filename": "binary"
    }),
});
const data = await response.json();

Tick

GET/tick

Response

Successful Response

Body

any

Request

const response = await fetch('/tick', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Incoming Something Handler

GET/incoming_something

Response

Successful Response

Body

any

Request

const response = await fetch('/incoming_something', {
    method: 'GET',
    headers: {},
});
const data = await response.json();