Management configuration API

Resource details

More information can be obtained for each resource by downloading the resource schema in a browser. You may want to install a JSON viewer extension to your browser in order to view the JSON strings in a readable format.

For example, to view the schema for aliases the URI would be:

https://<manageraddress>/api/admin/configuration/v1/conference_alias/schema/?format=json

Each schema contains information on the available fields including:

• whether the field is optional (nullable: true) or required (nullable: false)
• the default value
• the type of data the field must contain
• the choices for the field, e.g. valid_choices: ["audio", "video", "video-only"]
• which criteria can be used for filtering and ordering searches
• help text with additional information on usage.

Resource methods

Each configuration resource supports the following HTTP methods:

Getting resource details

See Retrieving, paginating, filtering and ordering resource details for information about how to retrieve the current configuration for a resource.

Creating a single resource object

To create a new object resource, a POST request is submitted to the root URI for the resource. The data should be a JSON object whose attributes match the field values for the resource.

Fields with default values may be omitted from the data.

The response to the POST method contains a Location header which contains the REST URI of the newly created resource.

For example, the URI of a VMR resource takes the format: /api/admin/configuration/v1/conference/<object ID>/

Note that Pexip Infinity always allocates a new object ID when creating a new resource.

Updating a single resource object

To update a single resource object, a PATCH request is submitted to the URI created by concatenating the object ID with the root URI of the resource.

For example, to make changes to the alias with ID 1 the URI would be:

https://<manageraddress>/api/admin/configuration/v1/conference_alias/1/

Updating multiple resource objects

The PATCH method can be used to create, update or delete multiple objects at once. To update multiple objects a PATCH request is submitted to the root URI for the resource. The data must be formatted as a JSON object with a single attribute objects whose value is a list of the new objects.

Note: for any objects in the list that already exist, the resource_uri field must be included in the request. For any objects that are to be created by the PATCH request, the resource_uri field should be omitted.

Deleting all resource objects

If a DELETE operation is invoked on the root resource URI, then all the resource objects will be deleted. You should therefore use this operation with caution, and ensure you include the resource ID in the URI unless your intention actually is to delete all objects.

For example, to delete ALL Virtual Meeting Rooms, the URI is:

"https://<manageraddress>/api/admin/configuration/v1/conference/"

whereas to delete the single Virtual Meeting Room with ID 1 only, the URI is:

"https://<manageraddress>/api/admin/configuration/v1/conference/1/"

Examples

Creating a Virtual Meeting Room, Virtual Auditorium, Virtual Reception, or Test Call Service

To create a new Virtual Meeting Room, Virtual Auditorium, Virtual Reception, or Test Call Service, you must submit a POST to the URI for this resource. You must specify the service_type as follows:

• conference for a Virtual Meeting Room
• lecture for a Virtual Auditorium
• two_stage_dialing for a Virtual Reception
• media_playback for a Media Playback Service
• test_call for a Test Call Service

If you do not specify a service_type, the service will by default be created as a Virtual Meeting Room.

The following example creates a new Virtual Meeting Room with the name VMR_1. It has no aliases.

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={'name': 'VMR_1', 'service_type': 'conference'}
    )
print("Created new Virtual Meeting Room:", response.headers['location'])

Getting a Virtual Meeting Room's configuration

By submitting a GET to the resource URI of a Virtual Meeting Room, you can get its configuration:

import json
import requests
response = requests.get(
    "https://<manageraddress>/api/admin/configuration/v1/conference/1/",
    auth=('<user1>', '<password1>'),
    verify=True
    )
print("Virtual Meeting Room:", response.json())

Example output

Virtual Meeting Room: {
    'aliases': [
        {
        'alias': 'meet@example.com',
        'conference': '/api/admin/configuration/v1/conference/1/',
        'creation_time': '2017-05-11T22:02:05.855877',
        'description': '',
        'id': 1
        }
        ]
    'allow_guests': False,
    'automatic_participants': [],
    'call_type': 'video',
    'creation_time': '2017-05-11T22:02:05.848612',
    'crypto_mode: '',
    'description': '',
    'enable_active_speaker_indication': false,
    'enable_chat': 'default',
    'enable_overlay_text': false,
    'force_presenter_into_main': false,
    'guest_identity_provider_group': '',
    'guest_pin': '',
    'guest_view': None,
    'guests_can_present': true,
    'host_identity_provider_group': '',
    'host_view': 'one_main_seven_pips',
    'id': 1,
    'ivr_theme': None,
    'match_string': '',
    'max_callrate_in': None,
    'max_callrate_out': None,
    'max_pixels_per_second': None,
    'mssip_proxy': null,
    'mute_all_guests': false,
    'name': 'VMR_1',
    'non_idp_paticipants': 'disallow_all',
    'participant_limit': None,
    'pin': '',
    'primary_owner_email_address': '',
    'replace_string': '',
    'resource_uri': '/api/admin/configuration/v1/conference/1/',
    'service_type': 'conference',
    'sync_tag': '',
    'system_location': null,
    'tag': ''
    }

Changing an existing Virtual Meeting Room

Submitting a PATCH to an existing Virtual Meeting Room URI allows the data for that Virtual Meeting Room to be modified.

The following example updates the Virtual Meeting Room PIN to 1234:

import json
import requests
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/conference/1/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={'pin': '1234'}
    )

Adding a Virtual Meeting Room alias

A Virtual Meeting Room must already exist before you can add an alias to it. To do this you submit a POST to the resource URI for Virtual Meeting Room aliases and add the partial URI of the Virtual Meeting Room to the data POSTed.

The following example creates a new alias meet@example.com for the Virtual Meeting Room with ID 1.

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/conference_alias/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'alias': 'meet@example.com',
        'conference': '/api/admin/configuration/v1/conference/1/',
        }
    )
print("Created new alias:", response.headers['location'])

Note that the request is rejected if the alias already exists.

Deleting a Virtual Meeting Room

Deleting a Virtual Meeting Room is achieved by submitting a DELETE request to an existing Virtual Meeting Room URI.

The following example deletes the Virtual Meeting Room with ID 1:

import requests
response = requests.delete(
    "https://<manageraddress>/api/admin/configuration/v1/conference/1/",
    auth=('<user1>', '<password1>'),
    verify=True
    )

Deleting a Virtual Meeting Room will also delete all aliases associated with it.

Creating a Virtual Meeting Room with aliases

To simplify the creation of a Virtual Meeting Room and the aliases that belong to it, you can submit a single POST with all the information.

The following example creates a new Virtual Meeting Room with the name VMR_1 and two aliases: meet and meet@example.com:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'name': 'VMR_1',
        'service_type': 'conference',
        'aliases': [{'alias' : 'meet'}, {'alias' : 'meet@example.com'}]
        }
    )
print("Created new Virtual Meeting Room:", response.headers['location'])

Note that if there is an existing VMR with the same alias, that alias is removed from the previous VMR and assigned to the new VMR.

Getting all Virtual Meeting Rooms, Virtual Auditoriums and Virtual Receptions

Retrieving all the configured Virtual Meeting Rooms, Virtual Auditoriums and Virtual Receptions is achieved by submitting a GET request to the resource URI they all share:

import json
import requests
response = requests.get(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True
    )
print("Virtual Meeting Rooms:", response.json()['objects'])

Getting all Virtual Meeting Rooms only

To retrieve all the configured Virtual Meeting Rooms but not Virtual Auditoriums or Virtual Receptions, you submit a GET request to the resource URI as above but filter it by service_type:

import json
import requests
response = requests.get(
    "https://<manageraddress>/api/admin/configuration/v1/conference/?service_type=conference",
    auth=('<user1>', '<password1>'),
    verify=True
    )
print("Virtual Meeting Rooms:", response.json()['objects'])

Creating multiple Virtual Meeting Rooms

Multiple Virtual Meeting Rooms can be created using a PATCH request.

The following example creates two Virtual Meeting Rooms; the first with the name VMR_1 and an alias meet1@example.com, and the second with the name VMR_2 and an alias meet2@example.com:

import json
import requests
data = { 'objects' : [
    {'name' : 'VMR_1', 'service_type': 'conference', 'aliases' : [{'alias' : 'meet1@example.com'}]},
    {'name' : 'VMR_2', 'service_type': 'conference', 'aliases' : [{'alias' : 'meet2@example.com'}]},
    ]}
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json=data
    )

Deleting multiple Virtual Meeting Rooms

Multiple Virtual Meeting Rooms can be deleted using a PATCH request.

The following example deletes four Virtual Meeting Rooms. The deleted_objects list should refer to existing VMR URIs; in this example it refers to the VMRs with IDs of 5, 46, 47 and 65.

import json
import requests
data = {
    'deleted_objects' : [
    "/api/admin/configuration/v1/conference/5/",
    "/api/admin/configuration/v1/conference/46/",
    "/api/admin/configuration/v1/conference/47/",
    "/api/admin/configuration/v1/conference/65/",
    ],
    "objects": []
    }
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json=data
    )

Creating a Virtual Auditorium

The following example creates a new Virtual Auditorium with the name Lecture and a single alias lecture@example.com:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'name': 'Lecture',
        'service_type': 'lecture',
        'aliases': [{'alias' : 'lecture@example.com'}]
        }
    )
print("Created new Virtual Auditorium:", response.headers['location'])

Creating a Virtual Reception

The following example creates a new Virtual Reception with the name Reception and a single alias reception@example.com:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/conference/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'name': 'Reception',
        'service_type': 'two_stage_dialing',
        'aliases': [{'alias' : 'reception@example.com'}]
        }
    )
print("Created new Virtual Reception:", response.headers['location'])

Creating Automatically Dialed Participants

You can create a new Automatically Dialed Participant by submitting a POST request to the resource URI for Automatically Dialed Participants. Automatically dialed participants are a little different from other resources as they may be associated with many different Virtual Meeting Rooms and Virtual Auditoriums.

The following example creates an Automatically Dialed Participant and associates them with an already created Virtual Meeting Room with ID 1:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/automatic_participant/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'alias' : 'myendpoint@mydomain.com',
        'remote_display_name' : 'My Name',
        'description' : "Dial myendpoint@mydomain.com whenever a related conference starts",
        'protocol' : 'sip',
        'role' : 'guest',
        'conference' : ['/api/admin/configuration/v1/conference/1/']
        }
    )
print("Created new automatically dialed participant:", response.headers['location'])

Modifying an Automatically Dialed Participant

The following examples use PATCH to modify an existing Automatically Dialed Participant.

The example below associates the Automatically Dialed Participant (created above) with two (already created) Virtual Meeting Rooms — one with ID 1, one with ID 2:

import json
import requests
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/automatic_participant/1/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'conference' : ['/api/admin/configuration/v1/conference/1/',
        '/api/admin/configuration/v1/conference/2/']
        }
    )
print("added existing automatic participant to an additional meeting room:", response)

Removing an Automatically Dialed Participant from a Virtual Meeting Room

The example below removes the association between the Automatically Dialed Participant and the Virtual Meeting Rooms:

import json
import requests
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/automatic_participant/1/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'conference' : []
        }
    )
print("Removed automatic participant from all meeting rooms:", response)

Deleting an Automatically Dialed Participant

The following example deletes the Automatically Dialed Participant with ID 1:

import requests
response = requests.delete(
    "https://<manageraddress>/api/admin/configuration/v1/automatic_participant/1/",
    auth=('<user1>', '<password1>'),
    verify=True
    )

Creating Call Routing Rules

To create a new Call Routing Rule you submit a POST to the URI for that resource.

The following example creates a Call Routing Rule with the name Route to Teams, which routes incoming Infinity Gateway calls (via H.323 or SIP) to Microsoft Teams:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/gateway_routing_rule/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'name': 'Route to Teams',
        'priority': 50,
        'match_incoming_calls': True,
        'match_outgoing_calls': False,
        'match_incoming_h323': True,
        'match_incoming_mssip': False,
        'match_incoming_sip': True,
        'match_incoming_webrtc': False,
        'match_string': '(\d{9,12})(@example\.com)?',
        'replace_string': '\1',
        'called_device_type': 'teams_conference',
        'outgoing_protocol': 'teams',
        }
    )
print("Created new Call Routing Rule:", response.headers['location'])

This example creates a Call Routing Rule that applies to outbound calls made from Pexip VMRs and routes them to registered devices only:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/gateway_routing_rule/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'name': 'Outbound calls to registered devices',
        'priority': 60,
        'match_incoming_calls': False,
        'match_outgoing_calls': True,
        'match_string': '.*@mycompany\.com',
        'replace_string': '',
        'called_device_type': 'registration',
        }
    )
print("Created new Call Routing Rule:", response.headers['location'])

Deleting a Call Routing Rule

The following example deletes the Call Routing Rule with ID 1:

import requests
response = requests.delete(
    "https://<manageraddress>/api/admin/configuration/v1/gateway_routing_rule/1/",
    auth=('<user1>', '<password1>'),
    verify=True
    )

Downloading a Conferencing Node for deployment

By submitting a POST request specifying a deployment_type from the list below, you can download an OVA (or ZIP file for Hyper-V) which can be used to deploy a new Proxying Edge Node onto the appropriate host server:

• MANUAL-ESXI6_7
• MANUAL-ESXI6
• MANUAL-HYPERV2012
• MANUAL-KVM

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/worker_vm/",
    auth=('<user1>', '<password1>'),
    verify=True,
    stream=True,
    json={
        'name': 'new_node',
        'hostname': 'newnode',
        'domain': 'example.test',
        'address': '<newnode_ip_address>',
        'netmask': '<newnode_ip_mask>',
        'gateway': '<ip_gateway_address>',
        'password': '<newnode_password>',
        'node_type': 'PROXYING',
        'system_location': '/api/admin/configuration/v1/system_location/1/',
        'deployment_type': 'MANUAL-ESXI6_7',
        'vm_cpu_count': '8',
        'vm_system_memory': '16384',
        }
    )
with open('conferencing_node.ova', 'wb') as handle:
    for chunk in response.iter_content(10*1024):
        handle.write(chunk)
print("Downloaded Conferencing Node OVA: conferencing_node.ova")

Deploying a Conferencing Node using a VM template and configuration file

You can use a deployment_type of MANUAL-PROVISION-ONLY to create a VM template for deployment onto unsupported hypervisors or orchestration layers.

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/worker_vm/",
    auth=('<user1>', '<password1>'),
    verify=True,
    stream=True,
    json={
        'name': 'new_node',
        'hostname': 'newnode',
        'domain': 'example.test',
        'address': '<newnode_ip_address>',
        'netmask': '<newnode_ip_mask>',
        'gateway': '<ip_gateway_address>',
        'password': '<newnode_password>',
        'node_type': 'CONFERENCING',
        'system_location': '/api/admin/configuration/v1/system_location/1/',
        'deployment_type': 'MANUAL-PROVISION-ONLY',
        }
    )
with open('conferencing_node.xml', 'wb') as handle:
    for chunk in response.iter_content(10*1024):
        handle.write(chunk)
print("Downloaded Conferencing Node provisioning document: conferencing_node.xml")

After the provisioning document has been obtained from the management API as above, it may be injected into the Conferencing Node to be provisioned as follows:

import requests
with open('conferencing_node.xml', 'rb') as handle:
    document = handle.read()
    response = requests.post(
        "https://<conferencingnodeaddress>:8443/configuration/bootstrap",
        verify=True,
        headers={'Content-Type': 'text/xml'},
        data=document,
        )
    if response.status_code == requests.codes.ok:
        print("Successfully provisioned Conferencing Node")

Note that this API is available only on Conferencing Nodes created using the MANUAL-PROVISION-ONLY deployment type.

Uploading a service theme

The following example will create a new theme, upload the theme contents and then configure a VMR to use the theme:

import requests
import json
from urllib.parse import urlsplit
​
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/ivr_theme/",
    auth=("<user1>", "<password1>"),
    json={"name": "New theme"},
    verify=True,
)
theme_uri = response.headers["location"]
theme_path = urlsplit(theme_uri).path
response = requests.patch(
    theme_uri,
    auth=("<user1>", "<password1>"),
    files={"package": open("test_theme.zip", "rb")},
    verify=True,
)
response = requests.patch(
    "https://<manageraddress>/api/admin/configuration/v1/conference/1/",
    auth=("<user1>", "<password1>"),
    json={"ivr_theme": theme_path},
    verify=True,
)

Returning a license

To return a license, send a DELETE request using the format:

import requests
response = requests.delete(
    "https://<manageraddress>/api/admin/configuration/v1/licence/<fulfillment_id>",
    auth=('<user1>', '<password1>'),
    verify=True
    )

where:

• the fulfillment ID is a 10 digit number
• you can force offline mode by adding ?offline_mode=True to the end of the URI, in which case it will return with a 202 response and a Location header telling you where to POST the response document.

Adding a license

To add a license entitlement key, send a POST request using the format:

import json
import requests
response = requests.post(
    "https://<manageraddress>/api/admin/configuration/v1/licence/",
    auth=('<user1>', '<password1>'),
    verify=True,
    json={
        'entitlement_id' : '<entitlement key>'
        }
    )
print("Added license entitlement key:", response.headers['location'])

where:

• the entitlement key is in the form XXXX-XXXX-XXXX-XXXX (where X is a hex digit [0-9A-F]) or is in an encoded format such as SrF1FPcyRjitSHOhtU_XGQ==
• you can force offline mode by adding 'offline_mode' : True to the JSON data, in which case it will return with a 202 response and a Location header telling you where to GET the request file from, and also where to POST the response document.

To export an offline/stored license request file, you can use:

import json
import requests
response = requests.get(
    "https://<manageraddress>/api/admin/configuration/v1/licence_request/<request_id>/export",
    auth=('<user1>', '<password1>'),
    verify=True
    )
print("License request:", response.json()['actions'])

where the URL to GET the file from is the one returned in the Location header of the response to the initial activation request.

To upload a license response file for a stored license request:

import requests
with open('response.xml', 'r') as response_file:
    response = requests.post(
        'https://<manageraddress>/api/admin/configuration/v1/licence_request/<request_id>',
        auth=('<user1>', '<password1>'),
        verify=True,
        files={'response_xml': ('response.xml', response_file.read())})
    print(response.status_code)