Difference between revisions of "Protocols/OSCAR/SNAC/INVITE REQUEST QUERY"

From NINA Wiki
Jump to navigation Jump to search
 
Line 51: Line 51:
 
| Personalized message to send in an invite
 
| Personalized message to send in an invite
 
|}
 
|}
 +
 +
=== From Aleksandr Shutko: SNAC(06,02) client invitation request SNAC(06,02) INVITE__REQUEST_QUERY ===
 +
 +
<table width=640 cellSpacing=0 cellPadding=0 border=0>
 +
<tr>
 +
<td>
 +
<br>
 +
There is a menu item in AIM clients that say something like "Sign On A Friend"
 +
and then it would ask for an email address/invitation text and it would sent a mail
 +
to them saying how perfectly wonderful the AIM service is and why you should
 +
use it and click here if you hate the person who sent this to you and want to
 +
complain and yell at them in a small box with pretty fonts. <br><br>
 +
 +
You can send invitation using this snac. Server should reply via
 +
[[Protocols/OSCAR/SNAC_06_03|SNAC(06,03)]]<br><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>&nbsp;00 06</td>
 +
<td width=5>&nbsp;</td>
 +
<td>word</td>
 +
<td width=5>&nbsp;</td>
 +
<td width=55%>SNAC family</td>
 +
</tr>
 +
<tr>
 +
<td>&nbsp;00 02</td>
 +
<td width=5>&nbsp;</td>
 +
<td>word</td>
 +
<td width=5>&nbsp;</td>
 +
<td width=55%>SNAC subtype</td>
 +
</tr>
 +
<tr>
 +
<td>&nbsp;00 00</td>
 +
<td width=5>&nbsp;</td>
 +
<td>word</td>
 +
<td width=5>&nbsp;</td>
 +
<td width=55%>SNAC flags</td>
 +
</tr>
 +
<tr>
 +
<td>&nbsp;xx xx xx xx</td>
 +
<td width=5>&nbsp;</td>
 +
<td>dword</td>
 +
<td width=5>&nbsp;</td>
 +
<td width=55%>SNAC request-id</td>
 +
</tr>
 +
</table>
 +
 +
</td></tr>
 +
<tr><td bgcolor=#E9E9E9>
 +
<table width=100% cellSpacing=0 cellPadding=0 align=center border=0>
 +
<tr><td>
 +
<!-- TLV 0x11 -->
 +
<table width=640 cellSpacing=0 cellPadding=0 align=center border=0>
 +
<tr><td height=8 colspan=3></td></tr>
 +
<tr><td width=30> </td>
 +
<td>
 +
<table width=600 bgcolor=darkgreen cellSpacing=0 cellPadding=0 border=0><tr><td>
 +
<table width=100% cellSpacing=2 cellPadding=0 align=center border=0>  <tr><td  bgcolor=#f9f9f9 >
 +
  <table width=600 cellSpacing=0 cellPadding=0 align=center border=0>
 +
  <tr>
 +
  <td width=25%>&nbsp;00 11</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=17%>word</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=60%>TLV.Type(0x11) - recipient email</td>
 +
  </tr>
 +
  <tr>
 +
  <td>&nbsp;xx xx</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td>word</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td>TLV.Length</td>
 +
  </tr>
 +
  </table>
 +
  </td></tr>
 +
  <tr><td bgcolor=#f9f9f9>
 +
  <table width=600 cellSpacing=0 cellPadding=0 align=center border=0>
 +
  <tr>
 +
  <td width=25%>&nbsp;xx ..</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=17%>string (ascii)</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=60%>Recipient email string</td>
 +
  </tr>
 +
  </table>
 +
  </td></tr>
 +
  </table>
 +
</td></tr></table>
 +
</td><td width=5>&nbsp;</td></tr>
 +
<tr><td height=5 colspan=3> </td></tr>
 +
</table>
 +
 +
<!-- TLV 0x15 -->
 +
<table width=640 cellSpacing=0 cellPadding=0 align=center border=0>
 +
<tr><td height=8 colspan=3></td></tr>
 +
<tr><td width=30> </td>
 +
<td>
 +
<table width=600 bgcolor=darkgreen cellSpacing=0 cellPadding=0 border=0><tr><td>
 +
<table width=100% cellSpacing=2 cellPadding=0 align=center border=0>  <tr><td  bgcolor=#f9f9f9 >
 +
  <table width=600 cellSpacing=0 cellPadding=0 align=center border=0>
 +
  <tr>
 +
  <td width=25%>&nbsp;00 15</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=17%>word</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=60%>TLV.Type(0x15) - invitation text</td>
 +
  </tr>
 +
  <tr>
 +
  <td>&nbsp;xx xx</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td>word</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td>TLV.Length</td>
 +
  </tr>
 +
  </table>
 +
  </td></tr>
 +
  <tr><td bgcolor=#f9f9f9>
 +
  <table width=600 cellSpacing=0 cellPadding=0 align=center border=0>
 +
  <tr>
 +
  <td width=25%>&nbsp;xx ..</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=17%>string (ascii)</td>
 +
  <td width=5>&nbsp;</td>
 +
  <td width=60%>Invitation string text</td>
 +
  </tr>
 +
  </table>
 +
  </td></tr>
 +
  </table>
 +
</td></tr></table>
 +
</td><td width=5> </td></tr>
 +
<tr><td height=5 colspan=3> </td></tr>
 +
</table>
 +
 +
</td></tr></table>
 +
</td></tr></table>
 +
</td></tr></table>
 +
</td></tr></table>
 +
 +
<br>Example SNAC dumps with flap header:
 +
<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>
 +
<font size=3><pre style="font-size: 13px">
 +
 +
  2a 02 07 e8 00 3f 00 06-00 02 00 00 00 01 00 02  *....?..........
 +
  00 11 00 16 41 56 53 68-75 74 6b 6f 40 6d 61 69  ....AVShutko@mai
 +
  6c 2e 6b 68 73 74 75 2e-72 75 00 15 00 17 74 65  l.khstu.ru....te
 +
  73 74 20 69 6e 76 69 74-61 74 69 6f 6e 20 6d 65  st invitation me
 +
  73 73 61 67 65                                    ssage
 +
 +
</pre></font>
 +
</td></tr></table>
 +
</td></tr></table>
 +
 +
 +
 +
  
 
== INVITE SNACs ==
 
== INVITE SNACs ==
 
{{Protocols/OSCAR/Foodgroups/INVITE/SNACs/Simple}}
 
{{Protocols/OSCAR/Foodgroups/INVITE/SNACs/Simple}}
  
 +
[[Category:With_Contrib]]
 
[[Category:Stub]]
 
[[Category:Stub]]
 
[[Category:AOL]]
 
[[Category:AOL]]

Latest revision as of 04:43, 13 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)
ID Origin Name Foodgroup Service Status Version
0x0006, 0x0002 Client INVITE__REQUEST_QUERY Unspecified BOS Active 1.5

This SNAC contains a request to send an invite to join NINA to a given email address.

SNAC Header

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

SNAC Data

The server will perform a lookup on the email address and if already a member will return an error.

Name Type Notes
inviteTLVs Rest of SNAC array of TLV [Class: INVITE__TAGS] Email and message to send

TLV Class: INVITE__TAGS

These are the tags used when inviting a user to join the AIM service.

Name Tag Type Notes
INVITE__TLV_TAGS_EMAIL 0x11 string Email address to invite
INVITE__TLV_TAGS_PERSONALIZED_TEXT 0x15 string Personalized message to send in an invite

From Aleksandr Shutko: SNAC(06,02) client invitation request SNAC(06,02) INVITE__REQUEST_QUERY


There is a menu item in AIM clients that say something like "Sign On A Friend" and then it would ask for an email address/invitation text and it would sent a mail to them saying how perfectly wonderful the AIM service is and why you should use it and click here if you hate the person who sent this to you and want to complain and yell at them in a small box with pretty fonts.

You can send invitation using this snac. Server should reply via SNAC(06,03)

 00 06   word   SNAC family
 00 02   word   SNAC subtype
 00 00   word   SNAC flags
 xx xx xx xx   dword   SNAC request-id
 00 11   word   TLV.Type(0x11) - recipient email
 xx xx   word   TLV.Length
 xx ..   string (ascii)   Recipient email string
 
 00 15   word   TLV.Type(0x15) - invitation text
 xx xx   word   TLV.Length
 xx ..   string (ascii)   Invitation string text


Example SNAC dumps with flap header: 


  2a 02 07 e8 00 3f 00 06-00 02 00 00 00 01 00 02   *....?..........
  00 11 00 16 41 56 53 68-75 74 6b 6f 40 6d 61 69   ....AVShutko@mai
  6c 2e 6b 68 73 74 75 2e-72 75 00 15 00 17 74 65   l.khstu.ru....te
  73 74 20 69 6e 76 69 74-61 74 69 6f 6e 20 6d 65   st invitation me
  73 73 61 67 65                                    ssage



INVITE SNACs

SNAC List
Subgroup Origin Name
0x0001 Any INVITE__ERR
This is the error SNAC for the INVITE foodgroup.
0x0002 Client INVITE__REQUEST_QUERY
This SNAC contains a request to send an invite to join NINA to a given email address.
0x0003 Host INVITE__REQUEST_REPLY
This SNAC is sent in reply to a successful INVITE__REQUEST_QUERY.
Retrieved from "https://wiki.nina.chat/index.php?title=Protocols/OSCAR/SNAC/INVITE_REQUEST_QUERY&oldid=3519"