Yocingo
Summary↑
| forward_message(chat_id, from_chat_id, message_id) | forward_message: Use this method to forward messages of any kind. Returns information in form of a HashMap |
| get_me() | A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a HashMap |
| get_updates(offset \\ 0, limits \\ 100, timeout \\ 20) | Use this method to receive incoming updates using long polling. Returns the updates in form of a HashMap |
| get_user_profiles_photos(user_id, offset \\ 0, limit \\ 100) | Use this method to get a list of profile pictures for a user. Returns info in form of a HashMap |
| send_audio(chat_id, audio, duration \\ 0, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send audio files. Returns info in form of a HashMap |
| send_chat_action(chat_id, action) | Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns info in form of a HashMap |
| send_document(chat_id, document, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send documents. Returns info in form of a HashMap |
| send_location(chat_id, latitude, longitude, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send point on the map. Returns info in form of a HashMap |
| send_message(chat_id, text, disable_web_page_preview \\ false, reply_to_mensaje_id \\ nil, reply_markup \\ %{"reply_markup" => []}) | Use this method to send text messages. Retruns information in form of a HashMap |
| send_photo(chat_id, photo, caption \\ nil, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send photos. Returns info in form of a HashMap |
| send_sticker(chat_id, sticker, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send documents. Returns info in form of a HashMap |
| send_video(chat_id, video, duration \\ 0, reply_to_message_id \\ nil, reply_markup \\ nil) | Use this method to send videos. Returns info in form of a HashMap |
Functions
forward_message: Use this method to forward messages of any kind. Returns information in form of a HashMap.
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- fromchatid: Integer, Required, Unique identifier for the chat where the original message was sent, user or group.
- message_id: Unique message identifier.
A simple method for testing your bot's auth token. Requires no parameters. Returns basic information about the bot in form of a HashMap.
Arguments
- offset: Integer, 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 is called with an offset higher than its update_id.
- limits: Integer, Optional, Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100
- timeout: Integer, Optional, Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling
Use this method to receive incoming updates using long polling. Returns the updates in form of a HashMap
Arguments
- offset: Integer, 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 is called with an offset higher than its update_id.
- limits: Integer, Optional, Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100
- timeout: Integer, Optional, Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling
Use this method to get a list of profile pictures for a user. Returns info in form of a HashMap
Arguments
- user_id: Integer, Required, Unique identifier of the target user.
- offset: Integer, Optional, Sequential number of the first photo to be returned. By default the value is 0 (means all).
- limit: Integer, Optional, Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.
Use this method to send audio files. Returns info in form of a HashMap
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- audio: [File | String], Required, Audio file to send. You can either pass a file_id as String to resend a audio file that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- duration: Integer, Optional, Duration of sent audio in seconds
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns info in form of a HashMap.
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- action: String, Required, Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, uploadphoto for photos, recordvideo or uploadvideo for videos, recordaudio or uploadaudio for audio files, uploaddocument for general files, find_location for location data.
Use this method to send documents. Returns info in form of a HashMap
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- document: [File | String], Required, File to send. You can either pass a file_id as String to resend a document that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options.
A JSON-serialized object for a custom reply keyboard, instructions to hide
keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method to send point on the map. Returns info in form of a HashMap.
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- latitude: Float, Required, Latitude of location.
- longitude: Float, Required, Longitude of location.
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method to send text messages. Retruns information in form of a HashMap.
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- text: String, Required, Text of the message to be sent.
- disablewebpage_preview: Boolean, Optional, Disables link previews for links in this message.
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method to send photos. Returns info in form of a HashMap
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- photo: [File | String], Required, Photo to send. You can either pass a file_id as String to resend a photo that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- caption: String, Optional, Photo caption (may also be used when resending photos by file_id).
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options. A JSON-serialized object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method to send documents. Returns info in form of a HashMap
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- sticker: [File | String], Required, Sticker to send. You can either pass a file_id as String to resend a sticker that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options.
A JSON-serialized object for a custom reply keyboard, instructions to hide
keyboard or to force a reply from the user. (Check Telegram API for more Information).
Use this method to send videos. Returns info in form of a HashMap
Arguments
- chat_id: Integer, Required, Unique identifier for the message recipient, user or group.
- video: [File | String], Required, Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new photo using multipart/form-data.
- replytomessage_id: Integer, Optional, If the message is a reply, ID of the original message.
- reply_markup: Dict of List of List, Optional, Additional interface options.
A JSON-serialized object for a custom reply keyboard, instructions to hide
keyboard or to force a reply from the user. (Check Telegram API for more Information).