Last updated

Terminology

Organization

When a user account is created, a default organization is automatically generated for that user. The user is assigned the Owner role within this organization.

All assets, such as services, gateways, and API keys, will be associated with the organization. A user can only be the Owner of one organization, but they may be a member of other organizations in different roles.

Unimsgs Service (Uniservice)

A Unimsgs service is a container for your messaging assets and configurations such as gateways, workflows, team members, and API keys. Each service operates in isolation from others.

There are various types of services, each tailored to specific messaging needs, such as messaging services, identity services, and email services.

Provider

A provider refers to a messaging service, such as an SMS or email provider, that offers a well-documented API for third parties to send messages.

Examples of such providers include Twilio, Infobip and Mailgun.

Gateway

A gateway serves as the link between the Unimsgs platform and a user's account at a provider's service. It stores all necessary configurations, such as the username, password, API key, and other settings required to execute API calls and perform actions on the provider's service.

Gateway Actions

A gateway action refers to a specific function or task that a gateway can perform, such as sending messages, querying account balance, checking message delivery status, or retrieving logs.

The availability of an action for a gateway may vary depending on the service provider's API, meaning certain functions may be supported by some providers but not by others.

Mock Gateway

A mock gateway simulates the behavior of a real gateway by generating mock responses. It allows you to test and validate the messaging workflow, routing, and API integration without interacting with a live service provider, making it ideal for development, debugging, and testing scenarios.