-
Notifications
You must be signed in to change notification settings - Fork 1
/
BotMethod.php
1733 lines (1658 loc) · 85.1 KB
/
BotMethod.php
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
<?php
/**
* @package Telegram
*
* @link https://github.com/MohsenJS/BotMethod
*
* @author MohsenJS
*/
namespace MohsenJS;
class BotMethod
{
/**
* Token get from @BotFather
* The Token looks something like
* 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11.
*
* @var string
*/
protected $token = null;
/**
* cURL synchronous requests handle.
*
* @var resource|null
*/
protected $ch;
/**
* initialize Class.
*
* @param string $api_token The Token looks something like
* 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
*
* @return bool
*/
public function __construct($api_token)
{
$this->token = $api_token;
if (strlen($this->token) == 45 && count(explode(':', $this->token)) == 2) {
$this->ch = curl_init();
return true;
}
return false;
}
/**
* Release resource if still active.
*/
public function __destruct()
{
if (is_resource($this->ch)) {
curl_close($this->ch);
}
}
/**
* Make Http Request.
*
* @param string $method Mothod for calling
* @param object $datas Datas for Send to Telegram
*
* @return object
*/
private function makeHttpRequest($method, $datas = null)
{
$url = 'https://api.telegram.org/bot' . $this->token . '/' . $method;
curl_setopt($this->ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($this->ch, CURLOPT_POSTFIELDS, ($datas));
curl_setopt($this->ch, CURLOPT_URL, $url);
$res = curl_exec($this->ch);
if (curl_error($this->ch)) {
$r = new \stdClass();
$r->ok = false;
$r->description = curl_error($this->ch);
$r->errno = curl_errno($this->ch);
return $r;
}
return $res;
}
/**
* Use this method to receive incoming updates using long polling.
*
* @param int $offset 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 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 forgotten.
* @param int $limit Limits the number of updates to be
* retrieved. Values between 1—100 are accepted
* @param int $timeout Timeout in seconds for long polling.
* @param array $allowed_updates List the types of updates you want your bot
* to receive. For example, specify [“message”, “edited_channel_post”,
* “callback_query”] to only receive updates of these types
*
* @return object
*/
public function getUpdates($offset = null, $limit = null, $timeout = null, $allowed_updates = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to specify a url and receive incoming updates via an
* outgoing webhook.
*
* @param string $url HTTPS url to send updates to. Use an empty
* string to remove webhook integration
* @param array $allowed_updates List the types of updates you want your
* bot to receive. For example, specify [“message”, “edited_channel_post”,
* “callback_query”] to only receive updates of these types
* @param int $max_connections Maximum allowed number of simultaneous
* HTTPS connections to the webhook for update delivery, 1-100
* @param file $certificate Upload your public key certificate so that
* the root certificate in use can be checked
*
* @return object
*/
public function setWebhook($url, $allowed_updates = null, $max_connections = null, $certificate = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to remove webhook integration if you decide to switch
* back to getUpdates.
*
* @return object
*/
public function deleteWebhook()
{
return $this->makeHttpRequest(__FUNCTION__);
}
/**
* Use this method to get current webhook status. Requires no parameters.
*
* @return object
*/
public function getWebhookInfo()
{
return $this->makeHttpRequest(__FUNCTION__);
}
/**
* A simple method for testing your bot's auth token.
* Returns basic information about the bot.
*
* @return object
*/
public function getme()
{
return $this->makeHttpRequest(__FUNCTION__);
}
/**
* Use this method to send text messages.
*
* @param int|string $chat_id Unique identifier for the target chat or username of the target
* channel (in the format @channelusername)
* @param string $text Text of the message to be
* sent
* @param int $reply_to_message_id If the message is a reply, ID
* of the original message
* @param string $parse_mode Send Markdown or HTML, if you want Telegram apps to show
* bold, italic, fixed-width text or inline URLs
* in your bot's message.
* @param bool $disable_web_page_preview Disables link previews for
* links in this message
* @param json $reply_markup Additional interface options.
* A JSON-serialized object for an inline keyboard, custom
* reply keyboard, instructions to remove reply keyboard or
* to force a reply from the user.
* @param bool $disable_notification Sends the message silently.
* Users will receive a notification with no sound.
*
* @return object
*/
public function sendMessage(
$chat_id,
$text,
$reply_to_message_id = null,
$parse_mode = null,
$disable_web_page_preview = null,
$reply_markup = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to forward messages of any kind.
*
* @param int|string $chat_id Unique identifier for the target chat or username of the target
* channel (in the format @channelusername)
* @param int|string $from_chat_id Unique identifier for the chat where the original message
* was sent (or channel username in the format @channelusername)
* @param int $message_id Message identifier in the chat
* specified in from_chat_id
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function forwardMessage($chat_id, $from_chat_id, $message_id, $disable_notification = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send photos.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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
* @param string $caption Photo caption (may also be used
* when resending photos by file_id), 0-200 characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendPhoto(
$chat_id,
$photo,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* 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 format.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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.
* @param string $caption Audio caption, 0-200 characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param string $title Track name
* @param int $duration Duration of the audio in seconds
* @param string $performer Performer
* @param file $thumb Thumbnail of the file sent. The
* thumbnail should be in JPEG format and less than 200 kB in size. A
* thumbnail‘s width and height should not exceed 90. 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>
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendAudio(
$chat_id,
$audio,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$title = null,
$duration = null,
$performer = null,
$thumb = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send general files.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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.
* @param string $caption Document caption (may also be
* used when resending documents by file_id), 0-200 characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param file $thumb Thumbnail of the file sent. The
* thumbnail should be in JPEG format and less than 200 kB in size. A
* thumbnail‘s width and height should not exceed 90. 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>
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendDocument(
$chat_id,
$document,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$thumb = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send video files, Telegram clients support mp4 videos
* (other formats may be sent as Document).
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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
* @param string $caption Video caption (may also be used
* when resending videos by file_id), 0-200 characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param file $thumb Thumbnail of the file sent. The
* thumbnail should be in JPEG format and less than 200 kB in size. A
* thumbnail‘s width and height should not exceed 90. 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>
* @param bool $supports_streaming Pass True, if the uploaded video
* is suitable for streaming
* @param int $duration Duration of sent video in seconds
* @param string $width Video width
* @param string $height Video height
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendVideo(
$chat_id,
$video,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$thumb = null,
$supports_streaming = false,
$duration = null,
$width = null,
$height = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send animation files (GIF or H.264/MPEG-4 AVC video
* without sound).
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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.
* @param string $caption Video caption (may also be used
* when resending videos by file_id), 0-200 characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param file $thumb Thumbnail of the file sent. The
* thumbnail should be in JPEG format and less than 200 kB in size. A
* thumbnail‘s width and height should not exceed 90. 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>
* @param int $duration Duration of sent video in seconds
* @param string $width Video width
* @param string $height Video height
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendAnimation(
$chat_id,
$animation,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$thumb = null,
$duration = null,
$width = null,
$height = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* 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 (other formats may be
* sent as Audio or Document).
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $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
* @param string $caption Voice message caption, 0-200
* characters
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $parse_mode Send Markdown or HTML, if you
* want Telegram apps to show bold, italic, fixed-width text or inline URLs
* in the media caption.
* @param int $duration Duration of the voice message in
* seconds
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendVoice(
$chat_id,
$voice,
$caption = null,
$reply_to_message_id = null,
$reply_markup = null,
$parse_mode = null,
$duration = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* As of v.4.0, Telegram clients support rounded square mp4 videos of up to
* 1 minute long. Use this method to send video messages.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $video_note Video note to send. Pass a
* file_id as String to send a video note that exists on the Telegram
* servers (recommended) or upload a new video using multipart/form-data. --
* Sending video notes by a URL is currently unsupported --
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param int $duration Duration of sent video in seconds
* @param int $length Video width and height
* @param file $thumb Thumbnail of the file sent. The
* thumbnail should be in JPEG format and less than 200 kB in size. A
* thumbnail‘s width and height should not exceed 90. 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>
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendVideoNote(
$chat_id,
$video_note,
$reply_to_message_id = null,
$reply_markup = null,
$duration = null,
$length = null,
$thumb = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send a group of photos or videos as an album.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param array $media A JSON-serialized array
* describing photos and videos to be sent, must include 2–10 items
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendMediaGroup($chat_id, $media, $reply_to_message_id = null, $disable_notification = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send point on the map.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param float $latitude Latitude of the location
* @param float $longitude Longitude of the location
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param int $live_period Period in seconds for which the
* location will be updated (see Live Locations, should be between 60 and
* 86400
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendLocation(
$chat_id,
$latitude,
$longitude,
$reply_to_message_id = null,
$reply_markup = null,
$live_period = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to edit live location messages sent by the bot or via the
* bot (for inline bots). A location can be edited until its live_period
* expires or editing is explicitly disabled by a call to
* stopMessageLiveLocation.
*
* @param float $latitude Latitude of new location
* @param float $longitude Longitude of new location
* @param int|string $chat_id Required if inline_message_id is not
* specified. Unique identifier for the target chat or username of the
* target channel (in the format @channelusername)
* @param int $message_id Required if inline_message_id is not
* specified. Identifier of the sent message
* @param string $inline_message_id Required if chat_id and message_id
* are not specified. Identifier of the inline message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
*
* @return object
*/
public function editMessageLiveLocation(
$latitude,
$longitude,
$chat_id = null,
$message_id = null,
$inline_message_id = null,
$reply_markup = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to stop updating a live location message sent by the bot
* or via the bot (for inline bots) before live_period expires.
*
* @param int|string $chat_id Required if inline_message_id is not
* specified. Unique identifier for the target chat or username of the
* target channel (in the format @channelusername)
* @param int $message_id Required if inline_message_id is not
* specified. Identifier of the sent message
* @param string $inline_message_id Required if chat_id and message_id
* are not specified. Identifier of the inline message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
*
* @return object
*/
public function stopMessageLiveLocation(
$chat_id = null,
$message_id = null,
$inline_message_id = null,
$reply_markup = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send information about a venue.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param float $latitude Latitude of the venue
* @param float $longitude Longitude of the venue
* @param string $title Name of the venue
* @param string $address Address of the venue
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $foursquare_id Foursquare identifier of the
* venue
* @param string $foursquare_type Foursquare type of the venue, if
* known. (For example, “arts_entertainment/default”,
* “arts_entertainment/aquarium” or “food/icecream”.)
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendVenue(
$chat_id,
$latitude,
$longitude,
$title,
$address,
$reply_to_message_id = null,
$reply_markup = null,
$foursquare_id = null,
$foursquare_type = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send phone contacts.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param string $phone_number Contact's phone number
* @param string $first_name Contact's first name
* @param string $last_name Contact's last name
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param string $vcard Additional data about the contact
* in the form of a vCard, 0-2048 bytes
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendContact(
$chat_id,
$phone_number,
$first_name,
$last_name = null,
$reply_to_message_id = null,
$reply_markup = null,
$vcard = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to send a native poll. A native poll can't be sent to a
* private chat.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername).
* A native poll can't be sent to a private chat.
* @param string $question Poll question, 1-255 characters
* @param array $options List of answer options, 2-10
* strings 1-100 characters each
* @param int $reply_to_message_id If the message is a reply, ID of
* the original message
* @param json $reply_markup Additional interface options. A
* JSON-serialized object for an inline keyboard, custom reply keyboard,
* instructions to remove reply keyboard or to force a reply from the user.
* @param bool $disable_notification Sends the message silently. Users
* will receive a notification with no sound.
*
* @return object
*/
public function sendPoll(
$chat_id,
$question,
$options,
$reply_to_message_id = null,
$reply_markup = null,
$disable_notification = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method when you need to tell the user that something is
* happening on the bot's side.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
* @param string $action Type of action to broadcast. Choose one:
* typing for text messages, upload_photo for photos, record_video or
* upload_video for videos, record_audio or upload_audio for audio files,
* upload_document for general files, find_location for location data,
* record_video_note or upload_video_note for video notes.
*
* @return object
*/
public function sendChatAction($chat_id, $action)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to get a list of profile pictures for a user.
*
* @param int $user_id Unique identifier of the target user
* @param int $limit Limits the number of photos to be retrieved. Values
* between 1—100 are accepted. Defaults to 100.
* @param int $offset Sequential number of the first photo to be returned.
* By default, all photos are returned.
*
* @return object
*/
public function getUserProfilePhotos($user_id, $limit = null, $offset = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to get basic info about a file and prepare it for
* downloading. For the moment, bots can download files of up to 20MB in
* size.
*
* @param string $file_id File identifier to get info about
*
* @return object
*/
public function getFile($file_id)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to get File link.
*
* @param string|object $file_path The file path received from the getFile
* function
*
* @return string
*/
public function getFileLink($file_path)
{
if (is_object($file_path)) {
$file_path = $file_path->file_path;
}
return 'https://api.telegram.org/file/bot' . $this->token . '/' . $file_path;
}
/**
* Use this method to kick a user from a group, a supergroup or a channel.
* In the case of supergroups and channels, the user will not be able to
* return to the group on their own using invite links, etc., unless
* unbanned first.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
* @param int $user_id Unique identifier of the target user
* @param int $until_date Date when the user will be unbanned, unix
* time. If user is banned for more than 366 days or less than 30 seconds
* from the current time they are considered to be banned forever
*
* @return object
*/
public function kickChatMember($chat_id, $user_id, $until_date = null)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to unban a previously kicked user in a supergroup or
* channel. The user will not return to the group or channel automatically,
* but will be able to join via link, etc.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
* @param int $user_id Unique identifier of the target user
*
* @return object
*/
public function unbanChatMember($chat_id, $user_id)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to restrict a user in a supergroup. The bot must be an
* administrator in the supergroup for this to work and must have the
* appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target chat or username of the target
* channel (in the format @channelusername)
* @param int $user_id Unique identifier of the
* target user
* @param bool $can_send_messages Pass True, if the user can
* send text messages, contacts, locations and venues
* @param bool $can_send_media_messages Pass True, if the user can
* send audios, documents, photos, videos, video notes and voice notes,
* implies can_send_messages
* @param bool $can_send_other_messages Pass True, if the user can
* send animations, games, stickers and use inline bots, implies
* can_send_media_messages
* @param bool $can_add_web_page_previews Pass True, if the user may add web page previews to their messages,
* implies can_send_media_messages
* @param int $until_date Date when restrictions will be lifted for the user, unix time.
* If user is restricted for more than 366 days or less than 30 seconds
* from the current time, they are considered to be restricted forever
*
* @return object
*/
public function restrictChatMember(
$chat_id,
$user_id,
$can_send_messages = null,
$can_send_media_messages = null,
$can_send_other_messages = null,
$can_add_web_page_previews = null,
$until_date = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to promote or demote a user in a supergroup or a channel.
* The bot must be an administrator in the chat for this to work and must
* have the appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target
* chat or username of the target channel (in the format @channelusername)
* @param int $user_id Unique identifier of the target
* user
* @param bool $can_post_messages Pass True, if the administrator
* can create channel posts, channels only
* @param bool $can_edit_messages Pass True, if the administrator
* can edit messages of other users and can pin messages, channels only
* @param bool $can_delete_messages Pass True, if the administrator
* can delete messages of other users
* @param bool $can_change_info Pass True, if the administrator
* can change chat title, photo and other settings
* @param bool $can_pin_messages Pass True, if the administrator
* can pin messages, supergroups only
* @param bool $can_invite_users Pass True, if the administrator
* can invite new users to the chat
* @param bool $can_promote_members Pass True, if the administrator
* can add new administrators with a subset of his own privileges or demote
* administrators that he has promoted, directly or indirectly (promoted by
* administrators that were appointed by him)
* @param bool $can_restrict_members Pass True, if the administrator
* can restrict, ban or unban chat members
*
* @return object
*/
public function promoteChatMember(
$chat_id,
$user_id,
$can_post_messages = null,
$can_edit_messages = null,
$can_delete_messages = null,
$can_change_info = null,
$can_pin_messages = null,
$can_invite_users = null,
$can_promote_members = null,
$can_restrict_members = null
) {
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to export an invite link to a supergroup or a channel.
* The bot must be an administrator in the chat for this to work and must
* have the appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
*
* @return object
*/
public function exportChatInviteLink($chat_id)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to set a new profile photo for the chat. Photos can't be
* changed for private chats. The bot must be an administrator in the chat
* for this to work and must have the appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
* @param file $photo New chat photo, uploaded using
* multipart/form-data
*
* @return object
*/
public function setChatPhoto($chat_id, $photo)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to delete a chat photo. Photos can't be changed for
* private chats. The bot must be an administrator in the chat for this to
* work and must have the appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
*
* @return object
*/
public function deleteChatPhoto($chat_id)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to change the title of a chat. Titles can't be changed
* for private chats. The bot must be an administrator in the chat for this
* to work and must have the appropriate admin rights.
*
* @param int|string $chat_id Unique identifier for the target chat or
* username of the target channel (in the format @channelusername)
* @param string $title New chat title, 1-255 characters
*
* @return object
*/
public function setChatTitle($chat_id, $title)
{
return $this->makeHttpRequest(__FUNCTION__, (object) get_defined_vars());
}
/**
* Use this method to change the description of a supergroup or a channel.
* The bot must be an administrator in the chat for this to work and must