WHM API 1 Functions - verify_oscar_access

This function tests the 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 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.

Warning:

AOL discontinued support for AIM in December 2017. This function only tests ICQ credentials, not AIM credentials.

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.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

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

Parameter	Type	Description	Possible values	Example
`username`	string	Required The ICQ account. Notes: 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. You cannot use this function to test an AIM account.	A valid account name.	`username`
`password`	string	Required The ICQ account's password. Note: You cannot use this function to test an AIM account.	A valid password.	`12345luggage`

Returns

Return	Type	Description	Possible values	Example
`message_id`	string	The test message's ID.	A valid string.	554d2cbd-efe61da3cacb

Function information

API Version:

WHM API 1

Available in:

WHM 11.52–68

Methods:

GET, POST

Required Parameters:

username, password

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - get_mailbox_status_list — This function lists the status of a cPanel's mail account's mailboxes.
Page:

WHM API 1 Sections - Server Administration — Server administration functions allow you to manage your server's services and functions.
Page:

WHM API 1 Functions - configurebackgroundprocesskiller — This function configures the server's background process killer.
Page:

WHM API 1 Functions - get_all_contact_importances — This function lists the importance of all application events in WHM's Contact Manager interface (Home >> Server Contacts >> Contact Manager).
Page:

WHM API 1 Functions - get_appconfig_application_list — This function lists registered AppConfig applications.

Child pages