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:
- 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.
- Clicking the URL within AIM, such as in an IM or Profile window.
- 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.