Please update the namespaces and the SOAPAction Header based on the version & schema you're working with. At present, the atomic actions are setup & tested to work with UCM v12.5.
Resources:
- AXL API Schema Reference: https://developer.cisco.com/docs/axl-schema-reference/
- Many of the atomic actions available in this repository expect a JSON input payload - please refer to the examples provided in the input descriptions before use. We're also working on making it easier for you to generate JSON payloads from the UCM XML schema - stay tuned!
Purpose: Run an SQL Query via UCM's AXL API
Steps to use:
- Setup your UCM Target & Account Key as AXL Credential
- Provide SQL Query to run as input
- If the request is successful, the output of this atomic is an XML string w/ the rows as seen in the SQL response
- If the request is not successful, the output contains the error message
TIP: If you're doing a SELECT query, use 'Read Table from XML' w/ the XML output in your workflow to have a table object you can iterate over.
2. Add Phone
Purpose: Create a new phone via UCM's AXL API
Steps to use:
- Setup your UCM Target & Account Key as AXL Credential
- Provide a JSON input with one or more of the supported fields for the addPhone AXL method (refer to README on Git repo for steps on how to generate this)
- If the request is successful, the output of this atomic is the UID response string returned from UCM for the added phone
- If the request is not successful, the output contains the error message
3. Add Line
Purpose: Create a new line via UCM's AXL API
Steps to use:
- Setup your UCM Target & Account Key as AXL Credential
- Provide a JSON input with one or more of the supported fields for the addLine AXL method (refer to README on Git repo for steps on how to generate this)
- If the request is successful, the output of this atomic is the UID response string returned from UCM for the added line
- If the request is not successful, the output contains the error message
4. Get Phone
Purpose: Retrieve details of a phone via UCM's AXL API
Steps to use:
- Setup your UCM Target & Account Key as AXL Credential
- Provide the Name or UUID of the phone to retrieve details. You must provide one of the two.
- You can also input a comma-separated list of what fields you'd like to have returned or leave the 'Fields to Return' input blank to return all fields
- If the request is successful, the output of this atomic is the XML response string returned from UCM for the searched
- If the request is not successful, the output contains the error message
5. Get Line
Purpose: Retrieve details of a line via UCM's AXL API
Steps to use:
- Setup your UCM Target & Account Key as AXL Credential
- Provide the Pattern & Route Partition or UUID of the line to retrieve details. You must provide one of the two.
- You can also input a comma-separated list of what fields you'd like to have returned or leave the 'Fields to Return' input blank to return all fields
- If the request is successful, the output of this atomic is the XML response string returned from UCM for the searched. You can also choose to Output as JSON by setting the boolean input variable to 'true'.
- If the request is not successful, the output contains the error message
Purpose: Run a Terminal (CLI) Command on UCM/UCOS
Steps to use:
- Setup a Terminal Endpoint for your UC Application & Account Key as OS/Platform credential. Under 'Terminal Interaction Patterns (regex)', set the prompt to
admin:. - Provide a list of commands as input (one per line). It is recommended to send more than one command at once to avoid having to recreate separate SSH sessions.
- The output of this atomic action is a table with CLI Commands & their Outputs
Contributors:
- Aman Sardana (amasarda@cisco.com)
- Saurabh Khaneja (sakhanej@cisco.com)
Cisco CX Managed Services - Operate & CX Professional Services, May 2021