CVcvcrm
Canais

Retorna canais do comunicador

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

get/canais

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/comunicador
  • URL
    https://integracao.cvcrm.com.br/api/v1/comunicador/canais
  • Auth
    none declared. Required headers: email

Query parameters

paginteger
Example:1

Número da página que retorna os canais

qtdinteger
Example:100

Quantidade de registros por página que retorna os canais

nomestring

Filtra os canais cujo nome contenha o valor informado

servico'whapi' | 'botmaker' | 'site' | 'terceiros' | 'whatsapp' nullable
Example:whapi

Filtra os canais pelo serviço

status'ativo' | 'inativo' | 'nao_autenticado' | 'nao_encontrado' nullable
Example:ativo

Filtra os canais pelo status (ativo, inativo, nao_autenticado = não autenticado, nao_encontrado = canal não encontrado)

com_chatsboolean
Example:true

Quando verdadeiro, retorna apenas os canais que possuem chats ativos (respeitando o escopo de empreendimentos e imobiliárias do gestor), ignorando os filtros nome, servico e status. Nesse modo o retorno é uma lista simplificada (idcanal, nome, servico, tipo).

tipo_chat'pre_venda' | 'pos_venda'
Example:pre_venda

Usado em conjunto com com_chats: filtra os canais com chats ativos pelo tipo de chat. Padrão: pre_venda.

Headers

emailstring required
Example:email@email.com
tokenstring
Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Response

Lista de canais

statusstring

Example response

{
  "paginacao": {
    "pagina": 1,
    "registros": 7,
    "total_de_registros": 7,
    "total_de_paginas": 1
  },
  "dados": [
    {
      "id_canal": 88,
      "data_cad": "2026-09-09 11:57:04",
      "nome": "SITE",
      "iniciar_conversa": true,
      "telefone": "556338255423",
      "identificador": "CATWMN-N8YB5",
      "status": "nao_autenticado",
      "servico": "whapi",
      "tipo": "pre_venda"
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.