[Index]
Voicemail Integration offering redundancy
Model ref.: view/GlobalSIPVMIntegration
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"target_cucm": {
"type": "string",
"description": "Provisioning Target Call Manager",
"title": "Provisioning Target Call Manager"
},
"options_partitionCUC": {
"default": "false",
"type": "boolean",
"description": "Create a unique partition/css for Unity Server",
"title": "Create Custom Unity Partition and CSS"
},
"options_tenantCUC": {
"default": "false",
"type": "boolean",
"description": "Compulsory check for Unity Tenants",
"title": "Unity Tenant(s) Present"
},
"options_SubTrunk": {
"default": "true",
"type": "boolean",
"description": "Provision Unity Subscriber Trunk and Ports to redundant systems",
"title": "Provision CUCM-Unity in Redundant Mode"
},
"target_cuc": {
"type": "string",
"description": "Provisioning Target Unity",
"title": "Provisioning Target Unity"
},
"ucm_stsp": {
"type": "string",
"description": "Add or choose existing SIP Trunk Security Profile",
"title": "SIP Trunk Security Profile"
},
"ucm_sp": {
"type": "string",
"description": "Choose existing or create a new SIP profile",
"title": "SIP Profile"
},
"ucm_sipTrunk_P_DevName": {
"type": "string",
"description": "Primary SIP Trunk Device Name",
"title": "Device Name"
},
"ucm_sipTrunk_P_Desc": {
"type": "string",
"description": "Primary SIP Trunk Description",
"title": "Description"
},
"ucm_sipTrunk_P_SRTP": {
"default": "false",
"type": "boolean",
"description": "If you will enable Cisco Unified CM authentication and encryption, check this check box",
"title": "SRTP Allowed"
},
"ucm_sipTrunk_P_CSS": {
"type": "string",
"title": "Calling Search Space"
},
"ucm_sipTrunk_P_RedirectInbound": {
"default": "true",
"type": "boolean",
"description": "Redirecting Diversion Header Delivery - Inbound Tickbox",
"title": "Redirecting Diversion Header Delivery - Inbound"
},
"ucm_sipTrunk_P_RedirectOutbound": {
"default": "true",
"type": "boolean",
"description": "Redirecting Diversion Header Delivery - Outbound",
"title": "Redirecting Diversion Header Delivery - Outbound"
},
"ucm_sipTrunk_P_DestIP": {
"type": "string",
"description": "IP Address of the target unity server",
"title": "Destination IP Address"
},
"ucm_sipTrunk_P_DestPort": {
"type": "string",
"description": "Port of the target unity server trunk",
"title": "Destination Port"
},
"ucm_sipTrunk_P_ReRouteCSS": {
"type": "string",
"description": "Rerouting Calling Search Space",
"title": "Rerouting Calling Search Space"
},
"ucm_sipTrunk_P_DevicePool": {
"type": "string",
"description": "Trunk Device Pool",
"title": "Trunk Device Pool"
},
"ucm_sipTrunk_P_SIPProf": {
"type": "string",
"description": "Trunk Sip Profile",
"title": "SIP Profile"
},
"ucm_sipTrunk_S_DevName": {
"type": "string",
"description": "SIP Trunk Device Name",
"title": "Device Name"
},
"ucm_sipTrunk_S_Desc": {
"type": "string",
"description": "SIP Trunk Description",
"title": "Description"
},
"ucm_sipTrunk_S_SRTP": {
"default": "false",
"type": "boolean",
"description": "If you will enable Cisco Unified CM authentication and encryption, check this check box",
"title": "SRTP Allowed"
},
"ucm_sipTrunk_S_CSS": {
"type": "string",
"title": "Calling Search Space"
},
"ucm_sipTrunk_S_RedirectInbound": {
"default": "true",
"type": "boolean",
"description": "Redirecting Diversion Header Delivery - Inbound Tickbox",
"title": "Redirecting Diversion Header Delivery - Inbound"
},
"ucm_sipTrunk_S_RedirectOutbound": {
"default": "true",
"type": "boolean",
"description": "Redirecting Diversion Header Delivery - Outbound",
"title": "Redirecting Diversion Header Delivery - Outbound"
},
"ucm_sipTrunk_S_DestIP": {
"type": "string",
"description": "IP Address of the target unity server",
"title": "Destination IP Address"
},
"ucm_sipTrunk_S_DestPort": {
"type": "string",
"description": "Port of the target unity server trunk",
"title": "Destination Port"
},
"ucm_sipTrunk_S_ReRouteCSS": {
"type": "string",
"description": "Rerouting Calling Search Space",
"title": "Rerouting Calling Search Space"
},
"ucm_sipTrunk_S_DevicePool": {
"type": "string",
"description": "Trunk Device Pool choice",
"title": "Trunk Device Pool"
},
"ucm_sipTrunk_S_SIPProf": {
"type": "string",
"description": "Trunk Sip Profile",
"title": "SIP Profile"
},
"ucm_cuc_Pilot": {
"type": "string",
"description": "Unity Pilot for Route Pattern",
"title": "Pilot Number"
},
"ucm_VoicemailPilot_CSS": {
"type": "string",
"description": "Voicemail Pilot calling search space",
"title": "Calling Search Space"
},
"ucm_VoicemailPilot_Desc": {
"type": "string",
"description": "Voicemail Pilot Description",
"title": "Voicemail Pilot Description"
},
"ucm_VoicemailPilot_DefaultPilot": {
"default": "false",
"type": "boolean",
"description": "Default Voice Mail Pilot for the System",
"title": "Default Voice Mail Pilot for the System"
},
"cuc_server_P": {
"type": "string",
"description": "Unity server selection",
"title": "Unity Server Publisher"
},
"cuc_server_S": {
"type": "string",
"description": "Unity Server Subscriber",
"title": "Unity Server Subscriber"
},
"cuc_phoneSystem": {
"type": "string",
"description": "Unity Phone System",
"title": "Phone System"
},
"cuc_portGroup_username": {
"type": "string",
"description": "Call Manager Authentication Username",
"title": "SIP Server Authentication Username"
},
"cuc_portGroup_password": {
"is_password": true,
"type": "string",
"description": "Call Manager Authentication Password",
"title": "SIP Server Authentication Password"
},
"cuc_portGroup_TCPport": {
"description": "SIP Security Profile",
"title": "SIP Security Profile (IP Port)",
"default": "5060",
"choices": [
{
"value": "5060",
"title": "5060"
},
{
"value": "5061",
"title": "5061/TLS"
}
],
"type": "string"
},
"cuc_portGroup_Protocol": {
"description": "SIP Transport Protocol for CUCM",
"title": "SIP Transport Protocol",
"default": "TCP",
"choices": [
{
"value": "TCP",
"title": "TCP"
},
{
"value": "UDP",
"title": "UDP"
}
],
"type": "string"
},
"cuc_portGroup_CUCMIP": {
"type": "string",
"description": "Primary CUCM IPv4 Address or Host Name",
"title": "Primary CUCM IPv4 Address or Host Name"
},
"cuc_portGroup_SIPServerArray": {
"items": {
"type": "object",
"properties": {
"cuc_portGroup_SipServer": {
"type": "string",
"title": "Call Manager Server IP or Host Name"
}
}
},
"type": "array",
"title": "Redundant SIP Servers"
},
"cuc_customPartition": {
"type": "string",
"description": "Custom Unity partition name for option",
"title": "Custom Unity Partition Name"
},
"cuc_customCSS": {
"type": "string",
"description": "Custom Unity CSS Name",
"title": "Custom Unity CSS Name"
},
"target_cucm_ip": {
"type": "string",
"title": "Target CUCM IP"
},
"target_cucm_bkey": {
"type": "string",
"title": "Target CUCM BKEY"
},
"target_cucm_pkid": {
"type": "string",
"title": "Target CUCM PKID"
},
"target_cuc_ip": {
"type": "string",
"title": "Target CUC IP"
},
"target_cuc_bkey": {
"type": "string",
"title": "Target CUC BKEY"
},
"target_cuc_pkid": {
"type": "string",
"title": "Target CUC PKID"
},
"cuc_port_enabled": {
"default": "true",
"type": "boolean",
"description": "Ports Enabled ",
"title": "Ports Enabled"
},
"cuc_port_PubServer": {
"type": "string",
"description": "Publisher Server",
"title": "Publisher Server"
},
"cuc_port_SubServer": {
"type": "string",
"description": "Subscriber Server",
"title": "Subscriber Server"
},
"cuc_port_AnswerCalls": {
"default": "true",
"type": "boolean",
"description": "Answer Calls",
"title": "Answer Calls"
},
"cuc_port_PerfMessNot": {
"default": "true",
"type": "boolean",
"description": "Perform Message Notification",
"title": "Perform Message Notification"
},
"cuc_port_MWI": {
"default": "true",
"type": "boolean",
"description": "Send MWI Requests",
"title": "Send MWI Requests"
},
"cuc_port_AllowTrap": {
"default": "true",
"type": "boolean",
"description": "Allow TRAP Connections",
"title": "Allow TRAP Connections"
},
"cuc_port_PubCount": {
"pattern": "^([01]?[1-9]?[0-9]|2[0-4][0-9]|25[0])$",
"type": "string",
"description": "Unity Port Count",
"title": "Publisher Port Count"
},
"cuc_port_SubCount": {
"pattern": "^([01]?[1-9]?[0-9]|2[0-4][0-9]|25[0])$",
"type": "string",
"description": "Unity Port Count",
"title": "Subscriber Port Count"
},
"cuc_tenant_alias": {
"type": "string",
"description": "Tenant Configured in Unity Connection",
"title": "Tenant"
},
"cuc_tenant_list": {
"type": "string",
"description": "this will only show 1 in the list but that is all we need to evaluate tenancy",
"title": "CUC Tenant List"
},
"ucm_routeList_name": {
"type": "string",
"description": "Custom name of route list",
"title": "Name"
},
"ucm_routeList_runAllNodes": {
"default": "true",
"type": "boolean",
"description": "Run Route List On All Active Unified CM Nodes",
"title": "Run On All Active Unified CM Nodes"
},
"ucm_routeList_cucmGroup": {
"type": "string",
"description": "Call Manager Group Assignment for Route List",
"title": "Call Manager Group"
},
"ucm_routeGroup_Name": {
"type": "string",
"description": "Route Group Name",
"title": "Name"
},
"ucm_routeGroup_distAlg": {
"description": "Route Group Distribution Algorithm",
"title": "Distribution Algorithm",
"default": "Top Down",
"choices": [
{
"value": "Circular",
"title": "Circular"
},
{
"value": "Top Down",
"title": "Top Down"
}
],
"type": "string"
},
"vmDpProfile": {
"type": "string",
"description": "Pre-Configured dial plan framework to reduce input",
"title": "Voicemail Service Dial Plan Profile"
},
"dpAdvancedMode": {
"default": "false",
"type": "boolean",
"description": "enable editing of Dial Plan element live (Optional)",
"title": "Dial Plan Advanced Mode"
},
"notes": {
"default": "Please choose the Call Manager, Unity Cluster and Dial Plan Profile before proceeding. Several fields rely on this input to set proper values. ",
"type": "string",
"description": "Important Notes",
"title": "NOTES"
},
"cuc_tenantCount": {
"type": "string",
"title": "CUC Tenant Count"
},
"ucm_VMProfile_name": {
"type": "string",
"description": "Voicemail Profile Name",
"title": "Name"
},
"ucm_VMProfile_desc": {
"type": "string",
"description": "Voicemail Profile Description",
"title": "Description"
},
"ucm_VMProfile_pilot": {
"type": "string",
"title": "Pilot"
},
"ucm_VMProfile_VMBoxMask": {
"type": "string",
"description": " Voice Mail Box Mask",
"title": " Voice Mail Box Mask"
},
"ucm_VMProfile_default": {
"default": "false",
"type": "boolean",
"description": "Make this the default Voice Mail Profile for the System",
"title": "Make this the default Voice Mail Profile for the System"
},
"ucm_routePatternPT": {
"type": "string",
"description": "Route Pattern Partition",
"title": "Route Pattern Partition"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/GlobalSIPVMIntegration/add/ |
|
The GUI Add form of view/GlobalSIPVMIntegration as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/view/GlobalSIPVMIntegration | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/GlobalSIPVMIntegration | POST | /api/view/GlobalSIPVMIntegration/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/GlobalSIPVMIntegration/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/GlobalSIPVMIntegration. | GET | /api/view/GlobalSIPVMIntegration/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/GlobalSIPVMIntegration as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/GlobalSIPVMIntegration/[pkid] | hierarchy=[hierarchy] | The view/GlobalSIPVMIntegration instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/GlobalSIPVMIntegration/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/GlobalSIPVMIntegration. |