Telebot  4.7.0
Library for Telegram bot API
telebot-methods.h
Go to the documentation of this file.
1 /*
2  * telebot
3  *
4  * Copyright (c) 2015 Elmurod Talipov.
5  *
6  * Licensed under the Apache License, Version 2.0 (the License);
7  * you may not use this file except in compliance with the License.
8  * You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing, software
13  * distributed under the License is distributed on an "AS IS" BASIS,
14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15  * See the License for the specific language governing permissions and
16  * limitations under the License.
17  */
18 
19 #ifndef __TELEBOT_METHODS_H__
20 #define __TELEBOT_METHODS_H__
21 
22 #include <stdbool.h>
23 
24 #ifdef __cplusplus
25 extern "C" {
26 #endif
27 
54 
66 
76 telebot_error_e telebot_set_proxy(telebot_handler_t handle, char *addr, char *auth);
77 
88 
103  int limit, int timeout, telebot_update_type_e allowed_updates[],
104  int allowed_updates_count, telebot_update_t **updates, int *count);
105 
115 
116 
139  char *certificate, int max_connections,telebot_update_type_e allowed_updates[],
140  int allowed_updates_count);
141 
151 
152 
163  telebot_webhook_info_t *info);
164 
174 
185 
194 
212 telebot_error_e telebot_send_message(telebot_handler_t handle, long long int chat_id,
213  const char *text, const char *parse_mode, bool disable_web_page_preview,
214  bool disable_notification, int reply_to_message_id, const char *reply_markup);
215 
229 telebot_error_e telebot_forward_message(telebot_handler_t handle, long long int chat_id,
230  long long int from_chat_id, bool disable_notification, int message_id);
231 
252 telebot_error_e telebot_send_photo(telebot_handler_t handle, long long int chat_id,
253  const char *photo, bool is_file, const char *caption, const char *parse_mode,
254  bool disable_notification, int reply_to_message_id, const char *reply_markup);
255 
256 
289 telebot_error_e telebot_send_audio(telebot_handler_t handle, long long int chat_id,
290  const char *audio, bool is_file, const char *caption, const char *parse_mode,
291  int duration, const char *performer, const char *title, const char *thumb,
292  bool disable_notification, int reply_to_message_id, const char *reply_markup);
293 
317 telebot_error_e telebot_send_document(telebot_handler_t handle, long long int chat_id,
318  const char *document, bool is_file, const char *thumb, const char *caption,
319  const char *parse_mode, bool disable_notification, int reply_to_message_id,
320  const char *reply_markup);
321 
350 telebot_error_e telebot_send_video(telebot_handler_t handle, long long int chat_id,
351  const char *video, bool is_file, int duration, int width, int height,
352  const char *thumb, const char *caption, const char *parse_mode,
353  bool supports_streaming, bool disable_notification, int reply_to_message_id,
354  const char *reply_markup);
355 
381 telebot_error_e telebot_send_animation(telebot_handler_t handle, long long int chat_id,
382  const char *animation, bool is_file, int duration, int width, int height,
383  const char *thumb, const char *caption, const char *parse_mode,
384  bool disable_notification, int reply_to_message_id, const char *reply_markup);
385 
386 
408 telebot_error_e telebot_send_voice(telebot_handler_t handle, long long int chat_id,
409  const char *voice, bool is_file, const char *caption, const char *parse_mode,
410  int duration, bool disable_notification, int reply_to_message_id,
411  const char *reply_markup);
412 
437 telebot_error_e telebot_send_video_note(telebot_handler_t handle, long long int chat_id,
438  char *video_note, bool is_file, int duration, int length, const char *thumb,
439  bool disable_notification, int reply_to_message_id, const char *reply_markup);
440 
458 telebot_error_e telebot_send_location(telebot_handler_t handle, long long int chat_id,
459  float latitude, float longitude, int live_period, bool disable_notification,
460  int reply_to_message_id, const char *reply_markup);
461 
480  long long int chat_id, int message_id, const char *inline_message_id,
481  float latitude, float longitude, const char *reply_markup);
482 
498  long long int chat_id, int message_id, char *inline_message_id,
499  const char *reply_markup);
500 
521 telebot_error_e telebot_send_venue(telebot_handler_t handle, long long int chat_id,
522  float latitude, float longitude, const char *title, const char *address,
523  const char *foursquare_id, const char *foursquare_type, bool disable_notification,
524  int reply_to_message_id, const char *reply_markup);
525 
544 telebot_error_e telebot_send_contact(telebot_handler_t handle, long long int chat_id,
545  const char *phone_number, const char *first_name, const char *last_name,
546  const char *vcard, bool disable_notification, int reply_to_message_id,
547  const char *reply_markup);
548 
574 telebot_error_e telebot_send_poll(telebot_handler_t handle, long long int chat_id,
575  const char *question, const char **options, int count_options, bool is_anonymous,
576  const char *type, bool allows_multiple_answers, int correct_option_id, bool is_closed,
577  bool disable_notification, int reply_to_message_id, const char *reply_markup);
578 
593 telebot_error_e telebot_send_dice(telebot_handler_t handle, long long int chat_id,
594  bool disable_notification, int reply_to_message_id, const char *reply_markup);
595 
616 telebot_error_e telebot_send_chat_action(telebot_handler_t handle, long long int chat_id,
617  char *action);
618 
634  int user_id, int offset, int limit, telebot_user_profile_photos_t *photos);
635 
645 
653 telebot_error_e telebot_download_file(telebot_handler_t handle, const char *file_id,
654  const char *path);
655 
672 telebot_error_e telebot_kick_chat_member(telebot_handler_t handle, long long int chat_id,
673  int user_id, long until_date);
674 
686 telebot_error_e telebot_unban_chat_member(telebot_handler_t handle, long long int chat_id,
687  int user_id);
688 
721  long long int chat_id, int user_id, long until_date, bool can_send_messages,
722  bool can_send_media_messages, bool can_send_polls, bool can_send_other_messages,
723  bool can_add_web_page_previews, bool can_change_info, bool can_invite_users,
724  bool can_pin_messages);
725 
756  long long int chat_id, int user_id, bool can_change_info, bool can_post_messages,
757  bool can_edit_messages, bool can_delete_messages, bool can_invite_users,
758  bool can_restrict_members, bool can_pin_messages, bool can_promote_members);
759 
774  long long int chat_id, int user_id, const char *custom_title);
775 
804  long long int chat_id, bool can_send_messages, bool can_send_media_messages,
805  bool can_send_polls, bool can_send_other_messages, bool can_add_web_page_previews,
806  bool can_change_info, bool can_invite_users, bool can_pin_messages);
807 
820  long long int chat_id, char **invite_link);
821 
833 telebot_error_e telebot_set_chat_photo(telebot_handler_t handle, long long int chat_id,
834  const char *photo);
835 
846 telebot_error_e telebot_delete_chat_photo(telebot_handler_t handle, long long int chat_id);
847 
859 telebot_error_e telebot_set_chat_title(telebot_handler_t handle, long long int chat_id,
860  const char *title);
861 
874  long long int chat_id, const char *description);
875 
890 telebot_error_e telebot_pin_chat_message(telebot_handler_t handle, long long int chat_id,
891  int message_id, bool disable_notification);
892 
903 telebot_error_e telebot_unpin_chat_message(telebot_handler_t handle, long long int chat_id);
904 
913 telebot_error_e telebot_leave_chat(telebot_handler_t handle, long long int chat_id);
914 
925 telebot_error_e telebot_get_chat(telebot_handler_t handle, long long int chat_id,
926  telebot_chat_t *chat);
927 
928 
936 
951 telebot_error_e telebot_get_chat_admins(telebot_handler_t handle, long long int chat_id,
952  telebot_chat_member_t **admin, int *count);
953 
962 
973  long long int chat_id, int *count);
974 
986 telebot_error_e telebot_get_chat_member(telebot_handler_t handle, long long int chat_id,
987  int user_id, telebot_chat_member_t *member);
988 
996 
1011  long long int chat_id, const char *sticker_set_name);
1012 
1025  long long int chat_id);
1026 
1048  const char *callback_query_id, const char *text, bool show_alert,
1049  const char *url, int cache_time);
1050 
1059  telebot_bot_command_t commands[], int count);
1060 
1070  telebot_bot_command_t **commands, int *count);
1071 
1079 
1098  long long int chat_id, int message_id, const char *inline_message_id,
1099  const char *text, const char *parse_mode, bool disable_web_page_preview,
1100  const char *reply_markup);
1101 
1117  long long int chat_id, int message_id, const char *inline_message_id,
1118  const char *caption, const char *parse_mode, const char *reply_markup);
1119 
1136  long long int chat_id, int message_id, const char *inline_message_id,
1137  const char *reply_markup);
1138 
1153 telebot_error_e telebot_stop_poll(telebot_handler_t handle, long long int chat_id,
1154  int message_id, const char *reply_markup);
1155 
1172 telebot_error_e telebot_delete_message(telebot_handler_t handle, long long int chat_id,
1173  int message_id);
1174 
1179 #ifdef __cplusplus
1180 }
1181 #endif
1182 
1183 #endif /* __TELEBOT_METHODS_H__ */
telebot_error_e telebot_put_user_profile_photos(telebot_user_profile_photos_t *photos)
This function is used to free memory allocated for user profile pictures object.
telebot_error_e
Enumerations of error code for telebot programming interface.
Definition: telebot-common.h:45
telebot_error_e telebot_put_me(telebot_user_t *me)
This function is used to release memory used for obtained information about telegram bot itself...
telebot_error_e telebot_forward_message(telebot_handler_t handle, long long int chat_id, long long int from_chat_id, bool disable_notification, int message_id)
Forward messages of any kind.
telebot_error_e telebot_get_chat_member(telebot_handler_t handle, long long int chat_id, int user_id, telebot_chat_member_t *member)
Get information about a member of a chat.
telebot_error_e telebot_delete_chat_sticker_set(telebot_handler_t handle, long long int chat_id)
Delete a group sticker set from a supergroup. The bot must be an administrator in the chat for this t...
telebot_error_e telebot_delete_message(telebot_handler_t handle, long long int chat_id, int message_id)
Delete a message, including service messages, with the following limitations:
telebot_error_e telebot_put_webhook_info(telebot_webhook_info_t *info)
This function is used to release memory used for obtained information about telegram bot itself...
telebot_error_e telebot_send_audio(telebot_handler_t handle, long long int chat_id, const char *audio, bool is_file, const char *caption, const char *parse_mode, int duration, const char *performer, const char *title, const char *thumb, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send audio files. if you want Telegram clients to display them in the music player. Your audio must be in the .mp3 format. Bots can currently send audio files of up to 50 MB in size. For backward compatibility, when the fields title and performer are both empty and the mime-type of the file to be sent is not audio/mpeg, the file will be sent as a playable voice message. For this to work, the audio must be in an .ogg file encoded with OPUS. For sending voice messages, use the telegram_send_voice() function instead.
telebot_error_e telebot_unban_chat_member(telebot_handler_t handle, long long int chat_id, int user_id)
Unban a previously kicked user in a supergroup or channel. The user will not return to the group or c...
telebot_error_e telebot_edit_message_reply_markup(telebot_handler_t handle, long long int chat_id, int message_id, const char *inline_message_id, const char *reply_markup)
Edit only the reply markup of messages sent by the bot or via the bot (for inline bots)...
This object represents an incoming update.
Definition: telebot-types.h:1191
telebot_error_e telebot_get_proxy(telebot_handler_t handle, char **addr)
Get proxy address currently used.
telebot_error_e telebot_restrict_chat_member(telebot_handler_t handle, long long int chat_id, int user_id, long until_date, bool can_send_messages, bool can_send_media_messages, bool can_send_polls, bool can_send_other_messages, bool can_add_web_page_previews, bool can_change_info, bool can_invite_users, bool can_pin_messages)
Restrict a user in a supergroup. The bot must be an administrator in the supergroup for this to work ...
telebot_error_e telebot_download_file(telebot_handler_t handle, const char *file_id, const char *path)
This function is used to download file.
telebot_error_e telebot_send_video(telebot_handler_t handle, long long int chat_id, const char *video, bool is_file, int duration, int width, int height, const char *thumb, const char *caption, const char *parse_mode, bool supports_streaming, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send video files, Telegram clients support mp4 videos (other formats may be sent as Document)...
telebot_error_e telebot_get_my_commands(telebot_handler_t handle, telebot_bot_command_t **commands, int *count)
Get the current list of the bot&#39;s commands.
telebot_error_e telebot_destroy(telebot_handler_t handle)
Final function to use telebo APIs.
enum telebot_update_type telebot_update_type_e
Enumerations of telegram update types.
telebot_error_e telebot_set_my_commands(telebot_handler_t handle, telebot_bot_command_t commands[], int count)
Change the list of the bot&#39;s commands.
telebot_error_e telebot_set_chat_admin_custom_title(telebot_handler_t handle, long long int chat_id, int user_id, const char *custom_title)
Export an invite link to a supergroup or a channel. The bot must be an administrator in the chat for ...
telebot_error_e telebot_put_chat_member(telebot_chat_member_t *member)
Release chat member otained with telebot_get_chat_member().
telebot_error_e telebot_send_venue(telebot_handler_t handle, long long int chat_id, float latitude, float longitude, const char *title, const char *address, const char *foursquare_id, const char *foursquare_type, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send information about a venue.
telebot_error_e telebot_set_proxy(telebot_handler_t handle, char *addr, char *auth)
Set proxy address to use telebot behind proxy.
telebot_error_e telebot_get_me(telebot_handler_t handle, telebot_user_t *me)
This function is used to get information about telegram bot itself.
telebot_error_e telebot_send_animation(telebot_handler_t handle, long long int chat_id, const char *animation, bool is_file, int duration, int width, int height, const char *thumb, const char *caption, const char *parse_mode, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send animation files (GIF or H.264/MPEG-4 AVC without sound).
This object represents a chat.
Definition: telebot-types.h:95
telebot_error_e telebot_get_webhook_info(telebot_handler_t handle, telebot_webhook_info_t *info)
This function is used to get information about telegram bot itself.
telebot_error_e telebot_edit_message_live_location(telebot_handler_t handle, long long int chat_id, int message_id, const char *inline_message_id, float latitude, float longitude, const char *reply_markup)
Edit live location messages sent by the bot or via the bot (for inline bots). A location can be edite...
telebot_error_e telebot_answer_callback_query(telebot_handler_t handle, const char *callback_query_id, const char *text, bool show_alert, const char *url, int cache_time)
Send answers to callback queries sent from inline keyboards. The answer will be displayed to the user...
This object represents a bot command.
Definition: telebot-types.h:1157
telebot_error_e telebot_delete_chat_photo(telebot_handler_t handle, long long int chat_id)
Delete a chat photo. Photos can&#39;t be changed for private chats. The bot must be an administrator in t...
telebot_error_e telebot_edit_message_caption(telebot_handler_t handle, long long int chat_id, int message_id, const char *inline_message_id, const char *caption, const char *parse_mode, const char *reply_markup)
Edit captions of messages sent by the bot or via the bot (for inline bots).
This object contains information about one member of a chat.
Definition: telebot-types.h:997
telebot_error_e telebot_unpin_chat_message(telebot_handler_t handle, long long int chat_id)
Unpin a message in a supergroup or a channel. The bot must be an administrator in the chat for this t...
telebot_error_e telebot_set_chat_title(telebot_handler_t handle, long long int chat_id, const char *title)
Change the title of a chat. Titles can&#39;t be changed for private chats. The bot must be an administrat...
telebot_error_e telebot_send_photo(telebot_handler_t handle, long long int chat_id, const char *photo, bool is_file, const char *caption, const char *parse_mode, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send photos.
telebot_error_e telebot_put_my_commands(telebot_bot_command_t *commands, int count)
Release bot commands obtained with telebot_get_my_commands().
telebot_error_e telebot_promote_chat_member(telebot_handler_t handle, long long int chat_id, int user_id, bool can_change_info, bool can_post_messages, bool can_edit_messages, bool can_delete_messages, bool can_invite_users, bool can_restrict_members, bool can_pin_messages, bool can_promote_members)
Promote or demote a user in a supergroup or a channel. The bot must be an administrator in the chat f...
telebot_error_e telebot_set_chat_sticker_set(telebot_handler_t handle, long long int chat_id, const char *sticker_set_name)
Set a new group sticker set for a supergroup. The bot must be an administrator in the chat for this t...
telebot_error_e telebot_put_updates(telebot_update_t *updates, int count)
This function is used to release memory used for obtained updates.
telebot_error_e telebot_set_chat_permissions(telebot_handler_t handle, long long int chat_id, bool can_send_messages, bool can_send_media_messages, bool can_send_polls, bool can_send_other_messages, bool can_add_web_page_previews, bool can_change_info, bool can_invite_users, bool can_pin_messages)
Set default chat permissions for all members. The bot must be an administrator in the group or a supe...
telebot_error_e telebot_send_voice(telebot_handler_t handle, long long int chat_id, const char *voice, bool is_file, const char *caption, const char *parse_mode, int duration, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send audio files, if you want Telegram clients to display the file as a playable voice message...
telebot_error_e telebot_set_chat_photo(telebot_handler_t handle, long long int chat_id, const char *photo)
Set a new profile photo for the chat. Photos can&#39;t be changed for private chats. The bot must be an a...
telebot_error_e telebot_get_updates(telebot_handler_t handle, int offset, int limit, int timeout, telebot_update_type_e allowed_updates[], int allowed_updates_count, telebot_update_t **updates, int *count)
This function is used to get latest updates.
Thi object represetns information about the current status of a webhook.
Definition: telebot-types.h:1252
telebot_error_e telebot_get_chat_members_count(telebot_handler_t handle, long long int chat_id, int *count)
Get the number of members in a chat.
telebot_error_e telebot_send_document(telebot_handler_t handle, long long int chat_id, const char *document, bool is_file, const char *thumb, const char *caption, const char *parse_mode, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send general files.
telebot_error_e telebot_send_dice(telebot_handler_t handle, long long int chat_id, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send a dice, which will have a random value from 1 to 6.
telebot_error_e telebot_put_chat_admins(telebot_chat_member_t *admins, int count)
Release chat admins obtained with telebot_get_chat_admins().
telebot_error_e telebot_send_location(telebot_handler_t handle, long long int chat_id, float latitude, float longitude, int live_period, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send point on the map.
telebot_error_e telebot_get_user_profile_photos(telebot_handler_t handle, int user_id, int offset, int limit, telebot_user_profile_photos_t *photos)
This function is used to get user profile pictures object.
telebot_error_e telebot_leave_chat(telebot_handler_t handle, long long int chat_id)
Leave a group, supergroup or channel.
telebot_error_e telebot_get_chat(telebot_handler_t handle, long long int chat_id, telebot_chat_t *chat)
Get up to date information about the chat (current name of the user for one-on-one conversations...
telebot_error_e telebot_pin_chat_message(telebot_handler_t handle, long long int chat_id, int message_id, bool disable_notification)
Pin a message in a supergroup or a channel. The bot must be an administrator in the chat for this to ...
telebot_error_e telebot_set_webhook(telebot_handler_t handle, char *url, char *certificate, int max_connections, telebot_update_type_e allowed_updates[], int allowed_updates_count)
This function is used to specify a url and receive incoming updates via an outgoing webhook...
telebot_error_e telebot_set_chat_description(telebot_handler_t handle, long long int chat_id, const char *description)
Change the description of a supergroup or a channel. The bot must be an administrator in the chat for...
telebot_error_e telebot_stop_poll(telebot_handler_t handle, long long int chat_id, int message_id, const char *reply_markup)
Stop a poll which was sent by the bot.
telebot_error_e telebot_kick_chat_member(telebot_handler_t handle, long long int chat_id, int user_id, long until_date)
Kick a user from a group, a supergroup or a channel. In the case of supergroups and channels...
telebot_error_e telebot_send_contact(telebot_handler_t handle, long long int chat_id, const char *phone_number, const char *first_name, const char *last_name, const char *vcard, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send phone contacts.
telebot_error_e telebot_send_message(telebot_handler_t handle, long long int chat_id, const char *text, const char *parse_mode, bool disable_web_page_preview, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send text messages.
telebot_error_e telebot_delete_webhook(telebot_handler_t handle)
This function is used to remove webhook integration if you decide to switch back to getUpdates...
telebot_error_e telebot_send_poll(telebot_handler_t handle, long long int chat_id, const char *question, const char **options, int count_options, bool is_anonymous, const char *type, bool allows_multiple_answers, int correct_option_id, bool is_closed, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send a native poll.
This object represent a user&#39;s profile pictures.
Definition: telebot-types.h:742
telebot_error_e telebot_get_chat_admins(telebot_handler_t handle, long long int chat_id, telebot_chat_member_t **admin, int *count)
Get a list of administrators in a chat. Response contains an array of objects that contains informati...
telebot_error_e telebot_edit_message_text(telebot_handler_t handle, long long int chat_id, int message_id, const char *inline_message_id, const char *text, const char *parse_mode, bool disable_web_page_preview, const char *reply_markup)
Edit text and game messages sent by the bot or via the bot (for inline bots).
telebot_error_e telebot_export_chat_invite_link(telebot_handler_t handle, long long int chat_id, char **invite_link)
Generate a new invite link for a chat; any previously generated link is revoked. The bot must be an a...
telebot_error_e telebot_put_chat(telebot_chat_t *chat)
Release chat obtained with telebot_get_chat().
telebot_error_e telebot_send_chat_action(telebot_handler_t handle, long long int chat_id, char *action)
Tell the user that something is happening on the bot&#39;s side. The status is set for 5 seconds or less ...
This object represents a Telegram user or bot.
Definition: telebot-types.h:62
telebot_error_e telebot_stop_message_live_location(telebot_handler_t handle, long long int chat_id, int message_id, char *inline_message_id, const char *reply_markup)
Stop updating a live location message sent by the bot or via the bot (for inline bots) before live_pe...
telebot_error_e telebot_create(telebot_handler_t *handle, char *token)
Initial function to use telebot APIs.
telebot_error_e telebot_send_video_note(telebot_handler_t handle, long long int chat_id, char *video_note, bool is_file, int duration, int length, const char *thumb, bool disable_notification, int reply_to_message_id, const char *reply_markup)
Send video messages. As of v.4.0, Telegram clients support rounded square mp4 videos of up to 1 minut...
struct telebot_handler_s * telebot_handler_t
This is opaque object to represent a telebot handler.
Definition: telebot-types.h:1296