Cisco Actions

Cisco has 3 different types of Actions:

  1. Phone Services

  2. Phone Services Dialer

  3. Dial Monitor

  4. Call Manager

Get Cisco Actions

Retrieve all Cisco actions by issuing a GET on the below URL

GET: http://<ServerIP>/unifiedgui/webapi/Cisco/Actions/

This will return a collection of Actions objects which could be a mix of the above-mentioned Action types.

GET: http://<ServerIP>/unifiedgui/webapi/Cisco/Action(actionId=b0c5b73e-39ff-e811-80cf-0050568f0d00)

The above will return a specific Action with Id.

[Note: Query filters may be applied on the Actions object. Refer to Query Methods portion of the document for more information]

The following API calls are deprecated and redirected to a different URL as specified below

POST:http://<ServerIP>/unifiedgui/webapi/CiscoNotifier/CiscoActions
Moved to POST: http://<ServerIP>/unifiedgui/webapi/Cisco/CallManager
GET: http://<ServerIP>/unifiedgui/webapi/CiscoNotifier/Actions
Moved to GET: http://<ServerIP>/unifiedgui/webapi/Cisco/Actions
GET: http://<ServerIP>/unifiedgui/webapi/CiscoNotifier/Action(actionId=b0c5b73e-39ff-e811-80cf-0050568f0d00)
Moved to GET: http://<ServerIP>/unifiedgui/webapi/Cisco/Action(actionId=b0c5b73e-39ff-e811-80cf-0050568f0d00)
POST: http://<ServerIP>/unifiedgui/webapi/CiscoNotifier/DeleteActions
POST: http://<ServerIP>/unifiedgui/webapi/Cisco/DeleteActions

 

Add or Update Cisco Actions

Phone Service Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution.

URL

This is not a create or update property but will be provided on all GET of an action. This is a dynamically generated callback URL to trigger this action.

 

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Cisco/PhoneService/
Example Request
  • This POST request adds one new PhoneService and updates another existing PhoneService (Note: the object with ‘Id’)

{  "actions" : [
    {
      "Name":"PhoneService_1",
      "Site":""
    },
    {
      "Id": "0b739e18-22a2-eb11-84f2-54bf64846080",
      "Name":"PhoneService_2",
      "Site" : "San Jose site"
    }
  ]
}
Example Response
{
"Ok": true,
"Successes":[
{
"Id": "36a173f7-d026-4d76-8458-321e7f2eff47",
"Name": " PhoneService_1",
"Message": null
},
{
"Id": "0b739e18-22a2-eb11-84f2-54bf64846080",
"Name": " PhoneService_2",
"Message": null
}
],
"Failures":[]

 

Phone Service Dialer Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution.

Extension

Dial an extension directly

URL

This is not a create or update property but will be provided on all GET of an actions. This is a dynamically generated callback URL to trigger this action.

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Cisco/PhoneServiceDialer/

Follow the same example as provided for PhoneService

 

Cisco Dial Monitor Actions Object

Name (required)

The name of action you are creating.

Site

Provide a Site (name) to associate the action.

A null or empty string for Site defaults the action to AllSites, i.e. The action will be available to all Sites configured in Revolution.

MonitoredNumber (required)

Enter specific number to monitor or use ? and * wildcards (?11 matches 911 and 411; 2* matches any number dialed beginning with 2)

CallingDNPattern

Enter specific phone to call from or use ? and * wildcards (207? matches monitored number dialed from phones in 207x range; 20* matches monitored number dialed from phones beginning with 20). Leave blank to include all.

CallingSearchSpace

Only monitor numbers called from this search space. Leave blank to include all.

Partition

Only monitor numbers called from this partition. Leave blank to include all.

DevicePool

Only monitor numbers called from this device pool. Leave blank to include all.

Actions may be added/updated in collections of Actions objects.

POST: http://<ServerIP>/unifiedgui/webapi/Cisco/DialMonitor/

Follow the same example as provided for PhoneService

Cisco Call Manager Action Objects

Name (required)

The type of action you are creating. (See below for list of valid actions.)

IPAddress (required)

IP address for the CUCM.

Username (required)

Username for the CUCM account.

Password (required)

Password for the CUCM account.

Version (required)

Call Manager Version number.

PreferenceOrder (optional)

Preference order for the CUCM.

One or more Cisco call managers may be added using the URL below.

POST: http://<ServerIP>/unifiedgui/webapi/Cisco/CallManager/
Example Request
  • This POST request adds two Cisco Call Managers.

{  "actions" : [
    {
      "Name":"CiscoAction_1",
      "IPAddress" : "192.168.11.99",
      "Username" : "name",
      "Password" : "888888",
      "Version" : "10.5
    },
    {
      "Name":"CiscoAction_2",
      "IPAddress" : "192.168.11.88",
      "Username" : "name",
      "Password" : "8888888",
      "Version" : "11.0
    }
  ]
}

Delete Cisco Actions

Delete Cisco Actions by sending a collection of Ids of actions that need to be deleted. The Ids could be a collection of mix of the above mentioned types of Cisco Actions.

POST: http://<ServerIP>/unifiedgui/webapi/Cisco/DeleteActions/
Example Request
  • This POST deletes actions with below IDs.

{  "ids" : ["68782574-051a-4000-b585-a056edbbf2fa", “7sdf42574-051a-4000-b585-a056edbbf2fa”]}