forked from tdlib/telegram-bot-api
-
Notifications
You must be signed in to change notification settings - Fork 27
/
tdlight-api-openapi.yaml
12426 lines (12370 loc) · 552 KB
/
tdlight-api-openapi.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
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
openapi: 3.0.0
info:
title: tdlight Bot API
description: OpenAPI schema for the tdlight bot api
version: 5.0.0
servers:
- url: 'https://botapi.giuseppem99.xyz/{type}{token}'
variables:
type:
default: bot
enum:
- bot
- user
token:
default: '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11'
description: Each bot is given a unique authentication token when it is created and each user is given a unique authentication token when logging in.
- url: 'https://telegram.rest/{type}{token}'
variables:
type:
default: bot
enum:
- bot
- user
token:
default: '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11'
description: Each bot is given a unique authentication token when it is created and each user is given a unique authentication token when logging in.
- url: '{base_url}/{type}{token}'
variables:
base_url:
default: 'https://botapi.giuseppem99.xyz'
description: Base url of the tdlight bot api server
type:
default: bot
enum:
- bot
- user
token:
default: '123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11'
description: Each bot is given a unique authentication token when it is created and each user is given a unique authentication token when logging in.
tags:
- name: added
description: Added Methods in the tdlight-bot-api
- name: user-only
description: These methods can only be called as user
- name: modified
description: These methods are modified in the tdlight-bot-api
paths:
/userLogin:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Use this method to receive the authorization token to log in as user.
Note: You don't have your token yet, so the domain is just {base_url}/userLogin
Returns an `AuthorizationState` with the user token on success.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
phone_number:
description: Your phone number to log in.
type: string
required:
- phone_number
multipart/form-data:
schema:
type: object
properties:
phone_number:
description: Your phone number to log in.
type: string
required:
- phone_number
application/json:
schema:
type: object
properties:
phone_number:
description: Your phone number to log in.
type: string
required:
- phone_number
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
$ref: '#/components/schemas/AuthorizationState'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
servers:
- url: '{base_url}'
description: Custom Endpoint to get the user token.
variables:
base_url:
default: 'https://botapi.giuseppem99.xyz'
description: Base url of the tdlight bot api server
/authCode:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Use this method in the authorization process to check your authentication code. Returns an `AuthorizationState` on success.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
code:
description: 'The verification code received via SMS, Telegram message, phone call, or flash call.'
type: integer
required:
- code
multipart/form-data:
schema:
type: object
properties:
code:
description: 'The verification code received via SMS, Telegram message, phone call, or flash call.'
type: integer
required:
- code
application/json:
schema:
type: object
properties:
code:
description: 'The verification code received via SMS, Telegram message, phone call, or flash call.'
type: integer
required:
- code
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
$ref: '#/components/schemas/AuthorizationState'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/authPassword:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Use this method in the authorization process to check your 2-factor-authorization password for correctness. Returns an `AuthorizationState` on success.
*Never* send your password over a plain http connection. Make sure https is enabled or use this API locally.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
password:
description: The password to check.
type: string
required:
- password
multipart/form-data:
schema:
type: object
properties:
password:
description: The password to check.
type: string
required:
- password
application/json:
schema:
type: object
properties:
password:
description: The password to check.
type: string
required:
- password
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
$ref: '#/components/schemas/AuthorizationState'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/registerUser:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Use this method to register a new user account. Only works after sending the authcode if the user is not yet registered. Returns an `AuthorizationState` on success.
User registration is disabled by default. You can enable it with the `--allow-users-registration` command line option or the env variable `TELEGRAM_ALLOW_USERS_REGISTRATION` set to `1` when using docker.s
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
first_name:
description: The first name of the user; 1-64 characters.
type: string
last_name:
description: The last name of the user; 0-64 characters.
type: string
disable_notification:
description: Disables "user joined Telegram" notification for other users that have the contact in their contact list.
default: false
type: boolean
required:
- first_name
multipart/form-data:
schema:
type: object
properties:
first_name:
description: The first name of the user; 1-64 characters.
type: string
last_name:
description: The last name of the user; 0-64 characters.
type: string
disable_notification:
description: Disables "user joined Telegram" notification for other users that have the contact in their contact list.
default: false
type: boolean
required:
- first_name
application/json:
schema:
type: object
properties:
first_name:
description: The first name of the user; 1-64 characters.
type: string
last_name:
description: The last name of the user; 0-64 characters.
type: string
disable_notification:
description: Disables "user joined Telegram" notification for other users that have the contact in their contact list.
default: false
type: boolean
required:
- first_name
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
$ref: '#/components/schemas/AuthorizationState'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/optimizeMemory:
post:
tags:
- added
description: Calling `optimizeMemory` will remove old data from the in-memory cache and give the freed memory back to the os. Returns *True* on success.
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
default: true
type: boolean
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getMessageInfo:
post:
tags:
- added
description: Get information about a message. Returns a `Message` on success.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Message identifier in the chat specified in *from\_chat\_id*
type: integer
required:
- chat_id
- message_id
multipart/form-data:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Message identifier in the chat specified in *from\_chat\_id*
type: integer
required:
- chat_id
- message_id
application/json:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Message identifier in the chat specified in *from\_chat\_id*
type: integer
required:
- chat_id
- message_id
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
$ref: '#/components/schemas/Message'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getChatMembers:
post:
tags:
- added
description: |-
Use this method to get a list of members in a chat. On success, returns an Array of [ChatMember](https://core.telegram.org/bots/api/#chatmember) objects that contains information about all chat members. Administrator privileges may be required for some filters.
Telegram only returns up to 10,000 members per group using this method. If you want to get more members, you can try to fetch additional users with different `query` parameters
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
filter:
description: 'Filter the members you want to get. Must be one of `members`, `banned`, `restricted`, `bots` or `admins`. Only works in supergroups and channels. Administrator privileges may be required for some filters.'
type: string
enum:
- members
- banned
- restricted
- bots
- admins
query:
description: Query to search for in names and usernames
type: string
offset:
description: Number of users to skip.
type: integer
limit:
description: The maximum number of users be returned; up to 200.
type: integer
minimum: 1
maximum: 200
required:
- chat_id
multipart/form-data:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
filter:
description: 'Filter the members you want to get. Must be one of `members`, `banned`, `restricted`, `bots` or `admins`. Only works in supergroups and channels. Administrator privileges may be required for some filters.'
type: string
enum:
- members
- banned
- restricted
- bots
- admins
query:
description: Query to search for in names and usernames
type: string
offset:
description: Number of users to skip.
type: integer
limit:
description: The maximum number of users be returned; up to 200.
type: integer
minimum: 1
maximum: 200
required:
- chat_id
application/json:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target supergroup or channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
filter:
description: 'Filter the members you want to get. Must be one of `members`, `banned`, `restricted`, `bots` or `admins`. Only works in supergroups and channels. Administrator privileges may be required for some filters.'
type: string
enum:
- members
- banned
- restricted
- bots
- admins
query:
description: Query to search for in names and usernames
type: string
offset:
description: Number of users to skip.
type: integer
limit:
description: The maximum number of users be returned; up to 200.
type: integer
minimum: 1
maximum: 200
required:
- chat_id
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: array
items:
$ref: '#/components/schemas/ChatMember'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/deleteMessages:
post:
tags:
- modified
description: |-
Use this method to delete multiple messages simultaneously.
This method can delete a set of message ids, or a range of message ids.
If you specify "message_ids", this method tries to delete the specified set of ids:
If some of the specified messages can't be found, they are skipped.
Returns True on success.
If you specify "start" and "end", this method deletes all the messages with message_id in range between start and end:
The start parameter MUST be less than the end parameter
Both start and end must be positive non zero numbers
The method will always return true as a result, even if the messages cannot be deleted
This method does not work on private chat or normal groups It is not suggested to delete more than 200 messages per call.
*NOTE*
The maximum number of messages to be deleted in a single batch is determined by the max-batch-operations parameter and is 10000 by default.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_ids:
type: array
items:
type: integer
start:
description: First message id to delete
type: integer
end:
description: Last message id to delete
type: integer
required:
- chat_id
multipart/form-data:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_ids:
type: array
items:
type: integer
start:
description: First message id to delete
type: integer
end:
description: Last message id to delete
type: integer
required:
- chat_id
application/json:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_ids:
type: array
items:
type: integer
start:
description: First message id to delete
type: integer
end:
description: Last message id to delete
type: integer
required:
- chat_id
required: true
responses:
'200':
description: 'Request was successful, the result is returned.'
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
default: true
type: boolean
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/ping:
post:
tags:
- added
description: Send an MTProto ping message to the telegram servers. Useful to detect the delay of the bot api server. Returns the time in seconds as double-precision floating-point number.
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: number
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getChats:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Returns an ordered list of chats. For optimal performance the number of returned chats is chosen by the library.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
multipart/form-data:
schema:
type: object
properties:
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
application/json:
schema:
type: object
properties:
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: array
items:
$ref: '#/components/schemas/Chat'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getCommonChats:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Returns list of chats you have in commen with the other user. Currently returns an Error because of a tdlight bug. For optimal performance the number of returned chats is chosen by the library.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
user_id:
description: Unique identifier of the target user
type: integer
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
required:
- user_id
multipart/form-data:
schema:
type: object
properties:
user_id:
description: Unique identifier of the target user
type: integer
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
required:
- user_id
application/json:
schema:
type: object
properties:
user_id:
description: Unique identifier of the target user
type: integer
offset_chat_id:
description: Chat identifier to return chats from.
type: integer
required:
- user_id
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: array
items:
$ref: '#/components/schemas/Chat'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/getInactiveChats:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Returns a list of recently inactive supergroups and channels. Can be used when user reaches limit on the number of joined supergroups and channels and receives CHANNELS_TOO_MUCH error.
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: array
items:
$ref: '#/components/schemas/Chat'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/searchPublicChats:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Searches public chats by looking for specified query in their username and title. Currently only private chats, supergroups and channels can be public. Returns a meaningful number of results. Returns nothing if the length of the searched username prefix is less than 5. Excludes private chats with contacts and chats from the chat list from the results.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
query:
description: Query to search for.
type: string
required:
- query
multipart/form-data:
schema:
type: object
properties:
query:
description: Query to search for.
type: string
required:
- query
application/json:
schema:
type: object
properties:
query:
description: Query to search for.
type: string
required:
- query
required: true
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
ok:
default: true
type: boolean
result:
type: array
items:
$ref: '#/components/schemas/Chat'
required:
- ok
- result
default:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
/setPollAnswer:
post:
tags:
- added
- user-only
description: |-
*ONLY FOR USERS*
Changes the user answer to a poll. A poll in quiz mode can be answered only once. Send an empty array of `option_ids` to retract your vote.
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Identifier of the message containing the poll.
type: integer
option_ids:
description: 0-based identifiers of answer options, chosen by the user. User can choose more than 1 answer option only is the poll allows multiple answers.
type: array
items:
anyOf:
- type: integer
required:
- chat_id
- message_id
- option_ids
multipart/form-data:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Identifier of the message containing the poll.
type: integer
option_ids:
description: 0-based identifiers of answer options, chosen by the user. User can choose more than 1 answer option only is the poll allows multiple answers.
type: array
items:
anyOf:
- type: integer
required:
- chat_id
- message_id
- option_ids
application/json:
schema:
type: object
properties:
chat_id:
description: Unique identifier for the target chat or username of the target channel (in the format `@channelusername`)
anyOf:
- type: integer
- type: string
message_id:
description: Identifier of the message containing the poll.
type: integer
option_ids:
description: 0-based identifiers of answer options, chosen by the user. User can choose more than 1 answer option only is the poll allows multiple answers.
type: array
items:
anyOf:
- type: integer
required:
- chat_id
- message_id
- option_ids
required: true
responses:
'200':
description: ''