Channels

Obtener canal

get/v1/channels/{channelId}

Request

Base URL
https://connect.cliengo.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cliengo/apis/cliengo-public-api/docs/v1/channels/:channelId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

channelIdstring required

ID del canal (== websiteId histórico).

Response

Detalle del canal

idstring

ID del canal (== websiteId histórico).

type'WEBSITE' | 'WHATSAPP_API' | 'WHATSAPP_BUSINESS' | 'FACEBOOK' | 'INSTAGRAM'

Tipo del canal/sitio. Ojo con el casing frente a Channel (el canal de una conversación): acá WhatsApp se distingue como WHATSAPP_API (WhatsApp Business API) o WHATSAPP_BUSINESS, mientras que Channel usa el valor genérico WHATSAPP.

labelstring

Nombre legible (título del sitio, número de WhatsApp, page de FB, etc.).

connectedboolean

Indica si el canal está conectado y recibiendo mensajes.

testChannelUrlstring uri

URL para probar el chatbot en este canal.

whatsappFormboolean

Solo aplica a canales WhatsApp — indica si el formulario de configuración está activo.

disconnectionRequestedboolean

Solo WhatsApp API — indica que se está procesando la desconexión.

Example response

{
  "chatbot": {
    "id": "5f08e255c9a881002afc06ec",
    "title": "Asistente de Ventas",
    "name": "bot-ventas",
    "connectedChannels": 2
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.