# VoIP.ms SMS Integration

Before proceeding with the next steps, you need to[ purchase a DID on the VoIP.ms platform](https://support.portsip.com/portsip-communications-solution/configuring-sip-trunks/voip.ms-sip-trunk/purchase-a-did-on-voip.ms).

The VoIP.ms SMS service has some limitations. Please refer to this link for more details: [Service Limitations](https://wiki.voip.ms/article/SMS-MMS#Service_Limitations).

***

### Set an API Password in VoIP.ms

PortSIP PBX uses the **VoIP.ms API Password** to send and receive SMS/MMS messages.\
If you have not already created an API password, follow these steps.

#### Step 1: Enable the VoIP.ms API

1. Sign in to the **VoIP.ms Client Portal**.
2. Navigate to **Main Menu > SOAP and REST/JSON API**.
3. If the API is not enabled, click **Enable the API**
4. Enter a value in the **API Password** field.
5. Click **Save API Password**.

> ❗**Important**
>
> * The API password is shown **only once** when it is created.
> * Copy and store it securely—you will need it later when configuring SMS in PortSIP PBX.
> * If the password is lost, you must **generate a new one**.

<figure><img src="https://846155343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfkamWLaD5pcQwlKWwC%2Fuploads%2Fn0zD6OOE6bCDIivbVZhY%2Fvoip.ms-flig12.png?alt=media&#x26;token=34a851d2-281e-4fcf-99ff-a4bbf55f4e17" alt=""><figcaption></figcaption></figure>

***

### Configure SMS with VoIP.ms Trunk in PortSIP PBX

Before configuring SMS in PortSIP PBX, ensure that a **VoIP.ms SIP trunk** has already been configured.

* [Configuring VoIP.ms Register Authentication Trunk](https://support.portsip.com/portsip-communications-solution/configuring-sip-trunks/voip.ms-sip-trunk/configuring-voip.ms-register-based-trunk)

***

### Sign in to the PortSIP PBX Web Portal

You can access the tenant configuration using one of the following methods.

#### Option 1: Sign in as System Administrator

1. Sign in to the PortSIP PBX Web Portal as a **System Administrator**.
2. Navigate to **Tenants**.
3. Select a tenant and click **Manage** to switch to that tenant.

#### Option 2: Sign in as Tenant Administrator

* Sign in directly as a **Tenant Administrator** to manage the tenant.

> ❗**Note**\
> For more information about roles and permissions, refer to [Tenant Management](https://support.portsip.com/portsip-communications-solution/portsip-pbx-administration-guide/3-tenant-management).

***

### Add an SMS Configuration in PortSIP PBX

#### Step 1: Create the SMS Configuration

1. In the PortSIP PBX Web Portal, navigate to **SMS/MMS**.
2. Click **Add**.
3. Select your configured **VoIP.ms trunk**.
4. Configure the following fields:
   * **Username**
     * Enter your **VoIP.ms account username** (usually your login email).
   * **Password**
     * Paste the **VoIP.ms API Password** created earlier.

<figure><img src="https://846155343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfkamWLaD5pcQwlKWwC%2Fuploads%2FZ2LA9CVxUNsmDZapTFkM%2Fvoip.ms-flig14.png?alt=media&#x26;token=5565a898-939d-4dd5-a0a1-e54cb93994d9" alt=""><figcaption></figcaption></figure>

***

#### Step 2: Copy the Webhook URL

6. You will be redirected to the **SMS/MMS list** page.
7. Copy the **Webhook URL** using one of the following methods:
   * Select the SMS configuration and click **Copy Webhook**.
   * Or, double-click the SMS configuration and copy the **Webhook URL** from the details page.

***

### Configure SMS Settings in VoIP.ms

#### Step 1: Assign the Webhook URL to the DID

1. Sign in to the **VoIP.ms Client Portal**.
2. Navigate to **DID Numbers > Manage DIDs**.
3. Click the **Edit (yellow pencil)** icon next to the DID you want to use for SMS.
4. Scroll down to the **Message Service (SMS/MMS)** section.
5. Enable the **SMS/MMS** service.
6. In the **SMS/MMS Webhook URL** field, paste the **Webhook URL** copied from PortSIP PBX.

***

#### Step 2: Select the SMS Number Format

7. Choose the SMS/MMS number format:

* **E.164 format**
  * Messages must include the `+` sign and country code
  * Example: `+13322496213`
* **NANPA format**
  * Messages use a 10-digit number without country code
  * Example: `3322496213`

8. Click **Click here to apply changes** to save the configuration.

<figure><img src="https://846155343-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfkamWLaD5pcQwlKWwC%2Fuploads%2FzGYrfJ953q2KcunXsKmd%2Fvoip.ms-flig13.png?alt=media&#x26;token=412cca13-3f42-4fb0-90c2-02ded55d3b43" alt=""><figcaption></figcaption></figure>

***

### Verify the Configuration

At this point, the VoIP.ms SMS/MMS integration is complete.

You can now [create outbound and inbound rules](https://support.portsip.com/portsip-communications-solution/configuring-sip-trunks/voip.ms-sip-trunk/configuring-outbound-and-inbound-calls) in PortSIP PBX to send and receive SMS/MMS messages using the VoIP.ms trunk, just as you would configure rules for voice calls.