Mobile Message API Documentation

Sending an SMS in Python using the requests library with native Basic Authentication:

import requests
from requests.auth import HTTPBasicAuth

# Set up variables for message details
to = "0412345678"
sender = "CompanyABC"
message = "Hello, this is a test message"
custom_ref = "tracking001"

# Create the data array
data = {
    "messages": [
        {
            "to": to,
            "message": message,
            "sender": sender,
            "custom_ref": custom_ref
        }
    ]
}

# Make the POST request with Basic Authentication
response = requests.post('https://api.mobilemessage.com.au/v1/messages', json=data, auth=HTTPBasicAuth('user123', 'mypassword'))

# Print the response from the API
print(response.json())

Using JavaScript (Fetch API) to send an SMS message:

// Set up variables for message details
const to = "0412345678";
const sender = "CompanyABC";
const message = "Hello, this is a test message";
const custom_ref = "tracking001";

// Create the message data object
const messageData = {
    messages: [
        {
            to: to,
            message: message,
            sender: sender,
            custom_ref: custom_ref
        }
    ]
};

// Fetch API call to send the SMS
fetch('https://api.mobilemessage.com.au/v1/messages', {
    method: 'POST',
    headers: {
        'Authorization': 'Basic ' + btoa('user123:mypassword'),
        'Content-Type': 'application/json'
    },
    body: JSON.stringify(messageData)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Sending an SMS in PHP using cURL with native Basic Authentication:

<?php
// Set up variables for message details
$to = "0412345678";  // Recipient phone number
$sender = "CompanyABC";  // Sender ID
$message = "Hello, this is a test message";  // Message content
$custom_ref = "tracking001";  // Optional custom reference

// Create the message data array
$message_data = [
    "to" => $to,
    "message" => $message,
    "sender" => $sender,
    "custom_ref" => $custom_ref
];

// Create the final data array
$data = [
    "messages" => [$message_data]
];

// Initialize cURL session
$ch = curl_init('https://api.mobilemessage.com.au/v1/messages');

// Set cURL options for Basic Authentication and JSON payload
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "user123:mypassword");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));

// Execute the request and get the response
$response = curl_exec($ch);
curl_close($ch);

// Output the response
echo $response;
?>

Sending an SMS in Java using HttpURLConnection:

import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class SendSMS {
    public static void main(String[] args) throws Exception {
        // Set up variables for message details
        String to = "0412345678";
        String sender = "CompanyABC";
        String message = "Hello, this is a test message";
        String custom_ref = "tracking001";

        // Create the JSON string for the message
        String jsonInputString = String.format(
            "{\"messages\": [{\"to\": \"%s\", \"message\": \"%s\", \"sender\": \"%s\", \"custom_ref\": \"%s\"}]}",
            to, message, sender, custom_ref);

        // Basic Authentication credentials
        String apiUsername = "user123";
        String apiPassword = "mypassword";
        String credentials = Base64.getEncoder().encodeToString((apiUsername + ":" + apiPassword).getBytes());

        // Make the HTTP connection
        URL url = new URL("https://api.mobilemessage.com.au/v1/messages");
        HttpURLConnection connection = (HttpURLConnection) url.openConnection();
        connection.setRequestProperty("Authorization", "Basic " + credentials);
        connection.setRequestProperty("Content-Type", "application/json");
        connection.setRequestMethod("POST");
        connection.setDoOutput(true);

        // Send the JSON data
        try (OutputStream os = connection.getOutputStream()) {
            byte[] input = jsonInputString.getBytes("utf-8");
            os.write(input, 0, input.length);
        }

        // Read the response
        // ...
    }
}

Sending an SMS in C# using HttpClient:

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;

class Program {
    static async Task Main() {
        // Set up variables for message details
        var to = "0412345678";
        var sender = "CompanyABC";
        var message = "Hello, this is a test message";
        var custom_ref = "tracking001";

        // Create the message data object
        var messageData = new {
            messages = new[] {
                new {
                    to = to,
                    message = message,
                    sender = sender,
                    custom_ref = custom_ref
                }
            }
        };

        // Initialize HttpClient with Basic Authentication
        var client = new HttpClient();
        var credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes("user123:mypassword"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);
        client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

        // Send the POST request
        var content = new StringContent(Newtonsoft.Json.JsonConvert.SerializeObject(messageData), Encoding.UTF8, "application/json");
        var response = await client.PostAsync("https://api.mobilemessage.com.au/v1/messages", content);
        var responseString = await response.Content.ReadAsStringAsync();

        // Output the response
        Console.WriteLine(responseString);
    }
}

Looking up a sent message in Python using the requests library with native Basic Authentication:

import requests
from requests.auth import HTTPBasicAuth

# Set up variables for message lookup
message_id = "abcd1234-efgh-5678-ijkl-9876543210mn"  # Use message_id or custom_ref

# Create the request URL
url = f"https://api.mobilemessage.com.au/v1/messages?message_id={message_id}"

# Make the GET request with Basic Authentication
response = requests.get(url, auth=HTTPBasicAuth('user123', 'mypassword'))

# Print the response from the API
print(response.json())

Using JavaScript (Fetch API) to look up a sent message by message_id:

// Set up variables for message lookup
const message_id = "abcd1234-efgh-5678-ijkl-9876543210mn";  // Use message_id or custom_ref

// Fetch API call to look up the sent message
fetch(`https://api.mobilemessage.com.au/v1/messages?message_id=${message_id}`, {
    method: 'GET',
    headers: {
        'Authorization': 'Basic ' + btoa('user123:mypassword'),
        'Content-Type': 'application/json'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Looking up a sent message in PHP using cURL:

<?php
// Set up variables for message lookup
$message_id = "abcd1234-efgh-5678-ijkl-9876543210mn";  // Use message_id or custom_ref

// Create the request URL
$url = "https://api.mobilemessage.com.au/v1/messages?message_id=" . $message_id;

// Initialize cURL session
$ch = curl_init($url);

// Set cURL options for Basic Authentication
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "user123:mypassword");

// Execute the request and get the response
$response = curl_exec($ch);
curl_close($ch);

// Output the response (JSON response from the API)
echo $response;
?>

Looking up a sent message in Java using HttpURLConnection:

import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class LookupMessage {
    public static void main(String[] args) throws Exception {
        // Set up variables for message lookup
        String message_id = "abcd1234-efgh-5678-ijkl-9876543210mn";  // Use message_id or custom_ref
        String url = "https://api.mobilemessage.com.au/v1/messages?message_id=" + message_id;

        // Basic Authentication credentials
        String apiUsername = "user123";
        String apiPassword = "mypassword";
        String credentials = Base64.getEncoder().encodeToString((apiUsername + ":" + apiPassword).getBytes());

        // Make the HTTP connection
        URL requestUrl = new URL(url);
        HttpURLConnection connection = (HttpURLConnection) requestUrl.openConnection();
        connection.setRequestProperty("Authorization", "Basic " + credentials);
        connection.setRequestMethod("GET");

        // Read the response
        // ...
    }
}

Looking up a sent message in C# using HttpClient:

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

class Program {
    static async Task Main() {
        // Set up variables for message lookup
        var message_id = "abcd1234-efgh-5678-ijkl-9876543210mn";  // Use message_id or custom_ref
        var url = $"https://api.mobilemessage.com.au/v1/messages?message_id={message_id}";

        // Initialize HttpClient with Basic Authentication
        var client = new HttpClient();
        var credentials = Convert.ToBase64String(System.Text.Encoding.ASCII.GetBytes("user123:mypassword"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);

        // Send the GET request
        var response = await client.GetAsync(url);
        var responseString = await response.Content.ReadAsStringAsync();

        // Output the response
        Console.WriteLine(responseString);
    }
}

Retrieving account credit balance in Python using the requests library with native Basic Authentication:

import requests
from requests.auth import HTTPBasicAuth

# Create the request URL
url = "https://api.mobilemessage.com.au/v1/account"

# Make the GET request with Basic Authentication
response = requests.get(url, auth=HTTPBasicAuth('user123', 'mypassword'))

# Print the response from the API
print(response.json())

Using JavaScript (Fetch API) to retrieve your account credit balance:

// Fetch API call to retrieve account credit balance
fetch('https://api.mobilemessage.com.au/v1/account', {
    method: 'GET',
    headers: {
        'Authorization': 'Basic ' + btoa('user123:mypassword'),
        'Content-Type': 'application/json'
    }
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error(error));

Retrieving account credit balance in PHP using cURL with native Basic Authentication:

<?php
// Create the request URL
$url = "https://api.mobilemessage.com.au/v1/account";

// Initialize cURL session
$ch = curl_init($url);

// Set cURL options for Basic Authentication
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, "user123:mypassword");

// Execute the request and get the response
$response = curl_exec($ch);
curl_close($ch);

// Output the response (JSON response from the API)
echo $response;
?>

Retrieving account credit balance in Java using HttpURLConnection:

import java.net.HttpURLConnection;
import java.net.URL;
import java.util.Base64;

public class GetBalance {
    public static void main(String[] args) throws Exception {
        // Create the request URL
        String url = "https://api.mobilemessage.com.au/v1/account";

        // Basic Authentication credentials
        String apiUsername = "user123";
        String apiPassword = "mypassword";
        String credentials = Base64.getEncoder().encodeToString((apiUsername + ":" + apiPassword).getBytes());

        // Make the HTTP connection
        URL requestUrl = new URL(url);
        HttpURLConnection connection = (HttpURLConnection) requestUrl.openConnection();
        connection.setRequestProperty("Authorization", "Basic " + credentials);
        connection.setRequestMethod("GET");

        // Read the response
        // ...
    }
}

Retrieving account credit balance in C# using HttpClient:

using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

class Program {
    static async Task Main() {
        // Initialize HttpClient with Basic Authentication
        var client = new HttpClient();
        var credentials = Convert.ToBase64String(System.Text.Encoding.ASCII.GetBytes("user123:mypassword"));
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", credentials);

        // Send the GET request
        var response = await client.GetAsync("https://api.mobilemessage.com.au/v1/account");
        var responseString = await response.Content.ReadAsStringAsync();

        // Output the response
        Console.WriteLine(responseString);
    }
}

Processing webhook payload in Node.js using Express:

const express = require('express');
const app = express();

app.use(express.json());

app.post('/webhook', (req, res) => {
    const { to, message, sender, received_at, type, original_message_id, original_custom_ref } = req.body;

    // Process the webhook data
    console.log(`Received ${type || 'status'} webhook:`);
    console.log(`To: ${to}, From: ${sender}, Message: ${message}, Received at: ${received_at}`);
    console.log(`Original Message ID: ${original_message_id}, Original Custom Ref: ${original_custom_ref}`);

    // Respond with success
    res.status(200).send({ status: 'success' });
});

app.listen(3000, () => {
    console.log('Webhook server is listening on port 3000');
});

Processing webhook payload in PHP:

<?php
// Read the raw POST data
$payload = file_get_contents('php://input');

// Decode the JSON payload
$data = json_decode($payload, true);

// Process the webhook data
$to = $data['to'];
$message = $data['message'];
$sender = $data['sender'];
$received_at = $data['received_at'];
$type = $data['type'] ?? 'status'; // Default to 'status' if not inbound
$original_message_id = $data['original_message_id'] ?? '';
$original_custom_ref = $data['original_custom_ref'] ?? '';

// Output the processed data
error_log("Received $type webhook: To: $to, From: $sender, Message: $message, Received at: $received_at");
error_log("Original Message ID: $original_message_id, Original Custom Ref: $original_custom_ref");

// Respond with success
header('Content-Type: application/json');
echo json_encode(['status' => 'success']);
?>

Processing webhook payload in Java using Spring Boot:

import org.springframework.web.bind.annotation.*;
import org.springframework.http.ResponseEntity;

@RestController
@RequestMapping("/webhook")
public class WebhookController {

    @PostMapping
    public ResponseEntity<String> handleWebhook(@RequestBody WebhookPayload payload) {
        // Process the webhook data
        System.out.println("Received " + (payload.getType() != null ? payload.getType() : "status") + " webhook:");
        System.out.println("To: " + payload.getTo() + ", From: " + payload.getSender() + ", Message: " + payload.getMessage() + ", Received at: " + payload.getReceivedAt());
        System.out.println("Original Message ID: " + payload.getOriginalMessageId() + ", Original Custom Ref: " + payload.getOriginalCustomRef());

        // Respond with success
        return ResponseEntity.ok("{\"status\": \"success\"}");
    }
}

class WebhookPayload {
    private String to;
    private String message;
    private String sender;
    private String receivedAt;
    private String type;
    private String originalMessageId;
    private String originalCustomRef;

    // Getters and setters...
}

Processing webhook payload in C# using ASP.NET Core:

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("webhook")]
public class WebhookController : ControllerBase
{
    [HttpPost]
    public IActionResult HandleWebhook([FromBody] WebhookPayload payload)
    {
        // Process the webhook data
        var type = payload.Type ?? "status";  // Default to 'status' if not inbound
        Console.WriteLine($"Received {type} webhook:");
        Console.WriteLine($"To: {payload.To}, From: {payload.Sender}, Message: {payload.Message}, Received at: {payload.ReceivedAt}");
        Console.WriteLine($"Original Message ID: {payload.OriginalMessageId}, Original Custom Ref: {payload.OriginalCustomRef}");

        // Respond with success
        return Ok(new { status = "success" });
    }
}

public class WebhookPayload
{
    public string To { get; set; }
    public string Message { get; set; }
    public string Sender { get; set; }
    public string ReceivedAt { get; set; }
    public string Type { get; set; }
    public string OriginalMessageId { get; set; }
    public string OriginalCustomRef { get; set; }
}