WSC Gateway

# Install the command line client
$ pip install coreapi-cli

# Install the Python client library
$ pip install coreapi

api

v1 > conference > create

POST /api/v1/conference/

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`caller` required
`receiver` required
`notifications` required
`source` required

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action api v1 conference create -p caller=... -p receiver=... -p notifications=... -p source=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "v1 > conference > create"]
var params = {
    caller: ...,
    receiver: ...,
    notifications: ...,
    source: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["api", "v1 > conference > create"]
params = {
    "caller": ...,
    "receiver": ...,
    "notifications": ...,
    "source": ...,
}
result = client.action(schema, action, params=params)

v1 > conference > read

GET /api/v1/conference/{token}/

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`token` required

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action api v1 conference read -p token=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "v1 > conference > read"]
var params = {
    token: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["api", "v1 > conference > read"]
params = {
    "token": ...,
}
result = client.action(schema, action, params=params)

v1 > conference-data > list

GET /api/v1/conference-data/

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action api v1 conference-data list

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "v1 > conference-data > list"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["api", "v1 > conference-data > list"]
result = client.action(schema, action)

v1 > video-call > create

POST /api/v1/video-call/

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action api v1 video-call create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["api", "v1 > video-call > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["api", "v1 > video-call > create"]
result = client.action(schema, action)

conference

api > callback > create

POST /conference/api/callback/

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action conference api callback create

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["conference", "api > callback > create"]
client.action(schema, action).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["conference", "api > callback > create"]
result = client.action(schema, action)

api > make > create

POST /conference/api/make

API to create a Conference endpoints. Token or Session Authorization is required.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`provider`
`callback_endpoint`	Callback endpoint where will be notified events regarding room or participants. All requests will contain HMAC SHA256 signature in the request header with key SIGNATURE. Signature are composed with a [SECRET-KEY] + [ROOM-ID]
`chat_enabled`
`automatic_join`

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action conference api make create -p provider=... -p callback_endpoint=... -p chat_enabled=... -p automatic_join=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["conference", "api > make > create"]
var params = {
    provider: ...,
    callback_endpoint: ...,
    chat_enabled: ...,
    automatic_join: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["conference", "api > make > create"]
params = {
    "provider": ...,
    "callback_endpoint": ...,
    "chat_enabled": ...,
    "automatic_join": ...,
}
result = client.action(schema, action, params=params)

api > make-external > create

POST /conference/api/make-external

API to create a Conference endpoints. Token or Session Authorization is required.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

Parameter	Description
`provider`
`externalbackend` required

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action conference api make-external create -p provider=... -p externalbackend=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["conference", "api > make-external > create"]
var params = {
    provider: ...,
    externalbackend: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["conference", "api > make-external > create"]
params = {
    "provider": ...,
    "externalbackend": ...,
}
result = client.action(schema, action, params=params)

api > retrieve > read

GET /conference/api/retrieve/{slug}/

API to retrieve a Conference data.

Path Parameters

The following parameters should be included in the URL path.

Parameter	Description
`slug` required

# Load the schema document
$ coreapi get https://wsc-gtw.europassistance.it/

# Interact with the API endpoint
$ coreapi action conference api retrieve read -p slug=...

var coreapi = window.coreapi  // Loaded by `coreapi.js`
var schema = window.schema    // Loaded by `schema.js`

// Initialize a client
var client = new coreapi.Client()

// Interact with the API endpoint
var action = ["conference", "api > retrieve > read"]
var params = {
    slug: ...,
}
client.action(schema, action, params).then(function(result) {
    // Return value is in 'result'
})

import coreapi

# Initialize a client & load the schema document
client = coreapi.Client()
schema = client.get("https://wsc-gtw.europassistance.it/")

# Interact with the API endpoint
action = ["conference", "api > retrieve > read"]
params = {
    "slug": ...,
}
result = client.action(schema, action, params=params)