[Index]

API Reference for relation/PexipConference

PexipConference relation

Model ref.: relation/PexipConference

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/PexipConference/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema",
     "type": "object",
     "properties": {
          "id": {
               "readonly": true,
               "type": "string",
               "title": "Id"
          },
          "allow_guests": {
               "required": false,
               "type": "boolean",
               "title": "Allow Guests"
          },
          "call_type": {
               "required": false,
               "type": "string",
               "title": "Call Type",
               "choices": [
                    {
                         "value": "audio",
                         "title": "Audio-only"
                    },
                    {
                         "value": "video",
                         "title": "Main video + presentation"
                    },
                    {
                         "value": "video-only",
                         "title": "Main video only"
                    }
               ],
               "default": "video"
          },
          "creation_time": {
               "required": false,
               "type": "string",
               "title": "Creation Time"
          },
          "crypto_mode": {
               "required": false,
               "type": "string",
               "title": "Crypto Mode",
               "choices": [
                    {
                         "value": "",
                         "title": "Use global setting"
                    },
                    {
                         "value": "besteffort",
                         "title": "Best effort"
                    },
                    {
                         "value": "on",
                         "title": "Required"
                    },
                    {
                         "value": "off",
                         "title": "No encryption"
                    }
               ],
               "default": ""
          },
          "description": {
               "required": false,
               "type": "string",
               "title": "Description"
          },
          "enable_chat": {
               "required": false,
               "type": "string",
               "title": "Enable Chat",
               "choices": [
                    {
                         "value": "default",
                         "title": "Use global chat setting"
                    },
                    {
                         "value": "yes",
                         "title": "Yes"
                    },
                    {
                         "value": "no",
                         "title": "No"
                    }
               ],
               "default": "default"
          },
          "enable_overlay_text": {
               "required": false,
               "type": "boolean",
               "title": "Enable Overlay Text"
          },
          "force_presenter_into_main": {
               "required": false,
               "type": "boolean",
               "title": "Force Presenter Into Main"
          },
          "gms_access_token": {
               "required": false,
               "type": "string",
               "title": "GMS Access Token"
          },
          "guest_pin": {
               "required": false,
               "type": "string",
               "title": "Guest Pin"
          },
          "guest_view": {
               "required": false,
               "type": "string",
               "title": "Guest View"
          },
          "guests_can_present": {
               "required": false,
               "type": "boolean",
               "title": "Guests Can Present"
          },
          "host_view": {
               "required": false,
               "type": "string",
               "title": "Host View",
               "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)"
                    }
               ],
               "default": "one_main_seven_pips"
          },
          "ivr_theme": {
               "target": "/api/device/pexip/IvrTheme/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "target_attr": "name",
               "format": "uri",
               "convert_to_primary_key": true,
               "required": false,
               "type": "string",
               "title": "IVR Theme",
               "target_model_type": "device/pexip/IvrTheme",
               "choices": []
          },
          "match_string": {
               "required": false,
               "type": "string",
               "title": "Match String"
          },
          "max_callrate_in": {
               "required": false,
               "type": "integer",
               "title": "Max Callrate In"
          },
          "max_callrate_out": {
               "required": false,
               "type": "integer",
               "title": "Max Callrate Out"
          },
          "max_pixels_per_second": {
               "required": false,
               "type": "string",
               "title": "Max Pixels Per Second",
               "choices": [
                    {
                         "value": "",
                         "title": "Use global setting"
                    },
                    {
                         "value": "sd",
                         "title": "SD"
                    },
                    {
                         "value": "hd",
                         "title": "HD"
                    },
                    {
                         "value": "fullhd",
                         "title": "Full HD (1080p)"
                    }
               ]
          },
          "mssip_proxy": {
               "required": false,
               "type": "string",
               "title": "MSSIP Proxy"
          },
          "mute_all_guests": {
               "required": false,
               "type": "boolean",
               "title": "Mute All Guests"
          },
          "name": {
               "required": true,
               "type": "string",
               "title": "Name"
          },
          "participant_limit": {
               "required": false,
               "type": "integer",
               "title": "Participant Limit"
          },
          "pin": {
               "required": false,
               "type": "string",
               "title": "Pin"
          },
          "post_match_string": {
               "required": false,
               "type": "string",
               "title": "Post Match String"
          },
          "post_replace_string": {
               "required": false,
               "type": "string",
               "title": "Post Replace String"
          },
          "primary_owner_email_address": {
               "required": true,
               "type": "string",
               "title": "Primary Owner Email Address"
          },
          "replace_string": {
               "required": false,
               "type": "string",
               "title": "Replace String"
          },
          "resource_uri": {
               "readonly": true,
               "required": false,
               "type": "string",
               "title": "Resource URI"
          },
          "scheduled_conferences": {
               "items": {
                    "type": "string"
               },
               "required": false,
               "type": "array",
               "title": "Scheduled Conferences"
          },
          "scheduled_conferences_count": {
               "required": false,
               "type": "integer",
               "title": "Scheduled Conferences Count"
          },
          "service_type": {
               "required": false,
               "type": "string",
               "title": "Service Type"
          },
          "sync_tag": {
               "required": false,
               "type": "string",
               "title": "Sync Tag"
          },
          "system_location": {
               "required": false,
               "type": "string",
               "title": "System Location"
          },
          "tag": {
               "required": false,
               "type": "string",
               "title": "Tag"
          },
          "teams_proxy": {
               "required": false,
               "type": "string",
               "title": "Teams Proxy"
          },
          "two_stage_dial_type": {
               "required": false,
               "type": "string",
               "title": "Two_stage_dial_type"
          },
          "ConferenceAlias": {
               "title": "Conference Alias",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "id": {
                              "readonly": true,
                              "type": "string",
                              "title": "Id"
                         },
                         "alias": {
                              "required": false,
                              "type": "string",
                              "title": "Alias"
                         },
                         "conference": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Conference"
                         },
                         "creation_time": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Creation Time"
                         },
                         "description": {
                              "required": false,
                              "type": "string",
                              "title": "Description"
                         },
                         "resource_uri": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Resource URI"
                         }
                    }
               }
          },
          "AutomaticParticipant": {
               "title": "Automatic Participant",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "id": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Id"
                         },
                         "alias": {
                              "required": false,
                              "type": "string",
                              "title": "Alias"
                         },
                         "call_type": {
                              "required": false,
                              "readonly": true,
                              "type": "string",
                              "title": "Call Type"
                         },
                         "conference": {
                              "items": {
                                   "type": "string"
                              },
                              "required": false,
                              "readonly": true,
                              "type": "array",
                              "title": "Conference"
                         },
                         "creation_time": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Creation Time"
                         },
                         "description": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Description"
                         },
                         "dtmf_sequence": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "DTMF Sequence"
                         },
                         "keep_conference_alive": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Keep conference alive"
                         },
                         "presentation_url": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Presentation URL"
                         },
                         "protocol": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Protocol"
                         },
                         "remote_display_name": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Remote display name"
                         },
                         "resource_uri": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Resource URI"
                         },
                         "role": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Role"
                         },
                         "routing": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "Routing"
                         },
                         "streaming": {
                              "readonly": true,
                              "required": false,
                              "type": "boolean",
                              "title": "Streaming"
                         },
                         "system_location": {
                              "readonly": true,
                              "required": false,
                              "type": "string",
                              "title": "System location"
                         }
                    }
               }
          }
     }
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/PexipConference/add/	hierarchy=[hierarchy] format=json	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]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/PexipConference
```
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/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "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.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for 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/	hierarchy=[hierarchy] modeltype=relation/PexipConference	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 call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

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 call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/relation/PexipConference/	hierarchy=[hierarchy] format=json schema=true	The relation/PexipConference schema and all instances as JSON.

(The list will return 0 to 3 relation/PexipConference instances)

GET http://[host]/api/relation/PexipConference/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "name",
          "direction": "asc",
          "current": "/api/relation/PexipConference/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
     },
     "operations": [
          "list",
          "help",
          "field_display_policy",
          "get",
          "configuration_template",
          "update",
          "bulk_update",
          "remove",
          "add",
          "export",
          "export_bulkload_template"
     ],
     "meta": {
          "model_type": "relation/PexipConference",
          "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"
               },
               {
                    "name": "hierarchy_friendly_name",
                    "title": "Located At",
                    "allow_filtering": true
               }
          ],
          "tagged_versions": [],
          "tags": [],
          "title": "",
          "business_key": {},
          "api_version": "21.2",
          "cached": true,
          "references": {
               "children": [],
               "parent": [
                    {
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
                         "pkid": "6t0ggef2c0deab00hb595101"
                    }
               ],
               "device": [
                    {
                         "href": "",
                         "pkid": ""
                    }
               ],
               "foreign_key": [],
               "self": [
                    {
                         "href": "/api/relation/PexipConference/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "list",
               "help",
               "field_display_policy",
               "get",
               "configuration_template",
               "update",
               "remove",
               "add",
               "export",
               "export_bulkload_template"
          ],
          "schema_version": null,
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/relation/PexipConference/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/relation/PexipConference/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/relation/PexipConference/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "export_bulkload_template": {
                         "method": "POST",
                         "class": "bulkload_template",
                         "href": "/api/relation/PexipConference/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "configuration_template": {
                         "method": "GET",
                         "class": "config",
                         "href": "/api/relation/PexipConference/configuration_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Configuration Template"
                    }
               },
               {
                    "field_display_policy": {
                         "method": "GET",
                         "class": "display_policy",
                         "href": "/api/relation/PexipConference/field_display_policy/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Field Display Policy"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/PexipConference/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/relation/PexipConference/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               }
          ]
     },
     "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

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

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	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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.

API Reference for relation/PexipConference

GET http://[host-proxy]/api/relation/PexipConference/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/relation/PexipConference/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Export

Get

Help