/README.md

https://github.com/abdullaheldeep/WhatsAPI · Markdown · 134 lines · 78 code · 56 blank · 0 comment · 0 complexity · ca3151582df69f3c581c1b366f3920fe MD5 · raw file 

    

  1. # WhatsAPI
    2. 

  2. 

  3. Interface to WhatsApp Messenger
    4. 

  4. 

  5. ----------
    6. 

  6. 

  7. ### Update March 15th, 2014
    8. 

  8. 

  9. Sources are back after brief downtime due to [DCMA takedown](https://github.com/github/dmca/blob/master/2014-02-12-WhatsApp.md).
    10. 

  10. 

  11. ### Note July 30th, 2013
    12. 

  12. *New policy:*
    13. 

  13. 

  14. *I no longer provide support to users who are trying to send bulk messages using this API (i.e. a large amount of messages and not the built-in bulk message functionality).*
    15. 

  15. *Sending advertisments on WhatsApp goes directly against their EULA and I have no way of determining whether the user is trying to send spam, advertising or sending mass messages to "opt-in users".*
    16. 

  16. *And I also don't want to waste the little spare time that I have on trying to figure out ways to fuck up this beautiful ad-free platform called WhatsApp by enabling people to send spam.*
    17. 

  17. *Everyone is free to use this API but there will be no more issue reports about being blocked after sending messages to semi-random users.*
    18. 

  18. 

  19. *In the famous words of Heath Ledger as the Joker (taken completely out of context by me):*
    20. 

  20. 

  21. **It's not about the money, it's about sending a message.**
    22. 

  22. 

  23. *\- [shirioko](https://github.com/shirioko)*
    24. 

  24. 

  25. ----------
    26. 

  26. 

  27. ### Note July 14th, 2013
    28. 

  28. *Events renamed:*
    29. 

  29. - *A large number of events have been renamed in the event handling system to better match the recent method names.*
    30. 

  30. - *All event names and parameters have been listed in the EVENTS.md file*
    31. 

  31. 

  32. 

  33. ----------
    34. 

  34. 

  35. ### Note July 10th, 2013
    36. 

  36. *Another massive overhaul in the code:*
    37. 

  37. - *MAJOR RENAMING OF MOST METHODS!! Old legacy code will break, we are sorry but it is necessary to provide a cleaner interface. Please check the new code.*
    38. 

  38. - *Methods renamed to give a more consistent feel to the API - all methods are now camelCase watch out for typo's!*
    39. 

  39. - *Initial movement towards bringing the code into alignment with PSR-2 (http://www.php-fig.org/psr/2/)*
    40. 

  40. - *There is absolutely NO, NONE, NADA, ZIP, 100% FREE of any need to use/enter a MAC address or IMEI in this code. DO NOT TRY!*
    41. 

  41. - *[New Android token used](https://github.com/karolsarnacki/whatsapp/commit/55d8233b852ecd9f6a6f845586e91e6fadbd0c44#L1L20) as WP7 one appears to no longer work. Long live the WP7 token?*
    42. 

  42. 

  43. ----------
    44. 

  44. 

  45. 

  46. ### Note June 18th, 2013
    47. 

  47. 

  48. *Big overhaul in the code. Big thanks to:*
    49. 

  49. - *[Ali Hubail](https://github.com/hubail) and*
    50. 

  50. - *[Ahmed Moh'd](http://fb.com/ahmed.mhd) for making this project happen (and adding me as a member)*
    51. 

  51. - *[Jannik Vogel](https://github.com/JayFoxRox) for helping me retrieve the latest WhatsApp token, someone should write a book about it some day..*
    52. 

  52. - *[Tarek Galal](https://github.com/tgalal) for providing the latest WhatsApp functionality in yowsup*
    53. 

  53. - *[Atans](https://github.com/atans) and*
    54. 

  54. - *[Jonathan Williamson](https://github.com/jonnywilliamson) for additional fixes*
    55. 

  55. 

  56. *\- [shirioko](https://github.com/shirioko)*
    57. 

  57. 

  58. 

  59. ----------
    60. 

  60. 

  61. ### What is WhatsApp?
    62. 

  62. According to [the company](http://www.whatsapp.com/):
    63. 

  63. 

  64. > “WhatsApp Messenger is a cross-platform mobile messenger that replaces SMS and works through the existing internet data plan of your device. WhatsApp is available for iPhone, BlackBerry, Android, Windows Phone, Nokia Symbian60 & S40 phones. Because WhatsApp Messenger uses the same internet data plan that you use for email and web browsing, there is no cost to message and stay in touch with your friends.”
    65. 

  65. 

  66. Late 2011 numbers: 1 billion messages per day, ~20 million users.
    67. 

  67. 

  68. ### Modified XMPP
    69. 

  69. WhatsApp uses some sort of customized XMPP server, named internally as FunXMPP, which is basically some extended proprietary version.
    70. 

  70. 

  71. ### Login procedure
    72. 

  72. Much like XMPP, WhatsApp uses JID (jabber id) and password to successfully login to the service. The password is generated by the server and received upon registration.
    73. 

  73. 

  74. 

  75. The JID is a concatenation between your country’s code and mobile number.
    76. 

  76. 

  77. Initial login uses Digest Access Authentication.
    78. 

  78. 

  79. ### Message sending
    80. 

  80. Messages are basically sent as TCP packets, following WhatsApp’s own format (unlike what’s defined in XMPP RFCs).
    81. 

  81. 

  82. Messages are application level encrypted using RC4 keystreams
    83. 

  83. 

  84. ### Multimedia Message sending
    85. 

  85. Photos, Videos and Audio files shared with WhatsApp contacts are HTTP-uploaded to a server before being sent to the recipient(s) along with Base64 thumbnail of media file (if applicable) along with the generated HTTP link as the message body.
    86. 

  86. 

  87. ### Event system
    88. 

  88. WhatsApi uses an event manager (created by [facine](https://github.com/facine)) which allows you to respond to certain events.
    89. 

  89. 

  90. List of events and example code on how to bind an event handler:
    91. 

  91. https://github.com/shirioko/WhatsAPI/wiki/WhatsApi-events
    92. 

  92. 

  93. # FAQ
    94. 

  94. 

  95. 

  96. - **What’s with the hex chars floating all over the code?**
    97. 

  97. 

  98. 	Mostly WhatsApp’s proprietary control chars/commands, or formatted data according to their server’s specifications, stored in predefined dictionaries within the clients.
    99. 

  99. 

  100. - **What’s your future development plans?**
    101. 

  101. 

  102. 	We don’t have any.
    103. 

  103. 

  104. - **Would it run over the web?**
    105. 

  105. 

  106. 	We’ve tested a slightly-modified version on top of Tornado Web Server and worked like a charm, however, building a chat client is a bit tricky, do your research.
    107. 

  107. 

  108. - **Can I receive chats?**
    109. 

  109. 

  110. 	Indeed, using the same socket-receiving mechanism. But you have to parse the incoming data. Parsing functions aren’t included in this release, maybe in the next one?
    111. 

  111. 

  112. - **I think the code is messy.**
    113. 

  113. 

  114. 	It’s working.
    115. 

  115. 

  116. - **How can I obtain my password?**
    117. 

  117. 

  118. 	Register a number using WhatsAPI or intercept your phone's password using MissVenom
    119. 

    120. 

  120. # NOTES
    121. 

  121. 

  122. - This proof of concept is extensible to contain every feature that make a fully-fledged client, similar to the official ones, actually could be even better.
    123. 

  123. 

  124. - During the two weeks of analysis of service mechanisms, we stumbled upon serious design and security flaws (they fixed some of them since 2011). For a company with such massive user base, we expected better practises and engineering.
    125. 

  125. 

  126. # License
    127. 

  127. 

  128. MIT - refer to the source code for the extra line.
    129. 

  129. 

  130. # Venomous
    131. 

  131. 

  132. Team of Bahraini Developers.
    133. 

  133. 

  134. Ahmed Moh'd ([fb.com/ahmed.mhd](https://www.facebook.com/ahmed.mhd)) and Ali Hubail ([@hubail](https://twitter.com/hubail)) contributed to this release.
    135.