API Documentation

Short Message Service (SMS)

Welcome to this comprehensive guide on integrating SMS functionality into your applications. In this documentation, we'll explore various methods and tools for sending SMS messages programmatically, catering to developers working with different programming languages and platforms. Whether you're using PHP, Python, Node.js, or any other language, you'll find a suitable approach to incorporate SMS capabilities into your applications, facilitating effective communication with your users via text messages.

Prerequisites:

Before we begin, ensure you have the following prerequisites in place:

1. Understanding of HTTP Requests: Familiarize yourself with the basics of making HTTP requests, including request methods (GET, POST, etc.), request headers, and request bodies.
2. Access to an SMS API Service Provider: Obtain access to an SMS API service provider that offers the necessary functionalities for sending SMS messages. Additionally, ensure you have the appropriate credentials, such as authentication tokens or API keys, to authenticate your requests with the SMS API service provider.
3. Access to a System with Necessary Tools: Ensure you have access to a system with the necessary tools and libraries installed for making HTTP requests and processing responses in your chosen programming language.

Step-by-Step Guide:

1. Select a Suitable SMS API Service Provider: Begin by selecting an SMS API service provider that meets your requirements in terms of features, pricing, reliability, and ease of integration. Research and compare different providers to find the one that best fits your needs.
2. Sign Up and Obtain Credentials: Sign up for an account with your chosen SMS API service provider and obtain the necessary credentials, such as authentication tokens, API keys, or username/password combinations, required to authenticate your requests with the provider's API.
3. Choose a Programming Language: Select the programming language you'll be using to integrate SMS functionality into your application. Whether it's PHP, Python, Node.js, Java, or any other language, ensure that the language has libraries or modules available for making HTTP requests and interacting with APIs.
4. Explore Integration Options: Explore the various integration options available for sending SMS messages programmatically in your chosen programming language. This may include using dedicated SMS libraries, leveraging built-in HTTP client libraries, or integrating with third-party SDKs provided by the SMS API service provider.
5. Construct the SMS Request: Prepare the necessary data for the SMS message, including the recipient's phone number, the sender's phone number (if applicable), and the content of the message. Ensure that the data is properly formatted according to the specifications of the SMS API service provider.
6. Send the SMS: Utilize the chosen method or tool to send the SMS message. This may involve making HTTP requests to the SMS API endpoint, using SDK methods provided by the API service provider, or invoking functions from SMS libraries/modules in your programming language.
7. Handle Responses and Errors: Implement error handling and response processing mechanisms to handle success and failure scenarios when sending SMS messages. This includes checking for HTTP status codes, parsing response data, and handling exceptions or errors gracefully.

This documentation provides a flexible and adaptable approach to integrating SMS functionality into your applications, catering to developers working with different programming languages and platforms. By following the outlined steps and leveraging the available tools and libraries in your chosen language, you can seamlessly incorporate SMS capabilities into your applications, enhancing communication and engagement with your users through text messaging.

curl --location 'https://api.ozibus.com.au/v1/sms' \
--header 'Content-Type: application/json' \
--header 'API-Key: <YOUR_API_KEY>' \
--header 'Merchant-Id: <YOUR_MERCHANT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--data '{
    "to":"+12345678901",
    "from":"+12513091299",
    "message": "Hello! Good morning from here.."
}'

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.ozibus.com.au/v1/sms',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "to":"+12345678901",
    "from":"+12513091299",
    "message": "Hello! Good morning from here.."
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'API-Key: <YOUR_API_KEY>',
    'Merchant-Id: <YOUR_MERCHANT_ID>',
    'Authorization: Bearer <YOUR_JWT_TOKEN>'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

<?php
$client = new Client();
$headers = [
  'Content-Type' => 'application/json',
  'API-Key' => '<YOUR_API_KEY>',
  'Merchant-Id' => '<YOUR_MERCHANT_ID>',
  'Authorization' => 'Bearer <YOUR_JWT_TOKEN>'
];
$body = '{
  "to": "+12345678901",
  "from": "+12513091299",
  "message": "Hello! Good morning from here.."
}';
$request = new Request('POST', 'https://api.ozibus.com.au/v1/sms', $headers, $body);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

const axios = require('axios');
let data = JSON.stringify({
  "to": "+12345678901",
  "from": "+12513091299",
  "message": "Hello! Good morning from here.."
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'http://localhost/messaging/api/sms',
  headers: { 
    'Content-Type': 'application/json',
    'API-Key': '<YOUR_API_KEY>', 
    'Merchant-Id': '<YOUR_MERCHANT_ID>', 
    'Authorization': 'Bearer <YOUR_JWT_TOKEN>'
  },
  data : data
};

axios.request(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});

curl --location 'https://api.ozibus.com.au/v1/sms' \
--header 'Content-Type: application/json' \
--header 'API-Key: <YOUR_API_KEY>' \
--header 'Merchant-Id: <YOUR_MERCHANT_ID>' \
--header 'Authorization: Bearer <YOUR_JWT_TOKEN>' \
--data '{
    "to":"+12345678901",
    "from":"+12513091299",
    "message": "Hello! Good morning from here.."
}'