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

# Listar Canais Conhecidos

> Obter lista de todos os canais (newsletters) conhecidos pela sessão

## Descrição

Este endpoint retorna a lista de todos os canais que a sessão conhece, incluindo canais seguidos e outros canais disponíveis no WhatsApp.

## Parâmetros de URL

<ParamField path="session" type="string" required>
  ID único da sessão WhatsApp autenticada
</ParamField>

## Resposta

<ResponseField name="newsletters" type="array">
  Array contendo os canais conhecidos

  <Expandable title="Propriedades do canal">
    <ResponseField name="id" type="string">
      ID único do canal
    </ResponseField>

    <ResponseField name="name" type="string">
      Nome do canal
    </ResponseField>

    <ResponseField name="description" type="string">
      Descrição do canal
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json Resposta de Sucesso theme={null}
  {
    "newsletters": [
      {
        "id": "123456789@newsletter",
        "name": "Canal de Notícias",
        "description": "Últimas notícias e atualizações"
      },
      {
        "id": "987654321@newsletter",
        "name": "Canal de Tecnologia",
        "description": "Novidades do mundo tech"
      }
    ]
  }
  ```
</ResponseExample>

## Códigos de Status

* `200` - Lista obtida com sucesso
* `401` - Não autorizado
* `500` - Erro interno do servidor

## Exemplo de Uso

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET https://api.wappfy.com.br/api/my-session/channels
  ```

  ```javascript JavaScript theme={null}
  const session = 'my-session';
  const response = await fetch(`https://api.wappfy.com.br/api/${session}/channels`);
  const data = await response.json();
  console.log(data.newsletters);
  ```

  ```python Python theme={null}
  import requests

  session = 'my-session'
  response = requests.get(f'https://api.wappfy.com.br/api/{session}/channels')
  data = response.json()
  print(data['newsletters'])
  ```
</CodeGroup>


## OpenAPI

````yaml viewer.json get /api/{session}/channels
openapi: 3.1.0
info:
  title: Wappfy - WhatsApp HTTP API
  version: '2.0'
  contact: {}
servers:
  - url: https://{host}
    description: Servidor Customizável
    variables:
      host:
        default: api.wappfy.com.br
        description: 'URL do servidor (ex: api.wappfy.com.br ou seu-servidor.com)'
security:
  - api_key: []
tags:
  - name: 🖥️ Sessions
    description: >-
      Controlar sessões do WhatsApp (contas) (Control WhatsApp sessions
      (accounts))
  - name: 🔑 Auth
    description: Autenticação
  - name: 🆔 Profile
    description: Informações do seu perfil
  - name: 🖼️ Screenshot
    description: Obter captura de tela do WhatsApp e mostrar código QR
  - name: 📤 Chatting
    description: Métodos de conversação
  - name: 📢 Channels
    description: Métodos de canais (newsletters) (Channels (newsletters) methods)
  - name: 🟢 Status
    description: Métodos de status (aka stories) (Status (aka stories) methods)
  - name: 💬 Chats
    description: Métodos de conversas
  - name: 👤 Contacts
    description: >-
      Métodos de contatos. Use número de telefone (sem +) ou número de telefone
      e `@c.us` no final como `contactId`. Ex: `12312312310` OU
      `12312312310@c.us` (Contacts methods.<br>
                      Use phone number (without +) or phone number and `@c.us` at the end as `contactId`.<br>
                      'E.g: `12312312310` OR `12312312310@c.us`<br>)
  - name: 👥 Groups
    description: Métodos de grupos (Groups methods).<br>
  - name: ✅ Presence
    description: Informações de presença
  - name: 📅 Events
    description: Mensagem de Evento
  - name: 🏷️ Labels
    description: Etiquetas - disponível apenas para contas WhatsApp Business
  - name: 🔍 Observability
    description: Outros métodos
  - name: 🗄️ Storage
    description: Métodos de armazenamento
externalDocs:
  description: Wappfy - WhatsApp HTTP API
  url: https://wappfy.com.br/
paths:
  /api/{session}/channels:
    get:
      tags:
        - 📢 Channels
      summary: Obter lista de canais conhecidos
      description: O parâmetro {session} deve ser o instanceName da sessão.
      operationId: ChannelsController_list
      parameters:
        - name: role
          required: false
          in: query
          schema:
            enum:
              - OWNER
              - ADMIN
              - SUBSCRIBER
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Channel'
      security:
        - api_key: []
components:
  schemas:
    Channel:
      type: object
      properties:
        id:
          type: string
          description: Newsletter id
          example: 123123123123@newsletter
        name:
          type: string
          description: Channel name
          example: Channel Name
        invite:
          type: string
          description: Invite link
          example: https://www.whatsapp.com/channel/111111111111111111111111
        preview:
          type: string
          description: Preview for channel's picture
          example: https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10
        picture:
          type: string
          description: Channel's picture
          example: https://mmg.whatsapp.net/m1/v/t24/An&_nc_cat=10
        role:
          enum:
            - OWNER
            - ADMIN
            - SUBSCRIBER
            - GUEST
          type: string
        description:
          type: string
        verified:
          type: boolean
        subscribersCount:
          type: number
      required:
        - id
        - name
        - invite
        - role
        - verified
        - subscribersCount
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: apikey
      description: Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

````