Retorna canais do comunicador

get

https://{dominiodocliente}.cvcrm.com.br/api/v1/comunicador/canais

🔒
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)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

pag

integer

Número da página que retorna os canais

qtd

integer

Quantidade de registros por página que retorna os canais

nome

string

Filtra os canais cujo nome contenha o valor informado

servico

string | null

enum

Defaults to null

Filtra os canais pelo serviço

Allowed:

status

string | null

enum

Defaults to null

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

Allowed:

com_chats

boolean

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

string

enum

Defaults to pre_venda

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

Allowed:

Headers

string

required

token

string

Responses

204

Requisição processada com sucesso, sem conteúdo retornado

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Lista de canais

401Token ou e-mail incorreto(s).

422Erro interno!