Description

This function retrieves the importance level of an application's events for WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).

The system will create a notification setting for the application's events if one does not already exist.

Examples


https://hostname.example.com:2087/cpsess##########/json-api/get_application_contact_importance?api.version=1&app=Check
https://hostname.example.com:2087/cpsess##########/xml-api/get_application_contact_importance?api.version=1&app=Check
whmapi1 get_application_contact_importance app=Check event=SecurityAdvisorStateChange

{
  "data": {
    "importance": 1,
    "name": "Disabled"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "get_application_contact_importance"
  }
}
<result>
    <data>
        <importance>0</importance>
        <name>Disabled</name>
    </data>
    <metadata>
        <reason>OK</reason>
        <version>1</version>
        <result>1</result>
        <command>get_application_contact_importance</command>
    </metadata>
</result>

     

Parameters

ParameterTypeDescriptionPossible valuesExample
appstring

Required

The application module's name.

A valid cPanel & WHM module name.Check

Returns

Return

TypeDescriptionPossible valuesExample
importanceintegerThe importance level at which to send the notification.
  • 1 — High.
  • 2Medium.
  • 3 — Low.
  • 0 — Disabled.
0
namestring

The text version of the importance setting.

  • High

  • Medium

  • Low

  • Disabled

Disabled