NusaSMS API v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Please be noted that there are two API host, development (test) and production server.

Production

Host: https://api.nusasms.com

You can use this host to make real transaction.

Grab your APIKey on app.nusasms.com, on Account > User management menu.

API Usage Notes

• Credit top up might be required for making transactions.
• Max API HIT is one hit per 50.0 milliseconds

Development (Test)

• Old (removed): https://cdev.nusasms.com
• New: https://dev.nusasms.com

Development (testing), which user’s client credit top up is for testing only. Any result of this API (this host) is not real. Credit top up is not required on this server host.

On this server, an account (and only one) is being provided to user the API. The APIKey for this test server is DEV_TESTING_API_KEY. Please use the APIkey kindly.

Response

Success

HTTP Response Code, either 200, 201, 202 or 204 and error=false on the json response is success request.

• 200: Request succeed
• 201: Request succeed and data saved/updated
• 204: Removal request succeed

Failed / Error

All neither 200, 201 nor 204 HTTP response code is failed response.

HTTP Status Code

• 401 or 403: Authentication failure
• 400: Invalid HTTP request parameter.
• 404: Not found
• 405: Method not allowed
• 422: Invalid parameter value / format
• 429: Rate limit
• 50X: Server Error

Note

• Set Accept header to text/xml or application/xml to get XML response.

Authentication

• API Key (APIKey)
  • Parameter Name: APIKey, in: header.

Account

Get user data using API Key

GET /nusasms_api/1.0/auth/api_key

BASE_URL=https://api.nusasms.com
# BASE_URL=https://dev.nusasms.com    # For testing

curl ${BASE_URL}/nusasms_api/1.0/auth/api_key \
    -H "APIKey: {YOUR_APIKEY}" \
    -H 'Content-Type: application/json' \
#   --insecure     # Ignore SSL Verification

import requests

BASE_URL = "https://api.nusasms.com/nusasms_api/1.0"
# For testing
# BASE_URL = "https://dev.nusasms.com/nusasms_api/1.0"
HEADERS = {
    "Accept": "application/json",
    "APIKey": "{YOUR_API_KEY}"
}

r = requests.get(
    f'{BASE_URL}/auth/api_key',
    headers=HEADERS,
    # verify=False      # Skip SSL Verification
)

print(r.json())

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "APIKey": []string{" YOUR_API_KEY "},
    }
    url := "https://api.nusasms.com/nusasms_api/1.0/auth/api_key"
    // For testing
    // url := "https://dev.nusasms.com/nusasms_api/1.0/auth/api_key"

    req, _ := http.NewRequest("GET", url, nil)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)

    if err != nil {
        panic(err)
    }

    body, _ := ioutil.ReadAll(resp.Body)

    fmt.Println(string(body))
    // ...
}

<?php
$BASE_URL = "https://api.nusasms.com/nusasms_api/1.0";
// For testing
// $BASE_URL = "https://dev.nusasms.com/nusasms_api/1.0";

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_HTTPHEADER => array(
        'APIKey: {YOUR_API_KEY}',
        'Content-Type: application/json'
    ),
    CURLOPT_URL => $BASE_URL . "/auth/api_key",

    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);
echo $resp;
curl_close($curl);

const axios = require('axios');

const headers = {
  'Accept':'application/json',
  'APIKey':'YOUR_API_KEY'
};
const url = 'https://api.nusasms.com/nusasms_api/1.0/auth/api_key'
// Test host
//const url = 'https://dev.nusasms.com/nusasms_api/1.0/auth/api_key'

axios.get(url, {headers: headers})
  .then(function(response) {
      console.log(response.data)
  })
  .catch(error => {
    if (error.response) {
      console.error(error.response.data)
    } else if (error.request) {
      console.error(error.request)
    } else {
      console.error(error.message);
    }
  });

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY'
}
url = 'https://api.nusasms.com/nusasms_api/1.0/auth/api_key'
# Dev host
# url = 'https://dev.nusasms.com/nusasms_api/1.0/auth/api_key'

result = RestClient.get(url, headers=headers)

puts JSON.parse(result)

Example responses

200 Response

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "userid": "string",
    "idPerson": 0,
    "idClient": 0
  }
}

Responses

Get Balance Data

GET /nusasms_api/1.0/balance

BASE_URL=https://api.nusasms.com/nusasms_api/1.0
# For testing
# BASE_URL=https://dev.nusasms.com/nusasms_api/1.0

curl -X GET "${BASE_URL}/balance" \
     -H  "accept: application/json" \
     -H  "APIKey: {YOUR_API_KEY}"
#     --insecure     # Ignore SSL Verification

<?php
$BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0';
// For test
// $BASE_URL = 'https://dev.nusasms.com/nusasms_api/1.0';

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $BASE_URL . '/balance',
    CURLOPT_HTTPHEADER => array(
        "APIKey: {YOUR_API_KEY}",
        'Accept: application/json',
        'Content-Type: application/json'
    ),
    CURLOPT_RETURNTRANSFER => 1,
    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);
echo $resp;
curl_close($curl);

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
# For testing
# BASE_URL = 'https://dev.nusasms.com/nusasms_api/1.0'
HEADERS = {
    "Accept": "application/json",
    "APIKey": "YOUR_API_KEY"
}

r = requests.get(
    f'{BASE_URL}/balance',
    headers=HEADERS,
    # Skip SSL Verification
    # verify = False
)

print(r.json())

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "APIKey": []string{" YOUR_API_KEY "},
    }
    url := "https://api.nusasms.com/nusasms_api/1.0/balance"
    // For testing
    // url := "https://dev.nusasms.com/nusasms_api/1.0/balance"

    req, _ := http.NewRequest("GET", url, nil)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)

    if err != nil {
        panic(err)
    }

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
    // ...
}

const axios = require('axios');

const headers = {
  'Accept':'application/json',
  'APIKey':'YOUR_API_KEY'
};
const url = 'https://api.nusasms.com/nusasms_api/1.0/balance'
// Test host
//const url = 'https://dev.nusasms.com/nusasms_api/1.0/balance'

axios.get(url, {headers})
  .then(function(response) {
      console.log(response.data)
  })
  .catch(error => {
    if (error.response) {
      console.error(error.response.data)
    } else if (error.request) {
      console.error(error.request)
    } else {
      console.error(error.message);
    }
  });

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY'
}
url = 'https://api.nusasms.com/nusasms_api/1.0/balance'
# Dev host
# url = 'https://dev.nusasms.com/nusasms_api/1.0/balance'

result = RestClient.get(url, headers=headers)

puts JSON.parse(result)

Example responses

200 Response

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "idClient": 0,
    "wa_balance": 0,
    "wa_expired_date": "2019-08-24",
    "hlr_balance": 0,
    "hlr_expired_date": "2019-08-24",
    "sim_balance": 0,
    "sim_expired_date": "2019-08-24",
    "sms_balance": 0,
    "sms_expired_date": "2019-08-24",
    "pulsa_balance": 0
  }
}

Responses

WhatsApp

Introduction

Tutorial Video: Send Message using PHP (Bahasa Indonesia)

Whatsapp API Introduction

• As for destination parameter, the value is either phone number or group id. Example: 628123456xxxx (Whatsapp phone number account), 628123456xxxx-1243456xxxx (Whatsapp group id)

Whatsapp Message Status

Emoticons

Source: Full Emoji List

Use the emoji code as API message parameter examples

Send Media

POST /nusasms_api/1.0/whatsapp/media

BASE_URL=https://api.nusasms.com/nusasms_api/1.0
# For testing
# BASE_URL=https://dev.nusasms.com/nusasms_api/1.0

curl -X POST "${BASE_URL}/whatsapp/media" \
    -H 'Content-type: application/json; charset=utf-8' \
    -H "Accept: application/json" \
    -H "APIKey: {YOUR_API_KEY}" \
    -d "{
      \"sender\": \"{YOUR_SENDER}\",
      \"destination\": \"628xxxxxxxxxx\",
      \"caption\": \"Caption text\",
      \"media_url\": \"https://example.com/image_name.png\"
    }"
#     --insecure     # Ignore SSL Verification
# Parameter `sender` is optional

import base64

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
# For testing
# BASE_URL = 'https://dev.nusasms.com/nusasms_api/1.0'

with open('file_name.png', 'rb') as file_descriptor:
    file_data = file_descriptor.read()

base64_file = base64.b64encode(file_data).decode('utf8')

headers = {
    "Accept": "application/json",
    "APIKey": "{YOUR_API_KEY}"
}
payloads = {
    'destination': '628xxxxxxxxxx',
    # Sender is optional
    'sender': YOUR_SENDER,
    'media_base64': base64_file,
    'file_name': 'your_image_file.png',
    'caption': 'Caption text'
}

# Send file with base64 encoded file
r = requests.post(
    f'{BASE_URL}/whatsapp/media',
    headers=headers,
    json=payloads,
    # verify=False      # Skip SSL Verification
)

print(r.json())

<?php
$BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp';
$BASE_TEST_URL = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp';

$curl = curl_init();

$payload = json_encode(array(
    'caption' => 'Caption text',
    // Sender is optional
    'sender' => 'YOUR_SENDER',
    'destination' => '628xxxxxxxxxx',
    'media_url' => 'https://example.com/image_name.png'
));

curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $BASE_URL . '/media',
    // For testing
    // CURLOPT_URL => $BASE_TEST_URL . '/media',
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => array(
        "APIKey: {YOUR_API_KEY}",
        'Content-Type: application/json'
    ),
    CURLOPT_POSTFIELDS => $payload,
    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);

if (!$resp)  else 
curl_close($curl);

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "APIKey": []string{"YOUR_API_KEY"},
    }
    payload, _ := json.Marshal(map[string]string{
        // Optional
        // "sender": " YOUR_SENDER ",
        "destination": "628xxxxxxxxxx",
        "caption": "Caption text",
        "media_url": "https://example.com/image_name.png",
    })
    url := "https://api.nusasms.com/nusasms_api/1.0/whatsapp/media"
    // For testing
    // url := "https://dev.nusasms.com/nusasms_api/1.0/whatsapp/media"

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
    // ...
}

const axios = require('axios');

const headers = {
  Accept: 'application/json',
  APIKey: 'YOUR_API_KEY'
};
var data = {
  destination: '628xxxxxxxxxx',
  // Sender is optional
  sender: 'YOUR_SENDER',
  caption: 'Caption text',
  media_url: 'https://example.com/your-image.png'
}
const url = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp/media'
// Test host
//const url = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp/media'

axios.post(url, data, {headers})
  .then(response => {
      console.log(response.data)
  })
  .catch(error => {
    if (error.response) {
      console.error(error.response.data)
    } else if (error.request) {
      console.error(error.request)
    } else {
      console.error(error.message);
    }
  });

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY',
    'Content-Type' => 'application/json',
}
payloads = {
    'destination' => '628xxxxxxxxxx',
    # Sender is optional
    'sender' => 'YOUR_SENDER',
    'caption' => 'Caption text',
    'media_url' => 'https://example.com/your-image.png'
}
base_url = 'https://api.nusasms.com/nusasms_api/1.0'
# Dev host
# base_url = 'https://dev.nusasms.com/nusasms_api/1.0'

response = RestClient::Request.new({
    method: :post,
    url: base_url + '/whatsapp/media',
    payload: payloads.to_json,
    headers: headers
}).execute do |response, request, result|
    case response.code
    # Success
    when 201
        [ :success, puts(response.to_str) ]
    when 400
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    when 403
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    when 422
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    else
        [
            :error,
            puts("Failed response=#{response.to_str}")
        ]
    end
end

Warning

Note

• Sender: if empty, the sender will be randomly chosen from your WA Gateways (if you have any) or from Blast WA Gateways.
• This endpoint will deduct 2 WA Credits.
• Allowed file types are: docx, jpg, jpeg, png, pdf.
• If media_base64 and media_url is provided, the API will use media_base64 to be media parameter.
• media_url is any HTTP URL of a file that can be directly downloaded
• On using media_base64 as media file parameter, max of the characters length is 512.0 Kilobytes
• On using media_url as paramater, the maximum size of the media file is 512.0 Kilobytes for JPG, JPEG, PNG, PDF and DOCX and 1 Megabytes for MP4, WEBM.
• Timeout argument is message timeout in second. If the message exceeds the timeout before it has being sent, the status of the message is going to be F (Failed).

Body parameter

{
  "timeout": 0,
  "sender": "string",
  "is_group": false,
  "destination": "string",
  "caption": "string",
  "media_url": "http://example.com",
  "media_base64": "string",
  "file_name": "string"
}

Parameters

Example responses

201 Response

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "sender": "string",
    "destination": "string",
    "caption": "string",
    "media_url": "string",
    "ref_no": "string"
  }
}

Responses

Send Message

POST /nusasms_api/1.0/whatsapp/message

BASE_URL=https://api.nusasms.com/nusasms_api/1.0
# For testing
# BASE_URL=https://dev.nusasms.com/nusasms_api/1.0

curl -X POST "${BASE_URL}/whatsapp/message" \
    -H 'Content-type: application/json; charset=utf-8' \
    -H "Accept: application/json" \
    -H "APIKey: {YOUR_API_KEY}" \
    -d "{
      \"destination\": \"628xxxxxxxxxx\",
      \"message\": \"Message text\"
    }"
#     --insecure     # Ignore SSL Verification
# Parameter `sender` is optional

<?php
$BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp';
$BASE_TEST_URL = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp';

$curl = curl_init();
$payload = json_encode(array(
    // 'sender' => 'YOUR_SENDER',
    'destination' => '628xxxxxxxxxx',
    'message' => 'Your message'
));
curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $BASE_URL . '/message',
    // For testing
    // CURLOPT_URL => $BASE_TEST_URL . '/message',
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => array(
        "APIKey: {YOUR_API_KEY}",
        'Content-Type:application/json'
    ),
    CURLOPT_POSTFIELDS => $payload,
    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);

if (!$resp)  else 
curl_close($curl);

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
# For testing
# BASE_URL = 'https://dev.nusasms.com/nusasms_api/1.0'

HEADERS = {
    "Accept": "application/json",
    "APIKey": "YOUR_API_KEY"
}
PAYLOADS = {
    'destination': '628xxxxxxxxxx',
    # Optional
    'sender': 'YOUR_SENDER',
    'message': "your message here.\\nGrinning face emoticon: \\\\U0001F600"
}

r = requests.post(
    f'{BASE_URL}/whatsapp/message',
    headers=HEADERS,
    json=PAYLOADS,
    # Skip SSL Verification
    # verify=False
)

print(r.json())

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {
    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "APIKey": []string{"YOUR_API_KEY"},
    }
    payload, _ := json.Marshal(map[string]string{
        // Sender is optional
        // "sender": "YOUR_SENDER",
        "destination": "628xxxxxxxxxx",
        "message": "Message text",
    })
    url := "https://api.nusasms.com/nusasms_api/1.0/whatsapp/message"
    // For testing
    // url := "https://dev.nusasms.com/nusasms_api/1.0/whatsapp/message"

    req, err := http.NewRequest("POST", url, bytes.NewBuffer(payload))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
    // ...
}

const axios = require('axios');

const headers = {
  Accept: 'application/json',
  APIKey: 'YOUR_API_KEY'
};
var data = {
  // sender: 'YOUR_SENDER',
  destination: '628xxxxxxxxxx',
  message: 'Message text',
}
const url = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp/message'
// Test host
//const url = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp/message'

axios.post(url, data, {headers})
  .then(response => {
      console.log(response.data)
  })
  .catch(error => {
    if (error.response) {
      console.error(error.response.data)
    } else if (error.request) {
      console.error(error.request)
    } else {
      console.error(error.message);
    }
  });

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY',
    'Content-Type' => 'application/json',
}
payloads = {
    # 'sender' => 'YOUR_SENDER',
    'destination' => '628xxxxxxxxxx',
    'message' => 'Message text',
}
base_url = 'https://api.nusasms.com/nusasms_api/1.0'
# Dev host
# base_url = 'https://dev.nusasms.com/nusasms_api/1.0'

response = RestClient::Request.new({
    method: :post,
    url: base_url + '/whatsapp/message',
    payload: payloads.to_json,
    headers: headers
}).execute do |response, request, result|
    case response.code
    # Success
    when 201
        [ :success, puts(response.to_str) ]
    when 400
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    when 403
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    when 422
        [
            :error,
            puts("Failed status_code=#{response.code} response=#{response.to_str}")
        ]
    else
        [
            :error,
            puts("Failed response=#{response.to_str}")
        ]
    end
end

Note

• This endpoint will deduct 1 WA Credits per 2000 (updated) character message.
• If sender parameter is not set, random sender will be used to send the message.

Body parameter

{
  "timeout": 0,
  "sender": "string",
  "is_group": false,
  "destination": "string",
  "message": "string"
}

Parameters

Example responses

201 Response

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "sender": "string",
    "destination": "string",
    "message": "string",
    "ref_no": "string"
  }
}

Responses

Message Info

GET /nusasms_api/1.0/whatsapp/status/{ref_no}

BASE_URL=https://api.nusasms.com/nusasms_api/1.0
# For testing
# BASE_URL=https://dev.nusasms.com/nusasms_api/1.0

curl -X GET "${BASE_URL}/whatsapp/status/{MESSAGE_REF_NO}" \
     -H "accept: application/json" \
     -H "APIKey: {YOUR_API_KEY}"
#     --insecure     # Ignore SSL Verification

<?php
$BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp';
$BASE_TEST_URL = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp';

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $BASE_URL . '/status/{MESSAGE_REF_NO}',
    CURLOPT_HTTPHEADER => array(
        "APIKey: {YOUR_API_KEY}",
        'Content-Type:application/json'
    ),
    CURLOPT_RETURNTRANSFER => 1,
    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);
if (!$resp)  else 
curl_close($curl);

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
# For testing
# BASE_URL = 'https://dev.nusasms.com/nusasms_api/1.0'

HEADERS = {
    "Accept": "application/json",
    "APIKey": "{YOUR_API_KEY}"
}

r = requests.get(
    f'{BASE_URL}/whatsapp/status/',
    headers=HEADERS,
    # Skip SSL Verification
    # verify=False
)

print(r.json())

package main

import (
    "fmt"
    "io/ioutil"
    "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "APIKey": []string{"YOUR_API_KEY"},
    }

    url := "https://api.nusasms.com/nusasms_api/1.0/whatsapp/status/{MESSAGE_REF_NO}"
    // For testing
    // url := "https://dev.nusasms.com/nusasms_api/1.0/whatsapp/status/{YOUR_REF_NO}"

    req, err := http.NewRequest("GET", url, nil)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }

    body, _ := ioutil.ReadAll(resp.Body)
    fmt.Println(string(body))
    // ...
}

const axios = require('axios');

const headers = {
  'Accept':'application/json',
  'APIKey':'YOUR_API_KEY'
};
const url = 'https://api.nusasms.com/nusasms_api/1.0/whatsapp/status'
// Test host
//const url = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp/status'
var ref_no = 'MESSAGE_REF_NO'

axios.get(url + '/' + ref_no, {headers: headers})
  .then(response => {
      console.log(response.data)
  })
  .catch(error => {
    if (error.response) {
      console.error(error.response.data)
    } else if (error.request) {
      console.error(error.request)
    } else {
      console.error(error.message);
    }
  });

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY'
}
url = 'https://api.nusasms.com/nusasms_api/1.0'
# Dev host
# url = 'https://dev.nusasms.com/nusasms_api/1.0'

result = RestClient.get(
    url + '/whatsapp/status/MESSAGE_REF_NO',
    headers=headers
)

puts JSON.parse(result)

Whatsapp message status

Note: if you set your own sender, please consider to set push callback to get immediate report of your message status to your server. Please contact support to set your push callback.

Test status on Test Server, with ref_no namely listed below:

• queued
• sent
• delivered
• read
• aborted
• failed

Parameters

Example responses

200 Response

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "destination": "string",
    "sender": "string",
    "is_group": false,
    "create_date": "2019-08-24T14:15:22Z",
    "sent_date": "2019-08-24T14:15:22Z",
    "read_date": "2019-08-24T14:15:22Z",
    "delivered_date": "2019-08-24T14:15:22Z",
    "ref_no": "string",
    "status": "string",
    "message": "string",
    "caption": "string",
    "media_url": "string"
  }
}

Responses

Inbox Push URL

# This script is need to be run on a Server with
# public IP or Domain

import json
from flask import Flask, request

app = Flask(__name__)

@app.route('/your_callback_url', methods=['POST'])
def get_push_callback():
	callback_data = {
		'id': request.form.get('id'),
		'gateway_no': request.form.get('gateway_number'),
		'sender': request.form.get('originator'),
		'receive_date': request.form.get('receive_date'),
		'message': request.form.get('msg'),
	}
	# You might want to save the result to DB or else here
	return json.dumps(callback_data)

/* This script is need to be run on a Server with
 * public IP or Domain
 */
$id = $_POST["id"];
$gateway_no = $_POST["gateway_number"];
$sender = $_POST["originator"];
$receive_date = $_POST["receive_date"];
$message = $_POST["msg"];

# you can write your code here, for example if you want to write the data to a file;
$myfile = fopen("inbox.txt", "w") or die("Unable to open file!");

fwrite($myfile, "ID: " . $id . PHP_EOL);
fwrite($myfile, "Gateway No: " . $gateway_no . PHP_EOL);
fwrite($mufile, "Sender: " . $sender . PHP_EOL);
fwrite($myfile, "Receive Date: " . $receive_date . PHP_EOL);
fwrite($myfile, "Message: " . $message . PHP_EOL);
fclose($myfile);

Set your Push URL to let us notify you of your WA message status.

Set Up

• Edit Gateway setting.

  

• Then fill the Push URL field.

  

SMS

Note

• BASE_URL: http://api.nusasms.com/api/v3

Response Status

Send Plain

POST /sms/v3/sendsms/plain

Notes

• URL: https://api.nusasms.com/api/v3/sendsms/plain
• For OTP (One-Time Password), otp=Y for argument value is required.

Parameters

Parameterized URL Examples

Plain SMS:

https://api.nusasms.com/api/v3/sendsms/plain?user=user&password=password&SMSText=Hello%20NusaSMS!&GSM=628*********

Plain SMS (JSON Response):

https://api.nusasms.com/api/v3/sendsms/plain?user=user&password=password&SMSText=Kode%20OTP%20anda%20xxxxxx&GSM=628********&otp=Y&output=json

OTP SMS:

https://api.nusasms.com/api/v3/sendsms/plain?user=user&password=password&SMSText=Hello%20NusaSMS!&GSM=628********&otp=Y

Success Response Examples

XML

<?xml version="1.0" encoding="UTF-8"?>
<results>
     <result>
          <status>0</status>
          <messageid>175041319203754627</messageid>
          <destination>6285100803380</destination>
     </result>
</results>

JSON

{
    "results": [{
        "status": "0", "messageid": "175041319203754627",
        "destination": "628510080XXXX"
    }]
}

Wrong User / Password Response

XML

<?xml version="1.0" encoding="UTF-8"?>
<results>
     <result>
          <status>-5</status>
          <messageid></messageid>
          <destination>6285100803380</destination>
     </result>
</results>

JSON

{
    "results": [{
        "status": "-5",
        "messageid": "",
        "destination": "6285100803380"
    }]
}

Missing Destination Number Response

XML

<?xml version="1.0" encoding="UTF-8"?> 
  <results> 
     <result> 
       <status>-13</status> 
       <messageid></messageid> 
       <destination>085100803380</destination> 
    </result>
</results>

JSON

{
    "results": [{
        "status": "-13", 
        "messageid": "", 
        "destination": "6285100803380"
    }]
}

Parameters

Example responses

200 Response

null

Responses

Response Schema

Send Group

POST /sms/v3/sendsms/group

Notes

• URL: https://api.nusasms.com/api/v3/sendsms/group
• Contacts group is list of GMS number. This could help to send same messages to many destination at once and easily.
• Contacts Group can be created on app.nusasms.com on Utilities > Address Book menu.

Parameters

Parameterized URL Example

https://api.nusasms.com/api/v3/sendsms/group?user=user&password=password&SMSText=Hello%20NusaSMS!&group=Example

Result Example

XML

<?xml version="1.0" encoding="UTF-8"?>
<results>
  <result>
    <status>0</status>
    <campaign_name>Group-Api-Campaign-cf27252-5101</campaign_name>
    <group>Example</group>
    </result>
</results>

JSON

{
    "results": [{
        "status": "0", 
        "campaign_name": "Group-Api-Campaign-cf27252-5101",
        "group": "Example"
    }]
}

Failed Response

Group is not available or the group has no contact list

XML

<?xml version="1.0" encoding="UTF-8"?>
<results>
     <result>
          <status>-55</status>
          <campaign_name>Group-Api-Campaign-cf27252-5101</campaign_name>
          <group>Example</group>
     </result>
</results>

JSON

{
    "results": [{
        "status": "-55", 
        "campaign_name": "Group-Api-Campaign-cf27252-5101", 
        "group": "Example"
    }]
}

Parameters

Example responses

200 Response

null

Responses

Response Schema

Command

GET /sms/command

Notes

• URL: https://api.nusasms.com/api/command

Command List

• CREDITS: return your available credits
• DR: Get delivery status of your message

Additional parameter

• output: Response format (e.g: XML or JSON)

Parameterized URL Examples

Check Credit

https://api.nusasms.com/api/command?user=user&password=password&cmd=CREDITS&type=sms&output=json

Check message status

https://api.nusasms.com/api/command?user=user&password=password&cmd=DR&ref_no=766387461827XXX

API Callback

Another way to get message delivery status is by registering your Server Callback URL on Account Setting menu on app.nusasms.com

Then set the callback URL

Example responses

200 Response

null

Responses

Response Schema

Push URL

import json
from flask import Flask, request

app = Flask(__name__)

@app.route('/your_callback_url', methods=['POST'])
def get_push_callback():
	callback_data = {
		'id': request.form.get('id'),
		'gateway_no': request.form.get('gateway_number'),
		'sender': request.form.get('originator'),
		'receive_date': request.form.get('receive_date'),
		'message': request.form.get('msg'),
	}
	# You might want to save the result to DB or else here
	return json.dumps(callback_data)

<?php

/* This script is need to be run on a Server with
 * public IP or Domain
 */

$id = $_POST["id"];
$gateway_no = $_POST["gateway_number"];
$sender = $_POST["originator"];
$receive_date = $_POST["receive_date"];
$message = $_POST["msg"];

# you can write your code here, for example if you want to 
# write the data to a file;
$myfile = fopen("inbox.txt", "w") or die("Unable to open file!");

fwrite($myfile, "ID: " . $id . PHP_EOL);
fwrite($myfile, "Gateway No: " . $gateway_no . PHP_EOL);
fwrite($mufile, "Sender: " . $sender . PHP_EOL);
fwrite($myfile, "Receive Date: " . $receive_date . PHP_EOL);
fwrite($myfile, "Message: " . $message . PHP_EOL);
fclose($myfile);

Set your SMS Push URL to let us notify you (via HTTP) when SMS is coming.

Set Up

• Open SMS Inbox > Activity menu.

  

• Add new Activity.

  

• Field the form and make sure you choose Push Inbox Type and fill the URL API field.

  

• Submit your activity on submit button below.

Schemas

Credit

{
  "idClient": 0,
  "wa_balance": 0,
  "wa_expired_date": "2019-08-24",
  "hlr_balance": 0,
  "hlr_expired_date": "2019-08-24",
  "sim_balance": 0,
  "sim_expired_date": "2019-08-24",
  "sms_balance": 0,
  "sms_expired_date": "2019-08-24",
  "pulsa_balance": 0
}

Credit

Properties

CreditResponse

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "idClient": 0,
    "wa_balance": 0,
    "wa_expired_date": "2019-08-24",
    "hlr_balance": 0,
    "hlr_expired_date": "2019-08-24",
    "sim_balance": 0,
    "sim_expired_date": "2019-08-24",
    "sms_balance": 0,
    "sms_expired_date": "2019-08-24",
    "pulsa_balance": 0
  }
}

CreditResponse

Properties

GetMessage

{
  "destination": "string",
  "sender": "string",
  "is_group": false,
  "create_date": "2019-08-24T14:15:22Z",
  "sent_date": "2019-08-24T14:15:22Z",
  "read_date": "2019-08-24T14:15:22Z",
  "delivered_date": "2019-08-24T14:15:22Z",
  "ref_no": "string",
  "status": "string",
  "message": "string",
  "caption": "string",
  "media_url": "string"
}

GetMessage

Properties

GetMessageResponse

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "destination": "string",
    "sender": "string",
    "is_group": false,
    "create_date": "2019-08-24T14:15:22Z",
    "sent_date": "2019-08-24T14:15:22Z",
    "read_date": "2019-08-24T14:15:22Z",
    "delivered_date": "2019-08-24T14:15:22Z",
    "ref_no": "string",
    "status": "string",
    "message": "string",
    "caption": "string",
    "media_url": "string"
  }
}

GetMessageResponse

Properties

HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationError

Properties

Person

{
  "userid": "string",
  "idPerson": 0,
  "idClient": 0
}

Person

Properties

PersonResponse

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "userid": "string",
    "idPerson": 0,
    "idClient": 0
  }
}

PersonResponse

Properties

SendMedia

{
  "sender": "string",
  "destination": "string",
  "caption": "string",
  "media_url": "string",
  "ref_no": "string"
}

SendMedia

Properties

SendMediaParams

{
  "timeout": 0,
  "sender": "string",
  "is_group": false,
  "destination": "string",
  "caption": "string",
  "media_url": "http://example.com",
  "media_base64": "string",
  "file_name": "string"
}

SendMediaParams

Properties

SendMediaResponse

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "sender": "string",
    "destination": "string",
    "caption": "string",
    "media_url": "string",
    "ref_no": "string"
  }
}

SendMediaResponse

Properties

SendMessage

{
  "sender": "string",
  "destination": "string",
  "message": "string",
  "ref_no": "string"
}

SendMessage

Properties

SendMessageParams

{
  "timeout": 0,
  "sender": "string",
  "is_group": false,
  "destination": "string",
  "message": "string"
}

SendMessageParams

Properties

SendMessageResponse

{
  "error": false,
  "error_code": 0,
  "message": "Data message",
  "data": {
    "sender": "string",
    "destination": "string",
    "message": "string",
    "ref_no": "string"
  }
}

SendMessageResponse

Properties

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties