---
title: Telegram
slug: aiops-documentacao-tecnica/telegram
docTags: 
createdAt: 2024-07-18T20:52:10.425Z
---

## Resumo

- Envie notificações via telegram bot, para um grupo ou usuário verificado.
- Além disso, o usuário pode tentar usar qualquer outro método de API de bot do telegram, se você especificar o argumento *api\_method*.

## Parâmetros

| **Parâmetro**                  | **Tipo** | **Escolhas \| Valor Padrão**                          | **Obrigatório** | **Comentários**                                                                                                                                                                                                                                                                                                                                                   |
| ------------------------------ | -------- | ----------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| token                          | string   |                                                       | Sim             | Token que identifica seu bot do telegram.                                                                                                                                                                                                                                                                                                                         |
| chat\_id                       | string   |                                                       | Sim             | Grupo de telegram ou usuário chat\_id.                                                                                                                                                                                                                                                                                                                            |
| msg                            | string   |                                                       | Sim             | Qual mensagem você deseja enviar. Se a mensagem a ser enviada for um link a opção msg\_format terá que ser html                                                                                                                                                                                                                                                   |
| msg\_format                    | string   | Escolhas:<br />-MarkdownV2<br />(default)<br />- html | Não             | Formato da mensagem. Opções de formatação, `MarkdownV2` e `html` descrito na documentação da API Telegram (https\://core.telegram.org/bots/api#formatting-options). Se a opção for `MarkdownV2` definida, a mensagem não será formatada.<br />O formato `html`  suporta apenas alguns tipos de tags. Veja mais em: https\://core.telegram.org/bots/api#html-style |
| disable\_notification          | boolean  |                                                       | Não             | Desabilita notificações da mensagem no celular. Default definido como `True`                                                                                                                                                                                                                                                                                      |
| disable\_web\_page\_preview    | boolean  |                                                       |                 | Desabiita visualização da página na mensagem                                                                                                                                                                                                                                                                                                                      |
| reply\_to\_mesage\_id          | string   |                                                       | Não             | Se a mensagem for um reply a mensagem original é identificada com um ID                                                                                                                                                                                                                                                                                           |
| allow\_sending\_without\_reply | boolean  |                                                       | Não             | Escolha `True`se a mensagem tenha que ser mandada mesmo se a mesagem de reply não for identificada. Default definido como `False`                                                                                                                                                                                                                                 |



## Notas

- Você precisará de uma conta e criar um bot no telegram para usar este módulo.
- `html`  suporta apenas alguns tipos de tags. Exemplos:

## Exemplos

```yaml
#Envia mensagem de texto para um grupo(chat_id negativo) ou usuário(chat_id positivo)
- name: Send Message
  telegram:
    token: 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
    chat_id: -123456789
    msg: 'teste'
    msg_format: 'html'
    disable_notification: True
    disable_web_page_preview: False
    reply_to_message_id: 0
    allow_sending_without_reply: False
    register: result
```

## Valores Retornados

| **Chave**       | **Tipo** | **Retornado quando** | **Descrição**                              |
| --------------- | -------- | -------------------- | ------------------------------------------ |
| msg             | string   | sucesso              | A mensagem que você tentou enviar          |
| telegram\_error | string   | fracasso             | Mensagem de erro obtida da API do Telegram |