Protocols/OSCAR/Clients/AIM/URLs

OSCAR Protocol

Introduction • Terms • Clients

Basic

Datatypes • FLAP • SNAC • TLV

UUIDs • Errors • Tool IDs

Host Interaction

Rate Limits • Migration • Messages

Other Services

ADMIN • ADVERT • ALERT

BART • BOS • BUCP • CHAT

CHAT_NAV

Tutorials

Sign On • BART • Rendezvous

ICBM • Locate • Buddies

Foodgroups

OSERVICE (0x0001)

LOCATE (0x0002)

BUDDY (0x0003)

ICBM (0x0004)

ADVERT (0x0005)

INVITE (0x0006)

ADMIN (0x0007)

POPUP (0x0008)

PD (0x0009)

USER_LOOKUP (0x000A)

STATS (0x000B)

TRANSLATE (0x000C)

CHAT_NAV (0x000D)

CHAT (0x000E)

ODIR (0x000F)

BART (0x0010)

FEEDBAG (0x0013)

ICQ (0x0015)

BUCP (0x0017)

ALERT (0x0018)

PLUGIN (0x0022)

UNNAMED_FG_24 (0x0024)

MDIR (0x0025)

ARS (0x044A)

Many AIM clients, both official and third party, allow for special URLs to be used to control the client. URLs can allow web pages and other programs to pass commands to AIM clients.

Introduction

There are several methods for launching AIM URLs:

1. In Windows, the command can be entered via the Run dialog accessed via the Start Menu or by using the system hot keys Windows + R.
2. Clicking the URL within AIM, such as in an IM or Profile window.
3. Clicking an AIM link that's embedded in a web page.

Most AIM URLs are used while the client is online, if it is not, the AIM client will typically prompt you to sign on.

URLs

Depending on the version of the AIM client in use, some URLs may not be available for use. Additionally, parameters are not case sensitive, but their values are.

aim:goIm

This action will invoke a IM window with the screenname of the recipient and the message to send pre-populated.

Parameter	Value	Note
ScreenName	[screenname]	Optional; If not set, the "To" field will be empty.
Message	[message]	Optional; If not set a message must be typed manually.
TargetBuddyList	[target link]	Optional; primary account is default if target linked account is not provided.

Examples

aim:goIm?ScreenName=MyNewBuddy&Message=Hello

The IM window is opened with MyNewBuddy in "To" field, primary account in "From" field, and the message Hello set.

aim:goIm?ScreenName=MyNewBuddy&Message=Hello&TargetBuddyList=LinkedSN123

The IM window is opened with MyNewBuddy in "To" field, LinkedSN123 in "From" field, and the message Hello set.

aim:goIm?ScreenName=MyNewBuddy&Message=%3Cb%3EHello%3C/b%3E

The IM window is opened with MyNewBuddy in "To" field, primary account in "From" field, and the message is Hello in bold

aim:goAway

This URL will invoke away action in AIM with the message specified in the URL.

Parameter	Value	Note
Hide	[true or false]	Optional; Window will be hidden or shown while away.
Quiet	[true or false]	Optional; Sounds will be disabled or enabled while away.
Notify	[true or false]	Optional; Popup notifications will be enabled or disabled while away.
Message	[message]	Optional; Text of away message.
Label	[label]	Optional; If set "New Away Message" editor will loading instead of going away
Save	[true or false]	Optional; only honored if Label is specified

Examples

aim:goAway?Message=Sorry,+I+am+away!

The away message is set with the text Sorry, I am away!, leaving default settings unchanged.

aim:goAway?Hide=true&Message=Sorry,+I+am+away!

The away message is set with the text Sorry, I am away! and the checkbox "Hide window while I'm away" checked.

aim:goAway?Quiet=true&Message=Sorry,+I+am+away!

The away message is set with the text Sorry, I am away! and the checkbox "Disable sounds while I'm away" checked.

aim:goAway?Notify=false&Message=Sorry,+I+am+away!

The away message is set with the text Sorry, I am away! and the checkbox "Disable pop-up notifications while I'm away" unchecked.

aim:goAway?Label=My+Away+Message&Message=Sorry,+I+am+away!

The New Away Message editor appears with the My Away Message label, Sorry, I am away! message and "Save with my away messages" unchecked.

aim:goAway?Label=My+Away+Message&Message=Sorry,+I+am+away!&save=true

The New Away Message editor appears with the My Away Message label, Sorry, I am away! message and "Save with my away messages" checked.

aim:goChat

This action will invoke the chat window open to the specified room name.

Parameter	Value	Note
RoomName	[room name]	Required
ChatTopic	[chat topic]	Optional
Exchange	[room exchange]	Optional
Instance	[room instance]	Optional

Examples

aim:goChat?RoomName=TestRoom

The TestRoom chat room is opened.

aim:goTalk

This action will invoke a IM window, using talk session, with the screenname of the recipient.

Parameter	Value	Note
ScreenName	[screenname]	Optional; If not set, the "To" field will be empty.
TargetBuddyList	[target link]	Optional; primary account is default if target linked account is not provided.

Examples

aim:goTalk?screenname=MyNewBuddy

The IM window, using talk session, is opened with MyNewBuddy in "To" field, primary account in "From" field.

aim:goTalk?screenname=+12129110024

The IM window, using VoIP session, is opened with +12129110024 in "To" field, primary account in "From" field.

aim:goIm?ScreenName=+12129110024&TargetBuddyList=LinkedSN123

Depending on AIM version and configuration, the IM window, using VoIP session, is opened with "+12129110024" in "To" field, LinkedSN123 in "From" field.

aim:addBuddy

This action will invoke the add Buddy to Buddy List action. It will take screenname or list of screennames in the URL and prompt the users for which group they would like to add it to their buddy list if there is no groupname specified in the URL.

Parameter	Value	Note
ScreenName	[screenname]	This or ListOfScreenNames is required.
ListOfScreenNames	[SN1, SN2, SN3...]	This or ScreenName is required.
GroupName	[target group]	Optional; Buddies group is default if target group is not provided
TargetBuddyList	[target link]	Optional; In linked screenname scenarios, the Buddy List of the entered target will be used, otherwise the primary screenname will be.

Examples

aim:addBuddy?ScreenName=MyNewBuddy

MyNewBuddy is added under the default group name Buddies in the Buddy List of the primary account.

aim:addBuddy?ScreenName=MyNewBuddy&TargetBuddyList=LinkedSN123

MyNewBuddy is added under the default group name Buddies in the Buddy List of the LinkedSN123 account.

aim:addBuddy?ScreenName=MyNewBuddy&GroupName=OtherFriends

MyNewBuddy is added under the group name OtherFriends in the Buddy List of the primary account.

aim:addBuddy?ScreenName=MyNewBuddy&GroupName=OtherFriends&TargetBuddyList=LinkedSN123

MyNewBuddy is added under the group name OtherFriends in the Buddy List of the LinkedSN123 account.

aim:addBuddy?ListOfScreenNames=MyNewBuddy,SportsFan7&GroupName=OtherFriends

MyNewBuddy, SportsFan7 are added under the group name OtherFriends in the Buddy List of the primary account.

aim:addBuddy?ListOfScreenNames=MyNewBuddy,SportsFan7&GroupName=OtherFriends&TargetBuddyList=LinkedSN123

MyNewBuddy, SportsFan7 are added under the group name OtherFriends in the Buddy List of the LinkedSN123 account.

aim:buddyIcon

This action invokes the Buddy Icon preferences window with the specified screenname or group name selected and the specified buddy icon displayed in the window.

Parameter	Value	Note
ScreenName	[screenname]	Optional; Setting Buddy Icon for screenname.
GroupName	[group name]	Optional; Setting Buddy Icon for group.
Src	[image URL]	Optional; Remote URL, must be of a compatible file.

Examples

aim:buddyIcon

Opens Buddy Icon preference window

aim:buddyIcon?Src=http://storage.levelleap.com/nina/bart/icons/a/aol.gif

The Buddy Icon preference window is opened with the image displayed.

aim:buddyIcon?ScreenName=MyNewBuddy&Src=http://storage.levelleap.com/nina/bart/icons/a/aol.gif

The Buddy Icon preference window is opened with the buddy MyNewBuddy selected and image displayed.

aim:buddyIcon?GroupName=Buddies&Src=http://storage.levelleap.com/nina/bart/icons/a/aol.gif

The Buddy Icon preference window is opened with the group Buddies selected and image displayed.

aim:setItem

This action sets up the AIM expressions with the given known AOL BART URLs (aolbart:/). AIM expressions include Buddy Icons, wallpaper, sounds, smileys.

Parameter	Value	Note
Src	[aolbart URL]	Only if you want to change one item at a time.
List	[aolbart URL1, aolbart URL2, ...]	Only if you want to change many items at once.

Examples

aim:setItem?src=aolbart:/1/id/2B000009A1

Your Buddy Icon has changed into dragon theme.

aim:setItem?src=aolbart:/129/id/2B000011F6

Your wallpaper has changed into basketball theme.

aim:setItem?List=aolbart:/1/id/2B00000ACB,aolbart:/129/id/2B0000158A

Both Buddy Icon and wallpaper have changed into cat theme.

aim:dockBuddyList

This action will invoke Buddy List docking on the specified side on your screen.

Parameter	Value	Note
Side	Left, Right, or None	Required; One of the three values is required

Examples

aim:dockBuddyList?Side=Left

The Buddy List window is docked at left side of your screen.

aim:dockBuddyList?Side=Right

The Buddy List window is docked at right side of your screen.

aim:dockBuddyList?Side=None

The Buddy List window is not docked at all.

aim:AIMToday

This action will open up AIM Today window in AIM Win Client.

Parameter	Value	Note
url	[URL]	Optional; This field is removed in newer versions of AIM.

Examples

aim:AIMToday

The AIM Today window is opened.

aim:AIMToday?url=http://aimtoday.nina.bz/today/main.adp

Depending on the version of AIM in use, either the provided URL will load in the AIM Today window, or the default AIM Today page will load.

aim:prefs

This action will open the Preference window with the specified Preference Name selected.

Parameter	Value	Note
PrefType	[Pref Name]	Optional; Available tabs listed below.

Available preference tabs:

AddInPrefs, AddressBookPrefs, AwayPrefs, BuddyListPrefs, EnhancedIMPrefs, ExpressionPrefs, FileSharePrefs, FileXferPrefs, IdlePrefs, IMChatPrefs, IMImagePrefs, IMLoggingPrefs, MailPrefs, MobilePrefs, NewsTickPrefs, OfflineIMPrefs, PluginPrefs, PrivacyPrefs, SecurityPrefs, SendBuddyListPrefs, SignOnPrefs, SoundPrefs, StockTickPrefs, StylePrefs, TalkPrefs, TextPrefs, ToasterPrefs

Examples

aim:prefs

The Preference window

aim:prefs?PrefType=SignOnPrefs

The Preference window is opened with the "Sign On/Off" Category selected.

aim:setOption

This action will set up launching options for given primary screenname.

Parameter	Value	Note
ScreenName	[target link]	Optional; primary account is default if target linked account is not provided
Today	[AIM, AOL, or None]	Optional; Type of Today shown at Sign On

Examples

aim:setOption?Today=AIM

AIMToday will be shown at the next sign on for primary account

aim:setOption?ScreenName=MyNewBuddy&Today=AOL

AOL.com will be shown at the next sign on for the LinkedSN123 account

aim:setStatus

This action will set status message for the specified screenname in AIM with the message specified in the URL.

Parameter	Value	Note
TargetBuddyList	[target link]	Optional; primary account is default if target linked account is not provided.
Message	[message]	Optional; default status message will be used if message is not provided.

Examples

aim:setStatus?Message=

Status message for primary account is shown as "Available"

aim:setStatus?Message=I+am+not+here

Status message for primary account is shown as I am not here.

aim:setStatus?Message=I+see+you+now&TargetBuddyList=LinkedSN123

Status message for LinkedSN123 account is shown as I see you now.

aim:checkMail

This action will invoke the mailbox open to the specified address.

Parameter	Value	Note
Address	[email address]	Optional; Parameter removed in later versions of AIM.

Examples

aim:checkMail

The mailbox for the primary account will be opened.

aim:checkMail?Address=sportsfan7@nina.bz

The mailbox for the account associated with sportsfan7@nina.bz will be opened.

aim:registerUser

This action will register the specified screenname with the client.

Parameter	Value	Note
ScreenName	[screenname]	Required
Password	[password]	Optional; but required if SignOnNow=True
SignOnNow	[true or false]	Optional; defaults to false if SignOnNow is not provided

Examples

aim:registerUser?ScreenName=SportsFan7

The SportsFan7 screenname will get registered with the client; sign-on window is shown with empty password

aim:registerUser?ScreenName=SportsFan7&Password=test123

The SportsFan7 screenname will get registered with the client; sign-on window is shown with **** password

aim:registerUser?ScreenName=SportsFan7&Password=test123&SignOnNow=True

The SportsFan7 screenname will get registered with the client; then the client will attempt to sign on.