Overview

A channel in AKMP is an entity that defines interaction with a subscriber (profile) through external integration.

Such interaction could be, for example, sending an SMS, a message to a CRM or to a social network community.

There are three types of channels:

• Built-in (Email, SMS, Push) — channels are strictly described in the system code and cannot be configured;
• System — channels whose settings are supplied with the system;
• Custom — systems configured by the user (administrator).

System channels are specified in the json_consts/channels directory.

A custom channel is configured in the platform admin panel, in the Setup > Custom Channels menu.

The channel contains:

• Channel name;
• Unique numeric and unique string identifiers designed to store the channel attribute in events, data structures, etc. Cannot be changed after creation;
• Type of communication: personalized or non-personalized;
• Identifier of the system module that controls the channel or configures pipelines for interaction with external services;
• Settings for events that occur in the channel;
• Settings for data fields and their displays in platform entities (content).

Non-personalized or indirect channels are used in cases where interaction occurs with an indefinite set of profiles, or when there are no such profiles in the platform. When sending messages to that channel, only one content will be created per mailing, and it cannot use personalized information.

For a personalized channel (direct), the mailing will create messages for each profile. Accordingly, they can use information associated with a profile, its fields and other data. To send messages, you must have a profile on the platform.

The channel has the ability to set events that are reflected in AKMP reports, profile history, segments, etc. Each event is assigned unique string and numeric identifiers, a name, the color of the graph in reports and a reflection of the internal platform event (for example, deliv — message delivery). To reflect events not provided for by the platform, the custom type (custom event) is used.

Content and channel settings are specified through fields. Fields can be set for the following AKMP entities:

• Template define message fields, such as the body of a text message or an image;
• Resource define customization fields in the resource, for example, an API key available to the user, or an application icon;
• Mailing define message fields and settings, such as an identifier for reporting;
• Sender define settings on the sender, for example, an API key that is not available to the user, or an API URL;
• Subscriptions define identifiers that associate a resource with a profile in a channel, for example, a user ID in CRM.

Interaction with external services when sending messages and receiving events on them occurs via pipelines.

Each pipeline consists of a JSON configuration in a special format that describes interaction with services: sending requests, converting data, saving and loading values, creating events in the platform.