> ## Documentation Index
> Fetch the complete documentation index at: https://docs.octasend.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar comunicação

> Endpoint get-communication: lê os canais e o conteúdo dos templates de uma comunicação, por canal, idioma, versão e status

O endpoint `GET /get-communication` devolve os canais de uma comunicação e, por idioma, o conteúdo dos templates com as `{{variáveis}}` ainda não preenchidas. Para ler o texto de uma mensagem já enviada, veja [Consultar logs](https://docs.octasend.com.br/api-reference/consultar-logs.md#conteudo-enviado).

```http theme={null}
GET https://api.octasend.com.br/functions/v1/get-communication?slug=boas-vindas&channel=email&language=pt-BR
Authorization: Bearer at_f4a92b...
```

> [!NOTE]
>
> **Autenticação:** a mesma do `send-message`. Veja [Autenticação](https://docs.octasend.com.br/api-reference/autenticacao.md).

## Parâmetros de consulta

Só `slug` é obrigatório. Os demais são opcionais e se combinam.

| Parâmetro | Descrição |
| - | - |
| `slug` | Slug da comunicação |
| `channel` | Devolve só este canal: `email`, `whatsapp`, `sms`, `telegram`, `slack`, `web_push`, `in_app` ou `push`. Outro valor responde `400` |
| `language` | Devolve só este idioma (ex.: `pt-BR`) |
| `version` | Nome da versão (ex.: `Versão 1`) |
| `status` | `published` ou `unpublished`. Outro valor responde `400` |

Sem `version` nem `status`, cada idioma traz só a versão **publicada**, a que é enviada. Um idioma sem versão publicada aparece com `"published": false`. Com qualquer um dos dois, cada idioma lista todas as versões que casam, cada uma com `published` `true` ou `false`. `versions_count` é sempre o total de versões do idioma, não só das que casaram. Canal ou idioma sem conteúdo devolve `channels` vazio.

## Resposta

```json theme={null}
{
  "communication": {
    "id": "3f2b6c1e-...",
    "name": "Boas-vindas",
    "slug": "boas-vindas",
    "description": "Enviada no cadastro",
    "is_active": true,
    "channels": [
      {
        "channel": "email",
        "is_active": true,
        "templates": [
          {
            "language_code": "pt-BR",
            "published": true,
            "version_name": "Versão 1",
            "versions_count": 1,
            "subject": "Bem-vindo, {{nome}}",
            "body_html": "<p>Olá, {{nome}}!</p>",
            "body_text": "Olá, {{nome}}!",
            "preheader": null
          }
        ]
      }
    ]
  }
}
```

> [!WARNING]
>
> Com `version` ou `status`, um idioma pode aparecer várias vezes. Essa saída é só para leitura: não a reenvie para editar a comunicação.

## MCP

No [servidor MCP](https://docs.octasend.com.br/api-reference/mcp-server.md#get_communication), a tool `get_communication` recebe os mesmos parâmetros.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.