masstack

Integration

Introduction

Communications is the system inside MasStack (the global set of microservices modelling the company) in charge of external communications towards the customers. Its main features are:

  • Communication templates management
  • Multiple channels
    • SMS
    • E-Mail
    • Rich Communication Services (RCS)
    • Mobile App Push Notifications (Planned)
  • Multiple languages
  • Traceability

It is important to have a clear idea of the terms used in this documentation that describes the way to define templates for different communications:

  • Communication Type: This concept defines a specific type of communication according to its purpose and it does not depend on the organization, language or channel used. For example, the type shipping_in_transit defines a communication which purpose is to notify that certain shipment has been already released for delivery.
  • Organization: The organization defines the brand/tenant/organization that is the source of the communication, the communication may be customized according to organization branding and style. e.g: MasMovil.
  • Channel: A communication can be sent by different channels such as SMS, email or mobile push notification. For the specific communication sending execution one or several channels must be chosen.
  • Communication Arguments: Some communications may require variable info depending on the receiver of the communication, this info is provided via specific arguments when the communication is performed. For example, for the communication type shipping_in_transit an individual link to the delivery tracking info is included as an argument for the communication.

Communication sending

See below a interactive sequence diagram of how to operate with the API ()

graph TB A[Authentication] --> B{Is the communication
templatizable and part
of an operational process?} B --> |YES|E{Does Communication Type
already exist?} B --> |NO|C(Check other alternatives
with Communications team) E --> |YES| F{Do Templates
already exist?} E --> |NO| H(Request Communication Type
creation to Communications team) H --> I[[Communication Type
created by team]] F --> |YES| G[POST /orgs/xxx/communications] F --> |NO| J(Request Templates creation
to Communications team) I --> J J --> K[[Templates created
by team]] K --> G click A "/en/guides/authorization/overview/" _self click E "https://docs.google.com/spreadsheets/d/1UTRcLhZPtF1LyotNW3bXr5XBduthRvi3hPmK-FDYTxo/edit#gid=1334068168" click F "https://docs.google.com/spreadsheets/d/1UTRcLhZPtF1LyotNW3bXr5XBduthRvi3hPmK-FDYTxo/edit#gid=206526989" click G "/en/docs/apis_communications_doc_swagger/2/communications/#op-POST-orgs/:org/communications" _self click H "https://jiranext.masmovil.com/browse/CUCO" click J "https://jiranext.masmovil.com/browse/CUCO"

Step 0: Authentication

Like all MasStack APIS the first step to consume them is to be correctly authenticathed. All this information can be expanded here .

Step 1: Check Communications suitability

The target of Mas-Communications application is to provide multi-channel and multi-language communication services to the other applications inside Mas-Stack and other integrated external systems handling business processes of the different organizations.

If the aimed communications are not part of regular business process and/or change frequently depending on commercial decisions, Communications might not be right application to handle them. Ask Communications team about other possibilities.

Step 2: Do you need a new Communication Type?

There are different Communication types already predefined and common for all the organization(tenants) supported by {< masstack >}}. Click here to see the catalog of existing communications types and their code.

If there was a need to expand this catalog, a new communication Type would have to be created, thus opening a ticket in Jira to the Communications team. After, the team will reply with the communication type code already created to be used in this object.

Step 3: Do you need a Template?

A Template resource represents a specific implementation of a Communication Type for a given brand, language and channel. The syntax of these objects can be checked here . Click here to see all Template’s Catalogue. To create new templates, one ticket on Jira must be created. After, Communications' Team will contact you with the the Template created.

Step 4: Send the communication

Once the template is ready to use, the next step is to send the communication. All the info about this process can be consulted here .

Integration