# SMS by Postman

## **What is SMS by Postman**

SMS by Postman is an action available to all .gov.sg users. It is a SMS messaging service built in accordance with the Singapore government SMS policy. Messages will be sent under the gov.sg sender ID, featuring a fixed header and footer, as demonstrated below.

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FfurcwI7OsUdEw4b761OT%2Fimage.png?alt=media&#x26;token=beeeca29-2062-429e-a721-34c8fb56cbd1" alt="" width="287"><figcaption></figcaption></figure>

## Getting started

To use SMS by Postman on Plumber, you must create a campaign ID and API key. Please follow the steps below.

### Step-by-step guide

1. Click "Create Campaign"

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FAVhr9BLm0ydazgc5JqxW%2Fimage.png?alt=media&#x26;token=e9629bdc-b8d6-48e2-96b5-4ad44746bb2b" alt=""><figcaption></figcaption></figure>

2. Assign a campaign name (You may alter it later)
3. Choose "General Public" and "gov.sg" from the dropdown menu.

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2F15qWBtr5TSbpxC6oHGjM%2Fimage.png?alt=media&#x26;token=47abb305-4676-42c9-ad0b-e94f3425eac2" alt=""><figcaption></figcaption></figure>

4. Enter`{{body}}` in the text field.&#x20;

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FInxMTY56HdKaZSajFxKD%2Fimage.png?alt=media&#x26;token=92ded296-2225-4fd8-ae01-aff0a3c7c6fa" alt=""><figcaption></figcaption></figure>

5. After creating the campaign, note down its campaign ID:<br>

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FiZKGPL3RrkguaktiXyIo%2FScreenshot%202024-06-14%20at%204.27.05%E2%80%AFPM.png?alt=media&#x26;token=877a71fd-8d5c-48a1-a88a-1f0ab1983e41" alt=""><figcaption></figcaption></figure>

6. Whitelist Plumber's IP addresses in your campaign by following this [guide](https://postman-v2.guides.gov.sg/postman-v2-admin-portal-for-api-users-mop/campaign-settings#ip-address-whitelisting). You should whitelist the 3 IPs below:
   1. 52.76.216.61
   2. 52.74.55.209
   3. 18.139.42.66
7. Generate API keys for your SMS campaign by following this [guide](https://postman-v2.guides.gov.sg/postman-v2-admin-portal-for-api-users-mop/campaign-settings#api-keys). You will need this when setting up Plumber later.

### Connecting SMS by Postman in Plumber

1. In the pipe creation page, select 'SMS by Postman' as the app.
2. Select 'Send SMS' as the action.
3. Click 'Continue' to connect your Postman SMS campaign to Plumber.
4. In the 'Choose connection' drop down, select 'Add new connection'
5. In the 'Label' field, enter a description for your campaign
6. In the "Campaign ID" field, paste your campaign ID&#x20;
7. In the 'API key' field, enter the API key for your campaign (you generated this in Step A4 above)
8. Click 'Submit' to finish connecting your Postman SMS campaign to Plumber

<figure><img src="https://2212031742-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXyVsBiX9OwOL1o9g5hLM%2Fuploads%2FL1m1LnLjzzKqjB1v8UoI%2Fimage.png?alt=media&#x26;token=21dcd06c-1854-4b92-9944-2ca27cefc942" alt=""><figcaption></figcaption></figure>

## Send SMS by Postman

| Feature                | Description                                                                                   | Required? |
| ---------------------- | --------------------------------------------------------------------------------------------- | --------- |
| Recipient phone number | Enter the recipient's phone number, including the country code.. Only 1 recipient per action. |           |
| Message Body           | The message that will be delivered to the recipient. We only support up to 1,000 characters.  | ✔️​       |

## Check step

{% hint style="warning" %}
Please note that an actual SMS will be sent to the recipient. If you are testing, use a phone number suitable for testing or use your own mobile number.
{% endhint %}

1. Click 'Continue' to proceed to test your action
2. Click on 'Check step' and verify that the SMS has been sent to the recipient's phone.

## FAQs

<details>

<summary>Are SMS messages chargeable?</summary>

Yes. For pricing matters, please refer to this [Postman guide](https://postman-v2.guides.gov.sg/postman-v2-pricing-from-1-july-2025/billing-overview/detailed-charges-and-pricing#how-much-will-messages-cost).&#x20;

</details>

<details>

<summary>Is this feature available to healthcare users?</summary>

Unfortunately not. To use the SMS feature in Plumber Flow, please contact us with your existing vendor. If you don't have one, do reach out to us as well.

You may contact us at go.gov.sg/plumber-support.

</details>

<details>

<summary>Can I send SMS to multiple recipients?</summary>

You can send SMS to multiple recipients by adding additional SMS actions. Each action can only cater to 1 recipient. Alternatively, you may use "For-each" to send SMS to multiple users.

</details>