Create Channel

POST

/api/v1/channels

• API de Produção

Create a new channel.

The channel will be created in ‘inactive’ status. For WhatsApp channels, you’ll need to call /connect to get a QR code. For API channels, the webhook URL will be generated automatically.

Authorizations

• HTTPBearer

Parameters

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Request Body ^required

ChannelCreate

Schema for creating a Channel.

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

config

Config

Channel-specific configuration

object

is_default

Is Default

Set as default channel for sending

boolean

auto_reply_enabled

Auto Reply Enabled

Enable auto-reply for new conversations

boolean

auto_reply_message

Any of:

string

string

<= 1000 characters

null

null

business_hours_enabled

Business Hours Enabled

Enable business hours

boolean

business_hours

Any of:

BusinessHours

BusinessHours

Business hours configuration.

object

monday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

tuesday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

wednesday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

thursday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

friday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

saturday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

sunday

Any of:

DaySchedule

DaySchedule

Schedule for a single day.

object

enabled

Enabled

boolean

default: true

start

Start

string

default: 09:00 /^\d{2}:\d{2}$/

end

End

string

default: 18:00 /^\d{2}:\d{2}$/

null

null

null

null

out_of_hours_message

Any of:

string

string

<= 1000 characters

null

null

assignment_mode

How to assign conversations

string

Allowed values: manual round_robin least_busy

default_assignee_id

Any of:

integer

integer

null

null

sla_enabled

Sla Enabled

Enable SLA tracking

boolean

sla_first_response_minutes

Any of:

integer

integer

>= 1 <= 1440

null

null

sla_resolution_minutes

Any of:

integer

integer

>= 1 <= 10080

null

null

Responses

201

Successful Response

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

string

null

null

business_hours_enabled

required

Business Hours Enabled

boolean

business_hours

Any of:

object

object

null

null

out_of_hours_message

Any of:

string

string

null

null

assignment_mode

required

AssignmentModeEnum

How conversations are assigned to agents.

string

Allowed values: manual round_robin least_busy

default_assignee_id

Any of:

integer

integer

null

null

sla_enabled

required

Sla Enabled

boolean

sla_first_response_minutes

Any of:

integer

integer

null

null

sla_resolution_minutes

Any of:

integer

integer

null

null

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

string format: date-time

null

null

disconnected_at

Any of:

string

string format: date-time

null

null

last_error

Any of:

string

string

null

null

webhook_url

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string