Interface Channel

Represents a channel for communication.

interface Channel {
    availability?: {
        closedInformation?: string;
        exceptionallyClosedInformation?: string;
        exceptions?: ContactOptionAvailabilityException[];
        hours?: ContactOptionTimeSlot[][];
        openInformation?: string;
        remark: string;
    };
    component?: ChannelComponent;
    icon?: ChannelIcon;
    id?: string;
    information?: string;
    name: string;
    opening_hours?: { info_text?: string; is_open: boolean };
    ouapi_contactline_id?: string;
    type: ChannelType;
    url?: string;
    value?:
        | null
        | {
            address: string;
            campaign: string;
            fields: {
                attrs: {
                    maxlength: number;
                    name: string;
                    placeholder: string;
                    required: string;
                    type: string;
                };
                label: string;
                type: string;
            }[];
            formId: string;
            information: string;
            name: string;
            workgroup: string;
        };
}

Properties

availability?: {
    closedInformation?: string;
    exceptionallyClosedInformation?: string;
    exceptions?: ContactOptionAvailabilityException[];
    hours?: ContactOptionTimeSlot[][];
    openInformation?: string;
    remark: string;
}

Availability details for the channel.

component?: ChannelComponent

The component of the channel.

Optional icon representing the channel.

id?: string

Optional ID of the channel.

information?: string

Optional additional information about the channel.

name: string

Name of the channel.

opening_hours?: { info_text?: string; is_open: boolean }

Opening hours status for the channel.

ouapi_contactline_id?: string

Optional contact line ID.

The type of channel.

url?: string

Optional URL for the channel.

value?:
    | null
    | {
        address: string;
        campaign: string;
        fields: {
            attrs: {
                maxlength: number;
                name: string;
                placeholder: string;
                required: string;
                type: string;
            };
            label: string;
            type: string;
        }[];
        formId: string;
        information: string;
        name: string;
        workgroup: string;
    }

Optional structured information for forms or additional data.