# Unimsgs API Docs

### Authentication

API requests are authenticated using Bearer Token. The Token can be obtained from the API Key associated with the appropriate service.

Browse to **Services** from the side bar in the portal and then select the service you want to use. Click on the **API Keys** tab to manage the API Keys and their tokens.

Version: 1.0.0

## Servers

```
https://api.unimsgs.com
```

## Security

### bearerAuth

Defines a bearer token security scheme, where the token is retrieved from the API Keys section of the user portal.

Type: http
Scheme: bearer

## Download OpenAPI description

[Unimsgs API Docs](https://unimsgs.redocly.app/_spec/api/docs.yaml)

## Messaging

Unimsgs supports sending various types of messages across multiple channels (Ominichannel messages), including SMS, email, WhatsApp, and Telegram.

One important aspect of ominichannel messages is the ability to address different destionation addresses for the target channels.

Unimsgs uses the **channels format** that addresses the destination of each channel and will override the default destination address.

The format is '`{default address}`;`{channel1}:{address1}`;`{channel2}:{address2}`'

The following are some examples:

- **'to': '`966501234567`'**: Descibes a (To) parameter with a default value that should be used for all channels.

- **'to': '`966501234567`;`email:john@example.com`'**: Descibes a (To) parameter with a default value that will be overriden with 'john@example.com' for email channels.

### Send text message

 - [POST /v1/messaging/{serviceId}/message](https://unimsgs.redocly.app/api/docs/messaging/sendtextmessage.md): The API to send a text message.

## Gateways

### Get gateway balance

 - [GET /v1/gateways/{gatewayKey}/balance](https://unimsgs.redocly.app/api/docs/gateways/getgatewaybalance.md): Get a gateway's balance if the action is supported by the provider.