CAPI Interface WADL


This is generated application.wadl for CAPI REST Interface
The AAC Conferencing API(CAPI) is a RESTful API for interacting with Avaya Aura Conferencing

CAPI supports three authentication methods – http-basic and form based for end user clients and trusted node/Oauth 2 for Enterprise Conferencing Portals.

1) HTTP-Basic auth.
Registered AAC users may include HTTP-Basic AAC username and password with each request. They are included as Authorization header in form of "Basic {credentials}" where "credentials" is userid:password encoded into Base64 format. Guests cannot perform HTTP-Basic authentication.

2) Form based auth.
Sessions can be created via a lightweight /session resource that the client may PUT its credentials to. It can be one of username/password or guest display name. Unlike Basic authentication, this is the only time the authentication is performed for the life of the session. For form authentication, once logged in the username and password are no longer required.

3) Enterprise Conferencing Portals auth.
The base goal of the ECP authentication is to allow a 3rd party server to act on behalf of users without knowing the user’s password.
3.1) Trusted Node Authentication for ECP
The ECP may be configured as a trusted node. Requests from the trusted IP address in the request URI or X-Forwarded-For header will be authenticated without a password. Configuring as a trusted node requires that the ECP include a “subject” parameter to identify the user to act on behalf of.Configuring the ECP as a trusted node implies that the ECP does not need to request a token on behalf of the user.
3.2) OAuth2 Authentication for ECP
OAuth2 authentication is a common server-to-server authentication protocol in the industry. It is working on the principal of granting a temporary token that client should use as proof of authentication.
For using that authentication type client should know secret API ID and API key which are stored on the server. Typical OAuth2 call flow is the following:
1) Client makes a request for a temporary “nonce” including “subject” as a request parameter.
2) Client generates a special HMAC value (HmacSHA1 is used now). API key is used as a signing key and (nonce+API ID) is used as a signing value.
3) Client requests for a token including API ID, HMAC and subject the server tries to validate the input.
4) The server returns an OAuth2 token, refresh token and token expiry value.
5) Client includes the OAuth2 token into each request into “Authorization” with a value of “Bearer {OAuth2Token}” as proof of authentication.
Notes:
1) OAuth2 token is a temporary value (12hours by default). If it is expired then client gets HTTP 401 response with appropriate message. Client may request for a new token by refreshToken endpoint.
2) Each token/nonce request invalidates old nonce/token.
3) Nonce value is removed once token is obtained or by short timeout (30 seconds be default). It is used to prevent replay attacks.

Summary

ResourceMethodDescription
https://{CA-SERVER}/capi/rest/system/settingsGET

The get settings resource allows the AAC client to retrieve the relevant configuration settings of this AAC system. These confgiuration settings are system wide and may be used to control client behavior.
https://{CA-SERVER}/capi/rest/system/supported-api-media-typesGET

The supported api media types resource is used to GET the product and api version information.
https://{CA-SERVER}/capi/rest/system/feature-keysGET

Allows to get participant and moderator TUI keys
https://{CA-SERVER}/capi/rest/system/password-policyGET

Allows to get current system password policy (AAC owned or external system owned)
https://{CA-SERVER}/capi/rest/tokenPOST

The Create Token resource allows to create an oAuth2 token.
https://{CA-SERVER}/capi/rest/token/noncePOST

The Create Token resource allows to create an oAuth2 token.
https://{CA-SERVER}/capi/rest/token/refreshTokenPUT

The Refresh Token resource allows to update an oAuth2 token for the user.
https://{CA-SERVER}/capi/rest/library/contents/{content-id}GET

POST

DELETE

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to get the content.

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to get the content.

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to delete the content.
https://{CA-SERVER}/capi/rest/library/contentsGET

The Contents resource is a child of the Library resource. It represents a collection of content that the conferencing user has uploaded to his web collaboration document library.
https://{CA-SERVER}/capi/rest/library/conversion-server-urlGET

The Conversion Server Url resource gets a Document Conversion Server URL such that the client may upload documents to their library.
https://{CA-SERVER}/capi/rest/history/conference/recordings/{recording-id}GET

PUT

DELETE

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to read the recording.

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to change the name, scope and to allow downloading during playback for the recording.

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to delete the recording name.
https://{CA-SERVER}/capi/rest/history/conference/reportsGET

The Reports resource is a child of the History resource. Reports are a collection of events that occurred during a collaboration session, such as minutes and messages.
https://{CA-SERVER}/capi/rest/history/conference/reports/{report-id}GET

PUT

DELETE

The Report resource represents the meeting reports from a conference. Reports are only generated for conferences that enable collaboration. Allows to read the report.

The Report resource represents the meeting reports from a conference. Reports are only generated for conferences that enable collaboration. Allows to change the report name.

The Report Resource represents the meeting report from a conference. Reports are only generated for conferences that enable collaboration. Allows to delete the report.
https://{CA-SERVER}/capi/rest/history/conference/reports/reports-launch-urlGET

The Reports Launch Url resource represents the URL to obtain reports.
https://{CA-SERVER}/capi/rest/history/conference/recordingsGET

The Recordings resource contains a list of recordings for the user. Recordings will only be available if the conference has been recorded.
https://{CA-SERVER}/capi/rest/conferencesGET

POST

The query conference resource is used to query whether a conference instance currently exists for the given collaboration code.

The create conference resource is used to create a conference for the given collaboration code. The returned Conference object includes a Participant that represents your client instance. Only the conference owner or a client using the moderator credentials may create a conference.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/minutesGET

POST

The Minutes resource is a child of the Conference resource. Usage of the conference Minutes resource requires Conference webCollabStatus to be ACTIVE before it can be used to post and retrieve meeting minutes. Allow to read minutes.

The Minutes resource is a child of the Conference resource. Usage of the conference Minutes resource requires Conference webCollabStatus to be ACTIVE before it can be used to post and retrieve meeting minutes. Allow to add minutes.
https://{CA-SERVER}/capi/rest/conferences/joinPOST

The join conference resource is a convenience method that includes many different resource requests, to allow a client a single request to create a session, create or join a conference, and start the collab, as well as options for allowing the server to monitor the session timeout. The returned Conference object includes a Participant that represents the joined client instance. Only the conference owner or a client using the moderator credentials may create a conference. It may be used in place of the create Conference and create Session resources.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}POST

GET

DELETE

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to update the conference.

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to read the conference.

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to delete the conference.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/agent-launch-urlGET

The Collaboration Agent Launch URL resource is a child of the Conferences resource. The CA Launch URL Resource provides the client a temporary URL that a web browser may use to join the conference using 1st party AAC conferencing client, the Collaboration Agent.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/sharing-launch-urlGET

The Web Collaboration Launch URL resource is a child of the Conferences resource. The resource provides the client a URL that a web browser may use to join the conference using 1st party AAC web sharing client.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/messagesGET

POST

The Messages resource is a child of the Conference resource. Usage of the Messages resource requires Conference webCollabStatus to be ACTIVE before it can be used. Allows to get messages

The Messages resource is a child of the Conference resource. Usage of the Messages resource requires Conference webCollabStatus to be ACTIVE before it can be used. Allows to add messages
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/participantsGET

POST

The Participants resource is a child of the Conference resource. Allows to get participants

The Participants resource is a child of the Conference resource. Allows to update or dial out to participants.
https://{CA-SERVER}/capi/rest/conferences/{conference-id}/participants/{participant-id}GET

POST

DELETE

The Read Participant resource is a child of the Participants resource. Allows to read participant

The Update Participant resource is a child of the Participants resource. Allows to update participant

The Delete Participant resource is a child of the Participants resource. Allows to delete participant
https://{CA-SERVER}/capi/rest/sessionPOST

GET

DELETE

The Create Session resource allows to read an HTTP session. One of username-password pair or displayName is required.

The Read Session resource allows to create an HTTP session. If the user is not logged in, an HTTP 404 (Not Found) is returned.

The Delete Session resource allows to delete an HTTP session.
https://{CA-SERVER}/capi/rest/session/guestPOST

The Guest Session resource allows to create a system username from display name.
https://{CA-SERVER}/capi/rest/settings/conference/feature-settingsGET

PUT

The Default Conference Feature Settings resource allows a client to get the conference features that are enabled or disabled by default for the users conference. The ability to get some of the features may be limited by what the system administrator has allowed for the user.

The Default Conference Feature Settings resource allows a client to set the conference features that are enabled or disabled by default for the users conference. The ability to set some of the features may be limited by what the system administrator has allowed for the user.
https://{CA-SERVER}/capi/rest/settings/conference/collaboration-codesGET

The Collaboration Codes Settings resource allows a client to get the collaboration codes
https://{CA-SERVER}/capi/rest/settings/conference/passcodesGET

PUT

The Passcode Settings resource allows a client to retrieve the passcodes. Passcodes may not be available for all users and is controlled by the system administrator. A client may inspect the Collaboration Codes Settings resource to find if passcodes apply for the user.

The Passcode Settings resource allows a client to update the passcodes. Passcodes may not be available for all users and is controlled by the system administrator. A client may inspect the Collaboration Codes Settings resource to find if passcodes apply for the user.
https://{CA-SERVER}/capi/rest/settings/conference/infoGET

https://{CA-SERVER}/capi/rest/settings/user/passwordPUT

The Change Password resource allows to set password if password is owned by external system. If password is owned by external system, it is not changeable through CA and is synced from external system as-is (no password policy is applied to it)
https://{CA-SERVER}/capi/rest/settings/user/communication-addressesGET

The Get Available Communication Address list resource allows to get list of commaddresses for users who logged in with enterprise identity
https://{CA-SERVER}/capi/rest/settings/user/default-communication-addressGET

PUT

The Get Default Communication Address list resource allows to get the default commaddress for user

The Update Default Communication Address list resource allows to set the default commaddress for user
https://{CA-SERVER}/capi/rest/settings/user/associated-numbersPUT

The Update Associated Numbers resource allows to modify the list of user associated numbers

Grammars

capi.xsd

Resources


https://{CA-SERVER}/capi/rest/system/settings

Methods
GETreadSystemSettings()

The get settings resource allows the AAC client to retrieve the relevant configuration settings of this AAC system. These confgiuration settings are system wide and may be used to control client behavior.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlsystemSettings
application/vnd.avaya.conferencing.v1+jsonsystemSettings
application/xmlsystemSettings
application/jsonsystemSettings

https://{CA-SERVER}/capi/rest/system/supported-api-media-types

Methods
GETgetSupportedAPIMediaTypes()

The supported api media types resource is used to GET the product and api version information.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlmediaTypes
application/vnd.avaya.conferencing.v1+jsonmediaTypes
application/xmlmediaTypes
application/jsonmediaTypes

https://{CA-SERVER}/capi/rest/system/feature-keys

Methods
GETgetFeatureKeys()

Allows to get participant and moderator TUI keys

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlfeatureKeys
application/vnd.avaya.conferencing.v1+jsonfeatureKeys
application/xmlfeatureKeys
application/jsonfeatureKeys

https://{CA-SERVER}/capi/rest/system/password-policy

Methods
GETgetPasswordPolicy()

Allows to get current system password policy (AAC owned or external system owned)

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlpasswordPolicy
application/vnd.avaya.conferencing.v1+jsonpasswordPolicy
application/xmlpasswordPolicy
application/jsonpasswordPolicy

https://{CA-SERVER}/capi/rest/token

The token Resource contains some methods regarding OAuth2 authentication. OAuth2 authentication is a common server-to-server authentication protocol in the industry. It is working on the principal of granting a temporary token that client should use as proof of authentication. The conferencing client should be configured as an Enterprise Conferencing Portal (ECP) in the AAC Element Manager. For using this authentication type the client should know secret API ID and API key which are configured against the ECP. Typical OAuth2 call flow is the following: 1) Client makes a request for a temporary "nonce" including "subject" as a request parameter. 2) Client generates a special HMAC value (HmacSHA1 is used now). API key is used as a signing key and (nonce+API ID) is used as a signing value. 3) Client requests for a token including API ID, HMAC and subject the server tries to validate the input. 4) The server returns an OAuth2 token, refresh token and token expiry value. 5) Client includes the OAuth2 token into each request into "Authorization" with a value of "Bearer {OAuth2Token}" as proof of authentication. Notes: 1) OAuth2 token is a temporary value (12hours by default). If it is expired then client gets HTTP 401 response with appropriate message. Client may request for a new token by refreshToken endpoint. 2) Each token/nonce request invalidates old nonce/token. 3) Nonce value is removed once token is obtained or by short timeout (30 seconds be default). It is used to prevent replay attacks.

Methods
POSTcreateToken()

The Create Token resource allows to create an oAuth2 token.

request
representations
application/x-www-form-urlencoded
query params
subjectstring
(required)
fully qualified user or guest name (user@domain) of the conferencing user they are acting on behalf of
apiIdstring
(required)
ECP unique identifier used for searching necessary ECP and creating HMAC
hmacstring
(required)
hashing sum of nonce+apiId with apiKey as a signing key

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmloAuth2token
application/vnd.avaya.conferencing.v1+jsonoAuth2token
application/xmloAuth2token
application/jsonoAuth2token

https://{CA-SERVER}/capi/rest/token/nonce

Methods
POSTcreateNonce()

The Create Token resource allows to create an oAuth2 token.

request
representations
application/x-www-form-urlencoded
query params
subjectstring
(required)
fully qualified user or guest name (user@domain) of the conferencing user they are acting on behalf of

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlnonce
application/vnd.avaya.conferencing.v1+jsonnonce
application/xmlnonce
application/jsonnonce

https://{CA-SERVER}/capi/rest/token/refreshToken

Methods
PUTupdateToken()

The Refresh Token resource allows to update an oAuth2 token for the user.

request
representations
application/x-www-form-urlencoded
query params
subjectstring
(required)
fully qualified user or guest name (user@domain) of the conferencing user they are acting on behalf of
refreshTokenstring
(required)
A key associated with an oAuth2 token used to update current token

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmloAuth2token
application/vnd.avaya.conferencing.v1+jsonoAuth2token
application/xmloAuth2token
application/jsonoAuth2token

https://{CA-SERVER}/capi/rest/library/contents/{content-id}

Methods
GETgetContent()

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to get the content.

request
template params
content-idstring
(required)
the id of the content

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlcontent
application/vnd.avaya.conferencing.v1+jsoncontent
application/xmlcontent
application/jsoncontent
POSTupdateContent()

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to get the content.

request
template params
content-idstring
(required)
the id of the content

representations
application/x-www-form-urlencoded
query params
namestringthe name of the content

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlcontent
application/vnd.avaya.conferencing.v1+jsoncontent
application/xmlcontent
application/jsoncontent
DELETEdeleteContent()

The Content resource is a child of the Library resource. It represents a document, slide deck or image that may be shared during web collaboration. Allows to delete the content.

request
template params
content-idstring
(required)
the id of the content

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlcontent
application/vnd.avaya.conferencing.v1+jsoncontent
application/xmlcontent
application/jsoncontent

https://{CA-SERVER}/capi/rest/library/contents

Methods
GETgetContents()

The Contents resource is a child of the Library resource. It represents a collection of content that the conferencing user has uploaded to his web collaboration document library.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlcontents
application/vnd.avaya.conferencing.v1+jsoncontents
application/xmlcontents
application/jsoncontents

https://{CA-SERVER}/capi/rest/library/conversion-server-url

Methods
GETgetConversionServerURL()

The Conversion Server Url resource gets a Document Conversion Server URL such that the client may upload documents to their library.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlurl
application/vnd.avaya.conferencing.v1+jsonurl
application/xmlurl
application/jsonurl

https://{CA-SERVER}/capi/rest/history/conference/recordings/{recording-id}

Methods
GETgetRecording()

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to read the recording.

request
template params
recording-idint
(required)
the recording id

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlrecording
application/vnd.avaya.conferencing.v1+jsonrecording
application/xmlrecording
application/jsonrecording
PUTupdateRecording()

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to change the name, scope and to allow downloading during playback for the recording.

request
template params
recording-idint
(required)
the recording id

representations
application/x-www-form-urlencoded
query params
namestringthe name of the recording
scopestringthe scope of the recording
allowDownloadDuringPlaybackbooleanwhether to allow users to download the recording

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlrecording
application/vnd.avaya.conferencing.v1+jsonrecording
application/xmlrecording
application/jsonrecording
DELETEdeleteRecording()

The Conference Recording resource is a child of the Recordings resource and represents a recording for a conference. Allows to delete the recording name.

request
template params
recording-idint
(required)
the recording id

responses
unspecified

https://{CA-SERVER}/capi/rest/history/conference/reports

Methods
GETgetReports()

The Reports resource is a child of the History resource. Reports are a collection of events that occurred during a collaboration session, such as minutes and messages.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlreport
application/vnd.avaya.conferencing.v1+jsonreport
application/xmlreport
application/jsonreport

https://{CA-SERVER}/capi/rest/history/conference/reports/{report-id}

Methods
GETgetReport()

The Report resource represents the meeting reports from a conference. Reports are only generated for conferences that enable collaboration. Allows to read the report.

request
template params
report-idstring
(required)
the report id

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlreport
application/vnd.avaya.conferencing.v1+jsonreport
application/xmlreport
application/jsonreport
PUTupdateReport()

The Report resource represents the meeting reports from a conference. Reports are only generated for conferences that enable collaboration. Allows to change the report name.

request
template params
report-idstring
(required)
the report id

representations
application/x-www-form-urlencoded
query params
namestring
(required)
the name of the report

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlreport
application/vnd.avaya.conferencing.v1+jsonreport
application/xmlreport
application/jsonreport
DELETEdeleteReport()

The Report Resource represents the meeting report from a conference. Reports are only generated for conferences that enable collaboration. Allows to delete the report.

request
template params
report-idstring
(required)
the report id

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlreport
application/vnd.avaya.conferencing.v1+jsonreport
application/xmlreport
application/jsonreport

https://{CA-SERVER}/capi/rest/history/conference/reports/reports-launch-url

Methods
GETgetReportsLaunchURL()

The Reports Launch Url resource represents the URL to obtain reports.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlurl
application/vnd.avaya.conferencing.v1+jsonurl
application/xmlurl
application/jsonurl

https://{CA-SERVER}/capi/rest/history/conference/recordings

Methods
GETgetRecordings()

The Recordings resource contains a list of recordings for the user. Recordings will only be available if the conference has been recorded.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlrecordings
application/vnd.avaya.conferencing.v1+jsonrecordings
application/xmlrecordings
application/jsonrecordings

https://{CA-SERVER}/capi/rest/conferences

The Conferences resource is a top level resource used to query a conference, make changes to a live conference and conference participants

Methods
GETqueryConferences()

The query conference resource is used to query whether a conference instance currently exists for the given collaboration code.

request
query params
collaborationCodestring
(required)
collaboration code used to identify a conference
passcodestringmoderator or participant passcode used to enter a conference. May be required to join/create depending on conference settings
participantIdstringthe id of the used participant

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconferences
application/vnd.avaya.conferencing.v1+jsonconferences
application/xmlconferences
application/jsonconferences
POSTcreateConference()

The create conference resource is used to create a conference for the given collaboration code. The returned Conference object includes a Participant that represents your client instance. Only the conference owner or a client using the moderator credentials may create a conference.

request
representations
application/x-www-form-urlencoded
query params
collaborationCodestring
(required)
collaboration code used to identify a conference
passcodestringmoderator or participant passcode used to enter a conference. May be required to join/create depending on conference settings

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/minutes

Methods
GETgetMinutes()

The Minutes resource is a child of the Conference resource. Usage of the conference Minutes resource requires Conference webCollabStatus to be ACTIVE before it can be used to post and retrieve meeting minutes. Allow to read minutes.

request
template params
conference-idstring
(required)

query params
participantIdstringidentify which participant instance to act on behalf of
startIndexint
default: 0
start index of messages

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlminutes
application/vnd.avaya.conferencing.v1+jsonminutes
application/xmlminutes
application/jsonminutes
POSTaddMinute()

The Minutes resource is a child of the Conference resource. Usage of the conference Minutes resource requires Conference webCollabStatus to be ACTIVE before it can be used to post and retrieve meeting minutes. Allow to add minutes.

request
template params
conference-idstring
(required)

representations
application/x-www-form-urlencoded
query params
participantIdstring
textstring
typestring
personalboolean
default: FALSE

responses
unspecified

https://{CA-SERVER}/capi/rest/conferences/join

Methods
POSTjoinConference()

The join conference resource is a convenience method that includes many different resource requests, to allow a client a single request to create a session, create or join a conference, and start the collab, as well as options for allowing the server to monitor the session timeout. The returned Conference object includes a Participant that represents the joined client instance. Only the conference owner or a client using the moderator credentials may create a conference. It may be used in place of the create Conference and create Session resources.

request
representations
application/x-www-form-urlencoded
query params
collaborationCodestringcollaboration code used to identify a conference
passcodestringpassCode moderator or participant passcode used to enter a conference. May be required to join/create depending on conference settings
usernamestringthe registered user communication address (user@domain)
passwordstringthe registered user password
displayNamestringthe guest display name
startCollabboolean
default: FALSE
whether or not to start web collab
monitorSessionboolean
default: FALSE
whether or not to monitor session
monitorParticipantIdboolean
default: FALSE
whether or not to monitor participant Id
allowEventConfStartboolean
default: TRUE
flag to allow moderator/delegate to start event conference or not

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference

https://{CA-SERVER}/capi/rest/conferences/{conference-id}

Methods
POSTupdateConference()

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to update the conference.

request
template params
conference-idstring
(required)
the id of the conference

representations
application/x-www-form-urlencoded
query params
participantIdstringidentify which participant instance to act on behalf of
tonesbooleantrue/false whether entry and exit tones are enabled
videobooleantrue/false change whether video is allowed on the conference
continuationbooleanwhether the conference will be allowed to continue after the moderator disconnects
recordingbooleanwhether the conference is being recorded
lockedbooleanwhether the conference is being recorded
lecturebooleanwhether lecture mode is active on the conference
silencestringwhether silence is enabled on the conference
panelbooleanwhether panel mode is active on the conference
webCollabbooleanwhether web collaboration is active on the conference

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference
GETreadConference()

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to read the conference.

request
template params
conference-idstring
(required)
the id of the conference

header params
If-Modified-Sincestringindicating the date and time of the last request for the resource from the client
If-None-MatchstringIf-None-Match header

query params
participantIdstringidentify which participant instance to act on behalf of
includeParticipantsboolean
default: FALSE
whether to include all participant info

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference
DELETEdeleteConference()

The Conference resource is a child of the Conferences resource. The Conference resource represents the current state of a live conference. Allows to delete the conference.

request
template params
conference-idstring
(required)
the id of the conference

query params
participantIdstringidentify which participant instance to act on behalf of

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/agent-launch-url

Methods
GETgetAgentLaunchURL()

The Collaboration Agent Launch URL resource is a child of the Conferences resource. The CA Launch URL Resource provides the client a temporary URL that a web browser may use to join the conference using 1st party AAC conferencing client, the Collaboration Agent.

request
template params
conference-idstring
(required)
the id of the conference

query params
participantIdstringidentify which participant instance to act on behalf of
startCollabbooleanwhether to automatically start the web collaboration
shareContentIdstringthe content id from the library to start sharing

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlurl
application/vnd.avaya.conferencing.v1+jsonurl
application/xmlurl
application/jsonurl

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/sharing-launch-url

Methods
GETgetCollaborationLaunchUrl()

The Web Collaboration Launch URL resource is a child of the Conferences resource. The resource provides the client a URL that a web browser may use to join the conference using 1st party AAC web sharing client.

request
template params
conference-idstring
(required)
the id of the conference

query params
participantIdstringidentify which participant instance to act on behalf of
platformTypestring
default: PC
the platform to generate URL for

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlurl
application/vnd.avaya.conferencing.v1+jsonurl
application/xmlurl
application/jsonurl

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/messages

Methods
GETgetMessages()

The Messages resource is a child of the Conference resource. Usage of the Messages resource requires Conference webCollabStatus to be ACTIVE before it can be used. Allows to get messages

request
template params
conference-idstring
(required)

query params
participantIdstringidentify which participant instance to act on behalf of
startIndexint
default: 0
start index of messages

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlmessages
application/vnd.avaya.conferencing.v1+jsonmessages
application/xmlmessages
application/jsonmessages
POSTaddMessage()

The Messages resource is a child of the Conference resource. Usage of the Messages resource requires Conference webCollabStatus to be ACTIVE before it can be used. Allows to add messages

request
template params
conference-idstring
(required)

representations
application/x-www-form-urlencoded
query params
participantIdstring
textstring
targetIdstring

responses
unspecified

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/participants

Methods
GETreadParticipants()

The Participants resource is a child of the Conference resource. Allows to get participants

request
template params
conference-idstring
(required)
the id of the conference

header params
If-None-MatchstringIf-None-Match header
If-Modified-Sincestringindicating the date and time of the last request for the resource from the client

query params
participantIdstringidentify which participant instance to act on behalf of

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlparticipants
application/vnd.avaya.conferencing.v1+jsonparticipants
application/xmlparticipants
application/jsonparticipants
POSTupdateParticipants()

The Participants resource is a child of the Conference resource. Allows to update or dial out to participants.

request
template params
conference-idstring
(required)
the id of the conference

representations
application/x-www-form-urlencoded
query params
participantIdstringidentify which participant instance to act on behalf of
collaborationCodestringcollaboration code used to identify a conference
passcodestringpassCode moderator or participant passcode used to enter a conference. May be required to join/create depending on conference settings
joinParticipantsbooleanrequired to join the participant list - value true joins the conference. Allows the user to view the advanced conference information.
forceoutboolean
default: FALSE
whether to forcing out existing user
sipAddressstringdials out to the sip addresses provided, returns participant instances for the dialed out users participants.
phoneNumberstringdials out to the numbers provided, returns participants instances for the dialed out participants.

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlparticipants
application/vnd.avaya.conferencing.v1+jsonparticipants
application/xmlparticipants
application/jsonparticipants

https://{CA-SERVER}/capi/rest/conferences/{conference-id}/participants/{participant-id}

Methods
GETreadParticipant()

The Read Participant resource is a child of the Participants resource. Allows to read participant

request
template params
conference-idstring
(required)
the id of the conference
participant-idstring
(required)
identify participant to act on

header params
If-Modified-Sincestring
If-None-Matchstring

query params
participantIdstring

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlparticipant
application/vnd.avaya.conferencing.v1+jsonparticipant
application/xmlparticipant
application/jsonparticipant
POSTupdateParticipant()

The Update Participant resource is a child of the Participants resource. Allows to update participant

request
template params
conference-idstring
(required)
the id of the conference
participant-idstring
(required)
identify participant to act on

representations
application/x-www-form-urlencoded
query params
participantIdstring
addRolestring
removeRolestring
audioStatestring
videoStatestring
handStatestring
associateParticipantIdstring
dissociateboolean
addAudiostring
permanentboolean

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlparticipant
application/vnd.avaya.conferencing.v1+jsonparticipant
application/xmlparticipant
application/jsonparticipant
DELETEdeleteParticipant()

The Delete Participant resource is a child of the Participants resource. Allows to delete participant

request
template params
conference-idstring
(required)
the id of the conference
participant-idstring
(required)
identify participant to act on

query params
participantIdstringidentify which participant instance to act on behalf of

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlparticipant
application/vnd.avaya.conferencing.v1+jsonparticipant
application/xmlparticipant
application/jsonparticipant

https://{CA-SERVER}/capi/rest/session

The Session resource allows a registered user or guest to establish an API session. For guests, the resource grants temporary accounts valid for the life of the session.

Methods
POSTcreateSession()

The Create Session resource allows to read an HTTP session. One of username-password pair or displayName is required.

request
representations
application/x-www-form-urlencoded
query params
usernamestring
(required)
the registered user communication address (user@domain)
passwordstring
(required)
the registered user password
displayNamestring
(required)
the guest display name

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlsession
application/vnd.avaya.conferencing.v1+jsonsession
application/xmlsession
application/jsonsession
GETreadSession()

The Read Session resource allows to create an HTTP session. If the user is not logged in, an HTTP 404 (Not Found) is returned.

request
query params
usernamestringthe guest id

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlsession
application/vnd.avaya.conferencing.v1+jsonsession
application/xmlsession
application/jsonsession
DELETEdeleteSession()

The Delete Session resource allows to delete an HTTP session.

request
representations
application/x-www-form-urlencoded
query params
usernamestringthe registered user communication address (user@domain)

responses
unspecified

https://{CA-SERVER}/capi/rest/session/guest

Methods
POSTcreateGuest()

The Guest Session resource allows to create a system username from display name.

request
representations
application/x-www-form-urlencoded
query params
displayNamestring
(required)
the guest display name

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlsession
application/vnd.avaya.conferencing.v1+jsonsession
application/xmlsession
application/jsonsession

https://{CA-SERVER}/capi/rest/settings/conference/feature-settings

Methods
GETreadDefaultConferenceFeatureSettings()

The Default Conference Feature Settings resource allows a client to get the conference features that are enabled or disabled by default for the users conference. The ability to get some of the features may be limited by what the system administrator has allowed for the user.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconferenceFeatureSettings
application/vnd.avaya.conferencing.v1+jsonconferenceFeatureSettings
application/xmlconferenceFeatureSettings
application/jsonconferenceFeatureSettings
PUTupdateDefaultConferenceFeatureSettings()

The Default Conference Feature Settings resource allows a client to set the conference features that are enabled or disabled by default for the users conference. The ability to set some of the features may be limited by what the system administrator has allowed for the user.

request
representations
application/x-www-form-urlencoded
query params
autoRecordbooleantrue/false, whether to automatically start recording when the conference starts
continuationbooleantrue/false, whether the conference should continue when the moderator disconnects
fastStartbooleantrue/false, whether to start the conference when the first dials in rather than wait for a moderator to join
tonesbooleantrue/false, whether entry and exit tones are enabled on the conference
videobooleantrue/false, whether video is allow video on the conference
panelbooleantrue/false, whether to allow panel mode on the conference

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconferenceFeatureSettings
application/vnd.avaya.conferencing.v1+jsonconferenceFeatureSettings
application/xmlconferenceFeatureSettings
application/jsonconferenceFeatureSettings

https://{CA-SERVER}/capi/rest/settings/conference/collaboration-codes

Methods
GETreadDefaultConferenceCollaborationCodeSettings()

The Collaboration Codes Settings resource allows a client to get the collaboration codes

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlcollaborationCodeSettings
application/vnd.avaya.conferencing.v1+jsoncollaborationCodeSettings
application/xmlcollaborationCodeSettings
application/jsoncollaborationCodeSettings

https://{CA-SERVER}/capi/rest/settings/conference/passcodes

Methods
GETreadDefaultConferencePasscodeSettings()

The Passcode Settings resource allows a client to retrieve the passcodes. Passcodes may not be available for all users and is controlled by the system administrator. A client may inspect the Collaboration Codes Settings resource to find if passcodes apply for the user.

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlpasscodeSettings
application/vnd.avaya.conferencing.v1+jsonpasscodeSettings
application/xmlpasscodeSettings
application/jsonpasscodeSettings
PUTupdateDefaultConferencePasscodeSettings()

The Passcode Settings resource allows a client to update the passcodes. Passcodes may not be available for all users and is controlled by the system administrator. A client may inspect the Collaboration Codes Settings resource to find if passcodes apply for the user.

request
representations
application/x-www-form-urlencoded
query params
passcodeRequiredbooleantrue/false whether a participant passcode is required to join the conference
partPasscodestringthe numeric participant passcode to join the conference
modPasscodestringthe numeric moderator passcode to join the conference

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlpasscodeSettings
application/vnd.avaya.conferencing.v1+jsonpasscodeSettings
application/xmlpasscodeSettings
application/jsonpasscodeSettings

https://{CA-SERVER}/capi/rest/settings/conference/info

Methods
GETreadDefaultConferenceSettings()

request
query params
collaborationCodestring
passcodestring
namestring

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlconference
application/vnd.avaya.conferencing.v1+jsonconference
application/xmlconference
application/jsonconference

https://{CA-SERVER}/capi/rest/settings/user/password

Methods
PUTchangePassword()

The Change Password resource allows to set password if password is owned by external system. If password is owned by external system, it is not changeable through CA and is synced from external system as-is (no password policy is applied to it)

request
representations
application/x-www-form-urlencoded
query params
passwordstringthe password to set

responses
unspecified

https://{CA-SERVER}/capi/rest/settings/user/communication-addresses

Methods
GETgetAvailableCommAddrList()

The Get Available Communication Address list resource allows to get list of commaddresses for users who logged in with enterprise identity

request
query params
usernamestringthe password to set

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlenterpriseLogin
application/vnd.avaya.conferencing.v1+jsonenterpriseLogin
application/xmlenterpriseLogin
application/jsonenterpriseLogin

https://{CA-SERVER}/capi/rest/settings/user/default-communication-address

Methods
GETgetDefaultCommunicationAddress()

The Get Default Communication Address list resource allows to get the default commaddress for user

request
unspecified
responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlEnterpriseSettings
application/vnd.avaya.conferencing.v1+jsonEnterpriseSettings
application/xmlEnterpriseSettings
application/jsonEnterpriseSettings
PUTupdateDefaultCommunicationAddress()

The Update Default Communication Address list resource allows to set the default commaddress for user

request
representations
application/x-www-form-urlencoded
query params
defaultCommunicationAddressstringthe communication address used by default

responses
status:
200 - OK
representations
application/vnd.avaya.conferencing.v1+xmlEnterpriseSettings
application/vnd.avaya.conferencing.v1+jsonEnterpriseSettings
application/xmlEnterpriseSettings
application/jsonEnterpriseSettings

https://{CA-SERVER}/capi/rest/settings/user/associated-numbers

Methods
PUTupdateAssociatedNumbers()

The Update Associated Numbers resource allows to modify the list of user associated numbers

request
representations
application/x-www-form-urlencoded
query params
addNumberstringthe number to add (associate with)

responses
unspecified