PlcmConferenceFactory

PlcmConferenceFactory

A Conference Factory. A Conference Factory can be activated by a caller dialing a matching SIP URI, and used to instantiate a new conference. Content-Type: application/vnd.plcm.plcm-conference-factory+xml or application/vnd.plcm.plcm-conference-factory+json. All attributes are used in ETag calculation except for entity-tag.


PlcmConferenceFactory Fields

NameTypeDescriptionAttributes
atomLinkList Array of LinkSee Definition of Link
conferenceFactoryIdentifierConferenceFactoryIdentifier The unique identifier of the conference factory. This is a system-generated identifier.
conferenceFactoryDialIdstring The unique id that, as a component of a dial string, invokes this conference factory. Mandatory
descriptionDescription The description of this conference factory.
enabledboolean Boolean indicating whether this conference factory is enabled.
conferenceTemplateNamestring Name of the conference template for this conference factory. This field is mandatory when override-default-conference-template-name is true.
overrideDefaultConferenceTemplateNameboolean Boolean indicating whether this conference factory overrides the default conference template. If true, a conference-template-name must also be specified.
mcuPoolOrderNamestring Name of the MCU pool order for this conference factory. This field is mandatory when override-default-mcu-pool-order-name is true.
overrideDefaultMcuPoolOrderNameboolean Boolean indicating whether this conference factory overrides the default MCU pool order. If true, an mcu-pool-order-name must also be specified.
territoryNamestring Name of the territory for this conference factory. This field is mandatory when override-default-territory-name is true.
overrideDefaultTerritoryNameboolean Boolean indicating whether this conference factory overrides the default territory. If true, a territory-name name must also be specified.
svcOnlyTerritoryNamestring Name of the svc-only-territory for this conference factory. This field is mandatory when override-default-svc-only-territory-name is true.
overrideDefaultSvcOnlyTerritoryNameboolean Boolean indicating whether this conference factory overrides the default svc-only-territory. If true, a svc-only-territory-name name must also be specified.
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.


Nested Types/Restrictions


NameTypeRestrictions
EntityTagstring
Length of value must be >=1
Length of value must be <=64
Descriptionstring
Length of value must be >=0
Length of value must be <=80
ConferenceFactoryIdentifier
Length of value must be >=0
Length of value must be <=128
T0string
Pattern of value must match the regular expression [0-9a-zA-Z~!@$%\*_\-\+={}\[\]\\/?\. ]*