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

 

Description

This function tests the AOL Instant Messenger (AIM) or ICQ credentials that the system uses for notifications.The system generates a unique string and includes it in the test message.

You can also review the user's AIM or ICQ message history to confirm that the server sent and received the message.

The test's success or failure depends on the following conditions:

  • Valid username and password combination.
  • Network configuration.
  • Service outages.
  • External server rate limit.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/verify_oscar_access?api.version=1&username=username&password=12345luggage
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/verify_oscar_access?api.version=1&username=username&password=12345luggage
 Command Line
whmapi1 verify_oscar_access username=username password=12345luggage

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)
{
  "data": {
    "message_id": "554d2c15-25f553d08b8da"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "verify_oscar_access"
  }
}
 Output (XML)
<result>
    <data>
        <message_id>554d2cbd-efe61da3cacb</message_id>
    </data>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>verify_oscar_access</command>
    </metadata>
</result>

Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The AIM or ICQ account.

Note:

If the username value consists entirely of numbers, the system assumes that it is an ICQ account. Otherwise, the system treats the account as an AOL account.

A valid account name.

username
passwordstring

Required

The AIM or ICQ account's password.

A valid password.12345luggage

Returns

ReturnTypeDescriptionPossible valuesExample
message_idstring

The test message's ID.

A valid string.

554d2cbd-efe61da3cacb