The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The active meeting management API enables real-time management of meetings that are currently in progress. In contrast, the scheduling API enables you to schedule and modify future meetings.
With the active meeting management API, you can develop client applications for monitoring and controlling active meetings, typically by concierge or service desk personnel.
Topics in this section include:
You can access the WSDL file for the active meeting management API at
http://administration-server-hostname-or-IP-address:8080/ctxapi/api/v1_1/amm?wsdl
The WSDL file provides a complete and accurate definition of the API that is supported by your Cisco TelePresence Exchange System. In the event of any discrepancies between the WSDL file and this document, you should follow the WSDL file definition.
All active meeting management API methods are described in alphabetical order in the following sections:
•echo
•sendEndpointTextToParticipant
This method removes a specified participant from an active meeting and hangs up on the endpoint of the participant.
Table 3-1 describes the input parameters for the Drop Participant service request.
The Drop Participant service returns a success or fault message. There is no response data returned.
The Echo service allows the system to confirm that the CDR API service is active. For additional details about this service, see the "echo" section.
This method provides information about all active meetings. You can filter results by including values for the optional parameters in the request.
Table 3-2 describes the fields in the Get Active Meetings request.
The service response returns a Get Active Meetings Result, which includes a list of activeMeeting elements. Table 3-3 describes the activeMeeting element.
This method obtains status information about the specified active meeting.
Table 3-4 describes the fields in the Get Current Meetings request.
|
|
|
---|---|---|
meetingKey |
String |
Enter the unique key that the system uses to identify the meeting. |
The service returns a GetCurrentMeetingStatusResult in the service response, which includes a list of apiMeetingStatus elements. Table 3-5 describes the apiMeetingStatus element.
|
|
|
---|---|---|
activeParticipants |
Complex |
Contains one or more participantsInCurrentMeeting elements. This element is described in Table 3-6. |
bridgeResourceName |
String |
Provisioned name of the media resource that is providing the meeting bridge and media bridge resources for a meeting. |
bridgeResourceType |
Enumeration |
Media bridge resource type. One of the following values: •CTMS—Cisco TelePresence Multipoint Switch •TPS—Cisco TelePresence Server MSE 8710 •TPS_8510—Cisco TelePresence MCU MSE 8510 |
endTime |
Date/time string |
Scheduled end time of the meeting. |
meetingId |
String |
Meeting identifier that the meeting participant enters to join the meeting after dialing the access number. |
organizationKey |
Integer |
Unique key that the system uses to identify the organization. |
scheduledProvisionedEndpoints |
Complex |
Contains one or more apiProvisionedEndpoint elements. This element is described in Table 3-7. |
unscheduledProvisionedEndpoints |
Complex |
Contains one or more apiUnprovisionedEndpoint elements. This element is described in Table 3-8. |
startTime |
String |
Start time of the meeting. For a Rendezvous meeting, this is the start time of the current meeting instance. |
subject |
String |
Text subject of the meeting. |
Table 3-6 describes the participantsInCurrentMeeting element.
Table 3-7 describes the apiProvisionedEndpoint element.
Table 3-8 describes the apiUnprovisionedEndpoint element.
The Get Version service returns the product software version. For additional details about this service, see the "getVersion" section.
This method blocks any more users from dialing into a specified meeting. Dial-out endpoints are not affected by whether a meeting is locked or unlocked.
Table 3-9 describes the input parameters for the Lock Meeting service request.
|
|
|
---|---|---|
meetingKey |
String |
Unique key that the system uses to identify the meeting. |
The Lock Meeting service returns a success or fault message. There is no response data returned.
This method modifies a specified meeting that is currently in progress. Table 3-10 describes the input parameters for the Modify Active Meeting service request. Except where otherwise specifically noted in the table, null parameter values are set for fields that you do not want to change.
Note The Modify Active Meeting service request must include the meeting key of the meeting that you want to modify.
Note When modifying a meeting, any endpoint lists that were previously defined for the meeting must be specified completely, even if there are no changes. A null value cannot be used to indicate that there are no changes to the endpoint lists.
|
|
|
---|---|---|
meetingKey |
String |
Unique key that the system uses to identify the meeting. |
newDuration |
String |
(Optional) New duration of meeting, in minutes. |
newProvisionedEndpoints |
Complex |
Contains one or more apiProvisionedEndpoint elements. This element is described in Table 3-7. Note The list must include all of the provisioned endpoints for the meeting (not just the added and changed endpoints). Any of the original endpoints that are not included in the list will be removed from the meeting. |
newUnprovisionedEndpoints |
Complex |
Contains one or more apiUnprovisionedEndpoint elements. This element is described in Table 3-8. Note The list must include all of the unprovisioned endpoints for the meeting (not just the added and changed endpoints). Any of the original endpoints that are not included in the list will be removed from the meeting. |
newRemoteEndpointList |
Complex |
Contains one or more endpoints from a remote system. Note The list must include all of the remote endpoints for the meeting (not just the added and changed endpoints). Any of the original endpoints that are not included in the list will be removed from the meeting. |
newAdditionalCapacity |
Integer |
(Optional) Number of additional segments of media bridge capacity to allocate for the meeting. Use this parameter to reserve media bridge resources for endpoints that you do not add to the meeting but that you expect to join the meeting. To determine how many segments to add for each endpoint, use the following guidelines, depending on which media resource provides the meeting bridge: •Cisco TelePresence Multipoint Switch—Add 4 segments for each three-screen endpoint and 2 segments for each single-screen endpoint. •Cisco TelePresence MCU MSE 8510—Add 1 segment for each endpoint. Only single-screen endpoints are supported. •Cisco TelePresence Server MSE 8710—Add 3 segments for each three-screen endpoint and 1 segment for each single-screen endpoint. |
newLayoutID |
Integer |
(Optional) Enter a default value for the screen layout. This value will be used if the meeting is hosted on a Cisco TelePresence MCU MSE 8510, which supports a variety of screen layout options. For details on the layout values, see the "Custom Layouts" section. |
newIsHostRoleEnabled |
Boolean |
(Optional) Element set to TRUE if the host role is enabled. |
newHostPin |
String |
(Optional) Enter a numerical host PIN for the meeting. By default, the system will create a random PIN. Note Only set a host PIN if the host role is enabled. |
newMeetingExtensionEnabledType |
Complex |
(Optional) Whether meeting extensions are enabled for the meeting. One of the following values: •DISABLE—Disables meeting extensions for the meeting. •ENABLE—Enables meeting extensions for the meeting. •INHERIT—Inherits the setting (either DISABLE or ENABLE) from the organization of the meeting scheduler. |
newMeetingExtensionPeriod |
Integer |
(Optional) Number of minutes to extend the meeting if participants are still in the meeting when it is scheduled to end. |
newMaxMeetingExtensionsAllowed |
Integer |
(Optional) Maximum number of times that the meeting can be extended. |
newSchedulerOrgKey |
String |
(Optional) Organization key of the scheduler. |
The service returns a Modify Active Meeting Result. Table 3-11 describes the Modify Active Meeting Result.
|
|
|
---|---|---|
capacityAllocated |
Integer |
Number of segments of media bridge capacity that is allocated to the meeting. |
This method mutes all participants in a meeting except a list of specified participants.
Table 3-12 describes the input parameters for the Mute All Except service request.
The Mute All Except service returns a success or fault message. There is no response data returned.
This method mutes a list of specified participants.
Table 3-13 describes the input parameters for the Mute Participant service request.
The Mute Participant service returns a success or fault message. There is no response data returned.
This method initiates a dial-out call to a specified participant.
Table 3-14 describes the input parameters for the Redial Participant service request.
The Redial Participant service returns a success or fault message. There is no response data returned.
This method sends text to display on all endpoints that are in the meeting.
Note The endpoint text display feature is not supported for meetings that are hosted on a Cisco TelePresence Multipoint Switch.
Table 3-15 describes the input parameters for the Send Endpoint Text service request.
The Send Endpoint Text service returns a success or fault message. There is no response data returned.
This method sends text to display on one or more specified endpoints.
Note The endpoint text display feature is not supported for meetings that are hosted on a Cisco TelePresence Multipoint Switch.
Table 3-16 describes the input parameters for the Send Endpoint Text To Participant service request.
The Send Endpoint Text To Participant service returns a success or fault message. There is no response data returned.
This method enables new participants to dial into a previously locked meeting. Dial-out endpoints are not affected by whether a meeting is locked or unlocked.
Table 3-17 describes the input parameters for the Unlock Meeting service request.
|
|
|
---|---|---|
meetingKey |
String |
Unique key that the system uses to identify the meeting. |
The Unlock Meeting service returns a success or fault message. There is no response data returned.
This method unmutes all participants in a meeting.
Table 3-18 describes the input parameters for the Unmute All service request.
|
|
|
---|---|---|
meetingKey |
String |
Unique key that the system uses to identify the meeting. |
The Unmute All service returns a success or fault message. There is no response data returned.
This method unmutes one or more specified participants in a meeting.
Table 3-19 describes the input parameters for the Unmute Participant service request.
The Unmute Participant service returns a success or fault message. There is no response data returned.
The Cisco TelePresence Exchange System API communicates an error condition to the client by returning a SOAP fault message. The fault message contains an API Active Meetings Management Exception, which is described in Table 3-20.
|
|
|
---|---|---|
cause code |
String |
(Optional) Provides more detailed information about an exception return code. The cause codes are listed in the "Cause Codes" section. |
erc |
String |
Exception return code. Note For information on API Active Meetings Management Exception values, see the "Exception Values" section. |
message |
String |
English text message that provides additional information about the exception code. The content of the message varies depending on the exception code. Note This message is not localized. Therefore, Cisco recommends that the message string not be displayed to the end user directly, due to the possibility that the portal may cater to multiple languages. |
value map |
String |
(Optional) A name/value map in which each element is a pair of strings (a key and a value). The key identifies the type of entity, and the value identifies the specific instance that caused the exception. Possible key values are as follows: MEETING_KEY |
Table 3-21 describes the exception values.
The list of possible cause codes includes the following:
CANNOT_ADD_UNSUPPORTED_ENDPOINT
CANNOT_CHANGE_DROP_PARTICIPANTS_ON_HOST_EXIT
CANNOT_CHANGE_MEETING_EXTENSION_SETTING
CANNOT_DECREASE_ADDITIONAL_CAPACITY
CANNOT_DECREASE_BANDWIDTH
CANNOT_DECREASE_CAPACITY
CANNOT_REMOVE_EXISTING_ENDPOINT
INVALID_ACTIVE_MEETING
LICENSE_NOT_VALID
LICENSE_SERVER_NOT_ACCESSIBLE
MUTE_FAILED
MUTE_ALL_EXCEPT_FAILED
UNMUTE_FAILED
UNMUTE_ALL_FAILED
DROP_PARTICIPANT_FAILED
REDIAL_PARTICIPANT_FAILED
SEND_ENDPOINT_TEXT_FAILED
LICENSING_EXCEPTION
BRIDGE_TYPE_NOT_VALID
MEETING_NOT_ACTIVE