Breadcrumbs

Channel



Object Name

Channel

Description

This object contains the attributes of the Channel object. The channel object represents a specific channel e.g. whatsapp, facebook etc.



Parameter

Type

Description

id Required

String

This is the UUID. Sample format is a5c80b3f-ea41-4caf-979d-641a1c32f9bd

name Required

String

Name of the channel

serviceIdentifier Required

String

It is a unique ID usually a phone number. Sample format is 524-942-9068

defaultOutbound Optional

Boolean

.... By default, it is set to FALSE

tenant Optional

Tenant

Keycloack multitenancy feature for specifying users. See

Tenant

for details.

channelConfig Optional

ChannelConfig

It is used to store channel configurations such as mode, routing policy etc. See

ChannelConfig

for details.

channelConnector Optional

ChannelConnector

Provides details of the channel connector for integration. See 

ChannelConnector

for details.

channelType Optional

ChannelType

Contains the channel type attributes. See

ChannelType

for details.