2.2.3.8 getConferencingCapabilities Response

  • Article

This section follows the product behavior described in product behavior note <15>.

A getConferencingCapabilities response indicates the status of the corresponding getConferencingCapabilities request and returns conferencing capabilities for the Focus Factory along with a list of MCU-Types available at the Focus Factory. A getConferencingCapabilities response is identified by a response element containing a getConferencingCapabilities child element. The getConferencingCapabilities child element MUST use the following element hierarchy.

getConferencingCapabilities element hierarchy

Figure 15: getConferencingCapabilities element hierarchy

The getConferencingCapabilities element can contain reason and capability-version attributes.

  • reason: When the code attribute of the enclosing response element is "success", this attribute SHOULD NOT be used. When the code attribute of the enclosing response element is "failure", this attribute indicates the cause of the failure. The value of this attribute SHOULD be one of the following strings to specify the problem found in the corresponding request:

    • "otherFailure": The cause of the failure is not clearly established (for example, if it is caused by memory exhaustion on the server). It SHOULD NOT be used if another reason describes the failure.

  • capability-version: A non-negative integer value specifying the set of capabilities advertised in this response. When the code attribute of the enclosing response element is "success", this attribute SHOULD be used. A Focus Factory compliant to this revision of this protocol SHOULD specify 0 when this attribute is used. The capability-version is not used when the code attribute of the enclosing response element is not "success".

The getConferencingCapabilities element MUST contain an mcu-types child element and an anonymous-scheduling element and can contain all of the other child elements. An mcu-types element contains zero or more mcuType elements.

  • mcuType: A string value that represents a type of MCU that can be used in a conference. The mcuType element has the same value space as the purpose subelement of the conf-uris element. For specification of the allowed values, see [MS-CONFBAS] section 2.2.2.4. This list MUST NOT include the mcuType "meeting"<16>.

anonymous-scheduling: A Boolean value that represents whether the Focus Factory can create conferences with the "anonymous" value for admission-policy. For details of the admission-policy, see section 2.2.1.2. If the value is true, the Focus Factory MUST allow "anonymous" as a value for admission-policy. If false, the Focus Factory MUST NOT allow "anonymous" as a value for admission-policy.

conference-key-optional: This field is deprecated and SHOULD NOT be used.

default-admission-policy: This value specifies an admission-policy that clients SHOULD use as the default when creating a new conference. It can be overridden by user input.

schedule-locked: A Boolean value that, if true, indicates that the client can schedule locked meetings.<17> If false, indicates that the client cannot schedule locked meetings.

schedule-key-optional: This field is deprecated and SHOULD NOT be used.

recording-allowed: A Boolean value that represents whether recording is allowed for the conference.<18> If true, recording is allowed, else if false, it is not allowed.

externaluser-recording-allowed: A Boolean value that, if false, indicates that an external user cannot record during the conference. If true, indicates that an external user can record during the conference. This value is applicable only if recording-allowed is true.<19> The term "external user" is defined in [MS-SIPRE].

autopromote-allowed: An unsigned integer that indicates the supported levels of people who can be automatically escalated to presenter when they join the meeting. This value is a bitmask. Bits with value 1 in the binary representation of the number indicate classes of participants who are escalated in this manner. If a particular bit is set, all less significant bits defined SHOULD also be set. Bits not defined by this specification are reserved for future use and MUST be 0. The allowed masks are as follows:<20>

  • None: 0x00000000 (as default)

  • Everyone: 0x80000000 (bit 31)

  • Company (Authenticated users): 0x00008000 (bit 15)

default-autopromote: An unsigned integer that indicates what the default autopromote value is if it is not specified in addConference or modifyConference. The bit mask values are the same as those specified for autopromote-allowed.<21>

pstn-lobby-bypass-allowed: A Boolean that indicates whether the server supports PSTN users bypassing the lobby when they join the meeting. If the value is true, the client can enable this bypass. If false, the client cannot enable this bypass.<22>

static-meeting-limit: This is an integer value that indicates the number of static meetings the user can have. The maximum value is 1.<23>

default-meeting-static: This Boolean value indicates whether the default meeting type is static. If this value is true, the client uses the same preexisting static meeting coordinates in all meeting invites. If this value is false, by default, the client creates a new meeting. How to create a conference is described in section 3.1.4.1.<24>

default-entry-exit-announcements: This Boolean value indicates the recommended default that the client uses for the entry-exit announcement feature when creating a meeting. If this value is true, the client will, by default, turn on the entry-exit announcement feature when scheduling meetings. If false, the client will turn off the entry-exit announcement feature. End-user or client can always choose a non-default value for this feature.<25> If the entry-exit announcement feature is enabled, the announcement will be played to all participants of the conference when a participant enters or exits the conference.

The pstn-bridging element MUST contain the following child elements:

  • enabled: A Boolean value that indicates whether the server supports PSTN bridging. If true, the PSTN bridging is supported, else if false, it is not supported.

  • access-numbers: A container for links and access numbers related to dial-in from the PSTN. It SHOULD contain the following child elements:

    • internal-url: A Hypertext Transfer Protocol (HTTP) link to a location where clients can get more information about the PSTN bridging numbers available to them if they are in the corporate network.

    • external-url: An HTTP link to a location where clients can get more information about the PSTN bridging numbers available to them if they are outside of the corporate network.

    • region: A group of access numbers applicable in the same geographic region. A region MUST contain the name attribute, which is a string giving a name for the region. A region MUST contain the following child elements:

      • access-number: An individual access number for PSTN access. An access-number MUST contain the following elements:

        • language: A representation of a language that the access number can interact with users in. The first language listed SHOULD indicate the default language used by the access number. A language MUST have a tag attribute that gives the identity of the language, as a value in the XML schema type for language. It MUST also have an lcid attribute, which gives the language as an unsigned integer, in the value space defined by [MS-LCID].

        • number: A string value giving a human readable phone number at which the access number can be reached.

        • toll-free: A Boolean value that indicates if the access number is toll-free.

    • default-region: A string value giving the client a hint about which region of access numbers to emphasize in a user interface. This value SHOULD equal the name of the region that most closely matches the user’s usual physical locale.

custom-invite: The custom-invite element MAY contain the following child elements:<26>

  • logo-url: An HTTP link to a location where clients can get a logo to render for the customized invite.<27>

  • legal-url: An HTTP link that clients can render for legal information for the customized invite.<28>

  • help-url: An HTTP link that clients can render for help information for the customized invite.<29>

  • settings-url: An HTTP link that clients can render to display link to user settings page for the customized invite.<30> 

  • custom-footer-text: A string value that clients can use to render a custom footer for the customized invite.<31>

endorse-allowed: Specifies whether the server hosting the conference allows the use of the Endorse User command defined in [MS-CONFBAS] section 2.2.3.5.<32>

main-video-mute-allowed: Specifies whether the server hosting the conference allows scheduling conferences that specify hard mute of the main video, defined in [MS-CONFAV] section 6.2.<33>

pano-video-mute-allowed: Specifies whether the server hosting the conference allows scheduling conferences that specify hard mute of the panoramic video, defined in [MS-CONFAV] section 6.2.<34>

im-mute-allowed: Specifies whether the server hosting the conference will allow a conference presenter to mute instant messaging in the conference.

questions-and-answers-allowed: Specifies whether the server hosting the conference supports the questions and answers feature.

in-room-user-notification-supported: Specifies whether the server hosting the conference supports the in-room user notification feature.