Protocols/OSCAR/SNAC/OSERVICE CLIENT ONLINE

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)

ID	Origin	Name	Foodgroup	Service	Status	Version
0x0001, 0x0002	Client	OSERVICE__CLIENT_ONLINE	Unspecified	All	Active	4.0

This message is sent by the client once it has initialized the host state (set preferences, Buddy Lists, locate information, capabilities) and is ready to be announced as being online by the host.

SNAC Header

Foodgroup	uint16 (word)	00 01
Subgroup	uint16 (word)	00 02
Flags	uint16 (word)	00 00
Request ID	uint32 (dword)	00 00 00 00

SNAC Data

The client may have used groups not in groupVersions during initialization, but once this SNAC has been received by the server, SNACs in groups not specified in groupVersions will be rejected. Other users will not see this user online until this SNAC is sent.

Name	Type	Notes
groupVersions	Rest of SNAC array of OSERVICE__CLIENT_VERSIONS	All foodgroups the client wants to support

Field	Size	Value
u08	flapHeader.startMarker	'*'
u08	flapHeader.frameType	2 ([Protocols/OSCAR/FLAP#Class:_FLAP_FRAME FLAP__FRAME_TYPE_DATA])
u16	flapHeader.sequenceNumber	XX
u16	flapHeader.payloadLength	YY
u16	snacHeader.foodgroup	1 ([Protocols/OSCAR/Foodgroups/OSERVICE OSERVICE])
u16	snacHeader.type	2 ([Protocols/OSCAR/SNAC/OSERVICE_CLIENT_ONLINE OSERVICE__CLIENT_ONLINE])
u16	snacHeader.flags	0
u32	snacHeader.requestId	ZZ
u16	groupVersions[0].foodgroup	1 ([Protocols/OSCAR/Foodgroups/OSERVICE OSERVICE])
u16	groupVersions[0].version	4
u16	groupVersions[0].tool_id	41
u16	groupVersions[0].tool_version	AA
u16	groupVersions[1].foodgroup	19 ([Protocols/OSCAR/Foodgroups/FEEDBAG FEEDBAG])
u16	groupVersions[1].version	3
u16	groupVersions[1].tool_id	41
u16	groupVersions[1].tool_version	AA
u16	groupVersions[1].foodgroup	3 ([Protocols/OSCAR/Foodgroups/BUDDY BUDDY])
u16	groupVersions[1].version	1
u16	groupVersions[1].tool_id	41
u16	groupVersions[1].tool_version	AA
u16	groupVersions[1].foodgroup	2 ([Protocols/OSCAR/Foodgroups/LOCATE LOCATE])
u16	groupVersions[1].version	1
u16	groupVersions[1].tool_id	41
u16	groupVersions[1].tool_version	AA
u16	groupVersions[1].foodgroup	6 ([Protocols/OSCAR/Foodgroups/INVITE INVITE])
u16	groupVersions[1].version	1
u16	groupVersions[1].tool_id	41
u16	groupVersions[1].tool_version	AA
u16	groupVersions[1].foodgroup	4 ([Protocols/OSCAR/Foodgroups/ICBM ICBM])
u16	groupVersions[1].version	1
u16	groupVersions[1].tool_id	41
u16	groupVersions[1].tool_version	AA

Datatype: OSERVICE__CLIENT_VERSIONS

Description of a foodgroup and the version of that foodgroup the client wants to use when communicating with the backend.

Name	Type	Notes
foodgroup	uint16 (word)	Foodgroup that the version represents
version	uint16 (word)	Version of the foodgroup implementation; should be 4 for OSERVICE, 3 for FEEDBAG, 1 for all others
tool_id	uint16 (word)	Should be 41 for all Open AIM clients
tool_version	uint16 (word)	Any version number the developer would like, usually the build number

Example

Here is an example of the raw SNAC data split up to demonstrate the otherwise in-line data.

Foodgroup	Version	Tool ID	Tool version
0x0001	0x0004	0x0010	0x0801
0x0002	0x0001	0x0110	0x0801
0x0003	0x0001	0x0110	0x0801
0x0004	0x0001	0x0110	0x0801
0x0006	0x0001	0x0110	0x0801
0x0008	0x0001	0x0104	0x0001
0x0009	0x0001	0x0110	0x0801
0x000a	0x0001	0x0110	0x0801
0x000b	0x0001	0x0104	0x0001
0x0013	0x0003	0x0110	0x0801

Client Version Map

A list of clients and their corresponding foodgroups, versions, and tool IDs and tool versions.

See More

OSERVICE SNACs

SNAC List

Subgroup Origin Name 0x0001 Any OSERVICE__ERR This is the error SNAC for the OSERVICE foodgroup. 0x0002 Client OSERVICE__CLIENT_ONLINE This message is sent by the client once it has initialized the host state (set preferences, Buddy Lists, locate information, capabilities) and is ready to be announced as being online by the host. 0x0003 Host OSERVICE__HOST_ONLINE This is the very first SNAC sent from the host to the client after the FLAP signon frames are sent. It contains an array of all of the foodgroups the service supports. 0x0004 Client OSERVICE__SERVICE_REQUEST This SNAC requests that the specified service (foodgroup) be provided to it in a way further specified by qualifying parameters. 0x0005 Host OSERVICE__SERVICE_RESPONSE This SNAC contains information about connecting to the new server. It is the response from the server to a service request. 0x0006 Client OSERVICE__RATE_PARAMS_QUERY This SNAC is sent by the client to query for the current rate limit parameters. 0x0007 Host OSERVICE__RATE_PARAMS_REPLY Contains response to the OSERVICE__RATE_PARAMS_QUERY. 0x0008 Client OSERVICE__RATE_PARAMS_SUB_ADD Subscribe to any rate parameter changes among the specified class IDs. If there was no prior subscription for a given class ID, an immediate notification will be queued. 0x0009 Client OSERVICE__RATE_DEL_PARAM_SUB Cancels any rate parameter subscriptions for the specified class IDs. 0x000A Host OSERVICE__RATE_PARAM_CHANGE This contains an array of class rate parameters that have changed since last query or notification. 0x000B Host OSERVICE__PAUSE_REQ This is sent by the server when it needs to migrate the client. 0x000C Client OSERVICE__PAUSE_ACK This is sent by the client to acknowledge the receipt and processing of a OSERVICE__PAUSE_REQ SNAC request. 0x000D Host OSERVICE__RESUME In certain situations the server may abort a migration after having told the client to PAUSE. 0x000E Client OSERVICE__USER_INFO_QUERY This is a query to find out one's current info. The server will send a OSERVICE__USER_INFO_UPDATE. 0x000F Host OSERVICE__USER_INFO_UPDATE This SNAC is sent by the server whenever significant parts of a user's info change. 0x0010 Host OSERVICE__EVIL_NOTIFICATION This is a notice that the user's evil level has changed. 0x0011 Client OSERVICE__IDLE_NOTIFICATION This SNAC is sent by the client to inform the server of the user's idle state. 0x0012 Host OSERVICE__MIGRATE_GROUPS This SNAC commands the client to reconnect to the server specified by the included OSERVICE__TLV_TAGS_RECONNECT_HERE TLV. 0x0013 Host OSERVICE__MOTD Message of the day (MOTD). Often contains upgrade information for clients as well as notices about clients. 0x0014 Client OSERVICE__SET_PRIVACY_FLAGS Set privacy flags. 0x0015 Host OSERVICE__WELL_KNOWN_URLS Service related URLs for the client to use or provide to the user. 0x0016 Client OSERVICE__NOOP Legacy SNAC keepalive, replaced in large part with FLAP level keepalive. 0x0017 Client OSERVICE__CLIENT_VERSIONS Sent after OSERVICE__HOST_ONLINE, it contains the client's foodgroup version list so the host knows what functionality the client is capable of. 0x0018 Host OSERVICE__HOST_VERSIONS The host responds to OSERVICE__CLIENT_VERSIONS with its foodgroup version list so that the client knows what this host provides and its capabilities. 0x0019 NCD OSERVICE__MAX_CONFIG_QUERY This is not currently documented. Want to contribute? 0x001A NCD OSERVICE__MAX_CONFIG_REPLY This is not currently documented. Want to contribute? 0x001B NCD OSERVICE__STORE_CONFIG This is not currently documented. Want to contribute? 0x001C NCD OSERVICE__CONFIG_QUERY This is not currently documented. Want to contribute? 0x001D NCD OSERVICE__CONFIG_REPLY This is not currently documented. Want to contribute? 0x001E Client OSERVICE__SET_USERINFO_FIELDS This allows the client to set some of the fields in user info that are sent to every client. 0x001F Host OSERVICE__PROBE_REQ Client verification request. 0x0020 Client OSERVICE__PROBE_ACK Client verification reply. 0x0021 Host OSERVICE__BART_REPLY This reply is used to tell the client that a BART item needs to be uploaded or changed. 0x0022 Client OSERVICE__BART_QUERY2 This query sees if the BART IDs are available; OSERVICE__BART_REPLY2 is sent as a response. 0x0023 Host OSERVICE__BART_REPLY2 This SNAC is sent on initial login about items in the personality section of the Feedbag. It is also used in response to a OSERVICE__BART_QUERY2.