Skip to main content
Skip table of contents

Channel

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


ParameterTypeDescription

id REQUIRED

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

name REQUIRED

StringName of the channel

serviceIdentifier REQUIRED

StringIt 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

TenantKeycloack multitenancy feature for specifying users. See Tenant for details.

channelConfig OPTIONAL

ChannelConfigIt is used to store channel configurations such as mode, routing policy etc. See ChannelConfig for details.

channelConnector OPTIONAL

ChannelConnectorProvides details of the channel connector for integration. See ChannelConnector for details.

channelType OPTIONAL

ChannelTypeContains the channel type attributes. See ChannelType for details.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.