defmodule Telegraph do
@moduledoc """
Provides access to Telegram Bot API.
## Reference
https://core.telegram.org/bots/api#available-methods
"""
alias Telegraph.Model.{
User,
Message,
Update,
UserProfilePhotos,
File,
Error,
WebhookInfo,
LabeledPrice
}
import Telegraph.API
@behaviour Telegraph.Behaviour
@doc """
A simple method for testing your bot's auth token. Requires no parameters.
Returns basic information about the bot in form of a User object.
"""
@spec get_me :: {:ok, User.t()} | {:error, Error.t()}
def get_me, do: request("getMe")
@doc """
Use this method to send text messages.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `text` - Text of the message to be sent
* `options` - orddict of options
Options:
* `:parse_mode` - Use `Markdown`, if you want Telegram apps to show bold, italic
and inline URLs in your bot's message
* `:disable_web_page_preview` - Disables link previews for links in this message
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_message(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_message(chat_id, text, options \\ []) do
request("sendMessage", [chat_id: chat_id, text: text] ++ options)
end
@doc """
Use this method to forward messages of any kind.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `from_chat_id` - Unique identifier for the chat where the original message was sent
or username of the target channel (in the format @channelusername)
* `:disable_notification` - Sends the message silently or without notification
* `message_id` - Unique message identifier
"""
@spec forward_message(integer | binary, integer | binary, integer) ::
{:ok, Message.t()} | {:error, Error.t()}
def forward_message(chat_id, from_chat_id, message_id) do
request(
"forwardMessage",
chat_id: chat_id,
from_chat_id: from_chat_id,
message_id: message_id
)
end
@doc """
Use this method to send photos.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `photo` - Photo to send. Either a `file_id` to resend a photo that is already on
the Telegram servers, or a `file_path` to upload a new photo
* `options` - orddict of options
Options:
* `:caption` - Photo caption (may also be used when resending photos by `file_id`)
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_photo(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_photo(chat_id, photo, options \\ []) do
request("sendPhoto", [chat_id: chat_id, photo: photo] ++ options, :photo)
end
@doc """
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.
On success, the sent 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 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. This behavior will be phased out in the
future. For sending voice messages, use the sendVoice method instead.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `audio` - Audio to send. Either a `file_id` to resend an audio that is already on
the Telegram servers, or a `file_path` to upload a new audio
* `options` - orddict of options
Options:
* `:duration` - Duration of the audio in seconds
* `:performer` - Performer
* `:title` - Track name
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_audio(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_audio(chat_id, audio, options \\ []) do
request("sendAudio", [chat_id: chat_id, audio: audio] ++ options, :audio)
end
@doc """
Use this method to send general files.
On success, the sent 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.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `document` - File to send. Either a `file_id` to resend a file that is already on
the Telegram servers, or a `file_path` to upload a new file
* `options` - orddict of options
Options:
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_document(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_document(chat_id, document, options \\ []) do
request("sendDocument", [chat_id: chat_id, document: document] ++ options, :document)
end
@doc """
Use this method to send .webp stickers.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `sticker` - File to send. Either a `file_id` to resend a sticker that is already on
the Telegram servers, or a `file_path` to upload a new sticker
* `options` - orddict of options
Options:
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_sticker(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_sticker(chat_id, sticker, options \\ []) do
request("sendSticker", [chat_id: chat_id, sticker: sticker] ++ options, :sticker)
end
@doc """
Use this method to send video files, Telegram clients support mp4 videos
(other formats may be sent as Document).
On success, the sent Message is returned.
Bots can currently send video files of up to 50 MB in size, this limit may be
changed in the future.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `video` - Video to send. Either a `file_id` to resend a video that is already on
the Telegram servers, or a `file_path` to upload a new video
* `options` - orddict of options
Options:
* `:duration` - Duration of the video in seconds
* `:caption` - Video caption (may also be used when resending videos by `file_id`)
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_video(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_video(chat_id, video, options \\ []) do
request("sendVideo", [chat_id: chat_id, video: video] ++ options, :video)
end
@doc """
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).
On success, the sent Message is returned.
Bots can currently send voice messages of up to 50 MB in size, this limit may be
changed in the future.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `voice` - Audio to send. Either a `file_id` to resend an audio that is already on
the Telegram servers, or a `file_path` to upload a new audio
* `options` - orddict of options
Options:
* `:duration` - Duration of the audio in seconds
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_voice(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_voice(chat_id, voice, options \\ []) do
request("sendVoice", [chat_id: chat_id, voice: voice] ++ options, :voice)
end
@doc """
Use this method to send point on the map.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `latitude` - Latitude of location
* `longitude` - Longitude of location
* `options` - orddict of options
Options:
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. Instructions to hide keyboard or to
force a reply from the user - `Telegraph.Model.ReplyKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardRemove` or `Telegraph.Model.ForceReply`
"""
@spec send_location(integer | binary, float, float, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_location(chat_id, latitude, longitude, options \\ []) do
request(
"sendLocation",
[chat_id: chat_id, latitude: latitude, longitude: longitude] ++ options
)
end
@doc """
Use this method to send information about a venue.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `latitude` - Latitude of location
* `longitude` - Longitude of location
* `title` - Name of the venue
* `address` - Address of the venue
* `options` - orddict of options
Options:
* `:foursquare_id` - Foursquare identifier of the venue
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. A JSON-serialized object for
an inline keyboard, custom reply keyboard, instructions to hide reply keyboard
or to force a reply from the user. - `Telegraph.Model.InlineKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardMarkup` or `Telegraph.Model.ReplyKeyboardRemove` or
`Telegraph.Model.ForceReply`
"""
@spec send_venue(integer | binary, float, float, binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_venue(chat_id, latitude, longitude, title, address, options \\ []) do
request(
"sendVenue",
[chat_id: chat_id, latitude: latitude, longitude: longitude, title: title, address: address] ++
options
)
end
@doc """
Use this method to send phone contacts.
On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `phone_number` - Contact's phone number
* `first_name` - Contact's first name
* `options` - orddict of options
Options:
* `:last_name` - Contact's last name
* `:disable_notification` - Sends the message silently or without notification
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `:reply_markup` - Additional interface options. A JSON-serialized object for
an inline keyboard, custom reply keyboard, instructions to hide reply keyboard
or to force a reply from the user. - `Telegraph.Model.InlineKeyboardMarkup` or
`Telegraph.Model.ReplyKeyboardMarkup` or `Telegraph.Model.ReplyKeyboardRemove` or
`Telegraph.Model.ForceReply`
"""
@spec send_contact(integer | binary, binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_contact(chat_id, phone_number, first_name, options \\ []) do
request(
"sendContact",
[chat_id: chat_id, phone_number: phone_number, first_name: first_name] ++ options
)
end
@doc """
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).
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `action` - Type of action to broadcast. Choose one, depending on what the user is
about to receive:
* `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
"""
@spec send_chat_action(integer | binary, binary) :: :ok | {:error, Error.t()}
def send_chat_action(chat_id, action) do
request("sendChatAction", chat_id: chat_id, action: action)
end
@doc """
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound).
On success, the sent Message is returned. Bots can currently send animation files of up
to 50 MB in size, this limit may be changed in the future.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `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.
Options:
* `:duration` - Duration of sent animation in seconds
* `:width` - Animation width
* `:height` - Animation height
* `:thumb` - Thumbnail of the file sent; can be ignored if thumbnail generation for the file
is supported server-side. thumbnail should be in JPEG format and less than 200 kB in size.
* `:caption` - Animation caption (may also be used when resending animation by file_id), 0-1024 characters
* `: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.
* `:disable_notification` - Sends the message silently. Users will receive a notification with no sound.
* `:reply_to_message_id` - If the message is a reply, ID of the original message
* `: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.
"""
@spec send_animation(integer | binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_animation(chat_id, animation, options \\ []) do
request("sendAnimation", [chat_id: chat_id, animation: animation] ++ options)
end
@doc """
Use this method to get a list of profile pictures for a user.
Returns a UserProfilePhotos object.
Args:
* `user_id` - Unique identifier of the target user
* `options` - orddict of options
Options:
* `:offset` - Sequential number of the first photo to be returned. By default, all
photos are returned
* `:limit` - Limits the number of photos to be retrieved. Values between 1—100 are
accepted. Defaults to 100
"""
@spec get_user_profile_photos(integer, [{atom, any}]) ::
{:ok, UserProfilePhotos.t()} | {:error, Error.t()}
def get_user_profile_photos(user_id, options \\ []) do
request("getUserProfilePhotos", [user_id: user_id] ++ options)
end
@doc """
Use this method to receive incoming updates using long polling.
An Array of Update objects is returned.
Args:
* `options` - orddict of options
Options:
* `: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 `get_updates` is called with an `offset` higher than
its `update_id`.
* `:limit` - Limits the number of updates to be retrieved. Values between 1—100 are
accepted. Defaults to 100
* `:timeout` - Timeout in seconds for long polling. Defaults to 0, i.e. usual short
polling
"""
@spec get_updates([{atom, any}]) :: {:ok, [Update.t()]} | {:error, Error.t()}
def get_updates(options \\ []), do: request("getUpdates", options)
@doc """
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. In case of
an unsuccessful request, we will give up after a reasonable amount of attempts.
Args:
* `options` - orddict of options
Options:
* `:url` - HTTPS url to send updates to.
"""
@spec set_webhook([{atom, any}]) :: :ok | {:error, Error.t()}
def set_webhook(options \\ []), do: request("setWebhook", options)
@doc """
Use this method to remove webhook integration if you decide to switch back to `Telegraph.get_updates/1`.
Returns `:ok` on success.
Requires no parameters.
"""
@spec delete_webhook() :: :ok | {:error, Error.t()}
def delete_webhook(), do: request("deleteWebhook")
@doc """
Use this method to get current webhook status. Requires no parameters.
On success, returns a `Telegraph.Model.WebhookInfo.t()` object with webhook details.
If the bot is using getUpdates, will return an object with the url field empty.
"""
@spec get_webhook_info() :: {:ok, WebhookInfo.t()} | {:error, Error.t()}
def get_webhook_info(), do: request("getWebhookInfo")
@doc """
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.
On success, a File object is returned.
The file can then be downloaded via the link
`https://api.telegram.org/file/bot<token>/<file_path>`, where <file_path> is taken
from the response. It is guaranteed that the link will be valid for at least 1 hour.
When the link expires, a new one can be requested by calling `get_file` again.
Args:
* `file_id` - File identifier to get info about
"""
@spec get_file(binary) :: {:ok, File.t()} | {:error, Error.t()}
def get_file(file_id), do: request("getFile", file_id: file_id)
@doc ~S"""
Use this method to get link for file for subsequent use.
This method is an extension of the `get_file` method.
iex> Telegraph.get_file_link(%Telegraph.Model.File{file_id: "BQADBQADBgADmEjsA1aqdSxtzvvVAg",
...> file_path: "document/file_10", file_size: 17680})
{:ok,
"https://api.telegram.org/file/bot#{Telegraph.Config.token()}/document/file_10"}
"""
@spec get_file_link(File.t()) :: {:ok, binary} | {:error, Error.t()}
def get_file_link(file) do
{:ok, build_file_url(file.file_path)}
end
@doc """
Use this method to kick a user from a group or a supergroup. In the case of supergroups,
the user will not be able to return to the group on their own using invite links, etc.,
unless unbanned first. The bot must be an administrator in the group for this to work.
Returns True on success.
Note: This will method only work if the ‘All Members Are Admins’ setting is off in the
target group. Otherwise members may only be removed by the group's creator or by the
member that added them.
Args:
* `chat_id` - Unique identifier for the target group or username of the target supergroup
(in the format @supergroupusername)
* `user_id` - Unique identifier of the target user
"""
@spec kick_chat_member(integer | binary, integer) :: :ok | {:error, Error.t()}
def kick_chat_member(chat_id, user_id) do
request("kickChatMember", chat_id: chat_id, user_id: user_id)
end
@doc """
Use this method for your bot to leave a group, supergroup or channel.
Returns True on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target supergroup or
channel (in the format @supergroupusername)
"""
@spec leave_chat(integer | binary) :: :ok | {:error, Error.t()}
def leave_chat(chat_id) do
request("leaveChat", chat_id: chat_id)
end
@doc """
Use this method to unban a previously kicked user in a supergroup. The user will not
return to the group automatically, but will be able to join via link, etc. The bot
must be an administrator in the group for this to work. Returns True on success.
Args:
* `chat_id` - Unique identifier for the target group or username of the target supergroup
(in the format @supergroupusername)
* `user_id` - Unique identifier of the target user
"""
@spec unban_chat_member(integer | binary, integer) :: :ok | {:error, Error.t()}
def unban_chat_member(chat_id, user_id) do
request("unbanChatMember", chat_id: chat_id, user_id: user_id)
end
@doc """
Use this method to get up to date information about the chat (current name of
the user for one-on-one conversations, current username of a user, group or channel, etc.)
Returns a Chat object on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target supergroup or
channel (in the format @supergroupusername)
"""
@spec get_chat(integer | binary) :: {:ok, Chat.t()} | {:error, Error.t()}
def get_chat(chat_id) do
request("getChat", chat_id: chat_id)
end
@doc """
Use this method to get a list of administrators in a chat. On success, returns an Array of
ChatMember objects that contains information about all chat administrators except other bots.
If the chat is a group or a supergroup and no administrators were appointed, only the creator
will be returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target supergroup or
channel (in the format @channelusername)
"""
@spec get_chat_administrators(integer | binary) :: {:ok, [ChatMember.t()]} | {:error, Error.t()}
def get_chat_administrators(chat_id) do
request("getChatAdministrators", chat_id: chat_id)
end
@doc """
Use this method to get the number of members in a chat. Returns Int on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target supergroup or
channel (in the format @channelusername)
"""
@spec get_chat_members_count(integer | binary) :: {:ok, integer} | {:error, Error.t()}
def get_chat_members_count(chat_id) do
request("getChatMembersCount", chat_id: chat_id)
end
@doc """
Use this method to get information about a member of a chat.
Returns a ChatMember object on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target supergroup or
channel (in the format @channelusername)
* `user_id` - Unique identifier of the target user
"""
@spec get_chat_member(integer | binary, integer) :: {:ok, ChatMember.t()} | {:error, Error.t()}
def get_chat_member(chat_id, user_id) do
request("getChatMember", chat_id: chat_id, user_id: user_id)
end
@doc """
Use this method to send answers to callback queries sent from inline keyboards.
The answer will be displayed to the user as a notification at the top of the chat
screen or as an alert. On success, True is returned.
Args:
* `callback_query_id` - Unique identifier for the query to be answered
* `options` - orddict of options
Options:
* `:text` - Text of the notification. If not specified, nothing will be shown
to the user
* `:show_alert` - If true, an alert will be shown by the client instead of a
notification at the top of the chat screen. Defaults to false.
"""
@spec answer_callback_query(binary, [{atom, any}]) :: :ok | {:error, Error.t()}
def answer_callback_query(callback_query_id, options \\ []) do
request("answerCallbackQuery", [callback_query_id: callback_query_id] ++ options)
end
@doc """
Use this method to edit text messages sent by the bot or via the bot (for inline bots).
On success, the edited Message is returned
Args:
* `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)
* `message_id` - Required if inline_message_id is not specified. Unique identifier of
the sent message
* `inline_message_id` - Required if `chat_id` and `message_id` are not specified.
Identifier of the inline message
* `text` - New text of the message
* `options` - orddict of options
Options:
* `: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.
* `:disable_web_page_preview` - Disables link previews for links in this message
* `:reply_markup` - A JSON-serialized object for an inline
keyboard - `Telegraph.Model.InlineKeyboardMarkup`
"""
@spec edit_message_text(integer | binary, integer, binary, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def edit_message_text(chat_id, message_id, inline_message_id, text, options \\ []) do
request(
"editMessageText",
[chat_id: chat_id, message_id: message_id, inline_message_id: inline_message_id, text: text] ++
options
)
end
@doc """
Use this method to delete message from a chat.
Bot should have admin permission to do that, and remember you can't delete messages that are more than
48 hours old.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `message_id` - Required if inline_message_id is not specified. Unique identifier of
the sent message
"""
@spec delete_message(integer | binary, integer) :: :ok | {:error, Error.t()}
def delete_message(chat_id, message_id) do
request(
"deleteMessage",
chat_id: chat_id,
message_id: message_id
)
end
@doc """
Use this method to edit captions of messages sent by the bot or via
the bot (for inline bots). On success, the edited Message is returned.
Args:
* `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)
* `message_id` - Required if inline_message_id is not specified. Unique identifier of
the sent message
* `inline_message_id` - Required if `chat_id` and `message_id` are not specified.
Identifier of the inline message
* `options` - orddict of options
Options:
* `:caption` - New caption of the message
* `:reply_markup` - A JSON-serialized object for an inline
keyboard - `Telegraph.Model.InlineKeyboardMarkup`
"""
@spec edit_message_caption(integer | binary, integer, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def edit_message_caption(chat_id, message_id, inline_message_id, options \\ []) do
request(
"editMessageCaption",
[chat_id: chat_id, message_id: message_id, inline_message_id: inline_message_id] ++ options
)
end
@doc """
Use this method to edit only the reply markup of messages sent by the bot or via
the bot (for inline bots). On success, the edited Message is returned.
Args:
* `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)
* `message_id` - Required if inline_message_id is not specified. Unique identifier of
the sent message
* `inline_message_id` - Required if `chat_id` and `message_id` are not specified.
Identifier of the inline message
* `options` - orddict of options
Options:
* `:reply_markup` - A JSON-serialized object for an inline
keyboard - `Telegraph.Model.InlineKeyboardMarkup`
"""
@spec edit_message_reply_markup(integer | binary, integer, binary, [{atom, any}]) ::
{:ok, Message.t()} | {:error, Error.t()}
def edit_message_reply_markup(chat_id, message_id, inline_message_id, options \\ []) do
request(
"editMessageReplyMarkup",
[chat_id: chat_id, message_id: message_id, inline_message_id: inline_message_id] ++ options
)
end
@doc """
Use this method to send answers to an inline query. On success, True is returned.
No more than 50 results per query are allowed.
Args:
* `inline_query_id` - Unique identifier for the answered query
* `results` - An array of results for the inline query
* `options` - orddict of options
Options:
* `cache_time` - The maximum amount of time in seconds that the result of the inline
query may be cached on the server. Defaults to 300.
* `is_personal` - Pass True, if results may be cached on the server side only for
the user that sent the query. By default, results may be returned to any user who
sends the same query
* `next_offset` - Pass the offset that a client should send in the next query with
the same text to receive more results. Pass an empty string if there are no more
results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.
* `switch_pm_text` - If passed, clients will display a button with specified text
that switches the user to a private chat with the bot and sends the bot a start
message with the parameter switch_pm_parameter.
* `switch_pm_parameter` - Parameter for the start message sent to the bot when user
presses the switch button.
"""
@spec answer_inline_query(binary, [Telegraph.Model.InlineQueryResult.t()], [{atom, any}]) ::
:ok | {:error, Error.t()}
def answer_inline_query(inline_query_id, results, options \\ []) do
encoded_results =
results
|> Enum.map(fn result ->
for {k, v} <- Map.from_struct(result), v != nil, into: %{}, do: {k, v}
end)
|> Jason.encode!()
args = [inline_query_id: inline_query_id, results: encoded_results]
request("answerInlineQuery", args ++ options)
end
@doc """
Use this method to get a sticker set. On success, a StickerSet object is returned.
Args:
* `name` - Name of the sticker set
"""
@spec get_sticker_set(binary) :: {:ok, Telegraph.Model.StickerSet.t()} | {:error, Error.t()}
def get_sticker_set(name) do
request("getStickerSet", name: name)
end
@doc """
Use this method to upload a .png file with a sticker for later use in
createNewStickerSet and addStickerToSet methods (can be used multiple times).
Returns the uploaded File on success.
Args:
* `user_id` - User identifier of sticker file owner
* `png_sticker` - Png image with the sticker, must be up to 512 kilobytes in size,
dimensions must not exceed 512px, and either width or height must be exactly 512px.
Either a `file_id` to resend a file that is already on the Telegram servers,
or a `file_path` to upload a new file from local, or a `HTTP URL` to get a file
from the internet.
"""
@spec upload_sticker_file(integer, binary) :: {:ok, File.t()} | {:error, Error.t()}
def upload_sticker_file(user_id, png_sticker) do
request("uploadStickerFile", [user_id: user_id, png_sticker: png_sticker], :png_sticker)
end
@doc """
Use this method to create new sticker set owned by a user. The bot will be able to
edit the created sticker set. Returns True on success.
Args:
* `user_id` - User identifier of created sticker set owner
* `name` - Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals).
Can contain only english letters, digits and underscores. Must begin with a letter,
can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username>
is case insensitive. 1-64 characters.
* `title` - Sticker set title, 1-64 characters
* `png_sticker` - Png image with the sticker, must be up to 512 kilobytes in size,
dimensions must not exceed 512px, and either width or height must be exactly 512px.
Either a `file_id` to resend a file that is already on the Telegram servers,
or a `file_path` to upload a new file from local, or a `HTTP URL` to get a file
from the internet.
* `emojis` - One or more emoji corresponding to the sticker
Options:
* `contains_masks` - Pass True, if a set of mask stickers should be created
* `mask_position` - A `Telegraph.Model.MaskPosition` object for position where the mask
should be placed on faces
"""
@doc since: "0.1.0"
@spec create_new_sticker_set(integer, binary, binary, binary, binary, [{atom, any}]) ::
:ok | {:error, Error.t()}
def create_new_sticker_set(user_id, name, title, png_sticker, emojis, options \\ []) do
request(
"createNewStickerSet",
[user_id: user_id, name: name, title: title, png_sticker: png_sticker, emojis: emojis] ++
options,
:png_sticker
)
end
@doc """
Use this method to add a new sticker to a set created by the bot. Returns True on success.
Args:
* `user_id` - User identifier of created sticker set owner
* `name` - Sticker set name
* `png_sticker` - Png image with the sticker, must be up to 512 kilobytes in size,
dimensions must not exceed 512px, and either width or height must be exactly 512px.
Either a `file_id` to resend a file that is already on the Telegram servers,
or a `file_path` to upload a new file from local, or a `HTTP URL` to get a file
from the internet.
* `emojis` - One or more emoji corresponding to the sticker
Options:
* `mask_position` - A `Telegraph.Model.MaskPosition` object for position where the mask
should be placed on faces
"""
@doc since: "0.1.0"
@spec add_sticker_to_set(integer, binary, binary, binary, [{atom, any}]) ::
:ok | {:error, Error.t()}
def add_sticker_to_set(user_id, name, png_sticker, emojis, options \\ []) do
request(
"addStickerToSet",
[user_id: user_id, name: name, png_sticker: png_sticker, emojis: emojis] ++ options,
:png_sticker
)
end
@doc """
Use this method to move a sticker in a set created by the bot to a specific position.
Returns True on success.
Args:
* `sticker` - File identifier of the sticker
* `position` - New sticker position in the set, zero-based
"""
@doc since: "0.1.0"
@spec set_sticker_position_in_set(binary, integer) :: :ok | {:error, Error.t()}
def set_sticker_position_in_set(sticker, position) do
request("setStickerPositionInSet", sticker: sticker, position: position)
end
@doc """
Use this method to delete a sticker from a set created by the bot. Returns True on success.
Args:
* `sticker` - File identifier of the sticker
"""
@doc since: "0.1.0"
@spec delete_sticker_from_set(binary) :: :ok | {:error, Error.t()}
def delete_sticker_from_set(sticker) do
request("deleteStickerFromSet", sticker: sticker)
end
@doc """
Use this method to pin a message in a group, a supergroup, or a channel. The bot must be an
administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right
in the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
* `message_id` - Identifier of a message to pin
Options:
* `disable_notification` - Pass True, if it is not necessary to send a notification to all
chat members about the new pinned message. Notifications are always disabled in channels.
"""
@doc since: "0.1.0"
@spec pin_chat_message(integer | binary, integer | binary, [{atom, any}]) ::
:ok | {:error, Error.t()}
def pin_chat_message(chat_id, message_id, options \\ []) do
request("pinChatMessage", [chat_id: chat_id, message_id: message_id] ++ options)
end
@doc """
Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an
administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in
the supergroup or ‘can_edit_messages’ admin right in the channel. Returns True on success.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target channel
(in the format @channelusername)
"""
@doc since: "0.1.0"
@spec unpin_chat_message(integer | binary) :: :ok | {:error, Error.t()}
def unpin_chat_message(chat_id) do
request("unpinChatMessage", chat_id: chat_id)
end
@doc """
Use this method to send invoices. On success, the sent Message is returned.
Args:
* `chat_id` - Unique identifier for the target chat or username of the target
* `title` - Product name, 1-32 characters
* `description` - Product description, 1-255 characters
* `payload` - Bot-defined invoice payload, 1-128 bytes. This will not be displayed to
the user, use for your internal processes.
* `provider_token` - Payments provider token, obtained via Botfather
* `start_parameter` - Unique deep-linking parameter that can be used to generate
this invoice when used as a start parameter
* `currency` - Three-letter ISO 4217 currency code
* `prices` - Array of `LabeledPrice`. Price breakdown (e.g. product price, tax,
discount, delivery cost, delivery tax, bonus, etc.)
Options:
* `provider_data` - A JSON-serialized data about the invoice, which will be shared
with the payment provider. A detailed description of required fields should be provided
by the payment provider.
* `photo_url` - URL of the product photo for the invoice. Can be a photo of the goods
or a marketing image for a service. People like it better when they see what they are paying for.
* `photo_size` - Photo size
* `photo_width` - Photo width
* `photo_height` - Photo height
* `need_name` - Pass True, if you require the user's full name to complete the order
* `need_phone_number` - Pass True, if you require the user's phone number to complete the order
* `need_email` - Pass True, if you require the user's email address to complete the order
* `need_shipping_address` - Pass True, if you require the user's shipping address to complete the order
* `send_phone_number_to_provider` - Pass True, if user's phone number should be sent to provider
* `send_email_to_provider` - Pass True, if user's email address should be sent to provider
* `is_flexible` - Pass True, if the final price depends on the shipping method
* `disable_notification` - Sends the message silently. Users will receive a notification with no sound.
* `reply_to_message_id` - If the message is a reply, ID of the original message
* `allow_sending_without_reply` - Pass True, if the message should be sent even if the
specified replied-to message is not found
* `reply_markup` - A JSON-serialized object for an inline keyboard - `Telegraph.Model.InlineKeyboardMarkup`
"""
@doc since: "0.8.0"
@spec send_invoice(
integer | binary,
binary,
binary,
binary,
binary,
binary,
binary,
[LabeledPrice.t()],
[{atom, any}]
) ::
{:ok, Message.t()} | {:error, Error.t()}
def send_invoice(
chat_id,
title,
description,
payload,
provider_token,
start_parameter,
currency,
prices,
options \\ []
) do
request(
"sendInvoice",
[
chat_id: chat_id,
title: title,
description: description,
payload: payload,
provider_token: provider_token,
start_parameter: start_parameter,
currency: currency,
prices: prices
] ++ options
)
end
@doc """
If you sent an invoice requesting a shipping address and the parameter is_flexible was specified,
the Bot API will send an Update with a shipping_query field to the bot. Use this method to reply
to shipping queries. On success, True is returned.
Args:
* `shipping_query_id` - Unique identifier for the query to be answered
* `ok` - Specify True if delivery to the specified address is possible and False if there are any
problems (for example, if delivery to the specified address is not possible)
Options:
* `shipping_address` - Required if ok is True. A list of `Telegraph.Model.ShippingOption`
* `error_message` - Required if ok is False. Error message in human readable form that explains
why it is impossible to complete the order (e.g. "Sorry, delivery to your desired address is
unavailable'). Telegram will display this message to the user.
"""
@doc since: "0.8.0"
@spec answer_shipping_query(integer | binary, boolean, [{atom, any}]) ::
:ok | {:error, Error.t()}
def answer_shipping_query(shipping_query_id, ok, options \\ []) do
request("answerShippingQuery", [shipping_query_id: shipping_query_id, ok: ok] ++ options)
end
@doc """
Once the user has confirmed their payment and shipping details, the Bot API sends the final
confirmation in the form of an Update with the field pre_checkout_query. Use this method to
respond to such pre-checkout queries. On success, True is returned. Note: The Bot API must receive
an answer within 10 seconds after the pre-checkout query was sent.
Args:
* `pre_checkout_query_id` - Unique identifier for the query to be answered
* `ok` - Specify True if everything is alright (goods are available, etc.) and the bot
is ready to proceed with the order. Use False if there are any problems.
Options:
* `error_message` - Required if ok is False. Error message in human readable form that explains
the reason for failure to proceed with the checkout (e.g. "Sorry, somebody just bought the last of
our amazing black T-shirts while you were busy filling out your payment details. Please choose
a different color or garment!"). Telegram will display this message to the user.
"""
@doc since: "0.8.0"
@spec answer_pre_checkout_query(integer | binary, boolean, [{atom, any}]) ::
:ok | {:error, Error.t()}
def answer_pre_checkout_query(pre_checkout_query_id, ok, options \\ []) do
request(
"answerPreCheckoutQuery",
[pre_checkout_query_id: pre_checkout_query_id, ok: ok] ++ options
)
end
end
