Skip to main content

​
Channels

Channels are communication endpoints that connect your assistants to different platforms like WhatsApp Business API, web widgets, and custom integrations. Channels handle message routing, webhook configuration, and platform-specific settings.

​
List Channels

GET /channels

Returns a paginated list of all channels in your workspace.

​
Response

​
message
string
Success message
​
data
array
Array of channel objects

​
Get Channel

GET /channels/:channel_id

Returns detailed information about a specific channel.
​
:channel_id
string
required
Channel unique identifier

​
Response

​
message
string
Success message
​
data
object

​
Update Channel

PUT /channels/:channel_id

Updates an existing channel’s properties.
​
:channel_id
string
required
Channel unique identifier

​
Request Body

​
string
Channel name (3-100 characters)
​
object
Channel-specific settings
​
boolean
Whether the channel should be active

​
Delete Channel

DELETE /channels/:channel_id

Deletes a channel permanently.
​
:channel_id
string
required
Channel unique identifier

​
WhatsApp Business API

​
Create WhatsApp Channel

POST /channels/waba

Creates a new WhatsApp Business API channel.

​
Send WhatsApp Message

POST /channels/:channel_id/waba/send

Sends a WhatsApp message using a template.
​
:channel_id
string
required
Channel unique identifier

​
Request Body

​
object
required
​
string
required
WhatsApp template ID
​
string
required
Template type: text, list, or carousel
​
string
required
Template language: en_US or pt_BR
​
object
Template components and parameters

​
WhatsApp Templates

​
List Templates

GET /channels/:channel_id/waba/templates

Lists all WhatsApp Business templates for a channel.
​
:channel_id
string
required
Channel unique identifier

​
Create Template

POST /channels/:channel_id/waba/templates

Creates a new WhatsApp Business template.
​
:channel_id
string
required
Channel unique identifier

​
Request Body

​
string
required
Template name
​
string
required
Template category: MARKETING, AUTHENTICATION, or UTILITY
​
string
required
Template language code
​
string
Template message content
​
array
required
Template components (headers, body, buttons, etc.)
​
boolean
Whether this is a carousel template

​
Worker Integration

​
Sync Worker to Channel

POST /channels/:channel_id/worker/:worker_id

Syncs a worker to a channel, enabling the worker’s assistants to handle conversations on that channel.
​
:channel_id
string
required
Channel unique identifier
​
:worker_id
string
required
Worker unique identifier

​
Channel Types

​
WhatsApp Business API

WhatsApp Business API channels enable you to send and receive messages through WhatsApp. They require:
  • WhatsApp Business Account setup
  • Template approval from Meta
  • Proper webhook configuration

​
Examples

​
List Channels

curl -X GET https://api.plati.ai/channels \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Get Channel

curl -X GET https://api.plati.ai/channels/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Update Channel

curl -X PUT https://api.plati.ai/channels/abc123 \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production WhatsApp",
    "active": true
  }'

​
Send WhatsApp Message

curl -X POST https://api.plati.ai/channels/abc123/waba/send \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "identity": {
      "name": "John Doe",
      "phone": "5511999999999"
    },
    "templateId": "welcome_template",
    "templateType": "text",
    "templateLanguage": "pt_BR",
    "templateComponents": {}
  }'

​
Next Steps

Workers

Connect workers to channels

Conversations

Start conversations through channels

WhatsApp Integration

Learn about WhatsApp setup

WhatsApp Templates

Understand template types