Conference

[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/conferences

Summary

Resources	Methods
https://localhost:8443/api/rest/conferences	GET Retrieves a list of conferences matching the input query parameters that the user is authorized to view. POST Creates a subscription to a list of conferences the user is authorized to view.
https://localhost:8443/api/rest/conferences/usage	GET Retrieves conference manager usage details.
https://localhost:8443/api/rest/conferences/usage/all	GET Retrieves conference manager usage details across all clusters.
https://localhost:8443/api/rest/conferences/device-associated-conferences	GET Retrieves a list of conferences matching the device-identifier.
https://localhost:8443/api/rest/conferences/start-conference	POST Activates the conference for the specified conference room.
https://localhost:8443/api/rest/conferences/{conference-identifier}	GET Retrieves an active conference. DELETE Ends a conference and disconnects all participants. POST Creates a subscription to the specified conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-display-text/{display-text}	POST Sets the conference display text.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-conference-layout/{layout-name}	POST Sets the conference layout format that is displayed on an endpoint's screen.
https://localhost:8443/api/rest/conferences/{conference-identifier}/lock-conference	POST Locks all new participants out of a running conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/unlock-conference	POST Unlocks a running conference to allow new participants to enter the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/start-recording	POST Begins recording of the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/stop-recording	POST Ends recording of the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/promote-conference	POST Attempts to promote WebRTC conference from MESH to MCU mixer.
https://localhost:8443/api/rest/conferences/{conference-identifier}/demote-conference	POST Attempts to transition a WebRTC conference from an MCU back to MESH.
https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-except	POST Mute all participants except for the list of participant IDs passed in.
https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all	POST Unmute all participants.
https://localhost:8443/api/rest/conferences/{conference-identifier}/suspend-video-all-except	POST Suspends the video from all participants except for the list of participant Ids passed in.
https://localhost:8443/api/rest/conferences/{conference-identifier}/resume-video-all	POST Resumes the video from all participants.
https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-audio-except-chair	POST Mutes the audio of all existing participants and new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-mute-audio-except-chair/{apply-to-existing-participants}	POST Mutes the audio of new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all-audio-except-chair	POST Deprecated.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-unmute-audio-except-chair/{apply-to-existing-participants}	POST Unmutes the audio of new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-video-except-chair	POST Suspends the video from all existing participants and new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-suspend-video-except-chair/{apply-to-existing-participants}	POST Suspends the video of new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all-video-except-chair	POST Deprecated.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-resume-video-except-chair/{apply-to-existing-participants}	POST Resumes the video of new callers upon joining the conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-new-calls-muted/{join-muted}	POST Sets mute state of new callers when added to a conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/set-lecturer	POST A request to make the specified participant the lecturer for this conference.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants	POST Creates and initiates a dial out to a new conference participant. GET Retrieves a list of participants for the conference. POST Creates a subscription to the specified list of participants.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}	GET Retrieves a participant. POST Creates a subscription to the specified participants.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/mute-audio	POST Mutes audio on the participant.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/unmute-audio	POST Unmutes audio on the participant.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/suspend-video	POST Suspends video on the participant.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/resume-video	POST Resumes video on the participant.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/disconnect	POST Disconnects the participant.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/set-display-name/{display-name}	POST Sets the participant's display name.
https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/set-chairperson/{is-chairperson}	POST Sets whether or not the participant is a chairperson.

Resources

https://localhost:8443/api/rest/conferences

Methods

GET

Retrieves a list of conferences matching the input query parameters that the user is authorized to view.
Propagation Delay: Note that the data retrieved by this method may be a few seconds out of date. It may
not reflect the most recent changes, including changes made through the API.
Users with Provisioner or Administrator roles can retrieve all conferences on the DMA system.
Users without these roles can only retrieve conferences happening in rooms that they own.

Applied to RPRM, users without permissions can not retrieve conferences. Users only own the Conference Operator(Restricted) permission can only retrieve conferences that they own.
[tags: DMA,RPRM]

Request

Query Parameters

Name	Type	Description
start-before	xs:dateTime	Return only conferences that started before this time.
start-after	xs:dateTime	Return only conferences that started after this time.
conference-room-identifier	xs:string	Return only conferences with a matching identifier. Wildcards are supported. Applied to RPRM, the parameter conference-room-identifier should be display-text(conference name).
limit	xs:int	Limit the number of users returned to this number, even if more results match the query. Note 1: The valid integer range is 1 to 500; values between 501 and 2147483647 will result in the default limit of 500 being used. Note 2: If the limit value is less than or equal to 0, the default of 500 will be used. Note 3: If the limit value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.
page	xs:int	When limiting the results, this specifies which page/subset of data to view. Note 1: The valid integer range is 1 to 2147483647. Note 2: If the page value is less than or equal to 0, the default of 1 will be used. Note 3: If the page value is greater than 2147483647, the system will respond with "404 Not Found". This is a framework response that is due to a numeric value that exceeds a integer type.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-list+xml application/vnd.plcm.plcm-conference-list+json application/vnd.plcm.plcm-conference-list-v2+xml application/vnd.plcm.plcm-conference-list-v2+json application/vnd.plcm.plcm-conference-list-v3+xml application/vnd.plcm.plcm-conference-list-v3+json	Information successfully retrieved Applied to RPRM, the Conferences of application/vnd.plcm.plcm-conference-list+xml is implemented and can be accessed by setting Http Accept. The representations of application/vnd.plcm.plcm-conference-list-v2+xml or application/vnd.plcm.plcm-conference-list-v3+xml are not available. Only pooled conferences are supported, direct conferences are not supported. If there are more one representations, Http Accept must be set with the right one.
304		Conference information has not changed since the last search. Note: The API client must provide the "plcm-conference-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other API client made changes to conferences on the server.

POST

Creates a subscription to a list of conferences the user is authorized to view. The consumer must implement plcm-conference-observer.wadl.
Updates are sent to the subscription observer based upon the user role/ownership. Any user may subscribe to a conference list. Users
with Provisioner or Administrator roles will receive updates about all conferences on the DMA. Users without these roles will only receive
updates about conferences happening in rooms that they own.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-list-subscription+xml

application/vnd.plcm.plcm-conference-list-subscription+json

application/vnd.plcm.plcm-conference-list-subscription-v2+xml

application/vnd.plcm.plcm-conference-list-subscription-v2+json

Response

Status	Representation	Description
201		Subscription created successfully.
400	text/plain	Bad request.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	time-to-live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or any integer between 1 and 93600 (26 hours) in seconds.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Inaccessible subscription consumer url. Expect 200 when sending HTTPS GET request to the url.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Malformed subscription consumer url.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only HTTPS subscription consumer url is allowed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The same user cannot subscribe to the same resource with the same consumer URL more than once.

https://localhost:8443/api/rest/conferences/usage

Methods

GET

Retrieves conference manager usage details.
[tags: DMA]

Request

Query Parameters

Name	Type	Description
cluster	xs:string	Returns conference manager usage details for the mentioned cluster

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-manager-usage+xml application/vnd.plcm.plcm-conference-manager-usage+json	conference manager usage retrieved successfully.
304		Conference manager usage has not changed since the last search. Note: The API client must provide the "plcm-conference-manager-usage" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-manager-usage" ETag can be accessed from the initial search result's HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The given cluster is invalid.

https://localhost:8443/api/rest/conferences/usage/all

Methods

GET

Retrieves conference manager usage details across all clusters.
[tags: DMA]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-manager-usage+xml application/vnd.plcm.plcm-conference-manager-usage+json	conference manager usage retrieved successfully.
304		Conference manager usage has not changed since the last search. Note: The API client must provide the "plcm-conference-manager-usage" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-manager-usage" ETag can be accessed from the initial search result's HTTP response header.
401	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unauthorized.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. DMA roles required: administrator, auditor, provisioner

https://localhost:8443/api/rest/conferences/device-associated-conferences

Methods

GET

Retrieves a list of conferences matching the device-identifier.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
device-identifier	xs:string	Return only ongoing conferences with a matching device-identifier.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-list-v4+xml application/vnd.plcm.plcm-conference-list-v4+json	Information successfully retrieved.
304		Conference information has not changed since the last search. Note: The API client must provide the "plcm-conference-list-v4" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-conference-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other API client made changes to conferences on the server.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Device ID is required.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Device doesn't exist.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Device ID is invalid.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	API access not available, no API license.

https://localhost:8443/api/rest/conferences/start-conference

Methods

POST

Activates the conference for the specified conference room.
Conferences activated using the API will wait up to five minutes for the first participant to arrive.
After that, they will become inactive within ten seconds of the last participant leaving.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-start-request+xml

application/vnd.plcm.plcm-conference-start-request+json

Response

Status	Representation	Description
201		Conference created successfully.
204		Starts an ongoing conference with a passthru to the conference whose passthru has not been previously set. The system accepts the request and sets the passthru of the conference. The passthru may not change during the life of the conference because the CDR record does not have a place to store multiple passthrus.
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. Starting a mesh-only conference via the API is not permitted.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such conference room.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Starting an ongoing conference is not allowed except when it provides a passthru to the conference whose passthru has not been previously set. The passthru may not change during the life of the conference because the CDR record does not have a place to store multiple passthrus.
501	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No server is responsible for the conference room. This might occur if the conference room to territory to server mapping is not configured correctly, or if all the configured servers are unavailable.
503	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Insufficient MCU resources. This might occur if: 1. All of the MCU resources available to the conference room are in use 2. The MCUs, MCU Pools, and MCU Pool Orders are configured so that no MCU resources are available to the conference room 3. The conference requires capabilities that are not supported by any of the configured MCUs

https://localhost:8443/api/rest/conferences/{conference-identifier}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

GET

Retrieves an active conference.
Propagation Delay: Note that the data retrieved by this method may be a few seconds out of date.
It may not reflect the most recent changes, including changes made through the API.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-conference-details+xml application/vnd.plcm.plcm-conference-details+json application/vnd.plcm.plcm-conference+xml application/vnd.plcm.plcm-conference+json application/vnd.plcm.plcm-conference-v2+xml application/vnd.plcm.plcm-conference-v2+json application/vnd.plcm.plcm-conference-v3+xml application/vnd.plcm.plcm-conference-v3+json	Information successfully retrieved Applied to RPRM, the Representation of application/vnd.plcm.plcm-conference+xml is implemented and can be accessed by setting Http Accept. Only pooled conferences are supported, direct conferences are not supported. If there are more one representations, Http Accept must be set with the right one.
304		Conference information has not changed since the last retrieval. Note: The API client must provide the "plcm-conference" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical single conference retrieval in the "If-None-Match" header, then the HTTP response will contain the conference representation in the message body. The "plcm-conference" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical conference identifier to ensure an equivalent ETag value. This also assumes no other API client made changes to the conference on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such conference

DELETE

Ends a conference and disconnects all participants.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference successfully ended
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No such conference

POST

Creates a subscription to the specified conference. The consumer must implement plcm-conference-observer.wadl.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-subscription+xml

application/vnd.plcm.plcm-subscription+json

application/vnd.plcm.plcm-subscription-v2+xml

application/vnd.plcm.plcm-subscription-v2+json

Response

Status	Representation	Description
201		Subscription created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	time-to-live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or any integer between 1 and 93600 (26 hours) in seconds.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Inaccessible subscription consumer url. Expect 200 when sending HTTPS GET request to the url.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Malformed subscription consumer url.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only HTTPS subscription consumer url is allowed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The same user cannot subscribe to the same resource with the same consumer URL more than once.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-display-text/{display-text}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
display-text	xs:string	The text to display for this conference

Methods

POST

Sets the conference display text.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference display text was set
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-conference-layout/{layout-name}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
layout-name	xs:string	The name that reflects how participants are placed on the screen such as "2 horizontal by 2 vertical". This example would place four participants in a 2-by-2 grid layout.

Methods

POST

Sets the conference layout format that is displayed on an endpoint's screen.

The API client must first read the desired conference. The conference
resource will contain the list of supported layouts.
The API client can pick one of the supported layout names, then supply
it in this method's {layout-name} path parameter.
The API client must apply URL encoding on this parameter since it contains spaces.

The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference layout was set successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The layout specified is invalid.

https://localhost:8443/api/rest/conferences/{conference-identifier}/lock-conference

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Locks all new participants out of a running conference.

The API client must supply unique conference identifier in this method's {conference-identifier} path parameter.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference was locked successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found.

https://localhost:8443/api/rest/conferences/{conference-identifier}/unlock-conference

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Unlocks a running conference to allow new participants to enter the conference.

The API client must supply unique conference identifier in this method's {conference-identifier} path parameter.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference was unlocked successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found.

https://localhost:8443/api/rest/conferences/{conference-identifier}/start-recording

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Begins recording of the conference.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Recording started
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - Recording is disabled in the conference template
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - The MCU does not support recording
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - There are no MCUs available for recording

https://localhost:8443/api/rest/conferences/{conference-identifier}/stop-recording

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Ends recording of the conference.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Recording ended
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/promote-conference

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Attempts to promote WebRTC conference from MESH to MCU mixer.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Promotion started
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - Promotion to an MCU is disabled within the conference template
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - There are no WebRTC MCUs available for promotion

https://localhost:8443/api/rest/conferences/{conference-identifier}/demote-conference

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Attempts to transition a WebRTC conference from an MCU back to MESH.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Demotion started
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - Demotion to a MESH is disabled within the conference template

https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-except

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Mute all participants except for the list of participant IDs passed in.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-mute-all-except-request+xml

application/vnd.plcm.plcm-conference-mute-all-except-request+json

Response

Status	Representation	Description
204		All participants are muted except for the list of participant identifiers passed in.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Unmute all participants.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		All participants are unmuted.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/suspend-video-all-except

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Suspends the video from all participants except for the list of participant Ids passed in.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-suspend-video-all-except-request+xml

application/vnd.plcm.plcm-conference-suspend-video-all-except-request+json

Response

Status	Representation	Description
204		Video from all participants is suspended except for the list of participant identifiers passed in.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/resume-video-all

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Resumes the video from all participants.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Video from all participants is resumed.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-audio-except-chair

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Mutes the audio of all existing participants and new callers upon joining the conference.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.
Note: This operation works only with MFW-compatible RMXs.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Mute states have been successfully updated.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-mute-audio-except-chair/{apply-to-existing-participants}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
apply-to-existing-participants	xs:boolean	Boolean value, true causes existing conference participants to be audio muted, false will preserve the audio mute state of existing participants. Note: This operation works only with MFW-compatible RMXs.

Methods

POST

Mutes the audio of new callers upon joining the conference. Audio of existing
participants will also be muted if the parameter apply-to-existing-participants
is true.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Audio mute states have been successfully updated.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all-audio-except-chair

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Deprecated. This will be removed in a future release. Use 'unmute-all' instead.

Unmutes the audio of all existing participants and new callers upon joining the conference.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.
Note: This operation works only with MFW-compatible RMXs.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Mute states have been successfully updated.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-unmute-audio-except-chair/{apply-to-existing-participants}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
apply-to-existing-participants	xs:boolean	Boolean value: True causes existing conference participants to be audio unmuted, and false will preserve the audio mute state of existing participants. Note: This operation works only with MFW-compatible RMXs.

Methods

POST

Unmutes the audio of new callers upon joining the conference. Audio of existing
participants will also be unmuted if the parameter apply-to-existing-participants
is true.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Mute states have been successfully updated.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/mute-all-video-except-chair

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Suspends the video from all existing participants and new callers upon joining the conference.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.

Note: This operation works only with MFW-compatible RMXs.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Video suspend states have been updated successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-suspend-video-except-chair/{apply-to-existing-participants}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
apply-to-existing-participants	xs:boolean	Boolean value, true causes existing conference participants to be video suspended, false will preserve the video suspend state of existing participants. Note: This operation works only with MFW-compatible RMXs.

Methods

POST

Suspends the video of new callers upon joining the conference. Video of existing
participants will also be suspended if the parameter apply-to-existing-participants
is true.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Video suspend states have been updated successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/unmute-all-video-except-chair

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Deprecated. This will be removed in a future release. Use 'resume-video-all' instead.

Resumes the video from all existing participants and new callers upon joining the conference.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.
Note: This operation works only with MFW-compatible RMXs.
[tags: DMA]

Request

Response

Status	Representation	Description
204		Video suspend states have been updated successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-resume-video-except-chair/{apply-to-existing-participants}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
apply-to-existing-participants	xs:boolean	Boolean value, true causes existing conference participants to be video resumed, false will preserve the video suspend state of existing participants. Note: This operation works only with MFW-compatible RMXs.

Methods

POST

Resumes the video of new callers upon joining the conference. Video of existing
participants will also be resumed if the parameter apply-to-existing-participants
is true.
The conference chair is excluded from this.

The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Video suspend states have been updated successfully.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-join-new-calls-muted/{join-muted}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
join-muted	xs:boolean	Boolean value, true causes all new inbound calls to be muted upon joining conference, false leaves them unmuted. This setting does not affect dialouts.

Methods

POST

Sets mute state of new callers when added to a conference.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Conference updated to mute/not mute new callers based on value
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/set-lecturer

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

A request to make the specified participant the lecturer for this conference.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-conference-set-lecturer-request+xml

application/vnd.plcm.plcm-conference-set-lecturer-request+json

Response

Status	Representation	Description
204		The participant was set to lecturer.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference or participant not found.

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier

Methods

POST

Creates and initiates a dial out to a new conference participant.
Currently the only elements in plcm-participant that have any effect for dial out are: dial-string, forward-dtmf-source, passback, and passthru; with dial-string being the only mandatory field for this case.
The conference-identifier element can optionally be set, but if it is, it must match the conference-identifier of the resource that is receiving the POST.
All other fields in plcm-participant are completely ignored.
The dial-string field specifies the string that should be dialed to connect to the desired endpoint.
For SIP calls, the dial-string must be a well-formed SIP or SIPS URI.
If dial-string is not a SIP or SIPS URI, then an H.323 call will be attempted.
TEL URIs are not supported.
The user must be the conference room owner or have Administrator or Provisioner roles.
An H.323 call to an encrypted conference will not work, even if the endpoint supports encryption.
createParticipant_v2 takes plcm-dial-out-participant-v2 as the request body, not plcm-participant.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-participant+xml

application/vnd.plcm.plcm-participant+json

application/vnd.plcm.plcm-dial-out-participant-v2+xml

application/vnd.plcm.plcm-dial-out-participant-v2+json

Response

Status	Representation	Description
201		Participant created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference not running
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	plcm-itu-phone-number choice is not yet implemented. Please use dial-string instead.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	For dial strings that begin with "sip:", "sips:", or "tel:", the settings "audio-only", "encrypted-media", and "auto-disconnect" must be set to "false" and "dtmf-suffix" must be empty. This version of the DMA system does not support these features for SIP calls.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid dial string.
409	application/vnd.plcm.plcm-error+xml	A mesh-only conference cannot add a dialout participant.
503	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The maximum number of participants provisioned for this conference has been reached.

GET

Retrieves a list of participants for the conference.
Propagation Delay: Note that the data retrieved by this method may be a few seconds out of date.
It may not reflect the most recent changes, including changes made through the API.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-participant-list+xml application/vnd.plcm.plcm-participant-list+json application/vnd.plcm.plcm-participant-list-v2+xml application/vnd.plcm.plcm-participant-list-v2+json	Information successfully retrieved
304		Participant information has not changed since the last search. Note: The API client must provide the "plcm-participant-list" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-participant-list" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other API client made changes to users on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.

POST

Creates a subscription to the specified list of participants. The consumer must implement plcm-participant-observer.wadl.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-subscription+xml

application/vnd.plcm.plcm-subscription+json

application/vnd.plcm.plcm-subscription-v2+xml

application/vnd.plcm.plcm-subscription-v2+json

Response

Status	Representation	Description
201		Subscription created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	time-to-live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or any integer between 1 and 93600 (26 hours) in seconds.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Inaccessible subscription consumer URL. Expect 200 when sending HTTPS GET request to the URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Malformed subscription consumer URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only HTTPS subscription consumer URL is allowed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The same user cannot subscribe to the same resource with the same consumer URL more than once.

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

GET

Retrieves a participant.
Propagation Delay: Note that the data retrieved by this method may be a few seconds out of date.
It may not reflect the most recent changes, including changes made through the API.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-participant+xml application/vnd.plcm.plcm-participant+json application/vnd.plcm.plcm-participant-v2+xml application/vnd.plcm.plcm-participant-v2+json	Information successfully retrieved
304		Participant information has not changed since the last retrieval. Note: The API client must provide the "plcm-participant" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical single participant retrieval in the "If-None-Match" header, then the HTTP response will contain the conference representation in the message body. The "plcm-participant" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical participant identifier to ensure an equivalent ETag value. This also assumes no other API client made changes to the participant on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant not found

POST

Creates a subscription to the specified participants. The consumer must implement plcm-participant-observer.wadl.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-subscription+xml

application/vnd.plcm.plcm-subscription+json

application/vnd.plcm.plcm-subscription-v2+xml

application/vnd.plcm.plcm-subscription-v2+json

Response

Status	Representation	Description
201		Subscription created successfully
400	text/plain	Bad request
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	time-to-live is out of range. Correct values are "0" (magic number which sets end time to the max, 26 hours), or any integer between 1 and 93600 (26 hours) in seconds.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Inaccessible subscription consumer URL. Expect 200 when sending HTTPS GET request to the URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Malformed subscription consumer URL.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only HTTPS subscription consumer URL is allowed.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The same user cannot subscribe to the same resource with the same consumer URL more than once.

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/mute-audio

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

POST

Mutes audio on the participant.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant muted successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/unmute-audio

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

POST

Unmutes audio on the participant.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant unmuted successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/suspend-video

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

POST

Suspends video on the participant.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant video is suspended successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/resume-video

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

POST

Resumes video on the participant.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant resumes video successfully
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/disconnect

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier

Methods

POST

Disconnects the participant.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant disconnected
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant not found
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid state - The participant is already disconnected

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/set-display-name/{display-name}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier
display-name	xs:string	The participant name to display

Methods

POST

Sets the participant's display name.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant's display name set
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found

https://localhost:8443/api/rest/conferences/{conference-identifier}/participants/{participant-identifier}/set-chairperson/{is-chairperson}

Template Parameters

Name	Type	Description
conference-identifier	xs:string	The conference identifier
participant-identifier	xs:string	The participant identifier
is-chairperson	xs:boolean	Boolean value: True indicates that the participant is a chairperson, and false leaves the participant as not a chairperson.

Methods

POST

Sets whether or not the participant is a chairperson.
This method will not indicate if an internal failure occurred. Instead,
it is recommended that the API client retrieve the participant resource
to ensure the state has changed.
The user must be the conference room owner or have Administrator or Provisioner roles.

[tags: DMA]

Request

Response

Status	Representation	Description
204		Participant's chairperson status is set.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Permission denied. The user must be the conference room owner or have Administrator or Provisioner roles.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference or participant not found