logo
API docs by Redocly

Guni SMS Gateway (1.0.0)

Download OpenAPI specification:

License: Apache 2.0 Terms of Service

Introduction

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.

Credentials

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.

Benefits

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.

Authentication

Endpoints related to authentication flows.

Verify App Token

Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": { }
}

SMS

Endpoints to send Single or Bulk SMS.

Send Quick SMS or Schedule Quick SMS

Quick SMS:

  • Message in standard English is max 1224 characters and with unicode max 536 characters.
  • Maximum 20 contacts per request.
  • You can use any valid australian number format e.g. 6140XXXXXXX, 40XXXXXXX, 040XXXXXXX, 40X XXX XXX, 61 40X XXX XXX, etc.

For scheduling a one-time Quick SMS campaign:
Include an additional scheduleAt field in the payload.

Include Bearer Token in the request header and use Content-Type: application/json.

Authorizations:
BearerAuth
Request Body schema: application/json
One of
sender
required
string
message
required
string
contacts
required
Array of strings

Responses

Request samples

Content type
application/json
Example
{
  • "sender": "GuniSMS",
  • "message": "My Guni SMS",
  • "contacts": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 1,
  • "is_enc": false,
  • "status": true,
  • "message": "Quick SMS Sent Successfully",
  • "message_type": "toast",
  • "data": {
    }
}

Send Bulk SMS or Schedule Bulk SMS Campaign

For sending (Bulk SMS):

  • Message in standard English is max 1224 characters; with unicode, max 536 characters.
  • Maximum 3000 contacts per request.
  • You can use any valid australian number format e.g. 6140XXXXXXX, 40XXXXXXX, 040XXXXXXX, 40X XXX XXX, 61 40X XXX XXX, etc.

For scheduling a one-time Bulk SMS campaign:
Include an additional scheduleAt field in the payload and set repeat to "one_time".

Include Bearer Token in the request header and use Content-Type: application/json.

Exactly one of these settings can be true:

  • If "optout" is false and "replyStopToOptOut" is true, the message will include "reply stop to opt out."
  • If "optout" is true and "replyStopToOptOut" is false, the message will include a URL formatted as "stopsms.co/u#####."
Authorizations:
BearerAuth
Request Body schema: application/json
One of
name
required
string
description
string
sender
required
string
message
required
string
contacts
required
Array of strings
optout
boolean
replyStopToOptOut
boolean

Responses

Request samples

Content type
application/json
Example
{
  • "name": "My BulkSMS Campaign",
  • "sender": "GuniSMS",
  • "message": "My bulk SMS message",
  • "contacts": [
    ],
  • "optout": true,
  • "replyStopToOptOut": false
}

Response samples

Content type
application/json
Example
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 0,
  • "is_enc": false,
  • "status": true,
  • "message": "SMS Campaign Sent Successfully",
  • "message_type": "toast",
  • "data": {
    },
  • "error": { }
}

MMS

Endpoints for sending MMS messages.

Send Quick MMS or Schedule Quick MMS

For immediate sending (Quick MMS):

  • Message in standard English is max 1500 characters and unicode is 600 characters max.
  • Maximum 20 contacts per request.
  • You can use any valid australian number format e.g. 6140XXXXXXX, 40XXXXXXX, 040XXXXXXX, 40X XXX XXX, 61 40X XXX XXX, etc.

For scheduling a one-time Quick MMS campaign:
Include an additional scheduleAt field in the payload.

Use this endpoint to send Quick MMS messages immediately or schedule them.

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
One of
media
required
string <uri>
message
required
string
sender
required
string
contacts
required
Array of strings

Responses

Request samples

Content type
multipart/form-data
Example
{
  "media": "https://example.com/beach.jpeg",
  "message": "My quick MMS",
  "sender": "#SharedNum#",
  "contacts": "['614xxxxxxxx']"
}

Response samples

Content type
application/json
Example
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 0,
  • "is_enc": false,
  • "status": true,
  • "message": "Request is being processed",
  • "message_type": "toast",
  • "data": {
    }
}

Send Bulk MMS

For Sending (Bulk MMS):

  • Message in standard English is max 1500 characters and unicode is 600 characters max.
  • Maximum 3000 contacts per request.
  • You can use any valid australian number format e.g. 6140XXXXXXX, 40XXXXXXX, 040XXXXXXX, 40X XXX XXX, 61 40X XXX XXX, etc.

Use this endpoint to send Bulk MMS messages.

If "replyStopToOptOut": true this will put reply stop to optout in message

Authorizations:
BearerAuth
Request Body schema: multipart/form-data
media
required
string <uri>
message
required
string
sender
required
string
contacts
required
string
name
string
replyStopToOptout
string

Responses

Request samples

Content type
multipart/form-data
{
  "media": "https://example.com/myImage.jpg",
  "message": "My bulk MMS message",
  "sender": "#SharedNum#",
  "contacts": "['614xxxxxxxx']",
  "replyStopToOptout": "true"
}

Response samples

Content type
application/json
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 0,
  • "is_enc": false,
  • "status": true,
  • "message": "MMS Campaign Sent Successfully",
  • "message_type": "toast",
  • "data": {
    },
  • "error": { }
}

Dynamic Callback and Auto Detect Long URL SMS

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.

Quick SMS: Auto Detect Long URL in message Content and Dynamic Callback

Quick SMS messages are sent by automatically detecting long URLs in the message content and including a callback URL for replies.

Authorizations:
BearerAuth
Request Body schema: application/json
sender
required
string
message
required
string
contacts
required
Array of strings
callback
string

Responses

Request samples

Content type
application/json
{
  • "sender": "#SharedNum#",
  • "message": "Testing Quick SMS with dynamic callback and long auto direct url https://www.google.com",
  • "contacts": [
    ],
  • "callback": "https://webhook.site/your-callback-url"
}

Response samples

Content type
application/json
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 1,
  • "is_enc": false,
  • "status": true,
  • "message": "Quick SMS Sent Successfully",
  • "message_type": "toast",
  • "data": {
    }
}

Bulk SMS: Auto Detect Long URL in message Content and Dynamic Callback

Bulk SMS messages are sent by automatically detecting long URLs in the message content and including a callback URL for replies.

Exactly one of these settings can be true:

  • If "optout" is false and "replyStopToOptOut" is true, the message will include "reply stop to opt out."
  • If "optout" is true and "replyStopToOptOut" is false, the message will include a URL formatted as "stopsms.co/u#####."
Authorizations:
BearerAuth
Request Body schema: application/json
name
required
string
description
string
sender
required
string
message
required
string
contacts
required
Array of strings
optout
boolean
replyStopToOptOut
boolean
callback
string

Responses

Request samples

Content type
application/json
{
  • "sender": "#SharedNum#",
  • "message": "Testing bulk SMS with dynamic callback and long auto direct url https://www.google.com",
  • "contacts": [
    ],
  • "name": "CampaignName",
  • "callback": "https://webhook.site/your-callback-url",
  • "optout": false,
  • "replyStopToOptOut": true
}

Response samples

Content type
application/json
{
  • "app_type": "web",
  • "app_version": "1.0",
  • "maintainence": 0,
  • "new_version": 0,
  • "force_update": 0,
  • "invalid_token": 0,
  • "refresh_token": "",
  • "show_message": 0,
  • "is_enc": false,
  • "status": true,
  • "message": "SMS Campaign Sent Successfully",
  • "message_type": "toast",
  • "data": {
    },
  • "error": { }
}