Guni SMS Gateway (1.0.0)

Effortlessly send millions of texts and media messages, including SMS Broadcast Australia and Bulk SMS Australia, while building 2-way conversations with high-value customers. All this is made possible through our all-in-one web platform with robust APIs, CRM integration, and email to SMS Australia services.

To access the API, an API key is required. Sign up for a developer account here to get access: https://app.gunisms.com.au/signup.

Instant Customer Reach

Engage your audience with fast and effective SMS communication.

Seamless Team Engagement

Keep your team informed, wherever they are.

Efficiency Through Automation

Automate routine tasks like appointment reminders.

Secure & Reliable Communication

Protect your business with secure, encrypted messaging.

Global Reach

Send millions of messages at once.

2-Way Conversation

Engage in 2-way personalized conversations.

Out-of-the-Box Integration

Easily integrate SMS into your existing systems.

App token is necessary for each action that requires authentication.

1. Go to the integration portal to generate a token: https://app.gunisms.com.au/integrations
2. Click Integration
3. Create APP Token
4. Copy the newly generated token

You can see the images below to know more:

Use the /api/v1/user/token/verify endpoint to confirm that your APP Token is valid.
Include the token in the Authorization header as a Bearer token:

Authorization: Bearer <YOUR_TOKEN>

How to Configure Webhooks

Guni uses webhooks to send real-time SMS delivery status (DLR) to your application.
You must configure your Callback URL in the Integration settings to receive these status updates.

1. Log in to Guni SMS.
2. Navigate to Integrations.
3. Locate Webhook Settings and enter your Callback URL.
4. Click Save to confirm.

Delivery Reports (DLRs)

For delivery reports or changes in the status of a message, Guni will send a POST request to your specified Callback URL. You may receive multiple notifications for a single message (e.g., queued → sent → delivered).

Example JSON:

{
  "_id": "615afd3cb033992b3a61933f",
  "status": "delivered",
  "type": "send",
  "sender": "+614xxxxxxxx",
  "receiver": "40XXXXXXX"
}

Request Body Parameters:

• _id – Unique message ID
• status – Current status of the message (e.g., delivered)
• type – The message action type (e.g., "send")
• reason – Error/failure description (if applicable)
• sender – The sending phone number
• receiver – The receiving phone number

Reply SMS

Guni also uses a webhook for real-time incoming SMS. You must update your Receive URL in the Integration Settings to handle replies:

1. Go to Guni Integrations.
2. Click Integration.
3. Enter your Receive Callback URL and click Update.

When a customer replies via SMS, Guni sends a POST request with the following JSON:

{
  "_id": "<unique_id>",
  "message": "This is reply message",
  "type": "receive",
  "sender": "40XXXXXXX",
  "receiver": "614xxxxxxxx"
}

Request Body Parameters:

• _id – Unique message ID
• message – The text response from your customer
• type – The message action type (e.g., "receive")
• sender – The customer's phone number (who sent the reply)
• receiver – Your Guni phone number that received the reply

When a customer replies via MMS, Guni sends a POST request with the following JSON:

{
  "_id": "<unique_id>",
  "status": "delivered",
  "type": "receive",
  "message": "{\"message\":\"<text_message>\",\"media\":[{\"url\":\"<media_url_1>\"},{\"url\":\"<media_url_2>\"}]}",
  "sender": "40XXXXXXX",
  "receiver": "614xxxxxxxx",
  "media": [
    {
      "url": "<media_url_1>"
    },
    {
      "url": "<media_url_2>"
    }
  ],
  "mms": true
}

Request Body Parameters:

• _id– Unique identifier for the message.
• status– It will be delivered.
• type– The message action type (e.g., "receive").
• message– A JSON-encoded string containing:
  • message– The text response from the customer (empty if it's an MMS with only media).
  • media– An array of media objects with URLs to attached images, videos, or other files.
• sender– The phone number of the customer who sent the message.
• receiver– Your Guni phone number that received the message.
• media– A separate array listing media URLs attached to the message.
• mms– It will be true.

Endpoints to send Single or Bulk SMS.

Endpoints for sending MMS messages.

Endpoints for dynamic callbacks and detecting long URLs in SMS. If the message content contains multiple URLs, the API will generate a short URL link only for the first long URL. All other URLs will remain unchanged.