> ## 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.

# Consultar canal

> Retorna um canal com as credenciais e os webhooks cadastrados.

## Resposta

| Campo | Descrição |
| - | - |
| `id` | ID do canal |
| `name` | Nome dado ao canal |
| `description` | Descrição dada ao canal |
| `token` | Token do canal (`sk_live_`), usado nas requisições da API do WhatsApp deste canal |
| `subscribed` | Situação da assinatura do canal |
| `on_trial` | Indica se o canal está no período de teste |
| `trial_ends_at` | Data e hora do fim do período de teste |
| `paused` | Indica se o canal está pausado, sem enviar nem receber mensagens |
| `waba_id` | ID da conta do WhatsApp Business na Meta |
| `phone_number_id` | ID do número na Meta, usado nas URLs de envio |
| `business_id` | ID do portfólio empresarial na Meta |
| `phone` | Número de telefone conectado ao canal |
| `display_name` | Nome exibido no WhatsApp |
| `webhook_secret` | Segredo usado na [assinatura](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/validar-assinatura.md) de todos os webhooks deste canal |
| `webhooks[].id` | ID do webhook |
| `webhooks[].url` | URL que recebe os eventos |
| `webhooks[].events` | [Eventos](https://developers.datafyapi.com.br/api-reference/whatsapp/webhooks/receber-eventos.md) assinados pelo webhook |
| `webhooks[].enabled` | Indica se o webhook está ativo |


## OpenAPI

````yaml api-reference/administracao/specs/canais.json GET /channels/whatsapp/{id}
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/{id}:
    get:
      summary: Consultar canal
      description: Retorna um canal com as credenciais e os webhooks cadastrados.
      operationId: consultarCanal
      parameters:
        - $ref: '#/components/parameters/CanalId'
      responses:
        '200':
          description: Dados do canal.
          content:
            application/json:
              example:
                id: 3f1c9a2e-7b4d-4c1a-9f0e-2d8b6a5c4e10
                name: Atendimento
                description: Canal do suporte
                token: sk_live_xxx
                subscribed: true
                on_trial: false
                trial_ends_at: null
                paused: false
                waba_id: '1804533510429086'
                phone_number_id: '833381263194512'
                business_id: '7284633064948531'
                phone: +55 11 98888-7777
                display_name: Minha Empresa
                webhook_secret: whsec_xxx
                webhooks:
                  - id: 9d8c7b6a-5f4e-4d3c-2b1a-0f9e8d7c6b5a
                    url: https://exemplo.com/webhook
                    events:
                      - messages
                    enabled: true
              schema:
                $ref: '#/components/schemas/CanalDetalhe'
        '401':
          $ref: '#/components/responses/NaoAutorizado'
        '403':
          $ref: '#/components/responses/AssinaturaInativa'
        '404':
          $ref: '#/components/responses/CanalNaoEncontrado'
components:
  parameters:
    CanalId:
      name: id
      in: path
      required: true
      schema:
        type: string
      description: ID do canal, retornado em Listar canais e em Criar canal.
  schemas:
    CanalDetalhe:
      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.
        token:
          type: string
          description: >-
            Token do canal (`sk_live_`), usado nas requisições da API do
            WhatsApp deste canal.
        subscribed:
          type: boolean
          description: Situação da assinatura do canal.
        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.
        phone:
          type:
            - string
            - 'null'
          description: Número de telefone conectado ao canal.
        display_name:
          type:
            - string
            - 'null'
          description: Nome exibido no WhatsApp.
        webhook_secret:
          type: string
          description: Segredo usado na assinatura de todos os webhooks deste canal.
        webhooks:
          type: array
          items:
            $ref: '#/components/schemas/Webhook'
          description: Webhooks cadastrados no canal.
    Webhook:
      type: object
      properties:
        id:
          type: string
          description: ID do webhook.
        url:
          type: string
          description: URL que recebe os eventos.
        events:
          type: array
          items:
            type: string
          description: Eventos assinados pelo webhook.
        enabled:
          type: boolean
          description: Indica se o webhook está ativo.
  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.
    CanalNaoEncontrado:
      description: Canal inexistente ou de outra conta.
      content:
        application/json:
          example:
            statusCode: 404
            message: Canal não encontrado
  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.