Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

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
titleWarning:

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


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/verify_oscar_access?api.version=1&username=username&password=12345luggage



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/verify_oscar_access?api.version=1&username=username&password=12345luggage



Expand
titleCommand Line


Code Block
languagebash
whmapi1 verify_oscar_access username=username password=12345luggage

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{
  "data": {
    "message_id": "554d2c15-25f553d08b8da"
  },
  "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "verify_oscar_access"
  }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<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>


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


   

Parameters

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The ICQ account.

Note
titleNotes:
  • 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
passwordstring

Required

The ICQ account's password.

Note
titleNote:

You cannot use this function to test an AIM account.


A valid password.12345luggage

Returns

Multiexcerpt
MultiExcerptNameoscarreturn


ReturnTypeDescriptionPossible valuesExample
message_idstring

The test message's ID.

A valid string.

554d2cbd-efe61da3cacb