summaryrefslogtreecommitdiff
path: root/Documentation.txt
blob: 0dcf56667f7a3d2e86f61189b5b95112703cd950 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
====== API Documentation
==== Connection
URL: http://omegle.com/

HTTP-Header:
 Host: omegle.com
 Content-type: application/x-www-form-urlencoded; charset=utf-8
 Accept: application/json

All API-Calls return JSON-Data. The Returncode for success is "win", the
errorcode is "fail".

==== Commands:
     O   --> /count
    \|/  --> /start() <- id
    / \      --> /send(id,msg) <- "win"
             --> /disconect(id) <- "win"
             --> /events(id) <- "[[msg1],...]

== /start - Start a conversation
URL: /start
METHOD: POST
PARAM: {}

RETURNS: "ABCDE"
 ABCDE is a random string to identify the connection

== /events - Poll for events
URL: /events
METHOD: POST
PARAM: {'id':'ABCDE'}

RETURNS: [[TYPE,data...],...]
  EXAMPLE 1: [["typing"], ["gotMessage", "im 22 m finland"]]
  EXAMPLE 2: [["gotMessage", "ok"]]
  EXAMPLE 3: [["typing"]]
  EXAMPLE 4: [["typing"], ["gotMessage", "hi"], ["typing"], ["gotMessage", "asl"]]
  EXAMPLE 5: [["waiting"], ["connected"]]

Return Messagetypes:
  ["typing"]               - Stranger is typing
  ["stoppedTyping"]        - Stranger has stopped typing
  ["gotMessage", "ABCDE"]  - Stranger send "ABCDE"
  ["waiting"]              - ???
  ["connected"]            - ready to send messages
  ["strangerDisconnected"] - Stranger pressed disconnect

Note: The omegle sorver is blocking the connection if no event
 occured.

== /send - Send Message
URL: /send
PARAM: {'id':'ABCDE', 'msg':'ABCDE'}

RETURNS: "win"
	 "fail"

== /disconnect - Disconnect/Quit Chat
URL: /disconnect
METHOD: POST
PARAM: {'id':'ABCDE'}

RETURNS: "win"
         "fail"

== /count - Get user count
URL: /count
METHOD: GET
PARAM: {}

RETURNS: 1234
 1234 is the number of users online