-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMessageAPI.json
2729 lines (2724 loc) · 98.8 KB
/
MessageAPI.json
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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"swagger": "2.0",
"info": {
"description": "Message 2.0 API",
"version": "1.0.0",
"title": "Cloudshare API"
},
"host": "123.57.47.96:8380",
"basePath": "/messaging",
"tags": [
{
"name": "通知消息接口",
"description": "本列表描述的是通知消息接口，uri前缀一般是：/api"
},
{
"name": "单聊消息接口",
"description": "本列表描述的是单聊消息接口，uri前缀一般是：/api"
},
{
"name": "多媒体聊天附件接口",
"description": "本列表描述的是多媒体聊天附件接口，uri前缀一般是：/api"
},
{
"name": "群聊信息接口",
"description": "本列表描述的是群聊信息接口，uri前缀一般是：/api"
},
{
"name": "群聊room管理员接口",
"description": "本列表描述的是群聊room管理员接口，uri前缀一般是：/adminapi"
},
{
"name": "iOS推送",
"description": "本列表描述的是iOS推送，uri前缀一般是：/api"
}
],
"schemes": [
"http"
],
"paths": {
"/api/notifs": {
"get": {
"tags": [
"通知消息接口"
],
"summary": "获取当前用户所有的通知消息",
"operationId": "getNotifs",
"produces": [
"text/plain;charset=UTF-8"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/NotifsPage"
}
},
"404": {
"description": "Not found"
}
}
},
"put": {
"tags": [
"通知消息接口"
],
"summary": "批量标记已读",
"operationId": "notifsMarkAsRead",
"produces": [
"text/plain;charset=UTF-8"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "ids",
"description": "id list",
"required": "true",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
{
"in": "query",
"name": "readFlag",
"description": "value MUST be true",
"required": "true",
"type": "boolean"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Status"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/notifs/search": {
"get": {
"tags": [
"通知消息接口"
],
"summary": "搜索当前用户的通知消息",
"operationId": "getNotifs",
"produces": [
"text/plain;charset=UTF-8"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "query",
"name": "q",
"description": "",
"required": true,
"type": "string"
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/NotifsPage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/convs/{oppositeId}/messages": {
"get": {
"tags": [
"单聊消息接口"
],
"summary": "按会话查询消息记录",
"description": "按会话查询聊天消息记录，url参数中的oppositeId表示对方id。即：查询的是调用者和oppositeId用户之间的会话。",
"operationId": "getChatMsgByOppositeId",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"name": "oppositeId",
"in": "path",
"description": "ID of opposite who is in the conversation",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "query",
"name": "page",
"description": "页码, 表示分页查询的页码，大于等于0，默认值0",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "pageSize",
"description": "每页大小, 大于0，默认值10",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "sort",
"description": "排序方式, 可以有多个字段，以逗号隔开，默认升序，负号表示降序。例如name, -age表示先按照name升序排列，如果name相同，再按照age降序排列。",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "过滤返回值中的字段, 只返回指定的字段，例如fields=type, content。如果不指定该参数，则返回所有字段。",
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/ChatMessagePage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/convs/unreadDigest": {
"get": {
"tags": [
"单聊消息接口"
],
"summary": "未读会话摘要",
"description": "获取所有含有未读消息的会话摘要，包括该会话的未读消息数量，和最后一条未读消息。",
"operationId": "getUnreadDigest",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/UnreadDigestPage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/convs/{oppositeId}": {
"put": {
"tags": [
"单聊消息接口"
],
"summary": "聊天消息已读反馈",
"description": "聊天消息以会话为单位进行已读反馈，此接口的语义是：对于和用户oppositeId的会话，我（调用者）已读到了第readSeq条信息。 （备注：当客户端发送了一条聊天消息，默认更新该会话为全部已读，不需要再通过REST接口更新已读反馈）。",
"operationId": "getReadFeedback",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "oppositeId",
"description": "ID of opposite who in the conversation",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "query",
"name": "readSeq",
"description": "最后已读消息的seq",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Status"
}
},
"404": {
"description": "Not found"
}
}
},
"get": {
"tags": [
"单聊消息接口"
],
"summary": "查看单个会话",
"description": "查看单个会话",
"operationId": "getConvByOppositeId",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"name": "oppositeId",
"in": "path",
"description": "ID of opposite who is in the conversation",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Conversation"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/messages": {
"delete": {
"tags": [
"单聊消息接口"
],
"summary": "批量删除聊天消息",
"description": "批量删除聊天消息。",
"operationId": "DeleteConvsMessage",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "ids",
"description": "id list",
"required": "true",
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Status"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/convs": {
"get": {
"tags": [
"单聊消息接口"
],
"summary": "查看所有会话",
"description": "查看所有会话。",
"operationId": "getAllConvs",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "page",
"description": "页码, 表示分页查询的页码，大于等于0，默认值0",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "pageSize",
"description": "每页大小, 大于0，默认值10",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "sort",
"description": "排序方式, 可以有多个字段，以逗号隔开，默认升序，负号表示降序。例如name, -age表示先按照name升序排列，如果name相同，再按照age降序排列。",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "过滤返回值中的字段, 只返回指定的字段，例如fields=type, content。如果不指定该参数，则返回所有字段。",
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/ConversationPage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/chat/convs/{oppositeId}/messages/search": {
"get": {
"tags": [
"单聊消息接口"
],
"summary": "搜索聊天记录",
"description": "搜索聊天记录",
"operationId": "getChatMsgRecord",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"name": "oppositeId",
"in": "path",
"description": "ID of opposite who is in the conversation",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "query",
"name": "page",
"description": "页码, 表示分页查询的页码，大于等于0，默认值0",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "pageSize",
"description": "每页大小, 大于0，默认值10",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "sort",
"description": "排序方式, 可以有多个字段，以逗号隔开，默认升序，负号表示降序。例如name, -age表示先按照name升序排列，如果name相同，再按照age降序排列。",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "过滤返回值中的字段, 只返回指定的字段，例如fields=type, content。如果不指定该参数，则返回所有字段。",
"type": "string"
},
{
"in": "query",
"name": "keyword",
"description": "搜索关键词",
"required": "true",
"type": "string"
},
{
"in": "query",
"name": "begin",
"description": "开始时间, 大于等于",
"required": "true",
"type": "integer",
"format": "int64"
},
{
"in": "query",
"name": "end",
"description": "结束时间, 可不填，默认当前时间；小于等于",
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/ChatMessagePage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/attachments/audio": {
"post": {
"tags": [
"多媒体聊天附件接口"
],
"summary": "上传语音消息附件",
"description": "上传语音消息附件",
"operationId": "uploadAudioAttachment",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "formData",
"name": "file",
"description": "上传的文件, 接受amr、mp3格式，大小限制5M",
"type": "file"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/AudioUrl"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/attachments/image": {
"post": {
"tags": [
"多媒体聊天附件接口"
],
"summary": "上传图片消息附件",
"description": "上传图片消息附件",
"operationId": "uploadImageAttachment",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "formData",
"name": "file",
"description": "上传的文件, 接受格式：jpg、jpeg、png、gif，大小限制5M",
"type": "file"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/ImageUrl"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/muc/rooms": {
"post": {
"tags": [
"群聊信息接口"
],
"summary": "创建room",
"description": "创建room",
"operationId": "createMucRoom",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "subject",
"description": "主题, 可为空字符串",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "occupantIds",
"description": "成员id列表, 至少2个成员",
"required": true,
"type": "array",
"minItems": 2,
"items": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Room"
}
},
"404": {
"description": "Not found"
}
}
},
"get": {
"tags": [
"群聊信息接口"
],
"summary": "查看加入的所有room",
"description": "查看加入的所有room",
"operationId": "getAllMucRooms",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "page",
"description": "页码, 表示分页查询的页码，大于等于0，默认值0",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "pageSize",
"description": "每页大小, 大于0，默认值10",
"type": "integer",
"format": "int32"
},
{
"in": "query",
"name": "sort",
"description": "排序方式, 可以有多个字段，以逗号隔开，默认升序，负号表示降序。例如name, -age表示先按照name升序排列，如果name相同，再按照age降序排列。",
"type": "string"
},
{
"in": "query",
"name": "fields",
"description": "过滤返回值中的字段, 只返回指定的字段，例如fields=type, content。如果不指定该参数，则返回所有字段。",
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/RoomPage"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/muc/rooms/{roomId}": {
"get": {
"tags": [
"群聊信息接口"
],
"summary": "查看单个room的信息",
"description": "查看单个room的信息",
"operationId": "getRoomById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "roomId",
"description": "ID of room",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Room"
}
},
"404": {
"description": "Not found"
}
}
},
"put": {
"tags": [
"群聊信息接口"
],
"summary": "修改room信息",
"description": "目前只能修改subject",
"operationId": "updateRoomById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "roomId",
"description": "ID of room",
"required": true,
"type": "integer",
"format": "int64"
},
{
"in": "query",
"name": "subject",
"description": "主题",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Status"
}
},
"404": {
"description": "Not found"
}
}
},
"delete": {
"tags": [
"群聊信息接口"
],
"summary": "删除room",
"description": "删除room",
"operationId": "deleteRoomById",
"produces": [
"application/json"
],
"parameters": [
{
"in": "query",
"name": "x-tenant-id",
"description": "Tenant id",
"required": true,
"type": "integer",
"format": "int32",
"default": 2
},
{
"in": "header",
"name": "x-ticket",
"description": "Unique identity for each user",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "roomId",
"description": "ID of room",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"schema": {
"$ref": "#/definitions/Status"
}
},
"404": {
"description": "Not found"
}
}
}
},
"/api/muc/rooms/{roomId}/occupants": {
"get": {
"tags": [
"群聊信息接口"
],
"summary": "查看room成员",
"description": "查看room成员",
"operationId": "getRoomOccupants",
"produces": [
"application/json"
],
"parameters": [