-
Notifications
You must be signed in to change notification settings - Fork 1
/
notifications.yaml
686 lines (682 loc) · 22.7 KB
/
notifications.yaml
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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
openapi: 3.0.0
info:
version: 1.0.0
title: Notifications
# description: |-
# The Rocket.Chat notifications endpoints are as follows:
# * **Banners**: Get and dismiss banners.
# * **Push token**: Create and manage push tokens.
servers:
- url: https://apiexplorer.support.rocket.chat
paths:
'/api/v1/banners/{id}':
parameters:
- schema:
type: string
example: ByehQjC44FwMeiLbX
name: id
in: path
required: true
description: The banner ID.
get:
summary: Get Banner by ID
tags:
- Banners
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
banners:
type: array
items:
type: object
properties: {}
success:
type: boolean
examples:
Success Example:
value:
banners: []
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Params:
value:
success: false
error: 'must have required property ''platform'' [invalid-params]'
errorType: invalid-params
'401':
$ref: '#/components/responses/authorizationError'
operationId: get-api-v1-banners-id
description: Gets the banner to be shown to the authenticated user.
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
- schema:
type: string
example: web
in: query
name: platform
description: The platform rendering the banner.
required: true
/api/v1/banners:
parameters: []
get:
summary: Get Banners
operationId: get-api-v1-banners
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
banners:
type: array
items:
type: object
properties: {}
success:
type: boolean
examples:
Success Example:
value:
banners: []
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Params:
value:
success: false
error: 'must have required property ''platform'' [invalid-params]'
errorType: invalid-params
'401':
$ref: '#/components/responses/authorizationError'
description: Gets the banners to be shown to the authenticated user.
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
- schema:
type: string
example: web
in: query
name: platform
description: The platform rendering the banner
required: true
tags:
- Banners
/api/v1/banners.dismiss:
parameters: []
post:
summary: Dismiss a Banner
operationId: post-api-v1-banners.dismiss
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Params:
value:
success: false
error: 'must have required property ''bannerId'' [invalid-params]'
errorType: invalid-params
'401':
$ref: '#/components/responses/authorizationError'
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
requestBody:
content:
application/json:
schema:
type: object
properties:
bannerId:
type: string
description: The banner ID that you want to dismiss.
example: ByehQjC44FwMeiLbX
required:
- bannerId
examples:
Success:
value:
bannerId: ByehQjC44FwMeiLbX
tags:
- Banners
/api/v1/banners.getNew:
get:
summary: Get a banner
deprecated: true
tags:
- Banners
responses:
'200':
description: OK
headers: {}
content:
application/json:
schema:
type: object
properties:
banners:
type: array
items:
type: object
properties: {}
success:
type: boolean
examples:
Example:
value:
banners:
- {}
success: true
operationId: get-api-v1-banners.getNew
description: '> This endpoint has been deprecated and is scheduled for removal in the 8.0.0 <a href="https://github.com/RocketChat/Rocket.Chat/releases" target="_blank">release</a>. Use [`banners`](https://developer.rocket.chat/apidocs/get-banners) or [`banners/:id`](https://developer.rocket.chat/apidocs/get-banner-by-id) instead.'
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
- schema:
type: string
example: web
in: query
name: platform
description: The platform rendering the banner.
required: true
- schema:
type: string
in: query
name: bid
description: The banner ID
required: true
/api/v1/push.get:
parameters: []
get:
summary: Get Push Notification
operationId: get-api-v1-push.get
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
message:
type: object
properties:
_id:
type: string
rid:
type: string
msg:
type: string
ts:
type: string
u:
type: object
properties:
_id:
type: string
username:
type: string
name:
type: string
urls:
type: array
items:
type: object
properties: {}
mentions:
type: array
items:
type: object
properties: {}
channels:
type: array
items:
type: object
properties: {}
md:
type: array
items:
type: object
properties:
type:
type: string
value:
type: array
items:
type: object
properties:
type:
type: string
value:
type: string
_updatedAt:
type: string
notification:
type: object
properties:
from:
type: string
badge:
type: integer
sound:
type: string
priority:
type: integer
title:
type: string
text:
type: string
payload:
type: object
properties:
host:
type: string
messageId:
type: string
notificationType:
type: string
rid:
type: string
sender:
type: object
properties:
_id:
type: string
username:
type: string
name:
type: string
senderName:
type: string
type:
type: string
name:
type: string
userId:
type: string
notId:
type: integer
gcm:
type: object
properties:
style:
type: string
image:
type: string
apn:
type: object
properties:
category:
type: string
success:
type: boolean
examples:
Success Example:
value:
data:
message:
_id: WkbwSntxt8D3jLp8G
rid: iu7jtPAhvEeAS5tNq
msg: fsfs
ts: '2021-10-22T14:29:23.581Z'
u:
_id: d26x6zSkaPSe5gCyy
username: rodriq
name: Rodriq
urls: []
mentions: []
channels: []
md:
- type: PARAGRAPH
value:
- type: PLAIN_TEXT
value: fsfs
_updatedAt: '2021-10-22T14:29:23.603Z'
notification:
from: push
badge: 2
sound: default
priority: 10
title: '#vb'
text: 'rodriq: fsfs'
payload:
host: 'http://localhost:3000/'
messageId: WkbwSntxt8D3jLp8G
notificationType: message
rid: iu7jtPAhvEeAS5tNq
sender:
_id: d26x6zSkaPSe5gCyy
username: rodriq
name: Rodriq
senderName: rodriq
type: c
name: vb
userId: d26x6zSkaPSe5gCyy
notId: 654494840
gcm:
style: inbox
image: 'http://localhost:3000/images/logo/android-chrome-192x192.png'
apn:
category: MESSAGE
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
examples:
Example:
value:
success: false
error: 'Match error: Missing key ''id'''
'401':
$ref: '#/components/responses/authorizationError'
description: |-
Get push notification for a message.
### Changelog
| Version | Description |
| ---------------- | ------------|
|3.5.0 | Added |
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
- schema:
type: string
example: WkbwSntxt8D3jLp8G
in: query
name: id
description: The message ID.
required: true
tags:
- Push Token
/api/v1/push.token:
parameters: []
delete:
summary: Delete Push Token
operationId: delete-api-v1-push.token
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Token Parameter:
value:
success: false
error: 'The required "token" body param is missing or invalid. [error-token-param-not-valid]'
errorType: error-token-param-not-valid
'401':
$ref: '#/components/responses/authorizationError'
description: |-
Removes push token from the workspace.
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.60.0 | Added |
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
requestBody:
content:
application/json:
schema:
type: object
properties:
token:
type: string
examples:
Example:
value:
token: abc
tags:
- Push Token
post:
summary: Create Push Token
operationId: post-api-v1-push.token
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
result:
type: object
properties:
token:
type: object
properties:
gcm:
type: string
appName:
type: string
userId:
type: string
enabled:
type: boolean
createdAt:
type: string
updatedAt:
type: string
_id:
type: string
success:
type: boolean
examples:
Success Example:
value:
result:
token:
gcm: TOKEN
appName: RocketAPP
userId: 52d5Rw8LT3TeDa59Z
enabled: true
createdAt: '2018-09-11T18:22:55.006Z'
updatedAt: '2018-09-11T18:22:55.006Z'
_id: DMMjKG2hFoLvM2hk7
success: true
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Token Param:
value:
success: false
error: 'The required "type" body param is missing or invalid. [error-type-param-not-valid]'
errorType: error-type-param-not-valid
'401':
$ref: '#/components/responses/authorizationError'
tags:
- Push Token
parameters:
- $ref: '#/components/parameters/X-Auth-Token'
- $ref: '#/components/parameters/X-User-Id'
requestBody:
content:
application/json:
schema:
type: object
properties:
type:
type: string
description: The possible values are `apn` or `gcm`.
value:
type: string
description: The token value.
appName:
type: string
description: The name of the application to associate the token with
required:
- type
- value
- appName
examples:
Example:
value:
type: gcm
value: TOKEN
appName: MyApp
description: |-
### Changelog
| Version | Description |
| ---------------- | ------------|
|0.60.0 | Added |
components:
parameters:
X-Auth-Token:
name: X-Auth-Token
in: header
required: true
schema:
type: string
example: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq
description: The authorization token of the user.
X-User-Id:
name: X-User-Id
in: header
required: true
schema:
type: string
example: aobEdbYhXfu5hkeqG
description: The user ID of the user.
offset:
name: offset
in: query
required: false
schema:
type: integer
example: 50
description: 'Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.'
count:
name: count
in: query
required: false
schema:
type: integer
example: 50
description: The number of items to return.
sort:
name: sort
in: query
required: false
schema: {}
description: 'List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, {"value": -1, "_id": 1}'
query:
name: query
in: query
required: false
schema: {}
description: 'This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" } }'
fields:
name: fields
in: query
required: false
schema:
type: string
description: 'This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }'
responses:
authorizationError:
description: Unauthorized
content:
application/json:
schema:
type: object
properties:
status:
type: string
message:
type: string
examples:
Authorization Error:
value:
status: error
message: You must be logged in to do this.
trueSuccess:
description: OK
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
examples:
Success Example:
value:
success: true