Aura –

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bridge architecture

Description of Aura bridge general architecture at the level of components

Introduction

aura-bridge architecture is designed based on three fundamental components:

aura-bridge: It is identified as the core component of the aura-bridge. It is in charge of starting the basic functionality modules, loading the plugins and starting the expressjs server.
aura-bridge-common: It can be defined as an SDK (Software Development Kit) to be able to develop a plugin.
aura-bridge-plugin. Component that provides functionality to aura-bridge. This component works the same way as a service in an architecture oriented to microservices (isolated, small and self-contained).

Aura bridge

As mentioned above, it is the core of the system and can work without the need for any plugin.

Source code structure

src
├── cache               # Two level cache module
├── config              # Configuration manager module 
├── controllers         # Generic and metric controllers (oastool)
├── make                # Aura bridge make up
├── message-sync        # Queue management system
├── middlewares         # Express middlewares
├── modules             # Bridge modules: behavior-manager, plugin-manager
└── utils               # Bridge utilities: prometheus-utils

Aura bridge common

aura-bridge-common contains all the necessary utilities in order to develop a new aura-bridge plugin and the models used in these utilities.

Aura bridge plugin

Base class to develop an aura-bridge client.

To implement a new client, it is only necessary to extend the class AuraBridgeClient and implement the sendMessage method.

export class TestClient extends AuraBridgeClient {

    public async sendMessage(message: TestMessage, options: SendMessageOptions): Promise<any> {
      ...
    }
}

If the new aura-bridge client needs to use the OAuth protocol, it is possible to extend the class AuraBridgeClientOAuthTokens and indicate the configuration of OAuth clients, passing the parameter authClients in constructor. In this way, the tokens will be updated automatically.

export class TestOauthClient extends AuraBridgeClientOAuthTokens {
  ...
}

aura-bridge-flow

AuraBridgeFlow allows the generation of a “processor” type plugin in a quickly and standardized way: control of errors, logs, metrics, client retry policies, etc.

As a rule, a “processor” type plugin receives, converts and sends a message to a destination. In case of error, it can send messages to another list of destinations.

sequenceDiagram
    Origin->>+Processor Plugin: Message
    Processor Plugin->>+Processor Plugin: Convert message

    alt ok
        Processor Plugin->>+Destination: Converted message
    end
    opt Extra response
        Processor Plugin->>+Error destination (1): Error message (1)
        Processor Plugin->>+Error destination (2): Error message (2)
    end

aura-bridge-utils

AuraBridgeUtils contains utilities for request information, get generic errors, etc.

aura-bridge plugins

A plugin is a module/component that provides aura-bridge with new functionality and works independently without affecting other existing functionality in the system.

📃 Find here detailed descriptive documentation about aura-bridge plugins.

📃 Find here the guidelines for the generation of a plugin and activation in aura-bridge.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bridge components

Description and role of the main Aura Bridge components

Introduction

aura-bridge components are shown in the following schema and described below or in specific documents.

You can find the complete list of plugins in Global plugins catalog

Server

The web server is implemented using express, that is the main web framework for nodeJS. It uses openapi-backend on top of Express to allow handling the OpenAPI v3 file.

It is in charge of setting up all the rest of the components that are needed during a request processing, as well as reading the before mentioned swagger file and setting up all the routes defined in it.

Access here to aura-bridge APIs definition.

Middlewares

Each route published in the API definition file is handled by a controller, but before a request lands on its controller, it goes through a series of middlewares, that provides some common steps needed by all the controllers of the server, such as: request authorization, request validation, common parameters extraction, logging, metrics initialization, etc.

Plugins

aura-bridge is composed of plugins, which provide functionality to the bridge.

Find complete information regarding this component in Aura bridge plugins.

Message syncer

One of the main features of aura-bridge is to be able to keep the order of the messages sent to the user, to assure that they are rendered in the correct order, so they are understandable by the users.

The component in charge of guaranteeing this order is call message syncer. It is an internal queue message system that lays on a two-level cache: a local one, that improves performance, and a remote one, to provide consistency.

Know the the detailed process for response messages synchronization managed by the message syncer.

Metrics

Aura metrics system is based on Prometheus that is an open-source systems monitoring and alerting toolkit originally built at SoundCloud.

Prometheus service pools every component to get the metrics generated during the last time period. Every component counts on a private endpoint (not accessible from internet) called /metrics where Prometheus requests the metrics.

For further information about metrics, read Metrics in aura-bridge.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bridge environment variables

Description of all the environment variables defined in Aura Bridge

Bridge Core environment variables

Properties marked in bold are mandatory.
Properties marked in italics are optional.

As aura-bridge and aura-bridge-outbound work together, the configuration of both components must be consistent, as it is detailed in the following tables.

Property	Type	Description	Modifiable by OB?	Same in aura-bridge-outbound?
AURA_AUTHORIZATION_HEADER	string	Complete authorization header to be sent to aura-groot, with the following format: `APIKEY xxxxxx`.	YES, but only if the previous APIKey was deprecated.	YES
AURA_BRIDGE_DIRECTLINE_ACTIONS	string[]	Actions that must be forwarded to Directline. By default: `['REDIRECT.COMMAND']`	YES	YES
AURA_BRIDGE_REMOTE_CONTAINER_PREFIX	number	Remote container prefix. By default: `aura-bridge`.	NO	YES
AURA_BRIDGE_RETRIES	number	Number of retries made by aura-bridge in case of error in an HTTP request. By default: `3`.	NO, only if checked and validated with Aura Global Team.	YES
AURA_BRIDGE_RETRY_DELAY	number	Delay between retries in case of error. By default: `100`.	NO, only if checked and validated with Aura Global Team.	YES
AURA_BRIDGE_RETRY_FACTOR	number	Factor to multiply delay for every HTTP request retried. By default: `10`.	NO, only if checked and validated with Aura Global Team.	YES
AURA_BRIDGE_SERVER_PORT	number	Port to where aura-bridge is listening. By default: `8045`.	NO	YES
AURA_BRIDGE_STARTUP	string[]	Tasks executed during start-up. By default: `['readAwaitedMessages']`.	YES	YES
AURA_BRIDGE_TIMEZONE	string	Timezone to be included in the channelData sent to aura-bot. By default: `Europe/Madrid`.	YES	YES
AURA_BRIDGE_WA_BLACKLISTED_NUMBERS	Set	Numbers that are blacklisted and will not be processed by aura-bridge. By default: ``. Example: ’number1,number2,number3'	YES	YES
AURA_CALLBACK_HEADER	string	Deprecated. Name of the HTTP header that contains the endpoint where aura-bridge sends the responses to the current user request. By default: `answers-callback`. Only for development.	NO	YES
AURA_CHANNELS_CONFIGURATION_API_ENDPOINT	string	Endpoint for aura-configuration-api.	NO	YES
AURA_DEFAULT_LOCALE	string	Culture code to be used by default in the current deployment: `de-de`, `en-gb`, `es-es`, `pt-br`.	NO	YES
AURA_ENCRYPTION_ALGORITHM	string	Encryption algorithm used to validate the APIKey. By default: `aes-256-cbc`.	NO. It would break APIKey validation.	YES
AURA_ENCRYPTION_IV_LENGTH	number	Size for the initialization vector used by the encryption algorithm that validates the APIKey. By default: `16`.	NO. It would break APIKey validation.	YES
AURA_ENCRYPTION_IV_POSITION	number	Position where to insert the initialization vector in the final string with the encrypted payload. By default: `35`.	NO. It would break APIKey validation.	YES
AURA_ENCRYPTION_KEY	string	Encryption key or comma-separated list of encryption keys to be used in the environment. It is mainly used to decrypt the APIKeys.	NO. It would break database encrypted data and APIKey validation.	YES
AURA_ENVIRONMENT_NAME	string	Name of the environment where aura-bridge is deployed. Used during aura-bridge make-up to handle the indexes of the database properly. For example: `ap-next`, `es-dev`, `de-pre`	NO	YES
AURA_HTTP_KEEP_ALIVE	boolean	Use of keep-alive in HTTP connections. Used in monkey-patcher. By default: `true`.	NO	YES
AURA_HTTP_KEEP_ALIVE_MSECS	number	Number of milliseconds to keep alive HTTP connections. Used in monkey-patcher. By default: `100000`.	NO	YES
AURA_HTTP_KEEP_MAX_SOCKETS	number	Maximum number of sockets. Used in monkey-patcher. By default: `200`.	NO	YES
AURA_HTTP_PATHS_LOG_DISABLED	string	HTTP paths separated by commas which request wouldn’t be logged. By default `aura-kpis,static-resources` Used in monkey-patcher.	YES, if there is a path that is not wanted to be logged. The default values are always added to the provided list.	YES
AURA_HTTP_MAX_REQUEST_SIZE	string	Maximum size in bytes of the request body. It is a string because, the allowed values must indicate the units: 10 mb, 200 kb… By default, `20mb`.	YES to decrease it, if it is considered too high. To increase it, both local and global operational teams must review it, because it could lead to DDoS attacks easily.	YES
AURA_HTTP_RECOVERABLE_CODES	string	List of HTTP codes, separated by commas, that can be retried. By default: `500, 502, 503, 504, 409, 408, 404`	Only after a careful review involving local and global teams, any of these codes can be considered unrecoverable.	YES
AURA_HTTP_INCOMING_PATHS_LOG_DISABLED	string	Comma-separated string with all the incoming paths whose requests should not be logged. By default, `/healthz`, `/metrics`, `/favicon.ico`	YES	YES
AURA_LOCALE_FOLDER	string	Full path to the local folder where locale files are stored. By default: `./locale`.	NO	YES
AURA_LOCALE_FORCE_IMPORT	boolean	`true` if locale remote loading must be carried out although there were validation errors. By default: `false`.	YES	YES
AURA_LOCALE_REMOTE_BACKUP	boolean	`true` if after updating locale files with the remote version, a backup of the former local files should be stored in Azure Storage. By default: `false`.	YES	YES
AURA_LOCALE_REMOTE_CONTAINER	string	Name of the Azure Storage Blob container where the locale files are stored. By default: `static-resources`.	NO	YES
AURA_LOCALE_REMOTE_CONTAINER_PREFIX	string	Path within `AURA_LOCALE_REMOTE_CONTAINER` where the locale files are stored. By default: `aura-bridge/locale`.	NO	YES
AURA_LOGGING_FORMAT	string	Format to be used in monitoring logs: `json` or `dev`(more visual format). By default: `json`.	NO. Only for development, set it to `dev`.	YES
AURA_LOGGING_LEVEL	string	Level to be used in monitoring logs, from more to less verbose: `'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'OFF'`. By default: `INFO`.	YES, for development set it to ‘DEBUG’. In pre/production, it should be ‘INFO’ or ‘ERROR’. For analysis of an issue in pre/production, it may be changed to ‘DEBUG’.	YES
AURA_LOGGING_EXTRA_TIME_METRICS	boolean	`true` if the time metrics should be logged in the monitoring logs. By default: `false`.	NO	YES
AURA_MAKEUP_MODE	string	It allows `dev` mode for the make-up with the value `local`. By default: `full`.	NO, only for development, set it to `local`.	YES
AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY	string	Microsoft Storage password of the deployment.	NO	YES
AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT	string	Microsoft Storage account of the environment.	NO	YES
AURA_MICROSOFT_AZURE_STORAGE_CONFIGURATION_CONTAINER	string	Aura configuration container name. By default: `aura-configuration`.	NO	YES
AURA_MICROSOFT_AZURE_STORAGE_STATIC_CONTAINER_NAME	string	Name of the container where the static resources are stored.	NO	YES
AURA_PHONE_COUNTRY_CODE_NU	string	Country code of the phone number. By default: `34`.	YES	YES
AURA_QUEUE_MANAGER_AWAITED_MESSAGES_BY_TURN	number	Number of messages to be imported by the Awaited Message Agent in each turn. By default: `100`.	NO	NO
AURA_QUEUE_MANAGER_AWAITED_MESSAGES_INTERVAL	number	In milliseconds, time interval of a shift for the Awaited Message Agent. By default: `20 * 1000`. (20 seg)	NO	NO
AURA_QUEUE_MANAGER_AWAITED_MESSAGE_TTL	number	In milliseconds, maximum lifetime of a message in aura-bridge. After this time, the system will delete the message. By default: `15 * 60 * 1000` (15 min).	NO	YES
AURA_QUEUE_MANAGER_AWAITED_RETRIES_FACTOR	number	Factor to manage the Backoff of the AWAITED Message Agent. The time to consider an AWAITED message will be: currentRetry MAX_PENDING_TIME AWAITED_RETRIES_FACTOR. By default: `0.1`.	NO	YES
AURA_QUEUE_MANAGER_CHECK_QUEUE_INTERVAL_TTL	number	In milliseconds, time interval used by the queue manager to check if the queue system has pending messages. If not, it deactivates the service and it will be reactivated when a new message comes in. By default: `1000`.	NO	YES
AURA_QUEUE_MANAGER_CONCURRENT	number	Number of messages processed by the memory queue simultaneously. By default: `50`.	NO	NO
AURA_QUEUE_MANAGER_CONCURRENT_FACTOR	number	Variable to control the queue execution in blocks. By default: `2`.	NO	NO
AURA_QUEUE_MANAGER_INTERVAL	number	In milliseconds, time interval for processing messages in the queue. By default: `200`.	NO	YES
AURA_QUEUE_MANAGER_FORCE_MESSAGE_ORDER	boolean	Flag to indicate whether or not aura-bridge outgoing messages order must be assured. By default: `false`.	NO	YES
AURA_QUEUE_MANAGER_MAX_PENDING_TTL	number	In milliseconds, time when a message is in `PENDING` status before it is considered `AWAITED`. By default: `30 * 1000`.	NO	YES
AURA_QUEUE_MANAGER_MAX_PENDING_TTL_MARGIN	number	In milliseconds, time margin used by the memory queue to manage the time that a `PENDING` message has before being discarded and returned to the AWAITEDs system. By default: `5 * 1000`.	NO	YES
AURA_QUEUE_MANAGER_MAX_RETRIES	number	Number of validation attempts. Do not confuse with message sending retries. These retries are for the validations that a message makes to see if it can be sent or if it has to continue waiting. By default: `100`.	NO	YES
AURA_QUEUE_MANAGER_MESSAGE_TTL	number	In milliseconds, lifetime of an incoming message. By default: `5 * 1000`.	NO	YES
AURA_QUEUE_MANAGER_SENT_MESSAGE_TTL	number	In milliseconds, lifetime of a message with status to `SENT`. If the ACK does not arrive from the client, then the message is considered as sent and is deleted from the system, making way for the next messages that the user has pending. By default: `5 * 1000`.	NO	YES
AURA_QUEUE_MANAGER_METRICS_PARTIAL_INTERVAL	number	In milliseconds, when the queue must write a partial summary of its execution cycle. By default: `30 * 1000`.	NO	YES
AURA_REDIS_MODE	string	Mode of Redis distribution. Values: `CLUSTER`, `SENTINEL`, `SINGLE`. By default: `SENTINEL`.	NO	YES
AURA_REDIS_SENTINEL_INSTANCE_NAME	string	Name of the Redis instance. Use in `SENTINEL` mode.	NO	YES
AURA_REDIS_HOSTS	string	A string with list of nodes separated by ‘,’, including host and port separated by ‘:’. For example: “localhost:port,localhost2:port2”.	NO	YES
AURA_REDIS_DATABASE	number	Database number for `SINGLE` or `SENTINEL` mode. By default: `0`.	YES	YES
AURA_REDIS_PASSWORD	string	String with Redis password.	YES	YES
AURA_ENVIRONMENT_PREFIX	string	Prefix that will be used by all Redis keys when using redis-connector. This allows mixing in a single Redis service messages coming from different environments in the same Azure subscription. By default: ``. (empty)	YES	YES
AURA_REDIS_USE_CONNECTION_POOL	string	Use pool connections for Redis. By default: `true`.	YES	YES
AURA_REDIS_CONNECTION_POOL_MIN	number	Minimum number of connections in the pool. By default: `2`.	YES	YES
AURA_REDIS_CONNECTION_POOL_MAX	number	Maximum number of connections in the pool. By default: `100`.	YES	YES
AURA_REDIS_MAX_RECONNECT_RETRIES	number	Number of retries to connect to Redis. By default: `25`	YES	YES
AURA_REDIS_MAX_RECONNECT_INTERVAL	number	Time in milliseconds to wait before reconnecting to Redis. By default: `5000`.	YES	YES
AURA_REQUEST_TIMEOUT	number	Number of seconds to wait for a request. By default: `30 * 1000`.	YES, in case of network issues.	YES
AURA_SERVICE_ENVIRONMENT	string	Type of environment: `'DEV', 'PRE', 'PRO'`. By default, `DEV`. It is used during locale translation, to get the correct text reference.	NO	YES
AURA_SHUTDOWN_GRACEFUL_TTL	number	Time in milliseconds to complete the SHUTDOWN signal and process all the messages in queue before SIGTERM. By default: `25 * 1000`.	YES	YES
AURA_SWAGGER_LOCAL_PATH	string	Location of the swagger file generated from all loaded plugins. By default: `swagger.yaml`. Used during makeup to upload the file to remote.	NO	YES
AURA_SWAGGER_LOCAL_CORE_PATH	string	Location of aura-bridge swagger base file. By default: `swagger-core.yaml`.	YES	YES
AURA_SWAGGER_REMOTE_CONTAINER_PREFIX	string	Remote container prefix to store the swagger information. By default: `aura-bridge/swagger`	YES	YES
AURA_VERSION	string	Mandatory, release of Aura.	NO	YES
BRIDGE_CACHE_MESSAGES_ACK_ACTIVE	boolean	Flag to enable/disable the ack messages cache. By default: `false`	YES	YES
BRIDGE_CACHE_MESSAGES_ACK_DELETE_WHEN_USED	boolean	Removes the ack message from the cache when it is used. By default: `true`.	YES	YES
BRIDGE_CACHE_MESSAGES_ACK_TTL	number	Time to live of the objects stored in the bridge ack cache messages in seconds. By default: `24 * 60 * 60`.	YES	YES
BRIDGE_EVENT_SERVICE_ACTIVE	boolean	Allows to enable/disable the bridge event service. By default: `false`.	YES	YES
DEV_AURA_BEHAVIOR_CACHE_TTL	number	Maximum lifetime of behavior cache in aura-bridge in seconds. After this time, the system will delete the message. By default: `60 * 60` (60 min).	YES	YES
DEV_AURA_BEHAVIOR_COMMAND_PATTERN	string	Pattern to recognize a behavior command. By default: `^\/bridge(:\| +)(get\|set\|unset)(:\| +)(\w+)(:\| +)?.+`	NO in production environments. This feature could only be activated in development environments.	YES
DEV_AURA_BEHAVIOR_MANAGER_ACTIVE	boolean	Flag to indicate whether or not behavior-manager module should be activated in the current deployment. It is only valid for development environments. By default: `false`	NO in production environments. This feature could only be activated in development environments.	YES
DEV_AURA_BEHAVIOR_SETTINGS_FILE_CRON_PATTERN	string	CRON expression associated with the reload time of the configuration file. Configuration file is defined in: `DEV_AURA_BEHAVIOR_SETTINGS_FILE_MICROSOFT_AZURE_STORAGE`. By default: `\/5 * * *`.	NO in production environments. This feature could only be activated in development environments.	YES
DEV_AURA_BEHAVIOR_SETTINGS_FILE_MICROSOFT_AZURE_STORAGE	string	Profile configuration file location for the behavior-manager. By default: `aura-bridge/aura-bridge-behavior-manager.json`	NO in production environments. This feature could only be activated in development environments.	YES

Bridge plugins environment variables

admin-api plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_BOT_ENDPOINT	string	Endpoint to make requests to aura-groot.	NO, for production environments. YES in local environments, to point to the local instance of aura-groot.	YES

directline-service plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_BOT_APIKEY	string	APIKey to be authorized in aura-groot requests.	YES, but only if the previous APIKey was deprecated.	YES
AURA_BOT_ENDPOINT	string	Endpoint to make requests to aura-groot.	NO for production environments. YES in local environments, to point to the local instance of aura-groot.	YES
AURA_BRIDGE_DOMAIN	string	aura-bridge domain. By default: `/aura-services`.	NO	YES
AURA_BRIDGE_ENDPOINT	string	aura-bridge endpoint used by aura-groot to send the use cases responses.	NO for production environments. YES in local environments, to point to the current instance of aura-bridge from aura-groot.	YES
AURA_BRIDGE_OVERWRITE_LIST_TYPE_FROM_MSG	boolean	If set to `true`, it will get the type from the message. By default: `false`.	YES	YES
AURA_BRIDGE_REQUEST_VERSION	string	Version to send in the `channelData` property sent to aura-groot. By default: `2.0.0`.	NO	YES

genesys-directline-processor plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_GENESYS_CALLBACK_HEADER	string	Name of the HTTP header that contains the endpoint where aura-bridge will send the callback response to Genesys. By default: `genesys-callback`. Only for development.	NO	YES
AURA_GENESYS_AURA_COMMAND_DEFAULT_INTENT	string	Intent always sent to DirectLine as `Auracommand` suggestion. By default: `intent.common.handover`.	YES	YES

whatsapp-incoming-processor plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_FP_WHATSAPP_ENDPOINT	string	Endpoint to the WhatsApp API in Kernel. Used to access WA API through Kernel. Must not contain the API version.	NO	YES

whatsapp-service plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_WHATSAPP_DIRECTLINE_DEFAULT_VERSION	string	Default version used to comunicate between bridge and bot. Default value ‘2’. Individual version could be configured for every channel. See `defaultDirectlineVersion`	YES	YES
AURA_FP_WHATSAPP_ENDPOINT	string	Endpoint to the WhatsApp API in Kernel. It will be used to access WA API through Kernel. Must not contain the API version.	NO	YES
AURA_WHATSAPP_LIST_OPTION_MAX_TITLE_LENGTH	number	Maximum number of characters to use message list. By default: `20`.	YES, with caution respecting the limits of the WhatsApp API	YES
AURA_WHATSAPP_BUTTON_OPTION_MAX_TITLE_LENGTH	number	Maximum number of characters to use reply button. By default: `20`.	YES, with caution respecting the limits of the WhatsApp API	YES
AURA_WHATSAPP_ACK_NO_ANSWER_STATUSES	string	List of status, separated by commas, to avoid sending error messages to WhatsApp when ACKs arrive with the status error defined in this variable. By default, `470`.	YES	YES
AURA_WHATSAPP_BR_UNIFIED_CONVID	string	Unified conversation id for BR phones. By default, `false`.	YES	YES

whatsapp-client-service plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_FP_AUTHSERVER_ENDPOINT	string	URL of the Kernel AuthServer, used to get valid `access_token` or `introspect_token` to handle calls to Kernel data APIS. It MUST end with `/`	NO	YES
AURA_FP_WHATSAPP_ENDPOINT	string	Endpoint to the WhatsApp API in Kernel used to access WA API through Kernel. It must not contain the API version.	NO	YES

aurapush-sendfeedback-service plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_PUSH_FEEDBACK_ENDPOINT	string	URL for sending acks to Aura push	YES	YES
AURA_PUSH_FEEDBACK_SUBSCRIPTION_KEY	string	Subscription key to `AURA_PUSH_FEEDBACK_ENDPOINT`	YES	YES

auraline-conversation-api-plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURALINE_CONVERSATION_EXPIRATION_TIME	string {time}{unit}	Token validity time. This time can be expressed in years (y), months (M), days (d), hours (h), minutes (m) or seconds (s). Examples: 1y = one year 2M = two months 5h = five hours 3m = three minutes 90s = ninety seconds. By default `12h`	YES	YES

auraline-incoming-processor plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURALINE_CHANNEL_ID	string	Channel ID to be included in the `channelData` property sent to aura-bot. Only if the channel is always the same and is not sent in the message activity	YES	YES
AURALINE_DEFAULT_VERSION	string	Version to be included in the `channelData` property sent to aura-bot. By default `3`	NO	YES

rcs-service plugin

Property	Type	Description	Modifiable by OB?	Same in Aura Bridge Outbound?
AURA_RCS_DEFAULT_VERSION	string	Version to be included in the `channelData` property sent to aura-bot. By default `3`	NO	YES
AURA_RCS_BUSSINESS_MESSAGING_AUTH_ENDPOINTS	string	Google authentication endpoint list. By default: `https://www.googleapis.com/auth/rcsbusinessmessaging`.	YES	YES
AURA_RCS_BUSSINESS_MESSAGING_ENDPOINT	string	Google RCS messages endpoint. By default: `https://rcsbusinessmessaging.googleapis.com/`.	YES	YES

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura bridge functionalities

Description of the main functionalities carried by Aura bridge and the different processes that can be executed for its management

The current documents describe the main functionalities of aura-bridge and processes that can be carried out over it:

Actions managed by redirect command: Certain actions can be performed by aura-bridge through the redirect command, that manages messages from aura-groot.
Response messages synchronization: Description of the process for the synchronization of the user’s messages executed by aura-bridge.
Managing payload information: aura-bridge adds relevant information in communication with aura-groot through a field called payLoad, within the root channelData field of the activity.
Aura Bridge supports several WhatsApp numbers: functionality that allows Aura bridge to support several numbers in WhatsApp channel.
Errors management by Aura bridge: aura-bridge has to manage errors for different sources such as aura-groot, Kernel, WhatsApp, etc.
Aura bridge events management: aura-bridge can emit and listen to events through a centralized service.
Aura bridge channelData v3 configuration: aura-bridge configuration to communicate with aura-bot using channelData v3 for WhatsApp channels.
Aura bridge make-up process: the make-up process, that includes a set of operations to prepare an environment once a module has been deployed, must always be executed to correctly start aura-bridge component.
Management of list options for WA channel: Aura is able to use list messages in WhatsApp graphical interface. This interactive component is managed by aura-bridge.

Docs:

Mon, 01 Jan 0001 00:00:00 +0000

Aura Bridge APIs definition

Description of API swaggers for Aura bridge

Introduction

This section includes the OpenAPI definition files of the APIs of Aura. The folder contains the API of Aura and the partial published in Kernel.

The following APIs are available in aura-bridge: