Index | Telegram Bot SDK API

A

Actions — Class in namespace Telegram\Bot: Class Actions.
Api — Class in namespace Telegram\Bot: Class Api.
Api::addCommand() — Method in class Api: Add Telegram Command to the Command Bus.
Api::addCommands() — Method in class Api: Add Telegram Commands to the Command Bus.
CommandBus::addCommands() — Method in class CommandBus: Add a list of commands.
CommandBus::addCommand() — Method in class CommandBus: Add a command to the commands list.
Audio — Class in namespace Telegram\Bot\Objects: Class Audio.

B

TelegramServiceProvider::boot() — Method in class TelegramServiceProvider: Bootstrap the application events.
BaseObject — Class in namespace Telegram\Bot\Objects: Class BaseObject.

C

Api::commandsHandler() — Method in class Api: Processes Inbound Commands.
Command — Class in namespace Telegram\Bot\Commands: Class Command.
CommandBus — Class in namespace Telegram\Bot\Commands: Class CommandBus.
CommandInterface — Class in namespace Telegram\Bot\Commands: Interface CommandInterface.
TelegramResponseException::create() — Method in class TelegramResponseException: A factory for creating the appropriate exception based on the response from Telegram.
Chat — Class in namespace Telegram\Bot\Objects: Class Chat.
Contact — Class in namespace Telegram\Bot\Objects: Class Contact.

D

Api::detectMessageType() — Method in class Api: Detect Message Type Based on Update or Message Object.
Document — Class in namespace Telegram\Bot\Objects: Class Document.
TelegramResponse::decodeBody() — Method in class TelegramResponse: Converts raw API response to proper decoded response.

E

CommandBus::execute() — Method in class CommandBus: Execute the command.

F

Api::forwardMessage() — Method in class Api: Forward messages of any kind.
Api::forceReply() — Method in class Api: Display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply').
File — Class in namespace Telegram\Bot\Objects: Class File.

G

Api::getClient() — Method in class Api: Returns the TelegramClient service.
Api::getAccessToken() — Method in class Api: Returns Telegram Bot API Access Token.
Api::getLastResponse() — Method in class Api: Returns the last response returned from API request.
Api::getCommandBus() — Method in class Api: Returns SDK's Command Bus.
Api::getCommands() — Method in class Api: Returns list of available commands.
Api::getMe() — Method in class Api: A simple method for testing your bot's auth token.
Api::getUserProfilePhotos() — Method in class Api: Returns a list of profile pictures for a user.
Api::getFile() — Method in class Api: Returns basic info about a file and prepare it for downloading.
Api::getWebhookUpdates() — Method in class Api: Returns webhook updates sent by Telegram.
Api::getUpdates() — Method in class Api: Use this method to receive incoming updates using long polling.
Api::getContainer() — Method in class Api: Get the IoC Container.
Api::getTimeOut() — Method in class Api
Api::getConnectTimeOut() — Method in class Api
Command::getName() — Method in class Command: Get Command Name.
Command::getDescription() — Method in class Command: Get Command Description.
Command::getTelegram() — Method in class Command: Returns Telegram Instance.
Command::getUpdate() — Method in class Command: Returns Original Update.
Command::getArguments() — Method in class Command: Get Arguments passed to the command.
Command::getCommandBus() — Method in class Command: Returns an instance of Command Bus.
CommandBus::getCommands() — Method in class CommandBus: Returns the list of commands.
TelegramResponseException::getHttpStatusCode() — Method in class TelegramResponseException: Returns the HTTP status code.
TelegramResponseException::getErrorType() — Method in class TelegramResponseException: Returns the error type.
TelegramResponseException::getRawResponse() — Method in class TelegramResponseException: Returns the raw response used to create the exception.
TelegramResponseException::getResponseData() — Method in class TelegramResponseException: Returns the decoded response used to create the exception.
TelegramResponseException::getResponse() — Method in class TelegramResponseException: Returns the response entity used to create the exception.
InputFile::getFileName() — Method in class InputFile: Return the name of the file.
GuzzleHttpClient — Class in namespace Telegram\Bot\HttpClients: Class GuzzleHttpClient.
GuzzleHttpClient::getTimeOut() — Method in class GuzzleHttpClient
GuzzleHttpClient::getConnectTimeOut() — Method in class GuzzleHttpClient
Audio::getFileId() — Method in class Audio: Unique identifier for this file.
Audio::getDuration() — Method in class Audio: Duration of the audio in seconds as defined by sender.
Audio::getPerformer() — Method in class Audio: (Optional). Performer of the audio as defined by sender or by audio tags.
Audio::getTitle() — Method in class Audio: (Optional). Title of the audio as defined by sender or by audio tags.
Audio::getMimeType() — Method in class Audio: (Optional). MIME type of the file as defined by sender.
Audio::getFileSize() — Method in class Audio: (Optional). File size.
BaseObject::get() — Method in class BaseObject: Get an item from the collection by key.
BaseObject::getRawResponse() — Method in class BaseObject: Returns raw response.
BaseObject::getRawResult() — Method in class BaseObject: Returns raw result.
BaseObject::getStatus() — Method in class BaseObject: Get Status of request.
Chat::getId() — Method in class Chat: Unique identifier for this chat, not exceeding 1e13 by absolute value.
Chat::getType() — Method in class Chat: Type of chat, can be either 'private', 'group', 'supergroup' or 'channel'.
Chat::getTitle() — Method in class Chat: (Optional). Title, for channels and group chats.
Chat::getUsername() — Method in class Chat: (Optional). Username, for private chats and channels if available
Chat::getFirstName() — Method in class Chat: (Optional). First name of the other party in a private chat
Chat::getLastName() — Method in class Chat: (Optional). Last name of the other party in a private chat
Contact::getPhoneNumber() — Method in class Contact: Contact's phone number.
Contact::getFirstName() — Method in class Contact: Contact's first name.
Contact::getLastName() — Method in class Contact: (Optional). Contact's last name.
Contact::getUserId() — Method in class Contact: (Optional). Contact's user identifier in Telegram.
Document::getFileId() — Method in class Document: Unique file identifier.
Document::getThumb() — Method in class Document: (Optional). Document thumbnail as defined by sender.
Document::getFileName() — Method in class Document: (Optional). Original filename as defined by sender.
Document::getMimeType() — Method in class Document: (Optional). MIME type of the file as defined by sender.
Document::getFileSize() — Method in class Document: (Optional). File size.
File::getFileId() — Method in class File: Unique identifier for this file.
File::getFileSize() — Method in class File: (Optional). File size, if known.
File::getFilePath() — Method in class File: (Optional). File path. Use 'https://api.telegram.org/file/bot/' to get the file.
Location::getLongitude() — Method in class Location: Longitude as defined by sender.
Location::getLatitude() — Method in class Location: Latitude as defined by sender.
Message::getMessageId() — Method in class Message: Unique message identifier.
Message::getFrom() — Method in class Message: (Optional). Sender, can be empty for messages sent to channels.
Message::getDate() — Method in class Message: Date the message was sent in Unix time.
Message::getChat() — Method in class Message: Conversation the message belongs to.
Message::getForwardFrom() — Method in class Message: (Optional). For forwarded messages, sender of the original message.
Message::getForwardDate() — Method in class Message: (Optional). For forwarded messages, date the original message was sent in Unix time.
Message::getReplyToMessage() — Method in class Message: (Optional). For replies, the original message. Note that the Message object in this field will not contain further replytomessage fields even if it itself is a reply.
Message::getText() — Method in class Message: (Optional). For text messages, the actual UTF-8 text of the message.
Message::getAudio() — Method in class Message: (Optional). Message is an audio file, information about the file.
Message::getDocument() — Method in class Message: (Optional). Message is a general file, information about the file.
Message::getSticker() — Method in class Message: (Optional). Message is a sticker, information about the sticker.
Message::getVideo() — Method in class Message: (Optional). Message is a video, information about the video.
Message::getVoice() — Method in class Message: (Optional). Message is a voice message, information about the file.
Message::getCaption() — Method in class Message: (Optional). Caption for the photo or video contact.
Message::getContact() — Method in class Message: (Optional). Message is a shared contact, information about the contact.
Message::getLocation() — Method in class Message: (Optional). Message is a shared location, information about the location.
Message::getNewChatParticipant() — Method in class Message: (Optional). A new member was added to the group, information about them (this member may be the bot itself).
Message::getLeftChatParticipant() — Method in class Message: (Optional). A member was removed from the group, information about them (this member may be the bot itself).
Message::getNewChatTitle() — Method in class Message: (Optional). A chat title was changed to this value.
Message::getDeleteChatPhoto() — Method in class Message: (Optional). Service message: the chat photo was deleted.
Message::getGroupChatCreated() — Method in class Message: (Optional). Service message: the group has been created.
Message::getSupergroupChatCreated() — Method in class Message: (Optional). Service message: the super group has been created.
Message::getChannelChatCreated() — Method in class Message: (Optional). Service message: the channel has been created.
Message::getMigrateToChatId() — Method in class Message: (Optional). The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value.
Message::getMigrateFromChatId() — Method in class Message: (Optional). The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value.
PhotoSize::getFileId() — Method in class PhotoSize: Unique identifier for this file.
PhotoSize::getWidth() — Method in class PhotoSize: Photo width.
PhotoSize::getHeight() — Method in class PhotoSize: Photo height.
PhotoSize::getFileSize() — Method in class PhotoSize: (Optional). File size.
Sticker::getFileId() — Method in class Sticker: Unique identifier for this file.
Sticker::getWidth() — Method in class Sticker: Sticker width.
Sticker::getHeight() — Method in class Sticker: Sticker height.
Sticker::getThumb() — Method in class Sticker: (Optional). Sticker thumbnail in .webp or .jpg format.
Sticker::getFileSize() — Method in class Sticker: (Optional). File size.
Update::getUpdateId() — Method in class Update: The update's unique identifier. Update identifiers start from a certain positive number and increase sequentially.
Update::getMessage() — Method in class Update: (Optional). New incoming message of any kind - text, photo, sticker, etc.
User::getId() — Method in class User: Unique identifier for this user or bot.
User::getFirstName() — Method in class User: User's or bot's first name.
User::getLastName() — Method in class User: (Optional). User's or bot's last name.
User::getUsername() — Method in class User: (Optional). User's or bot's username.
UserProfilePhotos::getTotalCount() — Method in class UserProfilePhotos: Total number of profile pictures the target user has.
Video::getFileId() — Method in class Video: Unique identifier for this file.
Video::getWidth() — Method in class Video: Video width as defined by sender.
Video::getHeight() — Method in class Video: Video height as defined by sender.
Video::getDuration() — Method in class Video: Duration of the video in seconds as defined by sender.
Video::getThumb() — Method in class Video: (Optional). Video thumbnail.
Video::getMimeType() — Method in class Video: (Optional). Mime type of a file as defined by sender.
Video::getFileSize() — Method in class Video: (Optional). File size.
Voice::getFileId() — Method in class Voice: Unique identifier for this file.
Voice::getDuration() — Method in class Voice: Duration of the audio in seconds as defined by sender.
Voice::getMimeType() — Method in class Voice: (Optional). MIME type of the file as defined by sender.
Voice::getFileSize() — Method in class Voice: (Optional). File size.
TelegramClient::getHttpClientHandler() — Method in class TelegramClient: Returns the HTTP client handler.
TelegramClient::getBaseBotUrl() — Method in class TelegramClient: Returns the base Bot URL.
TelegramRequest::getAccessToken() — Method in class TelegramRequest: Return the bot access token for this request.
TelegramRequest::getMethod() — Method in class TelegramRequest: Return the HTTP method for this request.
TelegramRequest::getEndpoint() — Method in class TelegramRequest: Return the API Endpoint for this request.
TelegramRequest::getParams() — Method in class TelegramRequest: Return the params for this request.
TelegramRequest::getHeaders() — Method in class TelegramRequest: Return the headers for this request.
TelegramRequest::getPostParams() — Method in class TelegramRequest: Only return params on POST requests.
TelegramRequest::getDefaultHeaders() — Method in class TelegramRequest: The default headers used with every request.
TelegramRequest::getTimeOut() — Method in class TelegramRequest
TelegramRequest::getConnectTimeOut() — Method in class TelegramRequest
TelegramResponse::getRequest() — Method in class TelegramResponse: Return the original request that returned this response.
TelegramResponse::getHttpStatusCode() — Method in class TelegramResponse: Gets the HTTP status code.
TelegramResponse::getEndpoint() — Method in class TelegramResponse: Gets the Request Endpoint used to get the response.
TelegramResponse::getAccessToken() — Method in class TelegramResponse: Return the bot access token that was used for this request.
TelegramResponse::getHeaders() — Method in class TelegramResponse: Return the HTTP headers for this response.
TelegramResponse::getBody() — Method in class TelegramResponse: Return the raw body response.
TelegramResponse::getDecodedBody() — Method in class TelegramResponse: Return the decoded body response.
TelegramResponse::getThrownException() — Method in class TelegramResponse: Returns the exception that was thrown for this request.

H

Api::hasContainer() — Method in class Api: Check if IoC Container has been set.
Command::handle() — Method in class Command: Process the command.
CommandBus::handler() — Method in class CommandBus: Handles Inbound Messages and Executes Appropriate Command.
CommandInterface::handle() — Method in class CommandInterface: Process the command.
HelpCommand — Class in namespace Telegram\Bot\Commands: Class HelpCommand.
HelpCommand::handle() — Method in class HelpCommand: Process the command.
HttpClientInterface — Class in namespace Telegram\Bot\HttpClients: Interface HttpClientInterface.

I

Api::isAsyncRequest() — Method in class Api: Check if this is an asynchronous request (non-blocking).
Api::isMessageType() — Method in class Api: Determine if a given type is the message.
InputFile — Class in namespace Telegram\Bot\FileUpload: Class InputFile.
TelegramRequest::isAsyncRequest() — Method in class TelegramRequest: Check if this is an asynchronous request (non-blocking).
TelegramResponse::isError() — Method in class TelegramResponse: Checks if response is an error.

L

Location — Class in namespace Telegram\Bot\Objects: Class Location.

M

Command::make() — Method in class Command: Process Inbound Command.
CommandInterface::make() — Method in class CommandInterface: Process Inbound Command.
BaseObject::mapRelatives() — Method in class BaseObject: Map property relatives to appropriate objects.
Message — Class in namespace Telegram\Bot\Objects: Class Message.
TelegramResponse::makeException() — Method in class TelegramResponse: Instantiates an exception to be thrown later.

O

InputFile::open() — Method in class InputFile: Opens file stream.

P

CommandBus::parseCommand() — Method in class CommandBus: Parse a Command for a Match.
TelegramServiceProvider::provides() — Method in class TelegramServiceProvider: Get the services provided by the provider.
PhotoSize — Class in namespace Telegram\Bot\Objects: Class PhotoSize.
TelegramClient::prepareRequest() — Method in class TelegramClient: Prepares the API request for sending to the client handler.

R

Api::removeCommand() — Method in class Api: Remove Telegram Command to the Command Bus.
Api::removeCommands() — Method in class Api: Remove Telegram Commands from the Command Bus.
Api::removeWebhook() — Method in class Api: Removes the outgoing webhook (if any).
Api::replyKeyboardMarkup() — Method in class Api: Builds a custom keyboard markup.
Api::replyKeyboardHide() — Method in class Api: Hide the current custom keyboard and display the default letter-keyboard.
Command::replyWithMessage() — Method in class Command: Reply Chat with a message. You can use all the sendMessage() parameters except chat_id.
Command::replyWithPhoto() — Method in class Command: Reply Chat with a Photo. You can use all the sendPhoto() parameters except chat_id.
Command::replyWithAudio() — Method in class Command: Reply Chat with an Audio message. You can use all the sendAudio() parameters except chat_id.
Command::replyWithVideo() — Method in class Command: Reply Chat with a Video. You can use all the sendVideo() parameters except chat_id.
Command::replyWithVoice() — Method in class Command: Reply Chat with a Voice message. You can use all the sendVoice() parameters except chat_id.
Command::replyWithDocument() — Method in class Command: Reply Chat with a Document. You can use all the sendDocument() parameters except chat_id.
Command::replyWithSticker() — Method in class Command: Reply Chat with a Sticker. You can use all the sendSticker() parameters except chat_id.
Command::replyWithLocation() — Method in class Command: Reply Chat with a Location. You can use all the sendLocation() parameters except chat_id.
Command::replyWithChatAction() — Method in class Command: Reply Chat with a Chat Action. You can use all the sendChatAction() parameters except chat_id.
CommandBus::removeCommand() — Method in class CommandBus: Remove a command from the list.
CommandBus::removeCommands() — Method in class CommandBus: Removes a list of commands.
TelegramServiceProvider::register() — Method in class TelegramServiceProvider: Register the service provider.
Audio::relations() — Method in class Audio: Property relations.
BaseObject::relations() — Method in class BaseObject: Property relations.
Chat::relations() — Method in class Chat: Property relations.
Contact::relations() — Method in class Contact: Property relations.
Document::relations() — Method in class Document: Property relations.
File::relations() — Method in class File: Property relations.
Location::relations() — Method in class Location: Property relations.
Message::relations() — Method in class Message: Property relations.
PhotoSize::relations() — Method in class PhotoSize: Property relations.
Sticker::relations() — Method in class Sticker: Property relations.
Update::relations() — Method in class Update: Property relations.
Update::recentMessage() — Method in class Update: Get recent message.
User::relations() — Method in class User: Property relations.
UserProfilePhotos::relations() — Method in class UserProfilePhotos: Property relations.
Video::relations() — Method in class Video: Property relations.
Voice::relations() — Method in class Voice: Property relations.

S

Api::setAccessToken() — Method in class Api: Sets the bot access token to use with API requests.
Api::setAsyncRequest() — Method in class Api: Make this request asynchronous (non-blocking).
Api::sendMessage() — Method in class Api: Send text messages.
Api::sendPhoto() — Method in class Api: Send Photos.
Api::sendAudio() — Method in class Api: Send regular audio files.
Api::sendDocument() — Method in class Api: Send general files.
Api::sendSticker() — Method in class Api: Send .webp stickers.
Api::sendVideo() — Method in class Api: Send Video File, Telegram clients support mp4 videos (other formats may be sent as Document).
Api::sendVoice() — Method in class Api: Send voice audio files.
Api::sendLocation() — Method in class Api: Send point on the map.
Api::sendChatAction() — Method in class Api: Broadcast a Chat Action.
Api::setWebhook() — Method in class Api: Set a Webhook to receive incoming updates via an outgoing webhook.
Api::setContainer() — Method in class Api: Set the IoC Container.
Api::setTimeOut() — Method in class Api
Api::setConnectTimeOut() — Method in class Api
Command::setName() — Method in class Command: Set Command Name.
Command::setDescription() — Method in class Command: Set Command Description.
GuzzleHttpClient::setClient() — Method in class GuzzleHttpClient: Sets HTTP client.
GuzzleHttpClient::send() — Method in class GuzzleHttpClient
HttpClientInterface::send() — Method in class HttpClientInterface
Sticker — Class in namespace Telegram\Bot\Objects: Class Sticker.
TelegramClient::setHttpClientHandler() — Method in class TelegramClient: Sets the HTTP client handler.
TelegramClient::sendRequest() — Method in class TelegramClient: Send an API request and process the result.
TelegramRequest::setAccessToken() — Method in class TelegramRequest: Set the bot access token for this request.
TelegramRequest::setMethod() — Method in class TelegramRequest: Set the HTTP method for this request.
TelegramRequest::setEndpoint() — Method in class TelegramRequest: Set the endpoint for this request.
TelegramRequest::setParams() — Method in class TelegramRequest: Set the params for this request.
TelegramRequest::setHeaders() — Method in class TelegramRequest: Set the headers for this request.
TelegramRequest::setAsyncRequest() — Method in class TelegramRequest: Make this request asynchronous (non-blocking).
TelegramRequest::setTimeOut() — Method in class TelegramRequest
TelegramRequest::setConnectTimeOut() — Method in class TelegramRequest

T

TelegramOtherException — Class in namespace Telegram\Bot\Exceptions: Class TelegramOtherException.
TelegramResponseException — Class in namespace Telegram\Bot\Exceptions: Class TelegramResponseException.
TelegramSDKException — Class in namespace Telegram\Bot\Exceptions: Class TelegramSDKException.
TelegramUndefinedPropertyException — Class in namespace Telegram\Bot\Exceptions: Class TelegramUndefinedPropertyException.
Telegram — Class in namespace Telegram\Bot\Laravel\Facades: Class Telegram.
TelegramServiceProvider — Class in namespace Telegram\Bot\Laravel: Class TelegramServiceProvider.
TelegramClient — Class in namespace Telegram\Bot: Class TelegramClient.
TelegramRequest — Class in namespace Telegram\Bot: Class TelegramRequest.
TelegramResponse — Class in namespace Telegram\Bot: Class TelegramResponse.
TelegramResponse::throwException() — Method in class TelegramResponse: Throws the exception.

U

Update — Class in namespace Telegram\Bot\Objects: Class Update.
User — Class in namespace Telegram\Bot\Objects: Class User.
UserProfilePhotos — Class in namespace Telegram\Bot\Objects: Class UserProfilePhotos.

V

Video — Class in namespace Telegram\Bot\Objects: Class Video.
Voice — Class in namespace Telegram\Bot\Objects: Class Voice.
TelegramRequest::validateAccessToken() — Method in class TelegramRequest: Validate that bot access token exists for this request.
TelegramRequest::validateMethod() — Method in class TelegramRequest: Validate that the HTTP method is set.

_

Api::__construct() — Method in class Api: Instantiates a new Telegram super-class object.
Api::__call() — Method in class Api: Magic method to process any "get" requests.
Command::__call() — Method in class Command: Magic Method to handle all ReplyWith Methods.
CommandBus::__construct() — Method in class CommandBus: Instantiate Command Bus.
TelegramResponseException::__construct() — Method in class TelegramResponseException: Creates a TelegramResponseException.
InputFile::__construct() — Method in class InputFile: Creates a new InputFile entity.
GuzzleHttpClient::__construct() — Method in class GuzzleHttpClient
GuzzleHttpClient::__destruct() — Method in class GuzzleHttpClient: Unwrap Promises.
BaseObject::__construct() — Method in class BaseObject: Builds collection entity.
BaseObject::__call() — Method in class BaseObject: Magic method to get properties dynamically.
TelegramClient::__construct() — Method in class TelegramClient: Instantiates a new TelegramClient object.
TelegramRequest::__construct() — Method in class TelegramRequest: Creates a new Request entity.
TelegramResponse::__construct() — Method in class TelegramResponse: Gets the relevant data from the Http client.