-
-
Notifications
You must be signed in to change notification settings - Fork 40
/
methods.go
4526 lines (3633 loc) · 203 KB
/
methods.go
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
package telego
import (
"fmt"
ta "github.com/mymmrac/telego/telegoapi"
)
// GetUpdatesParams - Represents parameters of getUpdates method.
type GetUpdatesParams struct {
// Offset - Optional. Identifier of the first update to be returned. Must be greater by one than the highest
// among the identifiers of previously received updates. By default, updates starting with the earliest
// unconfirmed update are returned. An update is considered confirmed as soon as getUpdates
// (https://core.telegram.org/bots/api#getupdates) is called with an offset higher than its update_id. The
// negative offset can be specified to retrieve updates starting from -offset update from the end of the updates
// queue. All previous updates will be forgotten.
Offset int `json:"offset,omitempty"`
// Limit - Optional. Limits the number of updates to be retrieved. Values between 1-100 are accepted.
// Defaults to 100.
Limit int `json:"limit,omitempty"`
// Timeout - Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling. Should
// be positive, short polling should be used for testing purposes only.
Timeout int `json:"timeout,omitempty"`
// AllowedUpdates - Optional. A JSON-serialized list of the update types you want your bot to receive. For
// example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types.
// See Update (https://core.telegram.org/bots/api#update) for a complete list of available update types. Specify
// an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count
// (default). If not specified, the previous setting will be used.
// Please note that this parameter doesn't affect updates created before the call to the getUpdates, so unwanted
// updates may be received for a short period of time.
AllowedUpdates []string `json:"allowed_updates,omitempty"`
}
// Update types you want your bot to receive
const (
MessageUpdates = "message"
EditedMessageUpdates = "edited_message"
ChannelPostUpdates = "channel_post"
EditedChannelPostUpdates = "edited_channel_post"
MessageReaction = "message_reaction"
MessageReactionCount = "message_reaction_count"
InlineQueryUpdates = "inline_query"
ChosenInlineResultUpdates = "chosen_inline_result"
CallbackQueryUpdates = "callback_query"
ShippingQueryUpdates = "shipping_query"
PreCheckoutQueryUpdates = "pre_checkout_query"
PollUpdates = "poll"
PollAnswerUpdates = "poll_answer"
MyChatMemberUpdates = "my_chat_member"
ChatMemberUpdates = "chat_member"
ChatJoinRequestUpdates = "chat_join_request"
)
// GetUpdates - Use this method to receive incoming updates using long polling (wiki
// (https://en.wikipedia.org/wiki/Push_technology#Long_polling)). Returns an Array of Update
// (https://core.telegram.org/bots/api#update) objects.
func (b *Bot) GetUpdates(params *GetUpdatesParams) ([]Update, error) {
var updates []Update
err := b.performRequest("getUpdates", params, &updates)
if err != nil {
return nil, fmt.Errorf("telego: getUpdates(): %w", err)
}
return updates, nil
}
// SetWebhookParams - Represents parameters of setWebhook method.
type SetWebhookParams struct {
// URL - HTTPS URL to send updates to. Use an empty string to remove webhook integration
URL string `json:"url"`
// Certificate - Optional. Upload your public key certificate so that the root certificate in use can be
// checked. See our self-signed guide (https://core.telegram.org/bots/self-signed) for details.
// Please upload as File, sending a FileID or URL will not work.
Certificate *InputFile `json:"certificate,omitempty"`
// IPAddress - Optional. The fixed IP address which will be used to send webhook requests instead of the IP
// address resolved through DNS
IPAddress string `json:"ip_address,omitempty"`
// MaxConnections - Optional. The maximum allowed number of simultaneous HTTPS connections to the webhook
// for update delivery, 1-100. Defaults to 40. Use lower values to limit the load on your bot's server, and
// higher values to increase your bot's throughput.
MaxConnections int `json:"max_connections,omitempty"`
// AllowedUpdates - Optional. A JSON-serialized list of the update types you want your bot to receive. For
// example, specify ["message", "edited_channel_post", "callback_query"] to only receive updates of these types.
// See Update (https://core.telegram.org/bots/api#update) for a complete list of available update types. Specify
// an empty list to receive all update types except chat_member, message_reaction, and message_reaction_count
// (default). If not specified, the previous setting will be used.
// Please note that this parameter doesn't affect updates created before the call to the setWebhook, so unwanted
// updates may be received for a short period of time.
AllowedUpdates []string `json:"allowed_updates,omitempty"`
// DropPendingUpdates - Optional. Pass True to drop all pending updates
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
// SecretToken - Optional. A secret token to be sent in a header “X-Telegram-Bot-Api-Secret-Token” in
// every webhook request, 1-256 characters. Only characters A-Z, a-z, 0-9, _ and - are allowed. The header is
// useful to ensure that the request comes from a webhook set by you.
SecretToken string `json:"secret_token,omitempty"`
}
func (p *SetWebhookParams) fileParameters() map[string]ta.NamedReader {
fp := make(map[string]ta.NamedReader)
if p.Certificate != nil {
fp["certificate"] = p.Certificate.File
}
return fp
}
// SetWebhook - Use this method to specify a URL and receive incoming updates via an outgoing webhook.
// Whenever there is an update for the bot, we will send an HTTPS POST request to the specified URL, containing
// a JSON-serialized Update (https://core.telegram.org/bots/api#update). In case of an unsuccessful request, we
// will give up after a reasonable amount of attempts. Returns True on success.
// If you'd like to make sure that the webhook was set by you, you can specify secret data in the parameter
// secret_token. If specified, the request will contain a header “X-Telegram-Bot-Api-Secret-Token” with the
// secret token as content.
func (b *Bot) SetWebhook(params *SetWebhookParams) error {
err := b.performRequest("setWebhook", params)
if err != nil {
return fmt.Errorf("telego: setWebhook(): %w", err)
}
return nil
}
// DeleteWebhookParams - Represents parameters of deleteWebhook method.
type DeleteWebhookParams struct {
// DropPendingUpdates - Optional. Pass True to drop all pending updates
DropPendingUpdates bool `json:"drop_pending_updates,omitempty"`
}
// DeleteWebhook - Use this method to remove webhook integration if you decide to switch back to getUpdates
// (https://core.telegram.org/bots/api#getupdates). Returns True on success.
func (b *Bot) DeleteWebhook(params *DeleteWebhookParams) error {
err := b.performRequest("deleteWebhook", params)
if err != nil {
return fmt.Errorf("telego: deleteWebhook(): %w", err)
}
return nil
}
// GetWebhookInfo - Use this method to get current webhook status. Requires no parameters. On success,
// returns a WebhookInfo (https://core.telegram.org/bots/api#webhookinfo) object. If the bot is using getUpdates
// (https://core.telegram.org/bots/api#getupdates), will return an object with the URL field empty.
func (b *Bot) GetWebhookInfo() (*WebhookInfo, error) {
var webhookInfo *WebhookInfo
err := b.performRequest("getWebhookInfo", nil, &webhookInfo)
if err != nil {
return nil, fmt.Errorf("telego: getWebhookInfo(): %w", err)
}
return webhookInfo, nil
}
// GetMe - A simple method for testing your bot's authentication token. Requires no parameters. Returns basic
// information about the bot in form of a User (https://core.telegram.org/bots/api#user) object.
func (b *Bot) GetMe() (*User, error) {
var user *User
err := b.performRequest("getMe", nil, &user)
if err != nil {
return nil, fmt.Errorf("telego: getMe(): %w", err)
}
return user, nil
}
// LogOut - Use this method to log out from the cloud Bot API server before launching the bot locally. You
// must log out the bot before running it locally, otherwise there is no guarantee that the bot will receive
// updates. After a successful call, you can immediately log in on a local server, but will not be able to log
// in back to the cloud Bot API server for 10 minutes. Returns True on success. Requires no parameters.
func (b *Bot) LogOut() error {
err := b.performRequest("logOut", nil)
if err != nil {
return fmt.Errorf("telego: logOut(): %w", err)
}
return nil
}
// Close - Use this method to close the bot instance before moving it from one local server to another. You
// need to delete the webhook before calling this method to ensure that the bot isn't launched again after
// server restart. The method will return error 429 in the first 10 minutes after the bot is launched. Returns
// True on success. Requires no parameters.
func (b *Bot) Close() error {
err := b.performRequest("close", nil)
if err != nil {
return fmt.Errorf("telego: close(): %w", err)
}
return nil
}
// SendMessageParams - Represents parameters of sendMessage method.
type SendMessageParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Text - Text of the message to be sent, 1-4096 characters after entities parsing
Text string `json:"text"`
// ParseMode - Optional. Mode for parsing entities in the message text. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// Entities - Optional. A JSON-serialized list of special entities that appear in message text, which can be
// specified instead of parse_mode
Entities []MessageEntity `json:"entities,omitempty"`
// LinkPreviewOptions - Optional. Link preview generation options for the message
LinkPreviewOptions *LinkPreviewOptions `json:"link_preview_options,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
// Parse modes
const (
ModeHTML = "HTML"
ModeMarkdown = "Markdown"
ModeMarkdownV2 = "MarkdownV2"
)
// SendMessage - Use this method to send text messages. On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned.
func (b *Bot) SendMessage(params *SendMessageParams) (*Message, error) {
var message *Message
err := b.performRequest("sendMessage", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendMessage(): %w", err)
}
return message, nil
}
// ForwardMessageParams - Represents parameters of forwardMessage method.
type ForwardMessageParams struct {
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// FromChatID - Unique identifier for the chat where the original message was sent (or channel username in
// the format @channel_username)
FromChatID ChatID `json:"from_chat_id"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the forwarded message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageID - Message identifier in the chat specified in from_chat_id
MessageID int `json:"message_id"`
}
// ForwardMessage - Use this method to forward messages of any kind. Service messages and messages with
// protected content can't be forwarded. On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned.
func (b *Bot) ForwardMessage(params *ForwardMessageParams) (*Message, error) {
var message *Message
err := b.performRequest("forwardMessage", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: forwardMessage(): %w", err)
}
return message, nil
}
// ForwardMessagesParams - Represents parameters of forwardMessages method.
type ForwardMessagesParams struct {
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// FromChatID - Unique identifier for the chat where the original messages were sent (or channel username in
// the format @channel_username)
FromChatID ChatID `json:"from_chat_id"`
// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to forward.
// The identifiers must be specified in a strictly increasing order.
MessageIDs []int `json:"message_ids"`
// DisableNotification - Optional. Sends the messages silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the forwarded messages from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
}
// ForwardMessages - Use this method to forward multiple messages of any kind. If some of the specified
// messages can't be found or forwarded, they are skipped. Service messages and messages with protected content
// can't be forwarded. Album grouping is kept for forwarded messages. On success, an array of MessageID
// (https://core.telegram.org/bots/api#messageid) of the sent messages is returned.
func (b *Bot) ForwardMessages(params *ForwardMessagesParams) (*MessageID, error) {
var messageID *MessageID
err := b.performRequest("forwardMessages", params, &messageID)
if err != nil {
return nil, fmt.Errorf("telego: forwardMessages(): %w", err)
}
return messageID, nil
}
// CopyMessageParams - Represents parameters of copyMessage method.
type CopyMessageParams struct {
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// FromChatID - Unique identifier for the chat where the original message was sent (or channel username in
// the format @channel_username)
FromChatID ChatID `json:"from_chat_id"`
// MessageID - Message identifier in the chat specified in from_chat_id
MessageID int `json:"message_id"`
// Caption - Optional. New caption for media, 0-1024 characters after entities parsing. If not specified,
// the original caption is kept
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the new caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the new caption,
// which can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// ShowCaptionAboveMedia - Optional. Pass True, if the caption must be shown above the message media.
// Ignored if a new caption isn't specified.
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
// CopyMessage - Use this method to copy messages of any kind. Service messages, paid media messages,
// giveaway messages, giveaway winners messages, and invoice messages can't be copied. A quiz poll
// (https://core.telegram.org/bots/api#poll) can be copied only if the value of the field correct_option_id is
// known to the bot. The method is analogous to the method forwardMessage
// (https://core.telegram.org/bots/api#forwardmessage), but the copied message doesn't have a link to the
// original message. Returns the MessageID (https://core.telegram.org/bots/api#messageid) of the sent message on
// success.
func (b *Bot) CopyMessage(params *CopyMessageParams) (*MessageID, error) {
var messageID *MessageID
err := b.performRequest("copyMessage", params, &messageID)
if err != nil {
return nil, fmt.Errorf("telego: copyMessage(): %w", err)
}
return messageID, nil
}
// CopyMessagesParams - Represents parameters of copyMessages method.
type CopyMessagesParams struct {
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// FromChatID - Unique identifier for the chat where the original messages were sent (or channel username in
// the format @channel_username)
FromChatID ChatID `json:"from_chat_id"`
// MessageIDs - A JSON-serialized list of 1-100 identifiers of messages in the chat from_chat_id to copy.
// The identifiers must be specified in a strictly increasing order.
MessageIDs []int `json:"message_ids"`
// DisableNotification - Optional. Sends the messages silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent messages from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// RemoveCaption - Optional. Pass True to copy the messages without their captions
RemoveCaption bool `json:"remove_caption,omitempty"`
}
// CopyMessages - Use this method to copy messages of any kind. If some of the specified messages can't be
// found or copied, they are skipped. Service messages, paid media messages, giveaway messages, giveaway winners
// messages, and invoice messages can't be copied. A quiz poll (https://core.telegram.org/bots/api#poll) can be
// copied only if the value of the field correct_option_id is known to the bot. The method is analogous to the
// method forwardMessages (https://core.telegram.org/bots/api#forwardmessages), but the copied messages don't
// have a link to the original message. Album grouping is kept for copied messages. On success, an array of
// MessageID (https://core.telegram.org/bots/api#messageid) of the sent messages is returned.
func (b *Bot) CopyMessages(params *CopyMessagesParams) (*MessageID, error) {
var messageID *MessageID
err := b.performRequest("copyMessages", params, &messageID)
if err != nil {
return nil, fmt.Errorf("telego: copyMessages(): %w", err)
}
return messageID, nil
}
// SendPhotoParams - Represents parameters of sendPhoto method.
type SendPhotoParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Photo - Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers
// (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new
// photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must
// not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Photo InputFile `json:"photo"`
// Caption - Optional. Photo caption (may also be used when resending photos by file_id), 0-1024 characters
// after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the photo caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// ShowCaptionAboveMedia - Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
// HasSpoiler - Optional. Pass True if the photo needs to be covered with a spoiler animation
HasSpoiler bool `json:"has_spoiler,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendPhotoParams) fileParameters() map[string]ta.NamedReader {
return map[string]ta.NamedReader{
"photo": p.Photo.File,
}
}
// SendPhoto - Use this method to send photos. On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned.
func (b *Bot) SendPhoto(params *SendPhotoParams) (*Message, error) {
var message *Message
err := b.performRequest("sendPhoto", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendPhoto(): %w", err)
}
return message, nil
}
// SendAudioParams - Represents parameters of sendAudio method.
type SendAudioParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Audio - Audio file to send. Pass a file_id as String to send an audio file that exists on the Telegram
// servers (recommended), pass an HTTP URL as a String for Telegram to get an audio file from the Internet, or
// upload a new one using multipart/form-data. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Audio InputFile `json:"audio"`
// Caption - Optional. Audio caption, 0-1024 characters after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the audio caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Duration - Optional. Duration of the audio in seconds
Duration int `json:"duration,omitempty"`
// Performer - Optional. Performer
Performer string `json:"performer,omitempty"`
// Title - Optional. Track name
Title string `json:"title,omitempty"`
// Thumbnail - Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
// <file_attach_name>. More information on Sending Files » (https://core.telegram.org/bots/api#sending-files)
Thumbnail *InputFile `json:"thumbnail,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendAudioParams) fileParameters() map[string]ta.NamedReader {
fp := make(map[string]ta.NamedReader)
fp["audio"] = p.Audio.File
if p.Thumbnail != nil {
fp["thumbnail"] = p.Thumbnail.File
}
return fp
}
// SendAudio - Use this method to send audio files, if you want Telegram clients to display them in the music
// player. Your audio must be in the .MP3 or .M4A format. On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned. Bots can currently send audio files of up to 50 MB
// in size, this limit may be changed in the future.
// For sending voice messages, use the sendVoice (https://core.telegram.org/bots/api#sendvoice) method instead.
func (b *Bot) SendAudio(params *SendAudioParams) (*Message, error) {
var message *Message
err := b.performRequest("sendAudio", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendAudio(): %w", err)
}
return message, nil
}
// SendDocumentParams - Represents parameters of sendDocument method.
type SendDocumentParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Document - File to send. Pass a file_id as String to send a file that exists on the Telegram servers
// (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one
// using multipart/form-data. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Document InputFile `json:"document"`
// Thumbnail - Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
// <file_attach_name>. More information on Sending Files » (https://core.telegram.org/bots/api#sending-files)
Thumbnail *InputFile `json:"thumbnail,omitempty"`
// Caption - Optional. Document caption (may also be used when resending documents by file_id), 0-1024
// characters after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the document caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// DisableContentTypeDetection - Optional. Disables automatic server-side content type detection for files
// uploaded using multipart/form-data
DisableContentTypeDetection bool `json:"disable_content_type_detection,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendDocumentParams) fileParameters() map[string]ta.NamedReader {
fp := make(map[string]ta.NamedReader)
fp["document"] = p.Document.File
if p.Thumbnail != nil {
fp["thumbnail"] = p.Thumbnail.File
}
return fp
}
// SendDocument - Use this method to send general files. On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned. Bots can currently send files of any type of up to
// 50 MB in size, this limit may be changed in the future.
func (b *Bot) SendDocument(params *SendDocumentParams) (*Message, error) {
var message *Message
err := b.performRequest("sendDocument", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendDocument(): %w", err)
}
return message, nil
}
// SendVideoParams - Represents parameters of sendVideo method.
type SendVideoParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Video - Video to send. Pass a file_id as String to send a video that exists on the Telegram servers
// (recommended), pass an HTTP URL as a String for Telegram to get a video from the Internet, or upload a new
// video using multipart/form-data. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Video InputFile `json:"video"`
// Duration - Optional. Duration of sent video in seconds
Duration int `json:"duration,omitempty"`
// Width - Optional. Video width
Width int `json:"width,omitempty"`
// Height - Optional. Video height
Height int `json:"height,omitempty"`
// Thumbnail - Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
// <file_attach_name>. More information on Sending Files » (https://core.telegram.org/bots/api#sending-files)
Thumbnail *InputFile `json:"thumbnail,omitempty"`
// Caption - Optional. Video caption (may also be used when resending videos by file_id), 0-1024 characters
// after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the video caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// ShowCaptionAboveMedia - Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
// HasSpoiler - Optional. Pass True if the video needs to be covered with a spoiler animation
HasSpoiler bool `json:"has_spoiler,omitempty"`
// SupportsStreaming - Optional. Pass True if the uploaded video is suitable for streaming
SupportsStreaming bool `json:"supports_streaming,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendVideoParams) fileParameters() map[string]ta.NamedReader {
fp := make(map[string]ta.NamedReader)
fp["video"] = p.Video.File
if p.Thumbnail != nil {
fp["thumbnail"] = p.Thumbnail.File
}
return fp
}
// SendVideo - Use this method to send video files, Telegram clients support MPEG4 videos (other formats may
// be sent as Document (https://core.telegram.org/bots/api#document)). On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned. Bots can currently send video files of up to 50 MB
// in size, this limit may be changed in the future.
func (b *Bot) SendVideo(params *SendVideoParams) (*Message, error) {
var message *Message
err := b.performRequest("sendVideo", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendVideo(): %w", err)
}
return message, nil
}
// SendAnimationParams - Represents parameters of sendAnimation method.
type SendAnimationParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Animation - Animation to send. Pass a file_id as String to send an animation that exists on the Telegram
// servers (recommended), pass an HTTP URL as a String for Telegram to get an animation from the Internet, or
// upload a new animation using multipart/form-data. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Animation InputFile `json:"animation"`
// Duration - Optional. Duration of sent animation in seconds
Duration int `json:"duration,omitempty"`
// Width - Optional. Animation width
Width int `json:"width,omitempty"`
// Height - Optional. Animation height
Height int `json:"height,omitempty"`
// Thumbnail - Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
// supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's
// width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
// Thumbnails can't be reused and can be only uploaded as a new file, so you can pass
// “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under
// <file_attach_name>. More information on Sending Files » (https://core.telegram.org/bots/api#sending-files)
Thumbnail *InputFile `json:"thumbnail,omitempty"`
// Caption - Optional. Animation caption (may also be used when resending animation by file_id), 0-1024
// characters after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the animation caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// ShowCaptionAboveMedia - Optional. Pass True, if the caption must be shown above the message media
ShowCaptionAboveMedia bool `json:"show_caption_above_media,omitempty"`
// HasSpoiler - Optional. Pass True if the animation needs to be covered with a spoiler animation
HasSpoiler bool `json:"has_spoiler,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendAnimationParams) fileParameters() map[string]ta.NamedReader {
fp := make(map[string]ta.NamedReader)
fp["animation"] = p.Animation.File
if p.Thumbnail != nil {
fp["thumbnail"] = p.Thumbnail.File
}
return fp
}
// SendAnimation - Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On
// success, the sent Message (https://core.telegram.org/bots/api#message) is returned. Bots can currently send
// animation files of up to 50 MB in size, this limit may be changed in the future.
func (b *Bot) SendAnimation(params *SendAnimationParams) (*Message, error) {
var message *Message
err := b.performRequest("sendAnimation", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendAnimation(): %w", err)
}
return message, nil
}
// SendVoiceParams - Represents parameters of sendVoice method.
type SendVoiceParams struct {
// BusinessConnectionID - Optional. Unique identifier of the business connection on behalf of which the
// message will be sent
BusinessConnectionID string `json:"business_connection_id,omitempty"`
// ChatID - Unique identifier for the target chat or username of the target channel (in the format
// @channel_username)
ChatID ChatID `json:"chat_id"`
// MessageThreadID - Optional. Unique identifier for the target message thread (topic) of the forum; for
// forum supergroups only
MessageThreadID int `json:"message_thread_id,omitempty"`
// Voice - Audio file to send. Pass a file_id as String to send a file that exists on the Telegram servers
// (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one
// using multipart/form-data. More information on Sending Files »
// (https://core.telegram.org/bots/api#sending-files)
Voice InputFile `json:"voice"`
// Caption - Optional. Voice message caption, 0-1024 characters after entities parsing
Caption string `json:"caption,omitempty"`
// ParseMode - Optional. Mode for parsing entities in the voice message caption. See formatting options
// (https://core.telegram.org/bots/api#formatting-options) for more details.
ParseMode string `json:"parse_mode,omitempty"`
// CaptionEntities - Optional. A JSON-serialized list of special entities that appear in the caption, which
// can be specified instead of parse_mode
CaptionEntities []MessageEntity `json:"caption_entities,omitempty"`
// Duration - Optional. Duration of the voice message in seconds
Duration int `json:"duration,omitempty"`
// DisableNotification - Optional. Sends the message silently
// (https://telegram.org/blog/channels-2-0#silent-messages). Users will receive a notification with no sound.
DisableNotification bool `json:"disable_notification,omitempty"`
// ProtectContent - Optional. Protects the contents of the sent message from forwarding and saving
ProtectContent bool `json:"protect_content,omitempty"`
// MessageEffectID - Optional. Unique identifier of the message effect to be added to the message; for
// private chats only
MessageEffectID string `json:"message_effect_id,omitempty"`
// ReplyParameters - Optional. Description of the message to reply to
ReplyParameters *ReplyParameters `json:"reply_parameters,omitempty"`
// ReplyMarkup - Optional. Additional interface options. A JSON-serialized object for an inline keyboard
// (https://core.telegram.org/bots/features#inline-keyboards), custom reply keyboard
// (https://core.telegram.org/bots/features#keyboards), instructions to remove a reply keyboard or to force a
// reply from the user
ReplyMarkup ReplyMarkup `json:"reply_markup,omitempty"`
}
func (p *SendVoiceParams) fileParameters() map[string]ta.NamedReader {
return map[string]ta.NamedReader{
"voice": p.Voice.File,
}
}
// SendVoice - Use this method to send audio files, if you want Telegram clients to display the file as a
// playable voice message. For this to work, your audio must be in an .OGG file encoded with OPUS, or in .MP3
// format, or in .M4A format (other formats may be sent as Audio (https://core.telegram.org/bots/api#audio) or
// Document (https://core.telegram.org/bots/api#document)). On success, the sent Message
// (https://core.telegram.org/bots/api#message) is returned. Bots can currently send voice messages of up to 50
// MB in size, this limit may be changed in the future.
func (b *Bot) SendVoice(params *SendVoiceParams) (*Message, error) {
var message *Message
err := b.performRequest("sendVoice", params, &message)
if err != nil {
return nil, fmt.Errorf("telego: sendVoice(): %w", err)
}
return message, nil