Value
Last updated on
May 15, 2021
|
Also applies to Adobe Connect 7, Adobe Connect 8, Adobe Connect 9
Update the disclaimer text that is shown when a user enters a meeting using an Adobe Connect API.
Availability
Acrobat Connect Pro 7
Description
Updates the disclaimer text that is shown when a user enters a meeting.
To comply with communications regulations or standards, you can set up a disclaimer notice to appear when a user enters a meeting. The disclaimer notice typically displays boilerplate information for your organization. It advises users of the status of the meeting and the terms of use for the meeting. For example, a disclaimer notice could advise users that the meeting is being recorded, and that users cannot join the meeting unless they accept the notice.
If the disclaimer is activated, the notice is shown in all meetings. Activate the disclaimer either through the management console or by using the meeting-feature-update action with the fid-meeting-disclaimer parameter set to enabled.
Request URL
https://servername/api/xml ?action=meeting-disclaimer-update &account-id=integer &disclaimer=string &session=string
Parameters
|
|
Type |
Required |
Description |
|
account-id |
BIGINT |
N |
The ID of the account for which the disclaimer text is updated. If not used, the account that you are currently logged into is updated. |
|
disclaimer |
String |
Y |
The disclaimer text that is shown when a user starts a meeting. The disclaimer can, for example, notify users that a meeting is being recorded. The limit is 1500 characters. The disclaimer text can contain XML-compliant HTML tags. For example: <b>This meeting is being recorded.</b> |
|
session |
String |
N |
The value of the BREEZESESSION cookie. |
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=code /> </results>
Response values
|
Element |
Attribute |
Type |
Description |
|
results |
|
Container |
All results the action returns. |
|
status |
|
Empty, with attributes |
The status of the response. |
|
|
code |
Allowed value |
A code indicating the response status (see status). |
Sample request
https://example.com/api/xml?action=meeting-disclaimer-update&disclaimer=Please note that this meeting is being recorded.
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> </results>
