Protocols/OSCAR/Messages: Difference between revisions

From NINA Wiki
Jump to navigation Jump to search
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:


== Message ==
== Message ==
=== From Aleksandr Shutko: Message format in extended data for rendezvous channel. ===
<table width=645 bgcolor=darkblue cellSpacing=0 cellPadding=0 border=0><tr><td>
<table width=100% cellSpacing=2 cellPadding=0 border=0><tr><td bgcolor=#4040FF>
<table width=100% cellSpacing=0 cellPadding=0 border=0><tr><td><b>
<font color="white">&nbsp;Message format in extended data for rendezvous channel&nbsp;</font>
</b></td><td width=20% align=right><b><font color="white">&nbsp;</font></b>
</td></tr></table>
</td></tr></table>
</td></tr></table>
<br>
<table width=640 bgcolor=darkblue cellSpacing=0 cellPadding=0 border=0><tr><td>
<table width=100% cellSpacing=2 cellPadding=0 border=0>
<tr><td bgcolor=#E9E9E9>
<table width=640 cellSpacing=0 cellPadding=0 align=center border=0>
<tr>
<td width=145>&nbsp;xx</td>
<td width=5>&nbsp;</td>
<td>byte</td>
<td width=5>&nbsp;</td>
<td width=60%>[[Protocols/OSCAR/Messages#Message_Types|message type]]</td>
</tr>
<tr>
<td>&nbsp;xx</td>
<td>&nbsp;</td>
<td>byte</td>
<td>&nbsp;</td>
<td>[[Protocols/OSCAR/Messages#Message_Flags|message flags]]</td>
</tr>
<tr>
<td>&nbsp;xx xx</td>
<td>&nbsp;</td>
<td>word (LE)</td>
<td>&nbsp;</td>
<td>status code</td>
</tr>
<tr>
<td>&nbsp;xx xx</td>
<td>&nbsp;</td>
<td>word (LE)</td>
<td>&nbsp;</td>
<td>priority code</td>
</tr>
<tr>
<td>&nbsp;xx xx</td>
<td>&nbsp;</td>
<td>word (LE)</td>
<td>&nbsp;</td>
<td>message string length</td>
</tr>
<tr>
<td>&nbsp;xx ..</td>
<td>&nbsp;</td>
<td>string</td>
<td>&nbsp;</td>
<td>message string (null-terminated)</td>
</tr>
</table>
</td></tr>
<tr><td bgcolor=#E9E9E9>
<table width=640 cellSpacing=0 cellPadding=0 align=center border=0>
<tr><td height=8 colspan=5></td></tr>
<tr><td bgcolor=#e9e9e9>
  <table width=640 cellSpacing=0 cellPadding=0 align=center border=0>
  <tr><td width=20></td>
  <td>
  <table width=620 bgcolor=darkred cellSpacing=0 cellPadding=0 border=0><tr><td>
  <table width=100% cellSpacing=2 cellPadding=0 align=center border=0>
  <tr><td bgcolor=#c9c9e9>If message type is MTYPE_PLAIN:</td></tr>
  <tr><td bgcolor=#f9f9f9>
    <table width=620 cellSpacing=0 cellPadding=0 align=center border=0>
    <tr>
    <td width=130>&nbsp;xx xx xx xx</td>
    <td width=5>&nbsp;</td>
    <td>dword (LE)</td>
    <td width=5>&nbsp;</td>
    <td width=60%>text color (rgbn, optional)</td>
    </tr>
    <tr>
    <td>&nbsp;xx xx xx xx</td>
    <td>&nbsp;</td>
    <td>dword (LE)</td>
    <td>&nbsp;</td>
    <td>background color (rgbn, optional)</td>
    </tr>
    <tr>
    <td>&nbsp;xx xx xx xx</td>
    <td>&nbsp;</td>
    <td>dword (LE)</td>
    <td>&nbsp;</td>
    <td>guid string length (optional)</td>
    </tr>
    <tr>
    <td>&nbsp;xx ..</td>
    <td>&nbsp;</td>
    <td>string</td>
    <td>&nbsp;</td>
    <td>guid string (optional)</td>
    </tr>
    </table>
  </td></tr></table>
  </td></tr></table>
  </td><td width=5>
  </td></tr></table>
</td></tr>
<tr><td height=8 colspan=5></td></tr>
</table>
</td></tr></table>
</td></tr></table>


== Message Types ==
== Message Types ==
    <b>Message types</b>. Each OSCAR message has type. It can be just plain message,
    url message, contact list, wwp, email express or another. Only one byte used for
    message type. Here is the list of known message types:<br><br>
<table width=570 cellSpacing=1 cellPadding=1 border=0>
<tr>
<td bgcolor=#f9f9f9 width=50 valign=top>&nbsp;&nbsp;<b>0x01</b></td>
<td bgcolor=#f9f9f9 width=1 valign=top>&nbsp;&nbsp;MTYPE_PLAIN&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 width=350 valign=top>&nbsp;&nbsp;Plain text (simple) message</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x02</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_CHAT&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Chat request message</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x03</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_FILEREQ&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;File request / file ok message</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x04</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_URL&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;URL message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x06</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTHREQ&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Authorization request message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x07</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTHDENY&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Authorization denied message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x08</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTHOK&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Authorization given message (empty)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x09</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_SERVER&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Message from OSCAR server (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x0C</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_ADDED&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;"You-were-added" message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x0D</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_WWP&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Web pager message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x0E</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_EEXPRESS&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Email express message (0xFE formatted)</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x13</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_CONTACTS&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Contact list message</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0x1A</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_PLUGIN&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Plugin message described by text string</td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0xE8</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTOAWAY&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Auto away message </td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0xE9</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTOBUSY&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Auto occupied message </td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0xEA</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTONA&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Auto not available message </td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0xEB</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTODND&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Auto do not disturb message </td>
</tr>
<tr>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;<b>0xEC</b></td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;MTYPE_AUTOFFC&nbsp;&nbsp;</td>
<td bgcolor=#f9f9f9 valign=top>&nbsp;&nbsp;Auto free for chat message </td>
</tr>
</table>


== Message Flags ==
== Message Flags ==

Latest revision as of 11:33, 14 February 2021

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)


Message

From Aleksandr Shutko: Message format in extended data for rendezvous channel.

 Message format in extended data for rendezvous channel 

 


 xx   byte   message type
 xx   byte   message flags
 xx xx   word (LE)   status code
 xx xx   word (LE)   priority code
 xx xx   word (LE)   message string length
 xx ..   string   message string (null-terminated)
If message type is MTYPE_PLAIN:
 xx xx xx xx   dword (LE)   text color (rgbn, optional)
 xx xx xx xx   dword (LE)   background color (rgbn, optional)
 xx xx xx xx   dword (LE)   guid string length (optional)
 xx ..   string   guid string (optional)

Message Types

   Message types. Each OSCAR message has type. It can be just plain message,
   url message, contact list, wwp, email express or another. Only one byte used for
   message type. Here is the list of known message types:
  0x01   MTYPE_PLAIN     Plain text (simple) message
  0x02   MTYPE_CHAT     Chat request message
  0x03   MTYPE_FILEREQ     File request / file ok message
  0x04   MTYPE_URL     URL message (0xFE formatted)
  0x06   MTYPE_AUTHREQ     Authorization request message (0xFE formatted)
  0x07   MTYPE_AUTHDENY     Authorization denied message (0xFE formatted)
  0x08   MTYPE_AUTHOK     Authorization given message (empty)
  0x09   MTYPE_SERVER     Message from OSCAR server (0xFE formatted)
  0x0C   MTYPE_ADDED     "You-were-added" message (0xFE formatted)
  0x0D   MTYPE_WWP     Web pager message (0xFE formatted)
  0x0E   MTYPE_EEXPRESS     Email express message (0xFE formatted)
  0x13   MTYPE_CONTACTS     Contact list message
  0x1A   MTYPE_PLUGIN     Plugin message described by text string
  0xE8   MTYPE_AUTOAWAY     Auto away message
  0xE9   MTYPE_AUTOBUSY     Auto occupied message
  0xEA   MTYPE_AUTONA     Auto not available message
  0xEB   MTYPE_AUTODND     Auto do not disturb message
  0xEC   MTYPE_AUTOFFC     Auto free for chat message

Message Flags

   Message flags. Message flag used to indicate additional message properties.

like auto message, multiple recipients message, etc. Message flag field occupy 1 byte. Here is the list of known message flag codes:

  0x01   MFLAG_NORMAL     Normal message
  0x03   MFLAG_AUTO     Auto-message flag
  0x80   MFLG_MULTI     This is multiple recipients message
Retrieved from "https://wiki.nina.chat/index.php?title=Protocols/OSCAR/Messages&oldid=3742"