> ## Documentation Index
> Fetch the complete documentation index at: https://brokeros.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Infobip (Omnichannel SMS Platform)

> Configure Infobip for enterprise SMS broadcasts, custom API base URLs, and advanced delivery reporting across Europe and the GCC.

**Infobip** is an international omnichannel communications provider with direct mobile operator connections across Europe, Africa, Latin America, and the Gulf Cooperation Council (GCC) region. The BrokerOS Infobip integration (`@brokeros/int-sms-infobip`) communicates via Infobip SMS Advanced REST APIs using dedicated tenant base URLs and API Keys.

***

## Infobip SMS Pipeline

```mermaid theme={null}
sequenceDiagram
    autonumber
    actor Worker as BullMQ SMS Processor
    participant Adapter as InfobipSmsClient (@brokeros/int-sms-infobip)
    participant InfobipAPI as Infobip API ({baseUrl}/sms/2/text/advanced)
    actor Lead as Buyer Handset
    participant InboundCtrl as Inbound SMS Controller
    participant Inbox as Team Inbox Workspace

    Worker->>Adapter: sendSms(options, credentials)
    Adapter->>InfobipAPI: POST /sms/2/text/advanced (from, destinations, text)
    InfobipAPI->>Lead: MNO Delivers Message to Handset
    InfobipAPI-->>Adapter: 200 OK with Response Array (messageId, status)
    
    Lead->>InfobipAPI: Buyer Replies: "Call me tomorrow"
    InfobipAPI->>InboundCtrl: Webhook POST /api/marketing/sms/inbound
    InboundCtrl->>Inbox: Upsert Inbound Message in Team Inbox
```

***

## Required Credentials

To connect Infobip, retrieve the following credentials from your [Infobip Portal](https://portal.infobip.com):

| Credential Field | Parameter in BrokerOS Modal | Requirements & Format |
| :- | :- | :- |
| **Base URL** | `Infobip Base URL / API Domain` | Your tenant-specific base URL (e.g., `https://xxxxxx.api.infobip.com`). |
| **API Key** | `Infobip API Key` | Secret API Key string (`App xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`). |
| **From Sender** | `Default From Sender / Header` | Approved alphanumeric sender header or virtual number. |
| **DLT Entity ID** | `DLT Principal Entity ID (Optional)` | (Optional) 19-digit DLT PE ID for India carrier routing. |

***

## Configuration Steps

**1. Retrieve API Key and Base URL**

Log in to `portal.infobip.com`. On your dashboard homepage, copy your dedicated **Base URL** (e.g., `https://xxxxx.api.infobip.com`). Generate an active **API Key** under **Settings -> API Keys**.

**2. Add Infobip in BrokerOS Settings**

In the BrokerOS web application:

1. Navigate to **Dashboard -> Marketing -> SMS -> Settings -> Gateways & Phone Pools** tab (`/dashboard/marketing/sms/settings?tab=providers`).
2. Click **Connect Gateway** (or select **INFOBIP** from the available gateways list).
3. In the **Connect Infobip** modal, configure the parameters:
   * **Account Nickname**: A descriptive label (e.g., `Infobip Europe / GCC Gateway`).
   * **Default From Sender / Header**: Your approved alphanumeric sender header or virtual number.
   * **Infobip Base URL / API Domain**: Your dedicated tenant endpoint (e.g., `https://2m4k1.api.infobip.com`).
   * **Infobip API Key**: Your secret API Key.
   * **DLT Principal Entity ID (Optional)**: 19-digit principal entity identifier if broadcasting to Indian mobile networks.
   * **Set as default gateway for SMS broadcasts**: Toggle on if Infobip is your primary SMS route.
4. Click **Verify & Save Credentials**. BrokerOS tests credentials against `https://${baseUrl}/sms/1/inbox/reports`, encrypts secrets with AES-256-GCM, and persists the configuration to PostgreSQL (`SmsIntegration`).

**3. Configure Delivery Reports and Inbound Webhooks**

In the Infobip Portal, configure message forwarding:

* **Delivery Reports URL**: `https://api.yourdomain.com/api/marketing/sms/webhooks/infobip`
* **Inbound Messages URL**: `https://api.yourdomain.com/api/marketing/sms/inbound`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.