By default, when meeting hosts create meetings, they can
set a passcode that users must enter to join the meeting. In Connect
Central, Account Administrators can enable and disable the ability
to enforce passcodes; the ability to enforce passcodes is disabled
by default.
Use the Web Services API to do the following:
-
Enable and disable the ability of meeting hosts to enforce
passcodes for meetings.
-
Set, reset, or remove the passcode for a meeting.
-
Check whether a meeting has a passcode
-
View a list of meetings that require passcodes
Enable and disable the ability to passcode protect meeting rooms
To enable the passcode protect option for an account, call the
following API:
http://<server>/api/xml?action=meeting-feature-update&account-id=<acc_id>&feature-id=fid-meeting-passcode-notallowed&enable=false
To disable the passcode protect option, pass
enable=true
.
Note:
Only administrators can call
meeting-feature-update
to
enable or disable a meeting feature.
Check whether the enforce passcode option is enabled for an account
Call the
meeting-feature-info
API:
http://<server>/api/xml?action=meeting-feature-info&account-id=<acc_id>
If the result list contains
feature-id=fid-meeting-passcode-notallowed
,
the passcode option is enabled. Otherwise, the passcode option is
not enabled. By default, the passcode options is disabled.
Set, reset, or remove a passcode
Call the
acl-field-update
API and pass the
meeting-passcode
parameter:
http://<server>/api/xml?action=acl-field-update&acl-id=<sco-id>&field-id=meeting-passcode&value=<passcode>
To remove a passcode, set the
value
parameter
to empty:
http://<server>/api/xml?action=acl-field-update&acl-id=<sco-id>&field-id=meeting-passcode&value=
Note:
Only administrators and meeting hosts can call
acl-field-update
with
field-id=meeting-passcode
.
Check whether a meeting has a passcode
http://<server>/api/xml?action=acl-field-info&filter-field-id=meeting-passcode&acl-id=<sco-id>
If a meeting has a passcode, the result is as follows:
<results>
<status code="ok"/>
<acl-fields>
<field acl-id="22701" field-id="meeting-passcode"><value>connect12</value></field>
</acl-fields>
</results>
If passcode is not set then the result is:
<results>
<status code="ok"/>
<acl-fields/>
</results>
Note:
Only administrators can call
acl-field-info
.
View a list of meetings that require passcodes:
http://<server>/api/xml?action=acl-field-list&field-id=meeting-passcode
The result is the list of
acl-ids
(meeting-ids):
<results>
<status code="ok"/>
<acl-field-list>
<acl acl-id="21907">
<value>breeze</value>
</acl>
<acl acl-id="22701">
<value>connect12</value>
</acl>
<acl acl-id="21401">
<value>raj</value>
</acl>
</acl-field-list>
</results>
Note:
Only administrators can call
acl-field-list
.