Channels

Channels

Get available channels

get

Fetch the list of available channels and indicate whether each is installed.

Path parameters

workspaceIdstringRequired

The ID of the workspace

Example: d587ce39-6be2-48c0-b400-5d776464a112

Responses

200

List of available channels with installation status

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Available Channels

404

Workspace not found

application/json

get

/api/channels/{workspaceId}/available

HTTPcURLJavaScriptPython

GET /api/channels/{workspaceId}/available HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Available Channels",
  "data": [
    {
      "name": "Whatsapp",
      "platform": "whatsapp",
      "icon": "url-to-whatsapp-icon",
      "status": "Install"
    }
  ]
}

Get WhatsApp setup information

get

Fetch detailed information required to set up WhatsApp as a channel.

Responses

200

WhatsApp setup information

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: WhatsApp Setup Information

404

Channel not found or unsupported

application/json

get

/api/channels/whatsapp/setup-info

HTTPcURLJavaScriptPython

GET /api/channels/whatsapp/setup-info HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "WhatsApp Setup Information",
  "data": {
    "preInstallation": "text",
    "preInstallationList": [
      "text"
    ],
    "installation": "text",
    "installationList": [
      "text"
    ],
    "overviewListImages": [
      "text"
    ],
    "overview": "text",
    "WhatCanWithWhatsApp": "text",
    "useWhatsAppToList": [
      "text"
    ],
    "capabilitiesText": "text",
    "capabilitiesTableOne": [
      {
        "type": "text",
        "send": "text",
        "receive": "text"
      }
    ],
    "capabilitiesTableTwo": [
      {
        "type": "text",
        "send": "text",
        "receive": "text"
      }
    ],
    "capabilitiesTableThree": [
      {
        "type": "text",
        "send": "text",
        "receive": "text"
      }
    ]
  }
}

Install a channel for a connector

post

Install a channel and link it to an existing connector.

Path parameters

workspace_idstring · uuidRequired

The workspace ID

Example: d587ce39-6be2-48c0-b400-5d776464a112

Body

application/json

connector_idstring · uuidOptional

The ID of the connector

namestringOptional

Name of the channel

platformstring · enumOptional

Platform of the channel

Possible values:

Responses

200

Channel installed successfully

No content

400

Validation error

application/json

post

/api/workspaces/{workspace_id}/channels/install

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspace_id}/channels/install HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "connector_id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "platform": "whatsapp"
}

No content

Get channels with optional platform filter

get

Fetch the list of channels for a workspace, optionally filtering by platform.

Path parameters

workspaceIdstringRequired

The ID of the workspace

Example: 04c51660-196a-468a-bf97-3fcef058944d

Query parameters

platformstringOptional

Platform to filter channels by (e.g., whatsapp)

Example: whatsapp

statusstringOptional

status to filter channels by (e.g., active)

Example: whatsapp

Responses

200

List of channels with optional platform filter

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Channels retrieved

404

Workspace not found

application/json

get

/api/workspaces/{workspaceId}/channels

HTTPcURLJavaScriptPython

GET /api/workspaces/{workspaceId}/channels HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Channels retrieved",
  "data": [
    {
      "name": "Whatsapp",
      "platform": "whatsapp",
      "icon": "url-to-whatsapp-icon",
      "status": "Installed"
    }
  ]
}

Get channels by organization with optional platform filter

get

Fetch all channels associated with an organization's workspaces, optionally filtered by platform.

Path parameters

organizationIdstring · uuidRequired

The ID of the organization

Query parameters

platformstring · enumOptional

Platform to filter channels by (e.g., whatsapp, sms)

Possible values:

Responses

200

List of channels for the organization

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Organization channels retrieved

404

Organization not found

application/json

get

/api/organizations/{organizationId}/channels

HTTPcURLJavaScriptPython

GET /api/organizations/{organizationId}/channels HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Organization channels retrieved",
  "data": [
    {
      "id": "text",
      "name": "text",
      "platform": "text",
      "status": "text",
      "workspace": {}
    }
  ]
}

Connect a channel to a workspace

post

Associate an existing channel with a specific workspace

Path parameters

workspace_idstring · uuidRequired

The ID of the workspace

channel_idstring · uuidRequired

The ID of the channel to connect

Responses

200

Channel connected successfully

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Channel connected to workspace successfully

400

Validation error or channel already connected

application/json

403

Unauthorized access

application/json

post

/api/workspaces/{workspace_id}/channels/{channel_id}/connect

HTTPcURLJavaScriptPython

POST /api/workspaces/{workspace_id}/channels/{channel_id}/connect HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "Channel connected to workspace successfully",
  "data": {
    "channel": {},
    "workspace": {}
  }
}