Métodos
Receber atualizações a partir de uma consulta.
ShellBot.getUpdates ...
| 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. |
Encaminha mensagem para um usuário/grupo/canal especificado.
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â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.
Envia mensagem para um usuário, grupo ou canal especificado.
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â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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- 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: < ;, >, & e "".
Envia arquivo de imagem para um usuário, grupo ou canal especificado.
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â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). |
| -m, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou 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 (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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
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.
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â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). |
| -m, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou html). |
| -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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
- Suporta somente arquivos do tipo
.mp3.
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.
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â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). |
| -m, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou 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 (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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
Envia sticker para um usuário, grupo ou canal especificado.
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â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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- 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.
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.
ShellBot.sendVideo --chat_id identificador --video <video> ...
São mencionados acima somente os parâmetros obrigatórios da função, tendo o
…como extensão para os opcionais.
| 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). |
| -m, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou html). |
| -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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
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.
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â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. |
| -k, --reply_markup <teclado> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
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.
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â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). |
| -m, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou html). |
| -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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Voz - Para funcionar, o áudio deve estar em um arquivo
.oggcodificado com o OPUS.- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
Envia localizão no mapa para um usuario, grupo ou canal.
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â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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
Envia informação sobre o local no mapa para um usuario, grupo ou canal.
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â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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
Envia contato para um usuário, grupo ou canal especificado.
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â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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
- Indentificador precisa ser id, @usuario, @grupo ou @canal válido.
Envia uma determina ação do bot em resposta a solicitação do usuário.
ShellBot.sendChatAction --chat_id identificador --action acao
| 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.
Edita mensagens enviadas ou no histórico de mensagens.
- So e possivel editar mensagens enviadas pelo bot.
ShellBot.editMessageText --chat_id identificador --message_id identificador --text texto...
| 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.
Edita o titulo da mensagem enviada ou no historico de mensagens.
- So é possivel editar mensagens enviadas pelo bot.
ShellBot.editMessageCaption --chat_id identificador --message_id identificador --caption texto ...
| 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. |
| -p, --parse_mode <modo> | String | Não | Modo de formatação aplicada ao texto enviado (markdown ou html). |
| -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.
Edita somente mensagem enviada do tipo teclado (ReplyKeyboardMarkup).
- Só é possivel editar mensagens enviadas pelo bot.
ShellBot.editMessageReplyMarkup --chat_id identificador --message_id identificador --reply_markup teclado ...
| 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.
Retorna uma lista contendo as fotos de perfil dáo usuário.
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â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
Retorna informações sobre o bot.
Utilize essa função para validar o TOKEN.
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
Retorna informações básicas do arquivo.
ShellBot.getFile --file_id identificador
| 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
Retorna informações atualizadas sobre o bate-papo (nome atual do usuario para conversas, username atual do usuario, grupo ou canal e etc.)
ShellBot.getChat --chat_id identificador
| 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.
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.
ShellBot.getChatAdministrators --chat_id identificador
| 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.
Retorna a quantidade de membros em um bate-papo.
ShellBot.getChatMembersCount --chat_id identificador
| 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.
Retorna informações sobre um membro do bate-papo.
ShellBot.getChatMember --chat_id identificador --user_id identificador
| 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
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.
ShellBot.kickChatMember --chat_id identificador --user_id identificador
| 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.
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.
ShellBot.unbanChatMember --chat_id identificador --user_id identificador
| 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. |
Função para que seu bot deixe um grupo, supergrupo ou canal.
ShellBot.leaveChat --chat_id identificador
| 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) |
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.
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â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. |
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.
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â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 |
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.
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â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 ["message", "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
- Você não poderá receber atualizações usando getUpdates enquanto estiver configurado um webhook de saída.
- 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á.
- Portas atualmente suportadas para Webhooks: 443, 80, 88, 8443.
Use esse método para remover a integração do webhook se você decidir voltar para getUpdates. Retorna Verdadeiro no sucesso.
ShellBot.deleteWebhook
Não requer parâmetros.
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.
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.
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â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. |
| -p, --permissions <Permissões> | ChatPermissions | Sim | Permissões do usuário. |
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.
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â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) |
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.
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â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) |
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.
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â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. |
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.
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â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) |
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.
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â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. |
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.
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â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. |
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.
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â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. |
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.
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â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) |
Use este método para obter um conjunto de Stickers. No sucesso, um objeto <StickerSet> é retornado.
ShellBot.getStickerSet --name <sticker_nome>
São mencionados acima somente os parâmetros obrigatórios da função.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -n, --name | String | Sim | Nome do conjunto de Stickers |
name|title|contains_masks|Stickers
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.
ShellBot.uploadStickerFile --user_id <identificador> --png_sticker <arquivo>
São mencionados acima somente os parâmetros obrigatórios da função.
| 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. |
file_id|file_size|file_path
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.
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â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. |
Use este método para adicionar um novo adesivo a um conjunto criado pelo bot. Retorna Verdadeiro no sucesso.
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â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. |
Use este método para mover um adesivo em um conjunto criado pelo bot para uma posição específica. Retorna true no sucesso.
Shell.Bot.setStickerPositionInSet --sticker <identificador> --position <posicao>
São mencionados acima somente os parâmetros obrigatórios da função.
| 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. |
Use este método para excluir um adesivo de um conjunto criado pelo bot. Retorna true no sucesso.
ShellBot.deleteStickerFromSet --sticker <identificador>
São mencionados acima somente os parâmetros obrigatórios da função.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -s, --sticker <identificador> | String | Sim | Identificador do arquivo do adesivo. |
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.
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â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. Veja também: ShellBot.InlineKeyboardMarkup |
Retorno: Message
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.
ShellBot.stopMessageLiveLocation --chat_id <identificador> --message_id <identificador> ...
São mencionados acima somente os parâmetros obrigatórios da função.
| 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. Veja também: ShellBot.InlineKeyboardMarkup |
Retorno: Message
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.
ShellBot.setChatStickerSet --chat_id <identificador> --sticker_set_name <indentificador>
| 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
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.
ShellBot.deleteChatStickerSet --chat_id <identificador>
| 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
Use este método para enviar um grupo de fotos ou vídeos como um álbum. No sucesso uma matriz Message enviadas é retornada.
ShellBot.sendMediaGroup --chat_id <identificador> --media <midias> ...
| 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
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.
ShellBot.sendAnimation --chat_id <identificador> --animation <video> ...
| 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> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
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.
ShellBot.editMessageMedia --chat_id <identificador> --media <_midia_>
| 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) |
Use este método para enviar respostas para uma consulta inline. No sucesso, True é retornado. Não são permitidos mais de 50 resultados por consulta
ShellBot.answerInlineQuery --inline_query_id <identificador> --results <resultados> ...
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -i, --inline_query_id <identificador> | String | Sim | Identificador exclusivo para a consulta respondida. |
| -r, --results <resultados> | Array de InlineQueryResult | Sim | Uma matriz serializada de resultados JSON para a consulta inline. Veja: ShellBot.InlineQueryResult. |
| -c, --cache_time <tempo> | Integer | Não | A quantidade máxima de tempo em segundos que o resultado da consulta in-line pode ser armazenado em cache no servidor. O padrão é 300. |
| -p, --is_personal <true ou false> | Boolean | Não | Passe 'true' se os resultados puderem ser armazenados em cache no lado do servidor apenas para o usuário que enviou a consulta. Por padrão, os resultados podem ser retornados para qualquer usuário que envie a mesma consulta. |
| -o, --next_offset <pagina> | String | Não | Passe o deslocamento que um cliente deve enviar na próxima consulta com o mesmo texto para receber mais resultados. Passe uma string vazia se não houver mais resultados ou se você não oferecer suporte à paginação. O comprimento do deslocamento não pode exceder 64 bytes. |
| -s, --switch_pm_text | String | Não | Se passado, os clientes irão mostrar um botão com o texto especificado que muda o usuário para um chat privado com o bot e envia ao bot uma mensagem inicial com o parâmetro switch_pm_parameter. |
| -m, --switch_pm_parameter | String | Não | Parâmetro de ligação profunda para a mensagem /start enviada ao bot quando o usuário pressiona o botão de mudança. 1-64 caracteres, apenas A-Z, a-z, 0-9, _ e - são permitidos. |
Exemplo: um bot em linha que envia vídeos do YouTube pode solicitar que o usuário conecte o bot a sua conta do YouTube para adaptar os resultados da pesquisa de acordo. Para fazer isso, ele exibe um botão "Conecte sua conta do YouTube" acima dos resultados ou até mesmo antes de exibir qualquer um deles. O usuário pressiona o botão, alterna para um bate-papo privado com o bot e, ao fazer isso, passa um parâmetro de início que instrui o bot a retornar um link oauth. Uma vez feito isso, o bot pode oferecer um botão switch_inline para que o usuário possa facilmente retornar ao bate-papo onde quer usar os recursos in-line do bot.|
Use este método para definir permissões de bate-papo padrão para todos os membros. O bot deve ser um administrador no grupo ou um supergrupo para que isso funcione e deve ter os direitos de administrador can_restrict_members. Retorna True em caso de sucesso.
ShellBot.setChatPermissions --chat_id <identificador> --permissions <permissoes> ...
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -c, --chat_id <identificador> | integer | Sim | Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino (no formato @channelusername) |
| -p, --permissions <permissoes> | ChatPermissions | Sim | Permissões do usuário. |
Use este método para definir um título personalizado para um administrador em um supergrupo promovido pelo bot.
ShellBot.setChatAdministratorCustomTitle --chat_id <identificador> --user_id <identificador> --custom_tilte <titulo>
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -c, --chat_id <identificador> | integer | Sim | Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino. |
| -u, --user_id <identificador> | Integer | Sim | Identificador exclusivo do usuário. |
| -t, --custom_title <titulo> | String | Sim | Novo título personalizado para o administrador; 0-16 caracteres, não são permitidos emojis. |
Use este método para enviar enquete nativa.
ShellBot.sendPoll --chat_id <identificador> --question <texto> --options <opcoes> ...
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -c, --chat_id <identificador> | integer | Sim | Identificador exclusivo para o bate-papo de destino ou nome de usuário do canal de destino. |
| -q, --question <texto> | String | Sim | Texto da enquete. 1-255 caracteres. |
| -o, --options <opcoes> | Array de string | Sim | Json serializado com as opções da enquete. 2-10 opções com 1-100 caracteres cada. |
| -a, --is_anonymous <true ou false> | Boolean | Não | Se a enquete precisa ser anônima. (Padrão: true) |
| -t, --type <tipo> | String | Não | Tipo da enquete, "quiz" ou "regular". (Padrão: regular) |
| -m, --allows_multiple_answers <true ou false> | Boolean | Não | Se a enquete permite multiplas respostas. Ignorado por enquete do tipo "quiz". |
| -i, --correct_option_id <indice> | Integer | Não | Identificador da opção correta. Requer enquete do tipo "quiz". |
| -l, --is_closed <true ou false> | Boolean | Não | Necessita que a enquete seja fechada imediatamente. |
| -n, --disable_notification <true ou false> | Boolean | Não | Envia mensagem silenciosa. Usuários devem receber notificações sem som. |
| -r, --reply_to_message_id <identificador> | Integer | Não | Se a mensagem é uma resposta. ID da mensagem original. |
| -k, --reply_markup <teclado> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
Use este método para alterar a lista de comandos do bot. Returna true para sucesso.
ShellBot.setMyCommands --commands <BotCommand>
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -c, --commands <BotCommands> | Array de string | Sim | Uma lista serializada de JSON de comandos de bot a ser definida como a lista de comandos do bot. No máximo 100 comandos podem ser especificados. |
Use este método para obter a lista atual dos comandos do bot. Não requer parâmetros.
ShellBot.getMyCommands
Use este método para enviar um emoji animado que exibirá um valor aleatório. Em caso de sucesso, a mensagem enviada é retornada.
ShellBot.sendDice --chat_id <identificador> ...
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| -c, --chat_id <identificador> | integer | Sim | Identificador único para o chat de destino ou nome de usuário do canal de destino. |
| -e, --emoji <emoji> | string | Não | Emoji no qual a animação de lançamento de dados é baseada. Atualmente, deve ser “🎲”, “🎯” ou “🏀”. Os dados podem ter valores de 1 a 6 para “🎲” e “🎯”, e valores de 1 a 5 para “🏀”. O padrão é “🎲”. |
| -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, ID da mensagem original. |
| -k, --reply_markup <teclado> | InlineKeyboardMarkup ou ReplyKeyboardMarkup ou ReplyKeyboardRemove ou ForceReply | Nâo | Interface do teclado personalizada. Veja também: ShellBot.InlineKeyboardMarkup, ShellBot.ReplyKeyboardMarkup, ShellBot.ReplyKeyboardRemove e ShellBot.ForceReply. |
