cPanel API 2 Functions - Contactus::sendcontact - Knowledgebase

Description

This function sends a support request to the site's host.

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=Contactus&cpanel_jsonapi_func=sendcontact&email=laurence%40cpanel.net&issue=It%20smells%20awful.&subject=My%20dog%20has%20no%20nose.

 LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.
  
// Send a support request to your host.
$send_request = $cpanel->api2(
    'Contactus', 'sendcontact', 
    array(
          email => 'username@example.com',
          subject => 'My dog has no nose.',
          issue => 'It smells awful.',
    ) 
);

 LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.
  
#  Send a support request to your host.
my $send_request = $cpliveapi->api2(
    'Contactus', 'sendcontact',
    {
     email => 'username@example.com',
     subject => 'My dog has no nose.',
     issue => 'It smells awful.',
    }
);

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 Contactus sendcontact email=username%40example.com subject="My dog has no nose." issue="It smells awful."

Notes:

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

 Output (JSON)

{
  "cpanelresult": {
    "apiversion": 2,
    "func": "sendcontact",
    "data": [
      {
        "status": 1
      }
    ],
    "event": {
      "result": 1
    },
    "module": "Contactus"
  }
}

Note:

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

Parameters

Parameter	Type	Description	Possible values	Example
email	string	Required The sender's contact email address.	A valid email address.	username@example.com
issue	string	Required The support request's message body.	A valid string.	It smells awful.
subject	string	Required The support request's subject line.	A valid string.	My dog has no nose.

Returns

Parameter	Type	Description	Possible values	Example
reason	string	A reason for failure. Note: This function only returns a reasonvalue 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

Parameter

Type

Description

Possible values

Example

reason

string

A reason for failure.

Note:

This function only returns a reasonvalue 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.

Knowledgebase

Categories

Categories