-
Notifications
You must be signed in to change notification settings - Fork 1
/
protocol.json
4241 lines (4241 loc) · 115 KB
/
protocol.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
{
"doc_version": "v1",
"version": {
"name": "signald",
"version": "0.15.0-6-7fb32321",
"branch": "main",
"commit": "7fb323214faf9924355b73a6a383ce8c0137c8d0"
},
"info": "This document describes objects that may be used when communicating with signald.",
"types": {
"v1": {
"JsonMessageEnvelope": {
"fields": {
"username": {
"type": "String",
"example": "\"+12024561414\""
},
"uuid": {
"type": "String",
"example": "\"0cc10e61-d64c-4dbc-b51c-334f7dd45a4a\""
},
"source": {
"type": "JsonAddress",
"version": "v1"
},
"sourceDevice": {
"type": "int"
},
"type": {
"type": "String"
},
"relay": {
"type": "String"
},
"timestamp": {
"type": "long",
"example": "1615576442475"
},
"timestampISO": {
"type": "String"
},
"serverTimestamp": {
"type": "long"
},
"serverDeliveredTimestamp": {
"type": "long",
"example": "161557644247580"
},
"hasLegacyMessage": {
"type": "boolean"
},
"hasContent": {
"type": "boolean"
},
"isUnidentifiedSender": {
"type": "boolean"
},
"dataMessage": {
"type": "JsonDataMessage",
"version": "v1"
},
"syncMessage": {
"type": "JsonSyncMessage",
"version": "v1"
},
"callMessage": {
"type": "JsonCallMessage",
"version": "v0"
},
"receipt": {
"type": "JsonReceiptMessage",
"version": "v0"
},
"typing": {
"type": "JsonTypingMessage",
"version": "v0"
}
}
},
"IncomingMessage": {
"fields": {
"account": {
"type": "String",
"example": "\"+12024561414\""
},
"source": {
"type": "JsonAddress",
"version": "v1"
},
"type": {
"type": "String"
},
"timestamp": {
"type": "long",
"example": "1615576442475"
},
"source_device": {
"type": "int"
},
"server_receiver_timestamp": {
"type": "long",
"example": "1615576442475"
},
"server_deliver_timestamp": {
"type": "long",
"example": "1615576442475"
},
"has_legacy_message": {
"type": "boolean"
},
"has_content": {
"type": "boolean"
},
"unidentified_sender": {
"type": "boolean"
},
"data_message": {
"type": "JsonDataMessage",
"version": "v1"
},
"sync_message": {
"type": "JsonSyncMessage",
"version": "v1"
},
"call_message": {
"type": "CallMessage",
"version": "v1"
},
"receipt_message": {
"type": "ReceiptMessage",
"version": "v1"
},
"typing_message": {
"type": "TypingMessage",
"version": "v1"
},
"server_guid": {
"type": "String"
}
}
},
"ListenerState": {
"fields": {
"connected": {
"type": "boolean"
}
},
"doc": "indicates when the incoming connection to the signal server has started or stopped"
},
"ClientMessageWrapper": {
"fields": {
"type": {
"type": "String",
"doc": "the type of object to expect in the `data` field"
},
"version": {
"type": "String",
"doc": "the version of the object in the `data` field"
},
"data": {
"type": "Object",
"doc": "the incoming object. The structure will vary from message to message, see `type` and `version` fields"
},
"error": {
"type": "Boolean",
"doc": "true if the incoming message represents an error"
}
},
"doc": "Wraps all incoming messages after a v1 subscribe request is issued"
},
"SendRequest": {
"fields": {
"username": {
"type": "String",
"example": "\"+12024561414\"",
"required": true
},
"recipientAddress": {
"type": "JsonAddress",
"version": "v1"
},
"recipientGroupId": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""
},
"messageBody": {
"type": "String",
"example": "\"hello\""
},
"attachments": {
"list": true,
"type": "JsonAttachment",
"version": "v1"
},
"quote": {
"type": "JsonQuote",
"version": "v1"
},
"timestamp": {
"type": "Long"
},
"mentions": {
"list": true,
"type": "JsonMention",
"version": "v1"
},
"previews": {
"list": true,
"type": "JsonPreview",
"version": "v1"
}
}
},
"SendResponse": {
"fields": {
"results": {
"list": true,
"type": "JsonSendMessageResult",
"version": "v1"
},
"timestamp": {
"type": "long",
"example": "1615576442475"
}
}
},
"NoSuchAccountError": {
"fields": {
"account": {
"type": "String"
},
"message": {
"type": "String"
}
},
"error": true
},
"ServerNotFoundError": {
"fields": {
"uuid": {
"type": "String"
},
"message": {
"type": "String"
}
},
"error": true
},
"InvalidProxyError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"NoSendPermissionError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"InvalidAttachmentError": {
"fields": {
"filename": {
"type": "String"
},
"message": {
"type": "String"
}
},
"error": true
},
"InternalError": {
"fields": {
"exceptions": {
"list": true,
"type": "String"
},
"message": {
"type": "String"
}
},
"doc": "an internal error in signald has occured.",
"error": true
},
"UnknownGroupError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"InvalidRecipientError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"RateLimitError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"ReactRequest": {
"fields": {
"username": {
"type": "String",
"example": "\"+12024561414\"",
"required": true
},
"recipientAddress": {
"type": "JsonAddress",
"version": "v1"
},
"recipientGroupId": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""
},
"reaction": {
"type": "JsonReaction",
"version": "v1",
"required": true
},
"timestamp": {
"type": "long"
}
},
"doc": "react to a previous message"
},
"VersionRequest": {
"fields": {}
},
"JsonVersionMessage": {
"fields": {
"name": {
"type": "String",
"example": "\"signald\""
},
"version": {
"type": "String",
"example": "\"0.15.0-6-7fb32321\""
},
"branch": {
"type": "String",
"example": "\"main\""
},
"commit": {
"type": "String",
"example": "\"7fb323214faf9924355b73a6a383ce8c0137c8d0\""
}
}
},
"AcceptInvitationRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"groupID": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"",
"required": true
}
},
"doc": "Accept a v2 group invitation. Note that you must have a profile name set to join groups."
},
"JsonGroupV2Info": {
"fields": {
"id": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""
},
"revision": {
"type": "int",
"example": "5"
},
"title": {
"type": "String",
"example": "\"Parkdale Run Club\""
},
"description": {
"type": "String"
},
"avatar": {
"type": "String",
"doc": "path to the group's avatar on local disk, if available",
"example": "\"/var/lib/signald/avatars/group-EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""
},
"timer": {
"type": "int",
"example": "604800"
},
"members": {
"list": true,
"type": "JsonAddress",
"version": "v1"
},
"pendingMembers": {
"list": true,
"type": "JsonAddress",
"version": "v1"
},
"requestingMembers": {
"list": true,
"type": "JsonAddress",
"version": "v1"
},
"inviteLink": {
"type": "String",
"doc": "the signal.group link, if applicable"
},
"accessControl": {
"type": "GroupAccessControl",
"version": "v1",
"doc": "current access control settings for this group"
},
"memberDetail": {
"list": true,
"type": "GroupMember",
"version": "v1",
"doc": "detailed member list"
},
"pendingMemberDetail": {
"list": true,
"type": "GroupMember",
"version": "v1",
"doc": "detailed pending member list"
},
"announcements": {
"type": "String",
"doc": "indicates if the group is an announcements group. Only admins are allowed to send messages to announcements groups. Options are UNKNOWN, ENABLED or DISABLED"
}
},
"doc": "Information about a Signal group"
},
"OwnProfileKeyDoesNotExistError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"ApproveMembershipRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"groupID": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"",
"required": true
},
"members": {
"list": true,
"type": "JsonAddress",
"version": "v1",
"doc": "list of requesting members to approve",
"required": true
}
},
"doc": "approve a request to join a group"
},
"GroupVerificationError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"GetGroupRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"groupID": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"",
"required": true
},
"revision": {
"type": "int",
"doc": "the latest known revision, default value (-1) forces fetch from server"
}
},
"doc": "Query the server for the latest state of a known group. If no account in signald is a member of the group (anymore), an error with error_type: 'UnknownGroupError' is returned."
},
"InvalidGroupStateError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"GetLinkedDevicesRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
}
},
"doc": "list all linked devices on a Signal account"
},
"LinkedDevices": {
"fields": {
"devices": {
"list": true,
"type": "DeviceInfo",
"version": "v1"
}
}
},
"JoinGroupRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"uri": {
"type": "String",
"doc": "The signal.group URL",
"example": "\"https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3\"",
"required": true
}
},
"doc": "Join a group using the a signal.group URL. Note that you must have a profile name set to join groups."
},
"JsonGroupJoinInfo": {
"fields": {
"groupID": {
"type": "String",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\""
},
"title": {
"type": "String",
"example": "\"Parkdale Run Club\""
},
"description": {
"type": "String",
"example": "\"A club for running in Parkdale\""
},
"memberCount": {
"type": "int",
"example": "3"
},
"addFromInviteLink": {
"type": "int",
"doc": "The access level required in order to join the group from the invite link, as an AccessControl.AccessRequired enum from the upstream Signal groups.proto file. This is UNSATISFIABLE (4) when the group link is disabled; ADMINISTRATOR (3) when the group link is enabled, but an administrator must approve new members; and ANY (1) when the group link is enabled and no approval is required. See theGroupAccessControl structure and the upstream enum ordinals."
},
"revision": {
"type": "int",
"doc": "The Group V2 revision. This is incremented by clients whenever they update group information, and it is often used by clients to determine if the local group state is out-of-date with the server's revision.",
"example": "5"
},
"pendingAdminApproval": {
"type": "boolean",
"doc": "Whether the account is waiting for admin approval in order to be added to the group."
}
}
},
"InvalidRequestError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"InvalidInviteURIError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"GroupNotActiveError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"RemoveLinkedDeviceRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"deviceId": {
"type": "long",
"doc": "the ID of the device to unlink",
"example": "3",
"required": true
}
},
"doc": "Remove a linked device from the Signal account. Only allowed when the local device id is 1"
},
"UpdateGroupRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The identifier of the account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"groupID": {
"type": "String",
"doc": "the ID of the group to update",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"",
"required": true
},
"title": {
"type": "String",
"example": "\"Parkdale Run Club\""
},
"description": {
"type": "String",
"doc": "A new group description. Set to empty string to remove an existing description.",
"example": "\"A club for running in Parkdale\""
},
"avatar": {
"type": "String",
"example": "\"/tmp/image.jpg\""
},
"updateTimer": {
"type": "int",
"doc": "update the group timer."
},
"addMembers": {
"list": true,
"type": "JsonAddress",
"version": "v1"
},
"removeMembers": {
"list": true,
"type": "JsonAddress",
"version": "v1"
},
"updateRole": {
"type": "GroupMember",
"version": "v1"
},
"updateAccessControl": {
"type": "GroupAccessControl",
"version": "v1",
"doc": "note that only one of the access controls may be updated per request"
},
"resetLink": {
"type": "boolean",
"doc": "regenerate the group link password, invalidating the old one"
},
"announcements": {
"type": "String",
"doc": "ENABLED to only allow admins to post messages, DISABLED to allow anyone to post"
}
},
"doc": "modify a group. Note that only one modification action may be performed at once"
},
"GroupInfo": {
"fields": {
"v1": {
"type": "JsonGroupInfo",
"version": "v1"
},
"v2": {
"type": "JsonGroupV2Info",
"version": "v1"
}
},
"doc": "A generic type that is used when the group version is not known"
},
"SetProfile": {
"fields": {
"account": {
"type": "String",
"doc": "The phone number of the account to use",
"example": "\"+12024561414\"",
"required": true
},
"name": {
"type": "String",
"doc": "New profile name. Set to empty string for no profile name",
"example": "\"signald user\"",
"required": true
},
"avatarFile": {
"type": "String",
"doc": "Path to new profile avatar file. If unset or null, unset the profile avatar",
"example": "\"/tmp/image.jpg\""
},
"about": {
"type": "String",
"doc": "an optional about string. If unset, null or an empty string will unset profile about field"
},
"emoji": {
"type": "String",
"doc": "an optional single emoji character. If unset, null or an empty string will unset profile emoji"
},
"mobilecoin_address": {
"type": "String",
"doc": "an optional *base64-encoded* MobileCoin address to set in the profile. Note that this is not the traditional MobileCoin address encoding, which is custom. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side. If unset, null or an empty string, will empty the profile payment address"
}
}
},
"InvalidBase64Error": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"ResolveAddressRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The signal account to use",
"example": "\"+12024561414\"",
"required": true
},
"partial": {
"type": "JsonAddress",
"version": "v1",
"doc": "The partial address, missing fields",
"required": true
}
},
"doc": "Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn't resolve all the partials it returns."
},
"JsonAddress": {
"fields": {
"number": {
"type": "String",
"doc": "An e164 phone number, starting with +. Currently the only available user-facing Signal identifier.",
"example": "\"+13215551234\""
},
"uuid": {
"type": "UUID",
"doc": "A UUID, the unique identifier for a particular Signal account."
},
"relay": {
"type": "String"
}
}
},
"MarkReadRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"to": {
"type": "JsonAddress",
"version": "v1",
"doc": "The address that sent the message being marked as read",
"required": true
},
"timestamps": {
"list": true,
"type": "Long",
"doc": "List of messages to mark as read",
"example": "1615576442475",
"required": true
},
"when": {
"type": "Long"
}
}
},
"UntrustedIdentityError": {
"fields": {
"identifier": {
"type": "String"
},
"message": {
"type": "String"
},
"identity_key": {
"type": "IdentityKey",
"version": "v1"
}
},
"error": true
},
"GetProfileRequest": {
"fields": {
"account": {
"type": "String",
"doc": "the signald account to use",
"required": true
},
"async": {
"type": "boolean",
"doc": "if true, return results from local store immediately, refreshing from server in the background if needed. if false (default), block until profile can be retrieved from server"
},
"address": {
"type": "JsonAddress",
"version": "v1",
"doc": "the address to look up",
"required": true
}
},
"doc": "Get all information available about a user"
},
"Profile": {
"fields": {
"name": {
"type": "String",
"doc": "The user's name from local contact names if available, or if not in contact list their Signal profile name"
},
"avatar": {
"type": "String",
"doc": "path to avatar on local disk"
},
"address": {
"type": "JsonAddress",
"version": "v1"
},
"capabilities": {
"type": "Capabilities",
"version": "v1"
},
"color": {
"type": "String",
"doc": "color of the chat with this user"
},
"about": {
"type": "String"
},
"emoji": {
"type": "String"
},
"profile_name": {
"type": "String",
"doc": "The user's Signal profile name"
},
"inbox_position": {
"type": "Integer"
},
"expiration_time": {
"type": "int"
},
"mobilecoin_address": {
"type": "String",
"doc": "*base64-encoded* mobilecoin address. Note that this is not the traditional MobileCoin address encoding. Clients are responsible for converting between MobileCoin's custom base58 on the user-facing side and base64 encoding on the signald side. If unset, null or an empty string, will empty the profile payment address"
}
},
"doc": "Information about a Signal user"
},
"ProfileUnavailableError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"ListGroupsRequest": {
"fields": {
"account": {
"type": "String",
"required": true
}
}
},
"GroupList": {
"fields": {
"groups": {
"list": true,
"type": "JsonGroupV2Info",
"version": "v1"
},
"legacyGroups": {
"list": true,
"type": "JsonGroupInfo",
"version": "v1"
}
}
},
"ListContactsRequest": {
"fields": {
"account": {
"type": "String",
"required": true
},
"async": {
"type": "boolean",
"doc": "return results from local store immediately, refreshing from server afterward if needed. If false (default), block until all pending profiles have been retrieved."
}
}
},
"ProfileList": {
"fields": {
"profiles": {
"list": true,
"type": "Profile",
"version": "v1"
}
}
},
"CreateGroupRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to interact with",
"example": "\"+12024561414\"",
"required": true
},
"title": {
"type": "String",
"example": "\"Parkdale Run Club\"",
"required": true
},
"avatar": {
"type": "String",
"example": "\"/tmp/image.jpg\""
},
"members": {
"list": true,
"type": "JsonAddress",
"version": "v1",
"required": true
},
"timer": {
"type": "int",
"doc": "the message expiration timer"
},
"member_role": {
"type": "String",
"doc": "The role of all members other than the group creator. Options are ADMINISTRATOR or DEFAULT (case insensitive)",
"example": "\"ADMINISTRATOR\""
}
}
},
"NoKnownUUIDError": {
"fields": {
"message": {
"type": "String"
}
},
"error": true
},
"LeaveGroupRequest": {
"fields": {
"account": {
"type": "String",
"doc": "The account to use",
"example": "\"+12024561414\"",
"required": true
},
"groupID": {
"type": "String",
"doc": "The group to leave",
"example": "\"EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=\"",
"required": true
}
}
},
"GenerateLinkingURIRequest": {
"fields": {
"server": {
"type": "String",
"doc": "The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)"
}
},
"doc": "Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request."
},
"LinkingURI": {
"fields": {
"uri": {
"type": "String"