System Manager Web Services API

[avc844244490912]

Hi Everyone...
Does anyone know where I can get the Avaya Aura® Session Manager Element Manager Web Service API Programming Reference?
Devconnect's pages are down and I cannot pull the old SDK documents.

I'm trying to connect to the rest api at mgmtwebservice/ and just have it list endpoint registrations and spit out an XML with all current registered endpoints. I recall I had this working once back in 2018, as they added the functionality in 7.1.3, but I cannot for the life of me, remember how this was done.

[jalperin]

Will investigate with Avaya Support and product team why it isn't available on the Support Portal. Note the most recent version of the document is for release 8.1.3 as there were no changes made in later releases.

[jalperin]

I've confirmed that the documentation is contained within the SDK download ZIP file itself. You can find the latest release SDK version at the interim page for DevConnect SDKs at https://www.avaya.com/en/partners/devconnect/sdks/ under the Avaya Aura System Manager materials. Just grab a copy of the SDK, unzip it, and you should find what you are looking for.

[derekf]

Did you find a service that actually lists all the registered SIP endpoints? I don't see that as an option in any of the SMGR web services manuals...

[rbrookes]

I asked that question of Avaya Ada (Avaya's generative AI chatbot) - I don't have specific knowledge on this topic, so I'm not sure the answer is right - I'll leave that to you to judge. Here's what Ada said - hope this helps:

regarding a service that lists all the registered SIP endpoints, the Avaya Aura® Session Manager does provide a way to retrieve this information. According to the Application Notes for Nectar Foundation with Avaya Aura® System Manager and Avaya Aura® Session Manager, you can navigate to Reports → Inventory → Avaya → System Manager (r7.1 or above) and select Registrations to verify that Session Manager Inventory can be retrieved using the Session Manager Element Manager Web Service. This should display the user registrations, which would include the list of registered SIP endpoints.

Note, in providing this response Ada consulted (and may or may not have used) the following documents: Application Notes for Nectar Foundation with Avaya Aura® System Manager and Avaya Aura® Session Manager - Issue 1.0, and Routing Web Service API Programming Reference Release 8.0.1, and Avaya Aura® Application Enablement Services Device, Media and Call Control API XML Programmer’s Guide R6.3.3

[derekf]

It looks like Nectar has found a way to do it, but they may be doing a scrape of the report in SMGR. I don't see any way of doing it using the APIs in these docs. Thanks!

[avc844244490912]

Hey Guys,
Sorry I hadn't checked back until now.

derekf - Yes, I did.

The SMGR can dump an XML file that contains all the same information you see when you go to "Elements->Session Manager->System Status->User Registrations"

You'll have to accommodate a 15 second retry for the "Cache Reload"

The SMGR uses Basic Authentication for the API call.


You essentially send the call to https://{fqdn}/ASM/ws/registrations and you'll get either a code returning that you need to reload the cache (IE 503) or a response with an XML that contains all of your current SIP stations and their registration statuses, along with things like, IP, Device status, etc...

You can convert that XML to JSON or any format form there and create an overview page that will essentially display the same information as SMGR.

I'm using this feature for auditing purposes currently, IE, assessing usage on a system.

[derekf]

That's fantastic! Thanks!! Where did you find this documented? I wonder what else I've been missing!

[avc844244490912]

derekf

Sorry again for the long wait, in the SessionmanagerEMWebServices zip, there's a docuemnt called "SMEMWebServiceAPIReference.pdf" (IE the Avaya Aura® Session Manager Element Manager Web Service)

Which outlines on page 17 using the Web Services URI's to pull Session Manager registration data.
You can also use http:{fqdn}/ASM/ws/asmstatus to get the status of Entity Links (Similar to what you see in SMGR), that'd be useful if you're making a dashboard for Nectar to display statuses on your SIP Trunk connections. IE, Trunk Status to SBC_Trunk_1, or "Messaging" etc..

You can split up either command with various delimeters to loo up things like, specific endpoints or entities.

There's other data you can pull from SMGR as well, like user management lists and actually make changes to things like endpoint passwords - but these are outlined in another document and require a lot more consideration.