[Index]
PexipConference relation
Model ref.: relation/PexipConference
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"max_callrate_in": {
"required": false,
"type": "integer",
"title": "Max Callrate In"
},
"scheduled_conferences_count": {
"required": false,
"type": "integer",
"title": "Scheduled Conferences Count"
},
"teams_proxy": {
"required": false,
"type": "string",
"title": "Teams Proxy"
},
"guests_can_present": {
"required": false,
"type": "boolean",
"title": "Guests Can Present"
},
"allow_guests": {
"required": false,
"type": "boolean",
"title": "Allow Guests"
},
"two_stage_dial_type": {
"required": false,
"type": "string",
"title": "Two_stage_dial_type"
},
"creation_time": {
"required": false,
"type": "string",
"title": "Creation Time"
},
"host_view": {
"default": "one_main_seven_pips",
"choices": [
{
"value": "one_main_zero_pips",
"title": "Full-screen main speaker only (1 + 0 layout)"
},
{
"value": "four_mains_zero_pips",
"title": "4 main speakers only (4 + 0 layout)"
},
{
"value": "one_main_seven_pips",
"title": "Large main speaker and up to 7 other participants (1 + 7 layout)"
},
{
"value": "one_main_twentyone_pips",
"title": "Small main speaker and up to 21 other participants (1 + 21 layout)"
},
{
"value": "two_mains_twentyone_pips",
"title": "2 small main speakers and up to 21 other participants (2 + 21 layout)"
}
],
"required": false,
"type": "string",
"title": "Host View"
},
"max_callrate_out": {
"required": false,
"type": "integer",
"title": "Max Callrate Out"
},
"tag": {
"required": false,
"type": "string",
"title": "Tag"
},
"max_pixels_per_second": {
"choices": [
{
"value": "",
"title": "Use global setting"
},
{
"value": "sd",
"title": "SD"
},
{
"value": "hd",
"title": "HD"
},
{
"value": "fullhd",
"title": "Full HD (1080p)"
}
],
"required": false,
"type": "string",
"title": "Max Pixels Per Second"
},
"AutomaticParticipant": {
"items": {
"type": "object",
"properties": {
"conference": {
"items": {
"type": "string"
},
"readonly": true,
"required": false,
"type": "array",
"title": "Conference"
},
"protocol": {
"readonly": true,
"required": false,
"type": "string",
"title": "Protocol"
},
"description": {
"readonly": true,
"required": false,
"type": "string",
"title": "Description"
},
"dtmf_sequence": {
"readonly": true,
"required": false,
"type": "string",
"title": "DTMF Sequence"
},
"streaming": {
"readonly": true,
"required": false,
"type": "boolean",
"title": "Streaming"
},
"creation_time": {
"readonly": true,
"required": false,
"type": "string",
"title": "Creation Time"
},
"remote_display_name": {
"readonly": true,
"required": false,
"type": "string",
"title": "Remote display name"
},
"alias": {
"required": false,
"type": "string",
"title": "Alias"
},
"presentation_url": {
"readonly": true,
"required": false,
"type": "string",
"title": "Presentation URL"
},
"role": {
"readonly": true,
"required": false,
"type": "string",
"title": "Role"
},
"routing": {
"readonly": true,
"required": false,
"type": "string",
"title": "Routing"
},
"keep_conference_alive": {
"readonly": true,
"required": false,
"type": "string",
"title": "Keep conference alive"
},
"system_location": {
"readonly": true,
"required": false,
"type": "string",
"title": "System location"
},
"id": {
"readonly": true,
"required": false,
"type": "string",
"title": "Id"
},
"call_type": {
"readonly": true,
"required": false,
"type": "string",
"title": "Call Type"
},
"resource_uri": {
"readonly": true,
"required": false,
"type": "string",
"title": "Resource URI"
}
}
},
"type": "array",
"title": "Automatic Participant"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
},
"mssip_proxy": {
"required": false,
"type": "string",
"title": "MSSIP Proxy"
},
"replace_string": {
"required": false,
"type": "string",
"title": "Replace String"
},
"enable_overlay_text": {
"required": false,
"type": "boolean",
"title": "Enable Overlay Text"
},
"sync_tag": {
"required": false,
"type": "string",
"title": "Sync Tag"
},
"call_type": {
"default": "video",
"choices": [
{
"value": "audio",
"title": "Audio-only"
},
{
"value": "video",
"title": "Main video + presentation"
},
{
"value": "video-only",
"title": "Main video only"
}
],
"required": false,
"type": "string",
"title": "Call Type"
},
"pin": {
"required": false,
"type": "string",
"title": "Pin"
},
"post_match_string": {
"required": false,
"type": "string",
"title": "Post Match String"
},
"service_type": {
"required": false,
"type": "string",
"title": "Service Type"
},
"mute_all_guests": {
"required": false,
"type": "boolean",
"title": "Mute All Guests"
},
"crypto_mode": {
"default": "",
"choices": [
{
"value": "",
"title": "Use global setting"
},
{
"value": "besteffort",
"title": "Best effort"
},
{
"value": "on",
"title": "Required"
},
{
"value": "off",
"title": "No encryption"
}
],
"required": false,
"type": "string",
"title": "Crypto Mode"
},
"description": {
"required": false,
"type": "string",
"title": "Description"
},
"participant_limit": {
"required": false,
"type": "integer",
"title": "Participant Limit"
},
"enable_chat": {
"default": "default",
"choices": [
{
"value": "default",
"title": "Use global chat setting"
},
{
"value": "yes",
"title": "Yes"
},
{
"value": "no",
"title": "No"
}
],
"required": false,
"type": "string",
"title": "Enable Chat"
},
"guest_view": {
"required": false,
"type": "string",
"title": "Guest View"
},
"guest_pin": {
"required": false,
"type": "string",
"title": "Guest Pin"
},
"ConferenceAlias": {
"items": {
"type": "object",
"properties": {
"conference": {
"readonly": true,
"required": false,
"type": "string",
"title": "Conference"
},
"description": {
"required": false,
"type": "string",
"title": "Description"
},
"creation_time": {
"readonly": true,
"required": false,
"type": "string",
"title": "Creation Time"
},
"alias": {
"required": false,
"type": "string",
"title": "Alias"
},
"id": {
"readonly": true,
"type": "string",
"title": "Id"
},
"resource_uri": {
"readonly": true,
"required": false,
"type": "string",
"title": "Resource URI"
}
}
},
"type": "array",
"title": "Conference Alias"
},
"system_location": {
"required": false,
"type": "string",
"title": "System Location"
},
"gms_access_token": {
"required": false,
"type": "string",
"title": "GMS Access Token"
},
"ivr_theme": {
"target": "/api/device/pexip/IvrTheme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"convert_to_primary_key": true,
"choices": [],
"target_attr": "name",
"target_model_type": "device/pexip/IvrTheme",
"title": "IVR Theme",
"type": "string"
},
"primary_owner_email_address": {
"required": true,
"type": "string",
"title": "Primary Owner Email Address"
},
"name": {
"required": true,
"type": "string",
"title": "Name"
},
"post_replace_string": {
"required": false,
"type": "string",
"title": "Post Replace String"
},
"match_string": {
"required": false,
"type": "string",
"title": "Match String"
},
"scheduled_conferences": {
"items": {
"type": "string"
},
"required": false,
"type": "array",
"title": "Scheduled Conferences"
},
"force_presenter_into_main": {
"required": false,
"type": "boolean",
"title": "Force Presenter Into Main"
},
"resource_uri": {
"readonly": true,
"required": false,
"type": "string",
"title": "Resource URI"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/PexipConference/add/ |
|
The GUI Add form of relation/PexipConference as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/PexipConference | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/PexipConference/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/PexipConference/[pkid1]", "/api/relation/PexipConference/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/PexipConference/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/PexipConference; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/PexipConference/export/ |
|
{ "hrefs":["/api/relation/PexipConference/[pkid1]", "/api/relation/PexipConference/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/PexipConference and the JSON format can be used to import instances of relation/PexipConference.
GET http://[host-proxy]/api/relation/PexipConference/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/PexipConference | POST | /api/relation/PexipConference/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/PexipConference/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/PexipConference/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/PexipConference/ |
|
The relation/PexipConference schema and all instances as JSON. |
(The list will return 0 to 3 relation/PexipConference instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/PexipConference/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/PexipConference/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/PexipConference/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/relation/PexipConference/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/relation/PexipConference/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/PexipConference/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/relation/PexipConference/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/relation/PexipConference/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/PexipConference/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/PexipConference/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/PexipConference",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"export"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "ivr_theme",
"title": "IVR Theme"
},
{
"name": "service_type",
"title": "Service Type"
},
{
"name": "primary_owner_email_address",
"title": "Owner's email address"
},
{
"name": "host_view",
"title": "View"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/PexipConference. | GET | /api/relation/PexipConference/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/PexipConference as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/PexipConference/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/PexipConference/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/PexipConference; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/PexipConference/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
Content-Language:en
Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
Content-Language:en
Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/PexipConference and the JSON format can be used to import instances of relation/PexipConference.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/PexipConference/[pkid] | hierarchy=[hierarchy] | The relation/PexipConference instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/PexipConference/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/PexipConference. |