Validate ICQ username and password

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.

Authorizations:
query Parameters
password
required
string

The ICQ account's password.

Note:

You cannot use this function to test an AIM account.

Example: password=12345luggage
username
required
string

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.
Example: username=username

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  verify_oscar_access \
  username='username' \
  password='12345luggage'

Response samples

Content type
application/json
{
  • "data": {
    • "message_id": "554d2cbd-efe61da3cacb"
    },
  • "metadata": {
    • "command": "verify_oscar_access",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}