Pular para o conteúdo
Healthing CRM

List Channels

GET
/api/v1/channels

List all channels for the current tenant.

Supports filtering by channel type and active status. Also includes legacy WhatsApp sessions from Sprint 21 for backward compatibility.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Query Parameters

Seção intitulada “Query Parameters ”
channel_type
Any of:
ChannelTypeEnum

Type of communication channel.

string
Allowed values: api whatsapp email telegram webchat

Filter by channel type

is_active
Any of:
boolean

Filter by active status

include_legacy_whatsapp
Include Legacy Whatsapp

Include Sprint 21 WhatsApp sessions

boolean
default: true

Include Sprint 21 WhatsApp sessions

page
Page

Page number

integer
default: 1 >= 1

Page number

per_page
Per Page

Items per page

integer
default: 20 >= 1 <= 100

Items per page

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Successful Response

ChannelList

Paginated list of channels.

object
items
required
Items
Array<object>
ChannelResponse

Schema for Channel response.

object
name
required
Name

Friendly name for the channel

string
>= 1 characters <= 255 characters
channel_type
required

Type of channel

string
Allowed values: api whatsapp email telegram webchat
id
required
Id
integer
status
required
ChannelStatusEnum

Status of a channel connection.

string
Allowed values: active inactive connecting error
config
required
Config
object
is_active
required
Is Active
boolean
is_default
required
Is Default
boolean
auto_reply_enabled
required
Auto Reply Enabled
boolean
auto_reply_message
Any of:
string
business_hours_enabled
required
Business Hours Enabled
boolean
business_hours
Any of:
object
out_of_hours_message
Any of:
string
assignment_mode
required
AssignmentModeEnum

How conversations are assigned to agents.

string
Allowed values: manual round_robin least_busy
default_assignee_id
Any of:
integer
sla_enabled
required
Sla Enabled
boolean
sla_first_response_minutes
Any of:
integer
sla_resolution_minutes
Any of:
integer
total_conversations
required
Total Conversations
integer
total_messages_sent
required
Total Messages Sent
integer
total_messages_received
required
Total Messages Received
integer
connected_at
Any of:
string format: date-time
disconnected_at
Any of:
string format: date-time
last_error
Any of:
string
webhook_url
Any of:
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
total
required
Total
integer
page
required
Page
integer
per_page
required
Per Page
integer

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string