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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
|
# Talk occ commands
## talk:bot:install
Install a new bot on the server
### Usage
* `talk:bot:install [--output [OUTPUT]] [--no-setup] [-f|--feature FEATURE] [--] <name> <secret> <url> [<description>]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `name` | The name under which the messages will be posted (min. 1 char, max. 64 chars) | yes | no | *Required* |
| `secret` | Secret used to validate API calls (min. 40 chars, max. 128 chars) | yes | no | *Required* |
| `url` | Webhook endpoint to post messages to (max. 4000 chars) | yes | no | *Required* |
| `description` | Optional description shown in the admin settings (max. 4000 chars) | no | no | `NULL` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
| `--no-setup` | Prevent moderators from setting up the bot in a conversation | no | no | no | `false` |
| `--feature\|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | *Required* |
## talk:bot:list
List all installed bots of the server or a conversation
### Usage
* `talk:bot:list [--output [OUTPUT]] [--] [<token>]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Conversation token to limit the bot list for | no | no | `NULL` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:bot:remove
Remove a bot from a conversation
### Usage
* `talk:bot:remove [--output [OUTPUT]] [--] <bot-id> [<token>...]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `bot-id` | The ID of the bot to remove in a conversation | yes | no | *Required* |
| `token` | Conversation tokens to remove bot up for | no | yes | `array ()` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:bot:state
Change the state or feature list for a bot
### Usage
* `talk:bot:state [--output [OUTPUT]] [-f|--feature FEATURE] [--] <bot-id> <state>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `bot-id` | Bot ID to change the state for | yes | no | *Required* |
| `state` | New state for the bot (0 = disabled, 1 = enabled, 2 = no setup via GUI) | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
| `--feature\|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | *Required* |
## talk:bot:setup
Add a bot to a conversation
### Usage
* `talk:bot:setup [--output [OUTPUT]] [--] <bot-id> [<token>...]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `bot-id` | The ID of the bot to set up in a conversation | yes | no | *Required* |
| `token` | Conversation tokens to set the bot up for | no | yes | `array ()` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:bot:uninstall
Uninstall a bot from the server
### Usage
* `talk:bot:uninstall [--output [OUTPUT]] [--url URL] [--] [<id>]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `id` | The ID of the bot | no | no | `NULL` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
| `--url` | The URL of the bot (required when no ID is given, ignored otherwise) | yes | yes | no | *Required* |
## talk:command:add
Add a new command
### Usage
* `talk:command:add [--output [OUTPUT]] [--] <cmd> <name> <script> <response> <enabled>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `cmd` | The command as used in the chat "/help" => "help" | yes | no | *Required* |
| `name` | Name of the user posting the response | yes | no | *Required* |
| `script` | Script to execute (Must be using absolute paths only) | yes | no | *Required* |
| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | *Required* |
| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:command:add-samples
Adds some sample commands: /wiki, …
### Usage
* `talk:command:add-samples`
## talk:command:delete
Remove an existing command
### Usage
* `talk:command:delete <command-id>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `command-id` | | yes | no | *Required* |
## talk:command:list
List all available commands
### Usage
* `talk:command:list [--output [OUTPUT]] [--] [<app>]`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `app` | Only list the commands of a specific app, "custom" to list all custom commands | no | no | `NULL` |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:command:update
Add a new command
### Usage
* `talk:command:update [--output [OUTPUT]] [--] <command-id> <cmd> <name> <script> <response> <enabled>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `command-id` | | yes | no | *Required* |
| `cmd` | The command as used in the chat "/help" => "help" | yes | no | *Required* |
| `name` | Name of the user posting the response | yes | no | *Required* |
| `script` | Script to execute (Must be using absolute paths only) | yes | no | *Required* |
| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | *Required* |
| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:monitor:calls
Prints a list with conversations that have an active call as well as their participant count
### Usage
* `talk:monitor:calls [--output [OUTPUT]]`
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:active-calls
Allows you to check if calls are currently in process
### Usage
* `talk:active-calls [--output [OUTPUT]]`
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
## talk:monitor:room
Prints the number of attendees, active sessions and participant in the call.
### Usage
* `talk:monitor:room [--output [OUTPUT]] [--separator SEPARATOR] [--] <token>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room to monitor | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
| `--separator` | Separator for the CSV list when output=csv is used | yes | yes | no | *Required* |
## talk:recording:consent
List all matching consent that were given to be audio and video recorded during a call (requires administrator or moderator configuration)
### Usage
* `talk:recording:consent [--output [OUTPUT]] [--token TOKEN] [--actor-type ACTOR-TYPE] [--actor-id ACTOR-ID]`
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` |
| `--token` | Limit to the given conversation | yes | yes | no | *Required* |
| `--actor-type` | Limit to the given actor (only valid when --actor-id is also provided) | yes | yes | no | *Required* |
| `--actor-id` | Limit to the given actor (only valid when --actor-type is also provided) | yes | yes | no | *Required* |
## talk:room:add
Adds users to a room
### Usage
* `talk:room:add [--user USER] [--group GROUP] [--] <token>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room to add users to | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--user` | Invites the given users to the room | yes | yes | yes | *Required* |
| `--group` | Invites all members of the given groups to the room | yes | yes | yes | *Required* |
## talk:room:create
Create a new room
### Usage
* `talk:room:create [--description DESCRIPTION] [--user USER] [--group GROUP] [--public] [--readonly] [--listable LISTABLE] [--password PASSWORD] [--owner OWNER] [--moderator MODERATOR] [--message-expiration MESSAGE-EXPIRATION] [--] <name>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `name` | The name of the room to create | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--description` | The description of the room to create | yes | yes | no | *Required* |
| `--user` | Invites the given users to the room to create | yes | yes | yes | *Required* |
| `--group` | Invites all members of the given group to the room to create | yes | yes | yes | *Required* |
| `--public` | Creates the room as public room if set | no | no | no | `false` |
| `--readonly` | Creates the room with read-only access only if set | no | no | no | `false` |
| `--listable` | Creates the room with the given listable scope | yes | yes | no | *Required* |
| `--password` | Protects the room to create with the given password | yes | yes | no | *Required* |
| `--owner` | Sets the given user as owner of the room to create | yes | yes | no | *Required* |
| `--moderator` | Promotes the given users to moderators | yes | yes | yes | *Required* |
| `--message-expiration` | Seconds to expire a message after sent. If zero will disable the expire message duration. | yes | yes | no | *Required* |
## talk:room:delete
Deletes a room
### Usage
* `talk:room:delete <token>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room to delete | yes | no | *Required* |
## talk:room:demote
Demotes participants of a room to regular users
### Usage
* `talk:room:demote <token> <participant>...`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room in which users should be demoted | yes | no | *Required* |
| `participant` | Demotes the given participants of the room to regular users | yes | yes | *Required* |
## talk:room:promote
Promotes participants of a room to moderators
### Usage
* `talk:room:promote <token> <participant>...`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room in which users should be promoted | yes | no | *Required* |
| `participant` | Promotes the given participants of the room to moderators | yes | yes | *Required* |
## talk:room:remove
Remove users from a room
### Usage
* `talk:room:remove <token> <participant>...`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | Token of the room to remove users from | yes | no | *Required* |
| `participant` | Removes the given participants from the room | yes | yes | *Required* |
## talk:room:update
Updates a room
### Usage
* `talk:room:update [--name NAME] [--description DESCRIPTION] [--public PUBLIC] [--readonly READONLY] [--listable LISTABLE] [--password PASSWORD] [--owner OWNER] [--message-expiration MESSAGE-EXPIRATION] [--] <token>`
| Arguments | Description | Is required | Is array | Default |
|---|---|---|---|---|
| `token` | The token of the room to update | yes | no | *Required* |
| Options | Description | Accept value | Is value required | Is multiple | Default |
|---|---|---|---|---|---|
| `--name` | Sets a new name for the room | yes | yes | no | *Required* |
| `--description` | Sets a new description for the room | yes | yes | no | *Required* |
| `--public` | Modifies the room to be a public room (value 1) or private room (value 0) | yes | yes | no | *Required* |
| `--readonly` | Modifies the room to be read-only (value 1) or read-write (value 0) | yes | yes | no | *Required* |
| `--listable` | Modifies the room's listable scope | yes | yes | no | *Required* |
| `--password` | Sets a new password for the room; pass an empty value to remove password protection | yes | yes | no | *Required* |
| `--owner` | Sets the given user as owner of the room; pass an empty value to remove the owner | yes | yes | no | *Required* |
| `--message-expiration` | Seconds to expire a mes
|
