Métodos

ShellBot.init

Use esse método para inicializar o bot a partir de uma chave (TOKEN) válida. É retornado um objeto bot em caso de sucesso.

É necessário inciar o bot (ShellBot.init) para obter acesso aos seus métodos.

Uso:

ShellBot.init --token token ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-t, --token <token>	String	Sim	Especificar a chave única de autenticação (TOKEN)
-m, --monitor	nenhum	Não	Ativa o modo monitor do bot. Utilize esse parâmetro para exibir no prompt os eventos do chat, tais como: comandos, mensagens e inicialização de variáveis. Para mensagens é necessário que o bot seja administrador do chat.
-f, --flush	nenhum	Nâo	Limpa a lista offset de atualizações do bot. Se houver registros é retornado o flush_first_id e flush_last_id da lista. Caso contrário seus valores serão iguais a 0 (zero). Quaisquer chamadas, eventos e requisições realizadas serão ignoradas durante o processo de inicialização. Os registros poderão ser recuperados informando o código de deslocamento negativo. Veja: ShellBot.getUpdates para mais informações.
-s, --service	nenhum	Nâo	Cria um Bot Unit Service no sistema de gerenciamento de processos systemd (Nota: requer privilégios de root). Realiza uma chamada em background e habilita o bot na inicialização do sistema. O parâmetro é obrigatório somente se opção -u, --user for informada.
-u, --user <usuario>	string	Não	Define o usuário sob o qual a instância do serviço irá executar. Se o parâmetro for omitido, o usuário atual do sistema será utilizado.
-r, --return <tipo>	String	Nâo	Tipo do dado retornado pelos métodos exceto ShellBot.getUpdates. Tipos: (json, map ou value [padrão] ). Veja: tipos de retorno
-l, --log_file <arquivo>	string	Nâo	Caminho completo do arquivo de log a ser gerado.
-o, --log_format <formato>	String	Não	Formato padrão de saída do log. Veja: flags de expansão
-d, --delimiter <delimitador>	String	Nâo	Define o delimitador padrão utilizado pela API para intercalação dos valores. (padrão: '|')

Cada bot criado recebe sua chave única de autenticação (TOKEN) para obter privilégios no momento de invocar seus métodos.

Tipos de retorno

É uma coleção de objetos formatado em tipo especifico de dado e que é retornado após a chamada de um método.

Tipo	Descrição
json	Retorna um objeto json.
value	Retorna somente os valores separados pelo delimitador padrão.
map	Inicializa o array associativo return mapeando as chaves e valores retornados. (Não verboso. Somente no modo monitor)

Nota: Se a chave contém uma coleção de elementos, os valores dos mesmos são anexados por meio do delimitador. return[chave]='valor1|valor2|valor3|...'

O array return é instanciado sempre que um método é chamado (exceto: ShellBot.getUpdates).

Flags de expansão

A flag de expansão é um identificador único cujo valor dinâmico referente é expandido a cada iteração.

Flag	Descrição
{OK}	Status de retorno do método. (true ou false)
{UPDATE_ID}	Identificador único da atualização.
{MESSAGE_ID}	Identificador exclusivo da mensagem no chat.
{FROM_ID}	Identificador exclusivo do usuário ou bot.
{FROM_IS_BOT}	Se o remetente da mensagem é um bot. (true ou false)
{FROM_FIRST_NAME}	Primeiro nome do usuário ou bot.
{FROM_USERNAME}	Nome do usuário ou bot.
{FROM_LANGUAGE_CODE}	Identificador do idioma do usuário.
{CHAT_ID}	Identificador exclusivo do supergrupo, canal ou grupo.
{CHAT_TITLE}	Título do supergrupo, canal ou grupo.
{CHAT_TYPE}	Tipo do chat. (private, group, supergroup or channel)
{MESSAGE_DATE}	Data em que a mensagem foi enviada no horário do Unix.
{ENTITIES_TYPE}	Tipo da entidade. (mention, hashtag, bot_command, url, email, bold, italic, code, pre, text_link, text_mention)
{BOT_TOKEN}	Chave única de autenticação.
{BOT_ID}	Identificador exclusivo do bot.
{BOT_FIRST_NAME}	Primeiro nome do bot.
{BOT_USERNAME}	Nome do usuário do bot.
{METHOD}	Nome do método chamado.
{RETURN}	Retorno do método.
{BASENAME}	Nome base do script.
%(FMT)T	Gera a string de data e hora resultante do uso do FMT como um formato string para strftime. ( "Hora atual: %(%H:%M)T" => "Hora atual: 12:30" )

Se o arquivo de log for especificado e o formato de saída for omitido, assume o padrão: %(%d/%m/%Y %H:%M:%S)T: {BASENAME}: {BOT_USERNAME}: {UPDATE_ID}: {METHOD}: {FROM_USERNAME}: {MESSAGE_TEXT}

ShellBot.token

Retorna o token do bot.

Uso:

ShellBot.token

• Função nao requer parametros.

Retorno:

bot_token

ShellBot.id

Retorna o identificador exclusivo do bot.

Uso:

ShellBot.id

• Função nao requer parametros.

Retorno:

bot_id

ShellBot.username

Retorna o nome de usuario do bot.

Uso:

ShellBot.username

• Função nao requer parametros.

Retorno:

bot_username

ShellBot.first_name

Retorna o primeiro nome do bot.

Uso:

ShellBot.first_name

• Função nao requer parametros.

Retorno:

bot_first_name

ShellBot.regHandleFunction

Associa um valor armazenado em $callback_query_data a uma função. Registra o handle do identificador a ser monitorado pela função ShellBot.watchHandle. O valor é retornado sempre que um inline_button é pressionado.

Uso:

ShellBot.RegHandleFunction --function <identificador> --callback_data <valor> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-f, --function <identificador>	String	Sim	Nome da função válida que será executada.
-d, --callback_data <valor>	String	Sim	Valor associado a um inline_button a ser retornado.
-a, --args <argumentos>	String	Não	Argumentos a serem passados na chamada da função.

ShellBot.watchHandle

Monitora as funções registradas com ShellBot.regHandleFunction e executa caso o valor especificado em callback_data for encontrado. A função deve receber um valor dinâmico. Ou seja, Utiliza-se a variável $callback_query_data como argumento.

Uso:

ShellBot.watchHandle --callback_data <$callback_query_data>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-d, --callback_data <$callback_query_data>	String	Sim	Variável dinâmica onde é armazenado o valor callback_data retornado quando um inline_button é pressionado.

ShellBot.TotalUpdates

Retorna o total de atualizações. O valor máximo de resultados é especificado em ShellBot.getUpdates.

Uso:

ShellBot.TotalUpdates

Função não requer parâmetros/argumentos.

ShellBot.ListUpdates

Retorna os índices das atualizações armazenadas. Se o número de atualizações for maior que 1 os resultados são armazenados em um array's indexado.

Uso:

ShellBot.ListUpdates

Função não requer parâmetros/argumentos.

ShellBot.OffsetEnd

Retorna o ID da última atualização. Retorna 0 caso não haja atualizações.

Uso:

ShellBot.OffsetEnd

Função não requer parâmetros/argumentos.

ShellBot.OffsetNext

Retorna o ID da próxima atualização (offset+1)

Uso:

ShellBot.OffsetNext

Função não requer parâmetros/argumentos.

ShellBot.setMessageRules

Use essa função para definir um conjunto de regras de ação em mensagens enviadas pelo usuário em um grupo, super-grupo ou bate-papo privado. (Veja também: ShellBot.manageRules)

Uso:

ShellBot.setMessageRules --name <regra> ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-s, --name <nome>	String	Sim	Nome da regra. Define um nome de identificação para o conjunto de regras cujo caracteres suportados são: [a-zA-Z0-9_].
-a, --action <funcao>	String	Não	Identificador de uma função válida. Define a função de ação para as regras estabelecidas.
-z, --action_args <argumentos>	String	Não	Lista de argumentos passados na chamada da função de ação. Se o parâmetro for omitido assume como padrão os argumentos posicionais contidos na mensagem.
-c, --command <comando>	String	Não	Comando do bot. O comando deve sempre começar com o símbolo / e não pode ter mais de 32 caracteres cujo suportados são: [a-zA-Z0-9_]. (Nota: Somente comandos de inicio de linha são considerados)
-i, --user_id <identificador>	Integer	Nâo	Identificador exclusivo do usuário. Suporta grupo de captura.
-u, --username <nome>	String	Não	Nome do usuário. Suporta grupo de captura.
-h, --chat_id <identificador>	Integer	Não	Identificador exclusivo do bate-papo. Suporta grupo de captura.
-v, --chat_name <nome>	String	Não	Nome exclusivo do grupo. Suporta grupo de captura.
-y, --chat_type <tipo>	String	Não	Tipo do bate-papo. (Tipos: private, group, supergroup). Suporta grupo de captura.
-l, --language_code <code>	String	Não	IETF language tag do idioma do usuário. Suporta grupo de captura.
-m, --message_id <identificador>	Integer	Não	Identificador exclusivo da mensagem. Suporta grupo de captura.
-b, --is_bot <valor>	Boolean	Não	Se o usuário é um bot. Suporta grupo de captura.
-t, --text <padrao>	String	Nâo	Um padrão ou uma sequência de caracteres contidos no corpo da mensagem. Suporta Expressões regulares.
-n, --entitie_type <entidade>	String	Nâo	Tipo da entidade da mensagem. (Entidades: mention, hashtag, bot_command, url, email, bold, italic, code pre, text_link, text_mention, cashtag e phone_number)
-f, --file_type <tipo>	String	Não	Tipo do arquivo enviado. (Tipos: photo, document, sticker, gif, video, audio, voice, contact e location)
-p, --mime_type <nome>	String	Não	Identificador do formato do arquivo transmitido. Suporta grupo de captura.
-q, --query_data <valor>	String	Nâo	Dados associados ao botão de retorno de chamada. Suporta grupo de captura.
-r, --query_id <identificador>	Integer	Não	ID exclusivo do teclado. Suporta grupo de captura.
-g, --chat_member <status>	String	Não	Status do usuário em um grupo. (Status: left e new).
-o, --num_args <nargs>	Integer	Não	Número de argumentos contidos na mensagem, cuja sequência de caracteres é delimitada por ' ' (espaço). Suporta grupo de captura.
-e, --time <hora>	String	Não	Período entre hora inicial e final. (Formato: HH:MM-HH:MM)
-d, --date <data>	String	Nâo	Período entre data inicial e final. (Formato: %d/%m/%Y-%d/%m/%Y)
-w, --weekday <dia>	Integer	Nâo	Dia da semana (1..7). 1 é segunda-feira. Suporta grupo de captura
-j, --user_status <status>	String	Não	Status do usuário em um grupo ou super-grupo. (creator, administrator, member, restricted, left ou kicked). Suporta grupo de captura.
-x, --message_status <status>	String	Não	Status da mensagem. (pode ser: edited, pinned e forwarded)
--bot_reply_message <texto>	String	Não	Envia automaticamente uma mensagem de resposta ao usuário. Suporta expansão de variáveis.
--bot_send_message <texto>	String	Nâo	Envia automaticamente uma mensagem ao usuário. Suporta somente expansão de variáveis.
--bot_forward_message <identificador>	Integer	Não	Encaminha a mensagem para o identificador do bate-papo especificado.
--bot_reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)
--bot_parse_mode <modo>	String	Nâo	Modo de formatação. Define a formatação do texto para --bot_reply_message e --bot_send_message'. Suporta somente formatação markdownehtml`
--exec <comandos>	String	Nâo	Lista de comandos. Executa os comandos em um shell não interativo no host local e envia uma mensagem automática ao remetente contendo o retorno do comando (se presente). Se o retorno for superior a 4096 caracteres o mesmo será divido em blocos menores até que todo contéudo seja enviado. O PIPE | é suportado somente em declarações explícitas, caso contrário será interpretado como um caractere literal. Suporta expansão de variáveis e argumentos posicionais. (ATENÇÃO: Utilize esse parâmetro com prudência vinculando-o somente à regras restritas.)
--continue	Nenhum	Não	Aplica a ação e continua a verificação das regras subsequentes.

Nota: São suportados múltiplos parâmetros na mesma regra. (exceto: -t, --text, -a, --action, --exec, --bot_reply_message, --bot_send_message, --bot_parse_mode e --bot_reply_markup)

O parâmetro -a, --action possui precedência na execução em relação ao --exec caso ambos sejam especificados na mesma regra.

Utilize somente aspas simples (') nos parâmetros --bot_reply_message, --bot_send_message e --exec para evitar a expansão prematura.

Grupo de captura

O grupo de captura é um conjunto contendo uma lista de elementos a serem verificados e que retorna verdadeiro se um elemento for encontrado. Os elementos podem ser delimitados por uma vírgula , ou PIPE | e deve respeitar a seguinte sintaxe:

Grupo

item1,item2,item3,... ou item1|item2|item3|...

Grupo (negado)

Utilize o metacaractere ! para definir um grupo negado, ou seja, tudo exceto o que foi especificado.

!(item1,item2,item3,...) ou !(item1|item2|item3|...)

Obs: não pode conter espaços entre os elementos.

Exemplo:

Liberando o comando /totalmembros somente para administradores específicos.

# Modo: --return value (ShellBot.init)
ShellBot.setMessageRules	--name 'comando_admins'				
							--entitie_type bot_command 				\
							--command '/totalmembros'				\
							--chat_type '!(private)' 				\	# Qualquer chat. (exceto: privado)
							--user_status 'administrator' 			\	# Somente admnistradores
							--username '(admin3,admin6,admin8)'		\	# Somente 'admin3', 'admin6' e 'admin8'
							--exec 'ShellBot.getChatMembersCount --chat_id ${message_chat_id} | cut -d"|" -f2'

# Obs: remova os comentários antes de usar.

Expansão de variáveis

O recurso de expansão permite acessar o valor de uma determinada variável por meio do seu identificador único, exemplo: ${var}.

Exemplo:

Criando um comando chamado /meuid que retorna o id do usuário.

ShellBot.setMessageRules	--name 'retornar_id' 									\
							--entitie_type bot_command 								\
							--num_args	1											\
							--command '/meuid'										\
							--bot_send_message '*O seu id é:* ${message_from_id}' 	\
							--bot_parse_mode markdown

Argumentos posicionais

O argumento posicional é análogo ao recurso de expansão, porém permite acessar elementos específicos da mensagem enviada pelo usuário informando o ${N} elemento, onde N é um inteiro que representa sua posição e que é delimitada por um espaço ( ). Utilize os metacaracteres @ ou * para capturar todos os argumentos, para mais detalhes: $ man bash.

É possível construir uma linha de comando dinâmica com os argumentos fornecidos na mensagem.

Exemplo 1:

Criando uma regra que simula a função do comando egrep.

Sintaxe: /egrep padrao arquivo

ShellBot.setMessageRules	--name 'cmd_egrep' 			\
							--entitie_type bot_command	\
							--chat_type	private			\
							--username 'admin'			\
							--command '/egrep'			\
							--num_args 3				\
							--exec 'grep -E "$2" $3'

Observação: Para evitar que o retorno seja enviado ao usuário basta suprimir a saída do mesmo inserindo &>/dev/null ao final do comando, exemplo: comandos .... &>/dev/null

Exemplo 2:

Implementando um shell linux que executa qualquer comando enviado pelo usuário. (Nota: Esse exemplo é somente para fins ditáticos, dada as circustâncias e riscos aplique somente em regras restritivas.)

Sintaxe: /shell commandos...

# Aceita a requisição no privado e executa o comando somente
# para o usuário especificado.
#
# Obs: Substitua os campos <...> pelas informações do seu usuário (Telegram).
ShellBot.setMessageRules	--name 'shell_linux'		\
							--entitie_type bot_command	\
							--command '/shell'			\
							--chat_type private			\
							--user_id <ROOT_ID>			\
							--username '<ROOT_NAME>'	\
							--exec '${@:2}'				# Executa os argumentos. (exceto: '/shell')

ATENÇÃO: Caso seja necessário acessar os elementos da mensagem é altamente recomendado o uso do argumento posicional, pois o valor é acessado por referência e não por substituíção como ocorre na expansão da variável, ou seja, se o valor de ${message_text} conter a sintaxe de um comando válido o mesmo é executado prematuramente. Se deseja acessar todos os elementos da mensagem, utilize $@ou $* ao invés ${message_text}.

Verificação

As regras são verificadas sequêncialmente na ordem em que foram definidas e, se a mensagem enviada satisfazer os critérios estabelecidos a ação é aplicada (se presente) e salta para a próxima requisição (exceto se --continue for especiifcado). Se um determinado parâmetro for especificado mais de uma vez a regra é aplicada se pelo menos um dos argumentos for válido.

Ignorando/Negando requisições.

Além da permissiva é possível definir uma regra que funcione como uma negativa de critérios, omitindo o parâmetro -a, --action ou --exec. Uma regra sem ação vinculada é útil quando precisamos simplesmente ignorar uma requisição ao invés de tratá-la. Para esse tipo de implementação é recomendado que precedam as regras de ação, ou seja, não se pode proibir o que já foi permitido. :D

Exemplo:

Ignorando a requisição do comando /botcmd para um determinado grupo de usuários, seja ele enviado em um super-grupo ou privado. (Veja também: manageRules.sh)

# Negar
ShellBot.setMessageRules	--name 'negar_commando_usuarios' 	\
				--command '/botcmd' 			\
				--chat_type supergroup 			\
				--chat_type private 			\
				--username 'usuario1'			\
				--username 'usuario2'			\
				--username 'usuario3'			\
				--username 'usuario4'

# Permitir (executa a ação em: "funcao_cmd")
ShellBot.setMessageRules	--name 'executar_comando'	\
				--command '/botcmd'		\
				--action 'funcao_cmd'

ShellBot.manageRules

Use essa função para gerenciar/executar as regras definidas para mensagens de usuários. Executa a função (se presente) somente se a mensagem satisfazer o conjunto de regras a qual está vinculada. Retorna true se uma regra for aplicada, caso contrário false. (Veja também: ShellBot.setMessageRules).

Uso:

ShellBot.manageRules --update_id <id>

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --update_id <id>	Integer	Sim	ID da atualização a ser gerenciada. (Veja: ShellBot.ListUpdates)

Se o modo monitor estiver ativado é retornado as informações referentes a regra aplicada no seguinte formato:

\[ShellBot.manageRules\]: <nmsg>: <data> <hora>: <tipo>: <grupo>: <usuario>: <arquivo>: <linha>: <regra>: <acao>: <comandos>

ShellBot.forwardMessage

Encaminha mensagem para um usuário/grupo/canal especificado.

Uso:

ShellBot.forwardMessage --chat_id identificador --from_chat_id identificador --message_id identificador ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o ... como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-f, --from_chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-n, --disable_notification <status>	boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som.
-m, --message_id <identificador>	integer	Sim	Identificador da mensagem no chat especificado em from_chat_id

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendMessage

Envia mensagem para um usuário, grupo ou canal especificado.

Uso:

ShellBot.sendMessage --chat_id identificador --text texto ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-t, --text <texto>	string	Sim	Mensagem de texto a ser enviada
-p, --parse_mode <modo>	string	Não	Modo de formatação aplicada ao texto enviado (markdown ou html).
-w, --disable_web_page_preview <status>	boolean	Nâo	Desabilita a pré-visualização de links na mensagem (true ou false).
-n, --disable_notification <status>	boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	inteiro	Não	Se a mensagem for uma resposta, informar o ID da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

Opções de formatação:

A API de Bot suporta a formatação básica para mensagens. Você pode usar texto negrito e itálico, bem como links inline e código pré-formatado nas mensagens de seus bots. Os clientes do Telegram irão processá-los adequadamente. Você pode usar formatação de estilo markdown ou HTML.

Observe que os clientes do Telegram exibirão um alerta para o usuário antes de abrir um link inline ('Abrir este link?' Juntamente com o URL completo).

Links tg://user?id=<user_id> pode ser usado para mencionar um usuário por sua identificação sem usar um nome de usuário. Observe:

Esses links funcionarão somente se forem usados dentro de um link in-line. Estas menções só são garantidas para funcionar se o usuário contatou o bot no passado ou é um membro no grupo onde ele foi mencionado.

Markdown

Utilize o parâmetro -p, --parse_mode markdown na chamada do método para ativar a formatação. Use a seguinte sintaxe na sua mensagem:

*bold text*
_italic text_
[text](http://www.example.com/)
`inline fixed-width code`
```text pre-formatted fixed-width code block```

HTML

Utilize o parâmetro -p, --parse_mode html na chamada do método para ativar a formatação. Use a seguinte sintaxe na sua mensagem:

<b>bold</b>, <strong>bold</strong>
<i>italic</i>, <em>italic</em>
<a href="http://www.example.com/">inline URL</a>
<code>inline fixed-width code</code>
<pre>pre-formatted fixed-width code block</pre>

Observe:

• somente as tags mencionadas acima são atualmente suportadas.
• As tags não devem ser aninhadas.
• Todos os símbolos <,> e & que não fazem parte de uma tag ou de uma entidade HTML devem ser substituídos pelas entidades HTML correspondentes (<com & lt ;,> com & gt; e com & amp;).
• Todas as entidades numéricas HTML são suportadas.
• A API atualmente suporta somente as seguintes entidades HTML nomeadas: &lt ;, >, & e "".

ShellBot.sendPhoto

Envia arquivo de imagem para um usuário, grupo ou canal especificado.

Uso:

ShellBot.sendPhoto --chat_id identificador --photo arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-p, --photo <foto>	string	Sim	Foto pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/foto.jpeg.
-t, --caption <texto>	string	Não	Insere texto abaixo da imagem enviada (Máx: 200 caracteres).
-n, --disable_notification <status>	boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendAudio

Envia arquivo de audio para um usuário, grupo ou canal especificado.

Bots podem atualmente enviar arquivos de até 50 MB de tamanho, este limite pode ser alterado no futuro.

Uso:

ShellBot.sendAudio --chat_id identificador --audio arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-a, --audio <audio>	String	Sim	Audio pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/audio.mp3.
-t, --caption <texto>	String	Não	Insere texto abaixo do audio enviado (Máx: 200 caracteres).
-d, --duration <tempo>	Integer	Nâo	Duração do audio em segundos.
-e, --performer <texto>	String	Não	Performace do áudio.
-i, --title <titulo>	String	Não	Título do áudio.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
• Suporta somente arquivos do tipo .mp3.

ShellBot.sendDocument

Envia arquivos de qualquer tipo para um usuário, grupo ou canal especificado.

Bots podem atualmente enviar arquivos de até 50 MB de tamanho, este limite pode ser alterado no futuro.

Uso:

ShellBot.sendDocument --chat_id identificador --document arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-d, --document <arquivo>	String	Sim	Arquivo pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/arquivo.
-t, --caption <texto>	String	Não	Insere texto abaixo do documento enviado (Máx: 200 caracteres).
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendSticker

Envia sticker para um usuário, grupo ou canal especificado.

Uso:

ShellBot.sendSticker --chat_id identificador --sticker arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-s, --sticker <sticker>	String	Sim	Sticker pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/arquivo.webp.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Sticker pode ser também uma URL HTTP como uma String para Telegram para obter um arquivo .webp da Internet.
• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendVideo

Envia arquivo de video para um usuário, grupo ou canal especificado.

Bots podem atualmente enviar arquivos de até 50 MB de tamanho, este limite pode ser alterado no futuro.

Uso:

ShellBot.sendVideo --chat_id identificador --video arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-v, --video <video>	String	Sim	Video pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/video.mp4.
-d, --duration	Integer	Não	Duração do vídeo em segundos.
-w, --width	Integer	Não	Largura do video.
-h, --height	Integer	Não	Altura do video.
-t, --caption <texto>	String	Não	Insere texto abaixo do video enviado (Máx: 200 caracteres).
-s, --supports_streaming	Boolean	Não	Se o video tem suporte a streaming.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendVideoNote

A partir da v.4.0, os clientes do Telegram suportam vídeos do quadrado arredondado mp4 de até 1 minuto de duração. Use este método para enviar mensagens de vídeo. Em caso de sucesso, a mensagem enviada é devolvida.

Uso:

ShellBot.sendVideoNote --chat_id <identificador> --video_note <arquivo> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-v, --video_note <video>	String	Sim	Video pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/video.mp4.
-t, --duration <tempo>	Integer	Não	Duração do vídeo em segundos.
-l, --length <dimensao>	Integer	Nâo	Largura e altura do vídeo
-n, --disable_notification <true ou false>	Boolean	Nâo	Envia a mensagem silenciosamente. Os usuários receberão uma notificação sem som.
-r, --reply_to_message_id <identificador>	Integer	Nâo	Se a mensagem for uma resposta, a ID da mensagem original.
-m, --reply_markup <teclado>	InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply	Não	Opções de interface adicionais. Um objeto serializado em JSON para um teclado inline, teclado de resposta personalizado, instruções para remover o teclado de resposta ou para forçar uma resposta do usuário.

ShellBot.sendVoice

Envia um arquivo de voz para um usuário, grupo ou canal especificado.

Bots podem atualmente enviar arquivos de até 50 MB de tamanho, este limite pode ser alterado no futuro.

Uso:

ShellBot.sendVoice --chat_id identificador --voice arquivo ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-v, --voice <voz>	String	Sim	Voz pode ser um file_id caso o arquivo já exista nos servidores do Telegram. Para envio de arquivos locais, utilize o caractere @ seguido do diretório do arquivo. Exemplo: @/dir/voz.ogg.
-t, --caption <texto>	String	Não	Insere texto abaixo do arquivo de voz enviado (Máx: 200 caracteres).
-d, --duration <tempo>	Integer	Nâo	Duração do audio em segundos.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Voz - Para funcionar, o áudio deve estar em um arquivo .ogg codificado com o OPUS.
• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendLocation

Envia localizão no mapa para um usuario, grupo ou canal.

Uso:

ShellBot.sendLocation --chat_id identificador --latitude coordenada --longitude coordenada ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-l, --latitude <latitude>	Float	Sim	Latitude da localização (float).
-g, --longitude <longitude>	Float	Sim	Longitude da localização (float).
-p, --live_period <tempo>	Integer	Não	Período em segundos para o qual a localização será atualizada. Localizações ao vivo deve estar entre 60 e 86400.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendVenue

Envia informação sobre o local no mapa para um usuario, grupo ou canal.

Uso:

ShellBot.sendVenue --chat_id identificador --latitude coordenada --longitude coordenada --title titulo --address endereco --foursquare_id quadrante ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-l, --latitude <latitude>	Float	Sim	Latitude da localização.
-g, --longitude <longitude>	Float	Sim	Longitude da localização.
-i, --title <titulo>	String	Sim	Nome do local.
-a, --address <endereco>	String	Sim	Endereço do local.
-f, --foursquare_id <quadrante>	String	Sim	Quadrante de identificação do local.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendContact

Envia contato para um usuário, grupo ou canal especificado.

Uso:

ShellBot.sendContact --chat_id identificador --phone_number telefone --first_name nome ..

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-p, --phone_number <numero>	String	Sim	Número de telefone do contato.
-f, --first_name <nome>	String	Sim	Nome do contato.
-l, --last_name <sobrenome>	String	Nâo	Sobrenome do contato.
-n, --disable_notification <status>	Boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som (true ou false).
-r, --reply_to_message_id <identificador>	Integer	Não	Se a mensagem for uma resposta, informar o identificador da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.sendChatAction

Envia uma determina ação do bot em resposta a solicitação do usuário.

Uso:

ShellBot.sendChatAction --chat_id identificador --action acao

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-a, --action <acao>	String	Sim	Tipo da ação para retorno. Escolha uma, dependendo sobre qual tipo de ação será enviada ao usuário: typing, upload_photo, record_video, upload_video, record_audio, upload_audio, upload_document, find_location, record_video_note ou upload_video_note.

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.editMessageText

Edita mensagens enviadas ou no histórico de mensagens.

• So e possivel editar mensagens enviadas pelo bot.

Uso:

ShellBot.editMessageText --chat_id identificador --message_id identificador --text texto...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	Integer	Sim	Identificador único da mensagem.
-t, --text <texto>	String	Não	Nova mensagem texto.
-i, --inline_message_id <identificador>	String	Não	Identificador da mensagem inline. (Função não suportada).
-p, --parse_mode <modo>	Boolean	Não	Modo de formatação aplicada ao texto enviado (markdown ou html).
-w, --disable_web_page_preview <status>	Boolean	Não	Desabilita a pré-visualizaço de links na mensagem.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Não	Interface do teclado personalizada (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.editMessageCaption

Edita o titulo da mensagem enviada ou no historico de mensagens.

• So é possivel editar mensagens enviadas pelo bot.

Uso:

ShellBot.editMessageCaption --chat_id identificador --message_id identificador --caption texto ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	Integer	Sim	Identificador único da mensagem.
-t, --caption <texto>	String	Não	Novo título da mensagem.
-i, --inline_message_id <identificador>	String	Não	Identificador da mensagem inline. (Função não suportada).
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Não	Interface do teclado personalizada (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.editMessageReplyMarkup

Edita somente mensagem enviada do tipo teclado (ReplyKeyboardMarkup).

• Só é possivel editar mensagens enviadas pelo bot.

Uso:

ShellBot.editMessageReplyMarkup --chat_id identificador --message_id identificador --reply_markup teclado ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	Integer	Sim	Identificador único da mensagem.
-i, --inline_message_id <identificador>	String	Não	Identificador da mensagem inline. (Função não suportada).
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Não	Interface do teclado personalizada (Veja: ShellBot.ReplyKeyboardMarkup)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.getUserProfilePhotos

Retorna uma lista contendo as fotos de perfil dáo usuário.

Uso:

ShellBot.getUserProfilePhotos --user_id identificador ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário.
-o, --offset <numero>	Integer	Não	Número sequencial da primeira foto a ser retornada (Padrão: retorna todas).
-l, --limit <limite>	Integer	Nâo	Limite de fotos a serem retornadas. Valor entre 1 e 100 (Padrão: 100).

• Indentificador precisa ser um user_id

ShellBot.getMe

Retorna informações sobre o bot.

Utilize essa função para validar o TOKEN.

Uso:

ShellBot.getMe

• Função não requer parâmetros ou argumentos.
• As informações retornadas tem seus campos separados pelo delimitador | PIPE com o padrão: id|usuario|nome|sobrenome

ShellBot.getFile

Retorna informações básicas do arquivo.

Uso:

ShellBot.getFile --file_id identificador 

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-f, --file_id <identificador>	Integer	Sim	Identificador do arquivo.

• As informações retornadas tem seus campos separados pelo delimitador | PIPE com o padrão a seguir: id|tamanho|diretorio

ShellBot.getChat

Retorna informações atualizadas sobre o bate-papo (nome atual do usuario para conversas, username atual do usuario, grupo ou canal e etc.)

Uso:

ShellBot.getChat --chat_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)

• As informações retornadas tem seus campos separados pelo delimitador | PIPE com o padrão: id|tipo|usuario|nome|sobrenome|Titulo|TodosAdministradores
• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.getChatAdministrators

Retorna uma lista de administradores em um bate-papo. Em caso de sucesso, retorna uma matriz de objetos ChatMember que contém informações sobre todos os administradores de bate-papo, exceto outros bots. Se o bate-papo for um grupo ou um supergrupo e nenhum administrador for nomeado, somente o criador será retornado.

Uso:

ShellBot.getChatAdministrators --chat_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)

• As informações retornadas tem seus campos separados pelo delimitador | PIPE com o padrão: id|usuario|nome|sobrenome|status
• O status de um administrador pode ser: creator, administrator.
• Indentificador precisa ser id, @grupo ou @canal válido.

ShellBot.getChatMembersCount

Retorna a quantidade de membros em um bate-papo.

Uso:

ShellBot.getChatMembersCount --chat_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)

• Indentificador precisa ser id, @usuario, @grupo ou @canal válido.

ShellBot.getChatMember

Retorna informações sobre um membro do bate-papo.

Uso:

ShellBot.getChatMember --chat_id identificador --user_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário.

• As informações retornadas tem seus campos separados pelo delimitador | PIPE com o padrão: status|id|usuario|nome|sobrenome|status
• O status de um membro pode ser: creator, administrator, member, left or kicked.
• Indentificador precisa ser um user_id

ShellBot.getUpdates

Receber atualizações a partir de uma consulta.

Uso:

ShellBot.getUpdates ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-o, --offset	Integer	Nâo	Obtem atualizações do servidor, contendo o Identificador da primeira atualização a ser retornada. Deve ser maior em um que o maior entre os identificadores de atualizações recebidas anteriormente. Por padrão, as atualizações começando com a primeira atualização não confirmada são retornadas. Uma atualização é considerada confirmada assim que getUpdates é chamado com um deslocamento superior ao seu update_id. O deslocamento negativo pode ser especificado para recuperar atualizações a partir de -offset update a partir do final da fila de atualizações. Todas as atualizações anteriores serão esquecidas.
-l, --limit	integer	Nâo	Limita o número de atualizações a serem recuperadas. Valores entre 1-100 são aceitos. O padrão é 100.
-t, --timeout	Integer	Não	Tempo limite em segundos para pesquisa. O padrão é 0, ou seja, a sondagem curta não é usual. Deve ser positivo, a sondagem curta deve ser usada apenas para fins de teste.
-a, --allowed_updates	Array ou String	Não	Liste os tipos de atualizações que você deseja que seu bot receba. Por exemplo, especifique ["mensagem", "edited_channel_post"] para receber apenas atualizações desses tipos. Especifique uma lista vazia para receber todas as atualizações, independentemente do tipo (padrão). Se não for especificado, a configuração anterior será utilizada.

ShellBot.kickChatMember

Para chutar um usuário de um grupo ou um supergrupo. No caso de supergrupos, o usuário não será capaz de retornar ao grupo por conta própria, usando links convidados, etc., a menos que seja primeiro interditado. O bot deve ser um administrador do grupo para que isso funcione.

Uso:

ShellBot.kickChatMember --chat_id identificador --user_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário.

Nota: Funcionará somente se a configuração 'Todos os membros forem administradores' estiver desativada no grupo-alvo. Caso contrário, os membros só podem ser removidos pelo criador do grupo ou pelo membro que os adicionou.

ShellBot.unbanChatMember

Desfazer a ção de um usuário chutado anteriormente em um supergrupo. O usuário não retornará ao grupo automaticamente, mas poderá juntar-se através da ligação, etc. O bot deve ser um administrador no grupo para que este trabalhe.

Uso:

ShellBot.unbanChatMember --chat_id identificador --user_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário.

ShellBot.leaveChat

Função para que seu bot deixe um grupo, supergrupo ou canal.

Uso:

ShellBot.leaveChat --chat_id identificador

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	Integer ou String	Sim	Identificador exclusivo para o chat de destino ou nome de usuário do canal de destino (no formato @channelusername)

ShellBot.ReplyKeyboardMarkup

Cria um teclado personalizado de seleção a partir um array.

Uso:

ShellBot.ReplyKeyboardMarkup --button ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-b, --button <array>	Array	Sim	Array contendo uma lista de botões, cada uma representada por uma matriz de objetos Keyboard.
-r, --resize_keyboard	Boolean	Nâo	Solicita aos clientes que redimensionem o teclado verticalmente para um ajuste ideal (por exemplo, faça o teclado menor se houver apenas duas linhas de botões). O padrão é false, caso em que o teclado personalizado é sempre da mesma altura que o teclado padrão do aplicativo.
-t, --one_time_keyboard <true ou false>	Boolean	Nâo	Solicita que os clientes ocultem o teclado assim que ele for usado. O teclado ainda estará disponível, mas os clientes exibirão automaticamente o teclado de letras usual no chat - o usuário pode pressionar um botão especial no campo de entrada para ver o teclado personalizado novamente. O padrão é false.
-s, --selective <true ou false>	Boolean	Nâo	Use esse parâmetro se você quiser mostrar o teclado somente para usuários específicos. Alvos: 1) usuários que são @mencionados no texto do objeto Mensagem; 2) se a mensagem do bot é uma resposta (tem reply_to_message_id), remetente da mensagem original. Exemplo: Um usuário solicita alterar o idioma do bot, bot responde ao pedido com um teclado para selecionar o novo idioma. Outros usuários no grupo não vêem o teclado.

Nota: O array deve ser um array de array.

A declaração dos elementos no array pode influenciar na forma como os botões são exibidos no Aplicativo. É possível realizar diversas combinações para obter o layout pretendido.

Exemplos:

array=‘[[“botao1”,”botao2”]]’

*Exbição*
[ botao1 ] [ botao2 ]

ou

array=‘[[“botao1”],[“botao2”]]’ 

*Exbição*
[ botao1 ]
[ botao2 ]

ou

array=‘[[“botao1”],[”botao2”,“botao3”]]’

*Exbição*
	[ botao1 ]
[ botao2 ] [ botao3 ]

ShellBot.InlineKeyboardButton

Cria um objeto inline_button contendo uma estrutura de configurações.

Uso:

ShellBot.InlineKeyboardButton --button <identificador> --callback_data <valor> --line <numero>...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-b, --button <identificador>	string	Sim	Nome da varíavel onde será armazenado a estrutura do objeto.
-t, --text <texto>	string	Sim	Texto do botão.
-c, --calback_data <dados>	String	Sim	Dados a serem enviados em uma consulta de retorno ao bot quando o botão é pressionado, 1-64 bytes
-l, --line <numero>	integer	Sim	Número da linha onde o botão será inserido. Esse valor determina sua posição no array da estrutura. É possível adicionar mais botões a mesma linha; Neste caso a sua posição será determinada pela ordem de declaração.
-u, --url <url>	String	Nâo	Url HTTP a ser aberta quando o botão é pressionado.
-q, --switch_inline_query <texto>	String	Nâo	Se configurado, pressionar o botão solicitará ao usuário selecionar um dos seus bate-papos, abrir esse bate-papo e inserir o nome de usuário do bot e a consulta inline especificada no campo de entrada. Pode estar vazio, caso em que apenas o nome de usuário do bot será inserido.
-s, --switch_inline_query_current_chat <texto>	String	Nâo	Se configurado, pressionar o botão irá inserir o nome de usuário do bot e a consulta inline especificada no campo de entrada do bate-papo atual. Pode estar vazio, caso em que apenas o nome de usuário do bot será inserido.

ShellBot.InlineKeyboardMarkup

Retorna um objeto do tipo Inline_Keyboard apartir de uma variável inline_button.

Uso:

ShellBot.InlineKeyboardMarkup --button <identificador>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-b, --button <identificador>	String	Sim	Nome da variável do tipo inline_button.
-d, --delete		Não	Apaga a estrutura inline_button existente no identificador especificado.

ShellBot.answerCallbackQuery

Use este método para enviar respostas para consultas de retorno de chamada enviadas a partir de teclados em linha. A resposta será exibida para o usuário como uma notificação na parte superior da tela de bate-papo ou como um alerta. No sucesso, True é retornado.

Uso:

ShellBot.answerCallbackQuery --callback_query_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --callback_query_id <identificador>	String	Sim	Identificador exclusivo para a consulta a ser respondida.
-t, --text <texto>	String	Não	Texto da notificação. Se não for especificado, nada será mostrado ao usuário, 0 a 200 caracteres.
-s, --show_alert <true ou false>	Boolean	Não	Se for verdade, um alerta será mostrado pelo cliente em vez de uma notificação na parte superior da tela de bate-papo. Por padrão, é falso.
-u, --url <url>	String	Não	URL que será aberto pelo cliente do usuário.
-e, --cache_time <tempo>	Integer	Não	A quantidade máxima de tempo em segundos que o resultado da consulta de retorno de chamada pode ser armazenada no lado do cliente. Os aplicativos de Telegram suportarão o armazenamento em cache a partir da versão 3.14. Padrão para 0.

ShellBot.deleteMessage

Use esse método para excluir uma mensagem. Uma mensagem só pode ser excluída se for enviada há menos de 48 horas. Qualquer mensagem enviada recentemente pode ser excluída. Além disso, se o bot for um administrador em um bate-papo em grupo, ele pode excluir qualquer mensagem. Se o bot for um administrador em um supergrupo, ele pode excluir mensagens de qualquer outro usuário e mensagens de serviço sobre pessoas que se juntam ou deixam o grupo (outros tipos de mensagens de serviço só podem ser removidos pelo criador do grupo). Nos canais, os bots só podem remover suas próprias mensagens. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.deleteMessage --chat_id <identificador> --message_id <indentificador>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	Inteiro	Sim	Identificador da mensagem para excluir

ShellBot.setWebhook

Use este método para especificar uma url e receber atualizações recebidas através de um webhook de saída. Sempre que houver uma atualização para o bot, enviaremos uma solicitação HTTPS POST ao URL especificado, contendo uma atualização serializada em JSON. Em caso de pedido sem sucesso, desistiremos após uma quantidade razoável de tentativas. Retorna verdadeiro.

Uso:

ShellBot.setWebhook --url <url> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --url <url>	String	Sim	HTTPS url para enviar atualizações para. Use uma string vazia para remover a integração do webhook.
-c, --certificate <ceritificado>	File	Não	Carregue seu certificado de chave pública para que o certificado raiz em uso possa ser verificado.
-m, --max_connections <valor>	Integer	Não	Número máximo permitido de conexões HTTPS simultâneas para o webhook para entrega de atualização, 1-100. Padrão para 40. Use valores mais baixos para limitar a carga no servidor do seu bot e valores mais altos para aumentar a taxa de transferência.
-a, --allowed_updates <array>	Array	Não	Liste os tipos de atualizações que deseja que seu bot receba. Por exemplo, especifique ["mensagem", "edited_channel_post", "callback_query"] para receber apenas atualizações desses tipos. Consulte Atualização para obter uma lista completa dos tipos de atualização disponíveis. Especifique uma lista vazia para receber todas as atualizações, independentemente do tipo (padrão). Se não for especificado, a configuração anterior será usada.

Notas

1. Você não poderá receber atualizações usando getUpdates enquanto estiver configurado um webhook de saída.
2. Para usar um certificado auto-assinado, você precisa fazer o upload do certificado de chave pública usando o parâmetro do certificado. Carregue como File, o envio de um String não funcionará.
3. Portas atualmente suportadas para Webhooks: 443, 80, 88, 8443.

ShellBot.deleteWebhook

Use esse método para remover a integração do webhook se você decidir voltar para getUpdates. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.deleteWebhook

Não requer parâmetros.

ShellBot.getWebhookInfo

Use este método para obter o status atual do webhook. Com sucesso, retorna um objeto WebhookInfo. Se o bot estiver usando getUpdates, retornará um objeto com o campo url vazio. Os valores são separados pelo delimitador '|' PIPE na seguinte ordem:

url|has_custom_certificate|pending_update_count|last_error_date|last_error_message|max_connections|allowed_updates

Campo	Descrição
url	Webhook URL, pode estar vazio se webhook não estiver configurado.
has_custom_certificate	true, se um certificado personalizado fosse fornecido para verificações de certificados webhook.
pending_update_count	Número de atualizações aguardando entrega.
last_error_date	Tempo Unix para o erro mais recente que ocorreu ao tentar entregar uma atualização via webhook. Caso contrário retorna null.
last_error_message	Mensagem de erro em formato legível para humanos para o erro mais recente que aconteceu ao tentar enviar uma atualização via webhook. Caso contrário retorna null.
max_connections	Número máximo permitido de conexões HTTPS simultâneas para o webhook para atualização de entrega. Caso contrário retorna null.
allowed_updates	Uma lista de tipos de atualização em que o bot está inscrito. Predefinições para todos os tipos de atualização. Caso contrário retorna null.

Não requer parâmetros.

ShellBot.restrictChatMember

Use este método para restringir um usuário em um supergrupo. O bot deve ser um administrador no supergrupo para que isso funcione e deve ter os direitos de administrador apropriados. Passe True para todos os parâmetros booleanos para levantar restrições de um usuário. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.restrictChatMember --chat_id <identificador> --user_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário alvo.
-d, --until_date <data>	Integer	Não	Data em que as restrições serão levantadas para o usuário, tempo unix. Se o usuário estiver restrito por mais de 366 dias ou menos de 30 segundos do tempo atual, eles são considerados restritos para sempre.
-s, --can_send_messages <true ou false>	Boolean	Não	Passe true, se o usuário pode enviar mensagens de texto, contatos, locais e locais.
-m, --can_send_media_messages <true ou false>	Boolean	Não	Passe true, se o usuário pode enviar áudios, documentos, fotos, vídeos, notas de vídeo e notas de voz, implica can_send_messages.
-o, --can_send_other_messages <true ou false>	Boolean	Não	Passe true, se o usuário pode enviar animações, jogos, adesivos e usar inline bots, implica can_send_media_messages.
-w, --can_add_web_page_previews <true ou false>	Boolean	Nâo	Passe true, se o usuário pode adicionar visualizações de páginas da web para suas mensagens, implica can_send_media_messages.

ShellBot.promoteChatMember

Use esse método para promover ou rebaixar um usuário em um supergrupo ou em um canal. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Passe False para todos os parâmetros booleanos para rebaixar um usuário. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.promoteChatMember --chat_id <identificador> --user_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-u, --user_id <identificador>	Integer	Sim	Identificador exclusivo do usuário alvo.
-i, --can_change_info <true ou false>	Boolean	Não	Passe true, se o administrador pode alterar o título do bate-papo, a foto e outras configurações
-p, --can_post_messages <true ou false>	Boolean	Nâo	Passe true, se o administrador pode criar postagens de canal, apenas canais.
-e, --can_edit_messages <true ou false>	Boolean	Não	Passe true, se o administrador pode editar mensagens de outros usuários, apenas canais.
-d, --can_delete_messages <true ou false>	Boolean	Nâo	Passe true, se o administrador pode excluir mensagens de outros usuários.
-v, --can_invite_users <true ou false>	Boolean	Não	Passe true, se o administrador pode convidar novos usuários para o bate-papo.
-r, --can_restrict_members <true ou false>	Boolean	Não	Passe true, se o administrador pode restringir, proibir ou desbanir membros do bate-papo.
-f, --can_pin_messages <true ou false>	Boolean	Não	Passe true, se o administrador pode inserir mensagens, somente supergrupos.
-m, --can_promote_members <true ou false>	Boolean	Nâo	Passe true, se o administrador pode adicionar novos administradores com um subconjunto de seus próprios privilégios ou rebaixar administradores que ele promoveu, direta ou indiretamente (promovido por administradores que foram nomeados por ele)

ShellBot.exportChatInviteLink

Use esse método para exportar um link de convite para um supergrupo ou um canal. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Devolve o link de convite exportado como string no sucesso.

Uso:

ShellBot.exportChatInviteLink --chat_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)

ShellBot.setChatPhoto

Use este método para definir uma nova foto de perfil para o bate-papo. As fotos não podem ser alteradas para bate-papo privado. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.setChatPhoto --chat_id <identificador> --photo <arquivo>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-p, --photo <arquivo>	file	Sim	Nova foto de bate-papo, carregada usando multipart/form-data.

ShellBot.deleteChatPhoto

Use este método para excluir uma foto de bate-papo. As fotos não podem ser alteradas para bate-papo privado. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.deleteChatPhoto --chat_id <identificador>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)

ShellBot.setChatTitle

Use este método para alterar o título de um bate-papo. Os títulos não podem ser alterados para bate-papo privado. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna Verdadeiro no sucesso.

Nota: Em grupos regulares (não supergrupos), esse método só funcionará se a configuração 'Todos os membros forem administradores' estiver desativada no grupo-alvo.

Uso:

ShellBot.setChatTitle --chat_id <identificador> --title <titulo>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-t, --title <titulo>	String	Sim	Novo título de bate-papo, 1-255 caracteres.

ShellBot.setChatDescription

Use este método para alterar a descrição de um supergrupo ou um canal. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.setChatDescription --chat_id <identificador> --description <descricao>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-d, --description <descricao>	String	Sim	Nova descrição do bate-papo, 0-255 caracteres.

ShellBot.pinChatMessage

Use este método para definir uma mensagem em um supergrupo. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna true no sucesso.

Uso:

ShellBot.pinChatMessage --chat_id <identificador> --message_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)
-m, --message_id <identificador>	Integer	Sim	Identificador exclusivo da mensagem a ser fixada.
-n, --disable_notification	Boolean	Não	True se não for necessário enviar uma notificação a todos os membros do bate-papo sobre a nova mensagem fixa. As notificações estão sempre desativadas nos canais.

ShellBot.unpinChatMessage

Use este método para desativar uma mensagem em um bate-papo de supergrupo. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.unpinChatMessage --chat_id <identificador>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	String ou Integer	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do supergrupo de destino (no formato @supergroupusername)

ShellBot.stickerMaskPosition

Cria um objeto e define sua posição onde uma máscara deve ser colocada por padrão.

Uso:

ShellBot.ShellBot.stickerMaskPosition --point <face> --x_shift <eixo-x> --y_shift <eixo-y> --scale <escala>

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-p, --point <face>	string	Sim	A parte da face em relação à qual a máscara deve ser colocada. Os valores são: "forehead”, “eyes”, “mouth”, ou “chin”.
-x, --x_shift <eixo-x>	Float	Sim	Deslocar pelo eixo X medido em larguras da máscara dimensionadas para o tamanho do rosto, da esquerda para a direita. Por exemplo, escolher -1.0 colocará a máscara apenas à esquerda da posição de máscara padrão.
-y, --y_shift <eixo-y>	Float	Sim	Deslocar pelo eixo Y medido em alturas da máscara dimensionadas para o tamanho do rosto, de cima para baixo. Por exemplo, 1.0 colocará a máscara logo abaixo da posição de máscara padrão.
-s, --scale <escala>	Float	Sim	Coeficiente de escala de máscara. Por exemplo, 2.0 significa tamanho duplo.

Retorno
Retorna um objeto do tipo <MaskPosition> com suas definições.

ShellBot.getStickerSet

Use este método para obter um conjunto de Stickers. No sucesso, um objeto <StickerSet> é retornado.

Uso:

ShellBot.getStickerSet --name <sticker_nome>

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-n, --name	String	Sim	Nome do conjunto de Stickers

Retorno:

name|title|contains_masks|Stickers

ShellBot.uploadStickerFile

Use este método para carregar um arquivo .png com uma etiqueta para uso posterior nos métodos createNewStickerSet e addStickerToSet (pode ser usado várias vezes). Retorna o arquivo carregado no sucesso.

Uso:

ShellBot.uploadStickerFile --user_id <identificador> --png_sticker <arquivo>

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --user_id <identificador>	Integer	Sim	Identificador de usuário do proprietário do arquivo de etiqueta.
-s, --png_sticker <arquivo>	File	Sim	A imagem Png com o adesivo deve ter até 512 kilobytes de tamanho, as dimensões não devem exceder 512px, e largura ou altura devem ser exatamente 512px.

Retorno:

file_id|file_size|file_path

ShellBot.createNewStickerSet

Use este método para criar um novo conjunto de adesivos de propriedade de um usuário. O bot poderá editar o conjunto de adesivos criados. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.createNewStickerSet --user_id <identificador> --name <sticker_nome> --title <titulo> --png_sticker <arquivo> --emojis <emojis> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --user_id <identificador>	Integer	Sim	Identificador de usuário do proprietário do conjunto de etiquetas criadas.
-n, --name <sticker_nome>	String	Sim	Nome breve do conjunto de adesivos, para ser usado em t.me/addstickers/ URLs (por exemplo, animais). Pode conter apenas letras inglesas, dígitos e sublinhados. Deve começar com uma carta, não pode conter sublinhados consecutivos e deve terminar em "by ". <Bot_username> é insensível a maiúsculas e minúsculas. 1-64 caracteres.
-t, --title <titulo>	String	Sim	Título do conjunto de adesivos, 1-64 caracteres
-s, --png_sticker <arquivo>	File	Sim	A imagem Png com o adesivo deve ter até 512 kilobytes de tamanho, as dimensões não devem exceder 512px, e largura ou altura devem ser exatamente 512px. Passe um file_id como uma String para enviar um arquivo que já existe nos servidores Telegram, passe um URL HTTP como String para Telegram para obter um arquivo da Internet, ou faça o upload de um novo usando multipart/form-data.
-e, --emojis <emojis>	String	Sim	Um ou mais emoji correspondente ao adesivo
-c, --contains_mask <true ou false>	Boolean	Não	Passe true, se um conjunto de adesivos de máscara deve ser criado
-m, --mask_position <MaskPosition>	MaskPosition	Nâo	Objeto <MaskPosition> contendo as definições e propriedades do Sticker.

ShellBot.addStickerToSet

Use este método para adicionar um novo adesivo a um conjunto criado pelo bot. Retorna Verdadeiro no sucesso.

Uso:

ShellBot.addStickerToSet --user_id <identificador> --name <sticker_nome> --png_sticker <arquivo> --emojis <emojis> ...

São mencionados acima somente os parâmetros obrigatórios da função, tendo o … como extensão para os opcionais.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-u, --user_id <identificador>	Integer	Sim	Identificador de usuário do proprietário do conjunto de etiquetas.
-n, --name <sticker_nome>	String	Sim	Nome do conjunto de adesivos.
-s, --png_sticker <arquivo>	File	Sim	A imagem Png com o adesivo deve ter até 512 kilobytes de tamanho, as dimensões não devem exceder 512px, e largura ou altura devem ser exatamente 512px. Passe um file_id como uma String para enviar um arquivo que já existe nos servidores Telegram, passe um URL HTTP como String para Telegram para obter um arquivo da Internet, ou faça o upload de um novo usando multipart/form-data.
-e, --emojis <emojis>	String	Sim	Um ou mais emoji correspondente ao adesivo.
-m, --mask_position <MaskPosition>	MaskPosition	Não	Objeto <MaskPosition> contendo as definições e propriedades do Sticker.

ShellBot.setStickerPositionInSet

Use este método para mover um adesivo em um conjunto criado pelo bot para uma posição específica. Retorna true no sucesso.

Uso:

Shell.Bot.setStickerPositionInSet --sticker <identificador> --position <posicao>

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-s, --sticker <identificador>	String	Sim	Identificador do arquivo do adesivo.
-p, --position <posicao>	Integer	Sim	Nova posição da etiqueta no conjunto, baseada em zero.

ShellBot.deleteStickerFromSet

Use este método para excluir um adesivo de um conjunto criado pelo bot. Retorna true no sucesso.

Uso:

ShellBot.deleteStickerFromSet --sticker <identificador>

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-s, --sticker <identificador>	String	Sim	Identificador do arquivo do adesivo.

ShellBot.downloadFile

Use este método para baixar um arquivo do diretório remoto no servidor do Telegram. Retorna um objeto file em caso de sucesso. É gerado um hash para a nomenclatura do arquivo criado com o seguinte formato: <fileDDMMYYYHHMMSS-xxxxx.ext>.

Uso:

ShellBot.downloadFile --file_path <caminho> --dir <destino>

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-f, --file_path <caminho>	String	Sim	Caminho do arquivo contido nos servidores do Telegram. Veja: ShellBot.getFile
-d, --dir <destino>	String	Sim	Diretório destino onde será salvo o arquivo.

ShellBot.editMessageLiveLocation

Use este método para editar mensagens de localização ao vivo enviadas pelo bot ou através do bot. Uma localização pode ser editada até o seu período de vida expirar ou a edição é explicitamente desabilitada por uma chamada ao método stopMessageLiveLocation. Se a mensagem foi enviada pelo bot, com sucesso a Mensagem enviada é retornada, caso contrário true é retornado.

Uso:

ShellBot.editMessageLiveLocation --chat_id <identificador> --message_id <identificador> --latitude <coordenada> --longitude <coordenada> ...

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Não	Obrigatório se inline_message_id não for especificado. Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	integer	Não	Obrigatório se inline_message_id não for especificado. Identificador da mensagem enviada.
-i, --inline_message_id <identificador>	string	Não	Obrigatório se chat_id e message_id não forem especificados. Identificador da mensagem em linha.
-l, --latitude <coordenada>	float	Sim	Latitude da nova localização.
-g, --longitude <coordenada>	float	Sim	Longitude da nova localização.
-r, --reply_markup <teclado>	InlineKeyboardMarkup	Não	Um objeto serializado em JSON para um novo teclado em linha.

Retorno: Message

ShellBot.stopMessageLiveLocation

Use este método para parar de atualizar uma mensagem de localização ao vivo enviada pelo bot ou pelo bot antes que expire o live_period. Se a mensagem foi enviada pelo bot, com sucesso a Mensagem enviada é retornada, caso contrário true é retornado.

Uso:

ShellBot.stopMessageLiveLocation --chat_id <identificador> --message_id <identificador> ...

São mencionados acima somente os parâmetros obrigatórios da função.

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Não	Obrigatório se inline_message_id não for especificado. Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --message_id <identificador>	integer	Não	Obrigatório se inline_message_id não for especificado. Identificador da mensagem enviada.
-i, --inline_message_id <identificador>	string	Não	Obrigatório se chat_id e message_id não forem especificados. Identificador da mensagem em linha.
-r, --reply_markup <teclado>	InlineKeyboardMarkup	Não	Um objeto serializado em JSON para um novo teclado em linha.

Retorno: Message

ShellBot.setChatStickerSet

Use este método para definir um novo grupo de etiqueta definido para um supergrupo. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Use o campo can_set_sticker_set opcionalmente devolvido em pedidos de getChat para verificar se o bot pode usar esse método. Retorna true no sucesso.

Uso:

ShellBot.setChatStickerSet --chat_id <identificador> --sticker_set_name <indentificador> 

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Obrigatório se inline_message_id não for especificado. Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-s, --sticker_set_name <identificador>	string	Sim	Nome do conjunto de adesivos a ser configurado como conjunto de adesivos de grupo.

Retorno: true ou false

ShellBot.deleteChatStickerSet

Use este método para excluir um conjunto de adesivos de grupo de um supergrupo. O bot deve ser um administrador no chat para que isso funcione e deve ter os direitos de administrador apropriados. Use o campo can_set_sticker_set opcionalmente devolvido em pedidos de getChat para verificar se o bot pode usar esse método. Retorna true no sucesso.

Uso:

ShellBot.deleteChatStickerSet --chat_id <identificador>

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Obrigatório se inline_message_id não for especificado. Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)

Retorno: true ou false

ShellBot.sendMediaGroup

Use este método para enviar um grupo de fotos ou vídeos como um álbum. No sucesso uma matriz Message enviadas é retornada.

Uso:

ShellBot.sendMediaGroup --chat_id <identificador> --media <midias> ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --media <midias>	Array InputMedia	Sim	Uma matriz serializada em JSON descrevendo fotos e vídeos a serem enviados deve incluir 2-10 itens.
-n, --disable_notification <true ou false>	boolean	Não	Envia as mensagens silenciosamente. Os usuários receberão uma notificação sem som.
-r, --reply_to_message_id <identificador>	integer	Nâo	Se as mensagens forem uma resposta, ID da mensagem original.

Retorno: Array Message

ShellBot.sendAnimation

Use este método para enviar arquivos de animação (vídeo GIF ou H.264/MPEG-4 AVC sem som). Os bots atualmente podem enviar arquivos de animação de até 50 MB, esse limite pode ser alterado no futuro.

Uso:

ShellBot.sendAnimation --chat_id <identificador> --animation <video> ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-a, --animation <video>	String	Sim	Arquivo para enviar. Passe um file_id para enviar um arquivo que existe nos servidores Telegram (recomendado), passe um URL HTTP para Telegram para obter um arquivo da Internet ou passe @caminho_do_arquivo para carregar um arquivo de video local usando multipart/form-data.
-d, --duration <tempo>	Integer	Não	Duração da animação.
-w, --width <largura>	Integer	Nâo	Largura da animação.
-h, --height <altura>	Integer	Nâo	Altura da animação.
-b, --thumb <file>	String	Não	Miniatura da animação enviada. A miniatura deve estar no formato JPEG e ter menos de 200 kB de tamanho. A largura e a altura de uma miniatura não devem exceder 90.
-o, --caption <legenda>	String	Não	Legenda da animação com 0 a 200 caracteres.
-p, --parse_mode <modo>	string	Não	Modo de formatação aplicada ao texto enviado (markdown e html).
-n, --disable_notification <status>	boolean	Não	Envia a mensagem silenciosamente. Os usuários do iOS não receberão uma notificação, os usuários do Android receberão uma notificação sem som.
-r, --reply_to_message_id <identificador>	inteiro	Não	Se a mensagem for uma resposta, informar o ID da mensagem original.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)

ShellBot.inputMedia

Use este método para criar um objeto InputMedia com uma estrutura de propriedades que represetam o elemento a ser enviado, cujo são: animation, video, photo, audio e document. É possível especificar mais de um elemento para a mesma mídia, caso a variável input já contenha um objeto os demais são anexados ao final da lista criando uma coleção de elementos.

Uso:

ShellBot.inputMedia --input <variavel> --type <tipo> ...

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-i, --input <variavel>	String	Sim	Identificador de uma variável válida que irá armazenar o objeto.
-t, --type <tipo>	String	Sim	Tipo do objeto media a ser criado. (animation, document, audio, photo e video)
-m, --media <midia>	String	Sim	Arquivo para enviar. Passe um file_id para enviar um arquivo que existe nos servidores Telegram (recomendado), passe um URL HTTP para Telegram para obter um arquivo da Internet ou passe @caminho_do_arquivo para carregar um arquivo local usando multipart/form-data.
-c, --caption <legenda>	String	Não	Legenda do objeto com 0 a 200 caracteres.
-p, --parse_mode <modo>	string	Não	Modo de formatação aplicada ao texto enviado (markdown e html).
-b, --thumb <file>	String	Não	Miniatura do arquivo enviado. A miniatura deve estar no formato JPEG e ter menos de 200 kB de tamanho. A largura e a altura de uma miniatura não devem exceder 90. (Somente para: animation, video, document, audio)
-w, --width <largura>	Integer	Nâo	Largura. (Somente para: animation e video)
-h, --height <altura>	Integer	Nâo	Altura. (Somente para: animation e video)
-d, --duration <tempo>	Integer	Não	Duração. (Somente para: animation, video e audio)
-s, --supports_streaming	Boolean	Não	Suporte a streaming. (Somente para: video)
-f, --performer <artista>	String	Nâo	Artista da faixa. (Somente para: audio)
-e, --title <titulo>	String	Nâo	Título da faixa. (Somente para: audio)

ShellBot.editMessageMedia

Use este método para editar mensagens de áudio, documentos, fotos ou vídeos. Se uma mensagem fizer parte de um álbum de mensagem, ela poderá ser editada apenas para uma foto ou um vídeo. Caso contrário, o tipo de mensagem pode ser alterado arbitrariamente. Quando a mensagem embutida é editada, não é possível carregar o novo arquivo. Use o arquivo enviado anteriormente por meio de seu file_id ou especifique um URL. Em sucesso, se a mensagem editada foi enviada pelo bot, a Mensagem editada é retornada, caso contrário, True é retornado.

Uso:

ShellBot.editMessageMedia --chat_id <identificador> --media <_midia_>

Parâmetros:

Parâmetro	Tipo	Obrigatório	Descrição
-c, --chat_id <identificador>	integer ou string	Sim	Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername)
-m, --media <midia>	InputMedia	Sim	Objeto midia a ser enviado.
-i, --message_id <identificador>	Integer	Não	Obrigatório se inline_message_id não for especificado. Identificador da mensagem enviada.
-n, --inline_message_id <identificador>	Integer	Nâo	Obrigatório se chat_id e message_id não forem especificados. Identificador da mensagem in-line.
-k, --reply_markup <teclado>	ReplyKeyboardMarkup	Nâo	Interface do teclado personalizada. (Veja: ShellBot.ReplyKeyboardMarkup)