cPanel API 2 Functions - CustInfo::displaycontactinfo - Knowledgebase

Description

This function displays an account's contact and notification settings.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_func=displaycontactinfo

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Display contact information.

$display_contact = $cpanel->api2(

'CustInfo', 'displaycontactinfo'

);

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

# Display contact information.

my $display_contact = $cpliveapi->api2(

'CustInfo', 'displaycontactinfo',

);

cPanel Tag System (deprecated)

Warning:

In cPanel & WHM version 11.30 and later, cPanel tags are deprecated. We strongly recommend that you only use the LiveAPI system to call the cPanel APIs.

cPanel API 2 calls that use cPanel tags vary widely in code syntax and in their output. For more information, read our Deprecated cPanel Tag Usage documentation. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI.

Command Line

cpapi2 --user=username CustInfo displaycontactinfo

Notes:

You must URI-encode values.
username represents your account-level username.

 Output (JSON)

{ 
   "cpanelresult":{ 
      "apiversion":2,
      "func":"displaycontactinfo",
      "data":[ 
         { 
            "value":"username@example.com",
            "name":"email",
            "descp":"This is an email address at which the system can contact you. This should be an email address that is not on your account.",
            "type":"string",
            "enabled":1
         },
         { 
            "value":"username.2@example.com",
            "name":"second_email",
            "descp":"If you wish to provide a second email address to receive notifications, enter it here.",
            "type":"string",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_contact_address_change",
            "descp":"My contact email address changes.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_contact_address_change_notification_disabled",
            "descp":"My preference for contact email address change notifications is disabled.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_disk_limit",
            "descp":"My account approaches its disk quota.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_bandwidth_limit",
            "descp":"My account approaches its bandwidth usage limit.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_email_quota_limit",
            "descp":"Any of my account's email accounts approaches or is over quota.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_password_change",
            "descp":"My account's password changes.",
            "type":"boolean",
            "enabled":1
         },
         { 
            "value":1,
            "name":"notify_password_change_notification_disabled",
            "descp":"My preference for account password change notifications is disabled.",
            "type":"boolean",
            "enabled":1
         }
      ],
      "event":{ 
         "result":1
      },
      "module":"CustInfo"
   }
}

Note:

Use cPanel's API Shell interface (Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
enabled	Boolean	Whether the notification setting is enabled.	1 — Send notification. 0 — Do not send notification.	1
value	string	The notification setting's value.	A Boolean value, if the type value is boolean. A string value, if the type value is string.	1
type	string	The notification setting's data type.	string boolean	string
descp	string	The notification setting's description.	A valid string.
name	string	The notification setting's name.	email second_email notify_disk_limit notify_bandwidth_limit notify_contact_address_change notify_contact_address_change_notification_disabled notify_email_quota_limit notify_password_change notify_password_change_notification_disabled	second_email
reason	string	A reason for failure. Note: This function only returns areasonvalue if it failed.	A string that describes the error.	This is an error message.
result	Boolean	Whether the function succeeded.	1 — The function succeeded. 0 — The function failed.	1

Knowledgebase

Categories

Categories