Page tree
Skip to end of metadata
Go to start of metadata

 

Description

This function calls WHM API 1's verify_oscar_access function with your specified ICQ accounts. You can specify ICQ accounts in the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup).

Examples


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/verify_icq_access?api.version=1
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/verify_icq_access?api.version=1
 Command Line
whmapi1 verify_icq_access

Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command. 
  • We introduced this functionality in cPanel & WHM version 11.52.0.8.

 Output (JSON)
{
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "verify_icq_access"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>verify_icq_access</command>
    </metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

   

Parameters

This function does not accept parameters.

Returns

ReturnTypeDescriptionPossible valuesExample
message_idstring

The test message's ID.

A valid string.

554d2cbd-efe61da3cacb

Note:

If the Contact Information section of WHM's Basic WebHost Manager Setup interface (Home >> Server Configuration >> Basic WebHost Manager Setup) contains multiple ICQ accounts, the function will return an array that contains the results for each account.