Browse code

Merge branch 'master' into offer_answer

Raphael Coeffic authored on 18/02/2011 11:36:25
Showing 1 changed files
... ...
@@ -57,6 +57,19 @@ If a room exists and the adminpin is not set (for example if the room is created
57 57
 by dial-in), the first call to roomInfo/dialout/kick/... with room/adminpin will
58 58
 set the adminpin.
59 59
 
60
+Participant ID
61
+--------------
62
+
63
+In some service environments, it may be necessary to determine in which conference
64
+rooms a certain user is at the moment. For example, if the active conferences of a
65
+user should be displayed on a web page, the conference bridge may be queried for the
66
+room a user is in.
67
+
68
+The findParticipant(string participant_id) function returns a list of rooms where the
69
+participant with a given ID is in. This participant ID can be given with
70
+ - a parameter to the dialout() function
71
+ - a header or P-App-Param parameter on incoming calls (see participant_id_param and
72
+   participant_id_header configuration in webconference.conf)
60 73
 
61 74
 implemented DI functions
62 75
 ------------------------
... ...
@@ -94,7 +107,7 @@ roomInfo(string room, string adminpin):
94 107
 ----
95 108
 dialout(string room, string adminpin, string callee,
96 109
         string from_user, string domain,
97
-        string auth_user, string auth_pwd [, headers [, callee_domain]]) :
110
+        string auth_user, string auth_pwd [, headers [, callee_domain, [participant_id]]]) :
98 111
      int code, string result, string callid
99 112
 
100 113
    code/result:
... ...
@@ -142,6 +155,10 @@ getRoomPassword(string master_pwd, string room)
142 155
 listRooms(string master_pwd)
143 156
     int code, string result
144 157
 ----
158
+findParticipant(string participant_id)
159
+    rooms: array of string
160
+  find all rooms a participant is in
161
+-----
145 162
 
146 163
 additionally there is feedback functions to save call quality reports 
147 164
 from users: vqRoomFeedback, vqCallFeedback, vqConferenceFeedback.
Browse code

webconference: updated doc on adminpin with private_rooms=yes

Stefan Sayer authored on 18/10/2010 13:04:34
Showing 1 changed files
... ...
@@ -39,11 +39,19 @@ The adminpin is used so that only authorized users can access the conference con
39 39
 The adminpin can be completely disabled by setting ignore_pin in webconference.conf, 
40 40
 in that case a specified adminpin is just ignored.
41 41
 
42
-On all actions that inspect or modify a room, if the room specified with room/adminpin
43
-does not exist, by default the room is (re)opened with the specified adminpin. 
44
-This means that roomCreate() does not necessarily need to be called; if roomInfo() 
45
-is called with a new room name and adminpin, the room is created and the adminpin 
46
-is set.
42
+There is two modes, configured in the configuration file: private_rooms=yes and
43
+private_rooms=no (which is the default).
44
+
45
+For private_rooms=no:
46
+  On all actions that inspect or modify a room, if the room specified with room/adminpin
47
+  does not exist, by default the room is (re)opened with the specified adminpin. 
48
+  This means that roomCreate() does not necessarily need to be called; if roomInfo() 
49
+  is called with a new room name and adminpin, the room is created and the adminpin 
50
+  is set.
51
+
52
+For private_rooms=yes:
53
+  The room has to be created with roomCreate, before anyone can enter the room by
54
+  dialing in or by creating a call with dialout.
47 55
 
48 56
 If a room exists and the adminpin is not set (for example if the room is created
49 57
 by dial-in), the first call to roomInfo/dialout/kick/... with room/adminpin will
... ...
@@ -56,9 +64,13 @@ All functions return as extra parameter the serverInfo, a status line showing th
56 64
 SEMS version, and current call statistics.
57 65
 
58 66
 ----
59
-roomCreate(string room):
67
+roomCreate(string room [, int timeout]):
60 68
    int code, string result, string adminpin
61 69
 
70
+  if webconference is configured with support_rooms_timeout=yes, the room is deleted
71
+  and participants are disconnected after <timeout>, if timeout parameter is present
72
+  and timeout > 0.
73
+
62 74
   code/result:
63 75
          0    OK
64 76
          1    room already open
Browse code

dded notes about session timer support in apps

Stefan Sayer authored on 20/09/2010 15:33:28
Showing 1 changed files
... ...
@@ -30,6 +30,9 @@ will save its results to a log file.
30 30
 A master password can be set, which serves to retrieve room PINs (adminpins),
31 31
 for site administrator or the like.
32 32
 
33
+There is SIP Session Timer (RFC4028) support, which is configured in 
34
+webconference.conf. By default, session timers are turned not enabled.
35
+
33 36
 Room adminpin handling
34 37
 ----------------------
35 38
 The adminpin is used so that only authorized users can access the conference control.
Browse code

added .txt extension to Readme files

git-svn-id: http://svn.berlios.de/svnroot/repos/sems/trunk@1555 8eb893ce-cfd4-0310-b710-fb5ebe64c474

Stefan Sayer authored on 22/10/2009 01:22:47
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,161 @@
1
+webconference : conference with dial-in and dial-out over DI (xmlrpc)
2
+
3
+Intro
4
+-----
5
+This conference module can do dial-in, dial-out and mixed 
6
+dial-in/dial-out conferences.  It can be controlled over DI functions 
7
+from other modules, and, for example, using the xmlrpc2di module, 
8
+the conference rooms can be controlled via XMLRPC.
9
+
10
+It implements conference rooms with dial-in and conference room entry
11
+via DTMF, and authenticated dial-out.
12
+
13
+For dial-in, usually the user is asked to enter the conference room 
14
+number via keypad, followed by the star key.
15
+
16
+In the configuration, a regular expression can be defined (direct_room_re),
17
+which, if matched to the user part of the request uri, connects the caller 
18
+directly to the conference room. direct_room_strip sets how many characters
19
+should be stripped from the user part in order to obtain the conference room 
20
+number.
21
+
22
+Participants can be listed, kicked out, muted and unmuted over DI 
23
+(using xmlrpc2di over XMLRPC).
24
+
25
+You will probably want to load uac_auth and xmlrpc2di modules. 
26
+
27
+There is some very simple feedback and call statistics functionality, which 
28
+will save its results to a log file.
29
+
30
+A master password can be set, which serves to retrieve room PINs (adminpins),
31
+for site administrator or the like.
32
+
33
+Room adminpin handling
34
+----------------------
35
+The adminpin is used so that only authorized users can access the conference control.
36
+The adminpin can be completely disabled by setting ignore_pin in webconference.conf, 
37
+in that case a specified adminpin is just ignored.
38
+
39
+On all actions that inspect or modify a room, if the room specified with room/adminpin
40
+does not exist, by default the room is (re)opened with the specified adminpin. 
41
+This means that roomCreate() does not necessarily need to be called; if roomInfo() 
42
+is called with a new room name and adminpin, the room is created and the adminpin 
43
+is set.
44
+
45
+If a room exists and the adminpin is not set (for example if the room is created
46
+by dial-in), the first call to roomInfo/dialout/kick/... with room/adminpin will
47
+set the adminpin.
48
+
49
+
50
+implemented DI functions
51
+------------------------
52
+All functions return as extra parameter the serverInfo, a status line showing the 
53
+SEMS version, and current call statistics.
54
+
55
+----
56
+roomCreate(string room):
57
+   int code, string result, string adminpin
58
+
59
+  code/result:
60
+         0    OK
61
+         1    room already open
62
+----
63
+roomInfo(string room, string adminpin):
64
+   int code, string result, list<participant> participants
65
+   participant: string call_tag, string number, int status, string reason, int muted
66
+
67
+  status:
68
+         0    Disconnected
69
+         1    Connecting
70
+         2    Ringing
71
+         3    Connected
72
+         4    Disconnecting
73
+	 5    Finished
74
+   reason: e.g. "200 OK", "606 Declined", ...
75
+
76
+  code/result:
77
+         0    OK
78
+         1    wrong adminpin
79
+----
80
+dialout(string room, string adminpin, string callee,
81
+        string from_user, string domain,
82
+        string auth_user, string auth_pwd [, headers [, callee_domain]]) :
83
+     int code, string result, string callid
84
+
85
+   code/result:
86
+          0     OK
87
+          1     wrong adminpin
88
+	  2     failed
89
+----
90
+kickout(string room, string adminpin, string call_tag) :
91
+     int code, string result
92
+
93
+   code/result:
94
+          0     OK
95
+          1     wrong adminpin
96
+	  2     call does not exist in room
97
+----
98
+mute(string room, string adminpin, string call_tag) :
99
+     int code, string result
100
+
101
+   code/result:
102
+          0     OK
103
+          1     wrong adminpin
104
+	  2     call does not exist in room
105
+----
106
+unmute(string room, string adminpin, string call_tag) :
107
+     int code, string result
108
+
109
+   code/result:
110
+          0     OK
111
+          1     wrong adminpin
112
+	  2     call does not exist in room
113
+----
114
+changeRoomAdminpin(string room, string adminpin, string new_adminpin) : 
115
+     int code, string result
116
+
117
+   code/result: 
118
+          0     OK
119
+          1     wrong adminpin
120
+----
121
+serverInfo():
122
+      string serverInfo
123
+----
124
+getRoomPassword(string master_pwd, string room)
125
+    int code, string result
126
+----
127
+listRooms(string master_pwd)
128
+    int code, string result
129
+----
130
+
131
+additionally there is feedback functions to save call quality reports 
132
+from users: vqRoomFeedback, vqCallFeedback, vqConferenceFeedback.
133
+resetFeedback, flushFeedback can be used to manipulate the feedback files.
134
+
135
+getRoomPassword and listRooms in only available if master password is set 
136
+in webconference.conf
137
+
138
+
139
+prompt suggestions: 
140
+------------------
141
+entering_conference: You are now entering the conference room.
142
+first_participant: You are the first participant in the conference.
143
+pin_prompt: Welcome to iptel dot org conference. Please enter your room number, followed by the pound key.
144
+wrong_pin: The room number is not correct. Please try again.
145
+
146
++ the numbers (0.wav ... 9.wav )
147
+
148
+
149
+webconference.iptel.org server
150
+------------------------------
151
+
152
+At the free SIP service iptel.org there is a SEMS webconference server 
153
+running, which can be accessed through its rather simple web GUI at
154
+ https://webconference.iptel.org/ and http://webconference.iptel.org/
155
+and through its XMLRPC control URI
156
+ https://webconference.iptel.org/control
157
+
158
+see also:
159
+--------
160
+pyqt example gui client in 
161
+ apps/webconference/pyqtgui