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

# Listar canais

> Lista os canais de WhatsApp da conta, com o status da assinatura.

## Resposta

| Campo | Descrição |
| - | - |
| `subscription` | Status da assinatura da conta na Datafy. Os valores estão em [Assinatura](https://developers.datafyapi.com.br/api-reference/administracao/introducao.md#assinatura). |
| `channels[].id` | ID do canal |
| `channels[].name` | Nome dado ao canal |
| `channels[].description` | Descrição dada ao canal |
| `channels[].subscribed` | Indica se a assinatura financeira do canal está ativa |
| `channels[].on_trial` | Indica se o canal está no período de teste |
| `channels[].trial_ends_at` | Data e hora do fim do período de teste |
| `channels[].paused` | Indica se o canal está pausado, sem enviar nem receber mensagens |
| `channels[].waba_id` | ID da conta do WhatsApp Business na Meta |
| `channels[].phone_number_id` | ID do número na Meta, usado nas URLs de envio |
| `channels[].business_id` | ID do portfólio empresarial na Meta |
| `channels[].display_name` | Nome exibido no WhatsApp |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json GET /channels/whatsapp
openapi: 3.1.0
info:
  title: Datafy API — Administração de canais
  version: 1.0.0
servers:
  - url: https://cloud.datafyapi.com.br
    description: Produção
security:
  - tokenDeConta: []
paths:
  /channels/whatsapp:
    get:
      summary: Listar canais
      description: Lista os canais de WhatsApp da conta, com o status da assinatura.
      operationId: listarCanais
      responses:
        '200':
          description: Canais da conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListaDeCanais'
              example:
                subscription: active
                channels:
                  - id: 3f1c9a2e-7b4d-4c1a-9f0e-2d8b6a5c4e10
                    name: Atendimento
                    description: Canal do suporte
                    subscribed: true
                    on_trial: false
                    trial_ends_at: null
                    paused: false
                    waba_id: '1804533510429086'
                    phone_number_id: '833381263194512'
                    business_id: '7284633064948531'
                    display_name: Minha Empresa
                  - id: 8a2d4f6b-1c3e-4a5b-8d7f-9e0a1b2c3d4e
                    name: Vendas
                    description: null
                    subscribed: false
                    on_trial: true
                    trial_ends_at: '2026-09-25T12:00:00Z'
                    paused: false
                    waba_id: null
                    phone_number_id: null
                    business_id: null
                    display_name: null
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
components:
  schemas:
    ListaDeCanais:
      type: object
      properties:
        subscription:
          type: string
          enum:
            - active
            - past_due
            - trial
            - pending
            - canceled
          description: Status da assinatura da conta na Datafy.
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Canal'
    Canal:
      type: object
      properties:
        id:
          type: string
          description: ID do canal.
        name:
          type: string
          description: Nome dado ao canal.
        description:
          type:
            - string
            - 'null'
          description: Descrição dada ao canal.
        subscribed:
          type: boolean
          description: Indica se a assinatura financeira do canal está ativa.
        on_trial:
          type: boolean
          description: Indica se o canal está no período de teste.
        trial_ends_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Data e hora do fim do período de teste.
        paused:
          type: boolean
          description: Indica se o canal está pausado, sem enviar nem receber mensagens.
        waba_id:
          type:
            - string
            - 'null'
          description: ID da conta do WhatsApp Business na Meta.
        phone_number_id:
          type:
            - string
            - 'null'
          description: ID do número na Meta.
        business_id:
          type:
            - string
            - 'null'
          description: ID do portfólio empresarial na Meta.
        display_name:
          type:
            - string
            - 'null'
          description: Nome exibido no WhatsApp.
  responses:
    NaoAutorizado:
      description: Token de conta ausente ou inválido.
      content:
        application/json:
          example:
            statusCode: 401
            message: Token de conta ausente ou inválido
    AssinaturaInativa:
      description: A assinatura da conta não está ativa.
      content:
        application/json:
          example:
            statusCode: 403
            message: >-
              Sua assinatura precisa estar ativa para usar a API. Acesse o
              painel para ativá-la.
  securitySchemes:
    tokenDeConta:
      type: http
      scheme: bearer
      description: >-
        Token de conta gerado no painel da Datafy, em Perfil. Formato:
        `sk_acct_xxx`. Diferente do token de canal (`sk_live_`).

````

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