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 10.0 milliseconds

Development /Test (Currently inactive)

• 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

Response Content Type

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

IP Whitelist

To be able to use NusaSMS API, you must register your IP address to be whitelisted.

Follow this steps to register your IP Address.

1. Login app.nusasms.com
2. Go to Account menu then choose IP Whitelist menu.
3. Click the add button (the blue button with plus icon)
4. Fill the fields and make sure to check the Active mark.
5. Click Save and close

Authentication

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

APIKey

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/auth/api_key";

$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,

    // 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,
  "message": "Data message",
  "data": {
    "userid": "string",
    "idPerson": 0,
    "idClient": 0
  }
}

Responses

Account

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 "Content-type: application/json" \
     -H "APIKey: {YOUR_API_KEY}"
#     --insecure     # Ignore SSL Verification

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

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $BASE_URL,
    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,
  "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 Official

Introduction

Whatsapp Official API helps to use WhatsApp Business API. You can send message using a message template by your channel (Whatsapp Account).

Usage flow

• Register Whatsapp Official Account.
• Request message templates (types: text, media/file or interactive (has button actions)
• Wait for template to be approved.
• Use a template (using its template_id) to send broadcast messages (see Send Broadcast Message section below).

Rate Limit

• One Channel message request is limited to 60 request / minute.

Terminology

• Template: template of Whatsapp message (You need to make request of your template to us and wait until its approved).
• Channel: Whatsapp Account that has been integrated with this service.

Types of Message

1. Broadcast Message

A message template is required to send broadcast message. You can send this message to anyone regarding either your recipient is valid Whatsapp account or not.

After the recipient reply your broadcast message, you will get a room. This room is assigned to your channel. room_id is going to be used to send reply message or interactive reply message.

For more information please see Send Broadcast Message section.

2. Reply Message

After getting room_id, you can send custom message without template, thus you will explicitly use previous channel which you use on broadcast message.

room_id is required to send reply message. You can get room_id from your Inbox after the recipient reply your broadcast message. room_id is active in 24 hours since is the the message recipient reply to broadcase message.

For more information please see Send Reply Message section.

3. Interactive Reply Message (Coming soon)

Interactive Reply Message is extension of reply message that allows to send custom message with interactive buttons which also require room_id.

Send Broadcast Message

POST /nusasms_api/1.0/wa_official/message/broadcast

# Template: "Your OTP Code is 1
# Sent message by this code: "Your OTP Code is CODE"

BASE_URL=https://api.nusasms.com/nusasms_api/1.0

curl -X POST "${BASE_URL}/wa_official/message/broadcast" \
  -H 'Content-type: application/json' \
  -H "Accept: application/json" \
  -H "APIKey: {YOUR_API_KEY}" \
  -d '{
  "destination": "YOUR_DESTINATION",
  "destination_name": "DESTINATION/RECIPIENT NAME",
  "template_id": "YOUR-TEMPLATE-UUID",
  "channel_id": "YOUR-CHANNEL-UUID",
  "parameters": {
    "body": [
      {
        "key": "1",
        "value": "code",
        "value_text": "CODE"
      }
    ]
  }
}'
#     --insecure     # Ignore SSL Verification

<?php

/*
Template: "Your OTP Code is 1""
Sent message by this code: "Your OTP Code is VARIABLE_VALUE"
*/

$URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/message/broadcast';

$curl = curl_init();
$payload = json_encode(array(
    'destination' => '628xxxxxxxxxx',
    'destination_name' => 'DESTINATION/RECIPIENT NAME',
    'template_id' => 'YOUR-TEMPLATE-UUID',
    'channel_id' => 'YOUR-CHANNEL-UUID',
    'parameters' => array(
        'body' => array(
            array(
                'key' => '1',
                'value' => 'VARIABLE_NAME',
                'value_text' => 'VARIABLE_VALUE'
            )
        ),
    )
));
curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $URL,
    // For testing
    // CURLOPT_URL => $BASE_TEST_URL,
    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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    echo $resp;
}
curl_close($curl);

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
HEADERS = {
    "Accept": "application/json",
    "APIKey": "YOUR_API_KEY"
}
PAYLOADS = {
    'destination': '628xxxxxxxxxx',
    "destination_name": "DESTINATION/RECIPIENT NAME",
    "template_id": "YOUR-TEMPLATE-UUID",
    "channel_id": "YOUR-CHANNEL-UUID",
    "parameters": {
        "header": {
            "format": "DOCUMENT",
            "params": [
                {
                    "key": "url",
                    "value": "https://buildmedia.readthedocs.org/media/pdf/read-the-docs/latest/read-the-docs.pdf"
                },
                {
                    "key": "filename",
                    "value": "example.pdf"
                }
            ]
        },
        "body": [
            {'key': 1, 'value': 'code', 'value_text': 'CODE'},
        ],
        "buttons": [
            {
                "index": "0",
                "type": "url",
                "value": "/url_endpoint?arg1=value"
            }
        ]
    }
}

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

print(r.json())

package main

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

/*
Template: "Your OTP Code is 1""
Sent message by this code: "Your OTP Code is CODE"
*/
func main() {
    headers := map[string][]string {
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "APIKey": []string{"YOUR_API_KEY"},
    }

    param_header := []map[string]interface{} {
        map[string]interface{}{
            "key": "1", "value": "code", "value_text": "CODE",
        },
    }
    payload, _ := json.Marshal(map[string]interface{} {
        "destination": "62822344641960",
        "destination_name": "Any name",
        "template_id": "65a08d56-a2b9-45f5-98d3-98671e639055",
        "channel_id": "15974c27-3116-49f4-8627-5fc30b0c66d8",
        "parameters": map[string]interface{} {
            "body": params_body,
        },
    })
    url := "https://api.nusasms.com/nusasms_api/1.0/wa_official/message/broadcast"

    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');

/*
Template: "Your OTP Code is 1""
Sent message by this code: "Your OTP Code is FIRST_PARAM"
*/

const headers = {
  Accept: 'application/json',
  APIKey: 'YOUR_API_KEY'
};
var data = {
  destination: '628xxxxxxxxxx',
  destination_name: 'DESTINATION/RECIPIENT NAME',
  template_id: "YOUR-TEMPLATE-UUID",
  channel_id: "YOUR-CHANNEL-UUID",
  parameters: {
    body: [
      {"key": "1", "value": "otp_code", "value_text": "FIRST_PARAM"}
    ]
  }
}
const url = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/message/broadcast'

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'

# Template: "Your OTP Code is 1""
# Sent message by this code: "Your OTP Code is VARIABLE_VALUE"

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY',
    'Content-Type' => 'application/json',
}
payloads = {
    'destination' => '628xxxxxxxxxx',
    'destination_name' => 'DESTINATION/RECIPIENT NAME',
    'template_id' => 'YOUR-TEMPLATE-UUID',
    'channel_id' => 'YOUR-CHANNEL-UUID',
    'parameters' => {
        'body' => [
            {
                'key' => '1',
                'value' => 'VARIABLE_NAME',
                'value_text' => 'VARIABLE_VALUE'
            }
        ]
    }
}
base_url = 'https://api.nusasms.com/nusasms_api/1.0'

response = RestClient::Request.new({
    method: :post,
    url: base_url + '/wa_official/message/broadcast',
    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

This endpoint allows you to send Whatsapp message using a template message.

API Parameters

• destination: Destination number

  Required: true

  Example: 628XXXXXXXXXX

• destination_name: Destination name.

  Required: true

  Example: Any name for your recipient

• template_id: Template ID

  (see Templates on WA Official menu on https://app.nusasms.com)

  Required: true

  Example: xxxxxxxx-xxxx-4eee-a150-5e2eacabd34f

• channel_id: Channel ID or Gateway

  (see Channels on WA Official menu on https://app.nusasms.com)

  Required: true

  Example: xxxxxxxx-023f-4eee-xxxx-5e2eacabd34f

• parameters (optional, please see you template): Parameter for your Template.

  Required: false (based on your template)

  Example: {"body": [ {"key": 1, "value": "code", "value_text": "CODE"} ]}

  Note: Parameter text value cannot have new-line/tab characters or more than 4 consecutive spaces.

  There are 3 valid types of parameters. See on list below

Type of parameters Parameter Value

• body: Contains list mapping/dictionary that consist of key, value and value_text.

  • key: Characters that is wrapped with { { and } }
  • value: Variable like name (free to write any but use only lowercase, numbers and underscore characters, length 2-32 characters)
  • value_text: Value that will replaced the key

  Example: {"key": "1", "value": "name", "value_text": "My Name"}

• headers: Mapping/dictionary of format and params This can be use if your template media is not Empty for message with buttons.

  • format: Media format.

    Choices: IMAGE, DOCUMENT

  • params: list of content parameters that consist of mapping/dictionary of key which hold value filename and value is for the media URL

  Example: {"format": "IMAGE", "params": [ {"key": "filename", "value": "example.png"}, {"key": "url", "value": "https://example.com/example.pdf"}, ]}

• buttons: There are 2 types of button for message template. You can only use one of them in a template.

  Non-Action

  • QUICK REPLY(static): Plain text button

  Action

  • URL(static and dynamic): go to the URL
  • PHONE NUMBER(static): call the number

  Note:

  • static means it only can be set during template message creation.
  • QUICK_REPLY and PHONE_NUMBER is static button
  • URL can be static or dynamic.
  • URL button value change can only be by appending its url value to its registered url.
  • You can only use one of Action or Non action can be registered on a template

  Example: {"button": [ { "index": "1", "value": "/endpoint?argument=value", "type": "url" } ]}

Body parameter

{
  "destination": "string",
  "destination_name": "string",
  "template_id": "string",
  "channel_id": "string",
  "parameters": {
    "property1": [
      null
    ],
    "property2": [
      null
    ]
  }
}

Parameters

Example responses

201 Response

{
  "error": false,
  "message": "Send broadcast message",
  "data": {
    "ref_no": "string"
  }
}

Responses

Send Reply Message

POST /nusasms_api/1.0/wa_official/message/reply

package main

import (
    "bytes"
    "fmt"
    "io/ioutil"
    "mime/multipart"
    "net/http"
)

const url := "https://api.nusasms.com/nusasms_api/1.0/wa_official/message/reply"

func main() {
    payload := &bytes.Buffer{}
    writer := multipart.NewWriter(payload)
    writer.WriteField("room_id", "YOUR-ROOM-UUID")
    // writer.WriteField("type", "text")
    writer.WriteField("text", "Your text here")
    err := writer.Close()
    if err != nil {
        panic(err)
    }

    req, err := http.NewRequest("POST", url, payload)

    req.Header.Add("Content-Type", writer.FormDataContentType())
    req.Header.Add("APIKey", "YOUR_API_KEY")

    client := &http.Client{}

    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

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

const axios = require('axios');
const fs = require('fs');

const url = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/message/reply'
const headers = {
  'Accept': 'application/json',
  'APIKey': 'YOUR_API_KEY',
  'Content-Type': 'multipart/form-data'
};
var data = {
  room_id: 'YOUR-ROOM-UUID',
  type: 'image',
  file: fs.createReadStream('/home/username/your-path/to-file.png'),
  text: 'Image caption'
}

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);
    }
  });

<?php

$APIKEY = 'YOUR_API_KEY';
$URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/message/reply';

$curl = curl_init();
$payload = array(
    'room_id' => 'YOUR-ROOM-ID',
    'text' => 'test message'
);
curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $URL,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => array(
        "APIKey: " . $APIKEY,
        'Content-Type: multipart/form-data'
    ),
    CURLOPT_POSTFIELDS => $payload,
    // CURLOPT_SSL_VERIFYPEER => 0,    // Skip SSL Verification
));

$resp = curl_exec($curl);

if (!$resp) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    echo $resp;
}
curl_close($curl);

import requests

BASE_URL = 'https://api.nusasms.com/nusasms_api/1.0'
HEADERS = {
    "Accept": "application/json",
    "APIKey": "YOUR_API_KEY"
}
PAYLOADS = {
    'room_id': 'YOUR-ROOM-ID',
    'type': 'text',
    'text': 'Teks anda di sini'
}

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

print(r.json())

require 'rest-client'
require 'json'

headers = {
    'Accept' => 'application/json',
    'APIKey' => 'YOUR_API_KEY',
    'Content-Type' => 'application/json',
}
payloads = {
    'room_id' => 'YOUR-ROOM-ID',
    'text' => 'test message'
}
base_url = 'https://api.nusasms.com/nusasms_api/1.0'

response = RestClient::Request.new({
    method: :post,
    url: base_url + '/wa_official/message/reply',
    payload: payloads,
    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

 BASE_URL=https://api.nusasms.com/nusasms_api/1.0

curl -X POST "${BASE_URL}/wa_official/message/reply" \
  -H "Accept: application/json" \
  -H "APIKey: YOUR_API_KEY" \
  --form 'type="text"' \
  --form 'text="Contoh text"' \
  --form 'room_id="YOUR-ROOM-UUID"'
#     --insecure     # Ignore SSL Verification

Send custom message without a template.

Parameters

• Content-type: multipart/form-data

• room_id: Your Room ID.

  Required: true

  Example: a8d8e40f-XXXX-429b-a23a-82f51ac27bec

• type: text.

  Default: text

  _To be added _: audio, document, image, and video

• text: message text / file caption

  Required: true if type is text

  Note: cannot have new-line/tab characters or more than 4 consecutive spaces.

  Example: Any text here

Body parameter

room_id: string
type: text
file_url: http://example.com
text: string

Parameters

Example responses

201 Response

{
  "error": false,
  "message": "Send reply message",
  "data": {
    "ref_no": "string"
  }
}

Responses

Get Templates

GET /nusasms_api/1.0/wa_official/templates

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/wa_official/templates"
    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/wa_official/templates'

axios.get(url, {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);
    }
  });

BASE_URL=https://api.nusasms.com/nusasms_api/1.0

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

<?php
$URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/templates';

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $URL,
    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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    echo $resp;
}
curl_close($curl);

import requests

URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/templates'

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

r = requests.get(
    URL, headers=HEADERS,
    # Skip SSL Verification
    # verify=False
)

print(r.json())

require 'rest-client'
require 'json'

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

result = RestClient.get(
    url + '/wa_official/templates',
    headers=headers
)

puts JSON.parse(result)

This endpoint show you list of your message templates.

Template need to be approved if you want to use it to send message. If you need to use new template, you will need to submit the template.

Therefore there are different statuses of template.

• Pending: This is when a business first submits a template that has not been on-boarded and approved.
• Approved: The template is approved to be sent.
• Rejected: The template is rejected to be on-boarded.

Example responses

200 Response

{
  "error": false,
  "message": "Templates",
  "data": [
    {
      "id": "string",
      "name": "string",
      "header": null,
      "body": null,
      "footer": null,
      "status": "string",
      "category": "string"
    }
  ]
}

Responses

Get Channels

GET /nusasms_api/1.0/wa_official/channels

BASE_URL=https://api.nusasms.com/nusasms_api/1.0

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

<?php
$URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/channels';

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $URL,
    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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    echo $resp;
}
curl_close($curl);

import requests

URL = 'https://api.nusasms.com/nusasms_api/1.0/wa_official/channels'

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

r = requests.get(
    URL, 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/wa_official/channels"
    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/wa_official/channels'

axios.get(url, {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'

result = RestClient.get(
    url + '/wa_official/channels',
    headers=headers
)

puts JSON.parse(result)

Channel is your Whatsapp Gateway/Sender which going to be used to send message to your destination. User may have more multiple channels.

This endpoint will show you list of your Channel.

Example responses

200 Response

{
  "error": false,
  "message": "Channels",
  "data": [
    {
      "id": "string",
      "webhook": "string",
      "settings": null,
      "organization_id": "string",
      "created_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Responses

Callback

<?php

$myfile = fopen("callback.txt", "w") or die("Unable to open file!");
$data = file_get_contents("php://input");

fwrite($myfile, "callback data: " . $data . PHP_EOL);
fclose($myfile);

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

import json
from flask import Flask, request, current_app

app = Flask(__name__)


@app.route('/callback_delivery_status', methods=['POST'])
def get_push_callback():
	callback_data = request.get_json()
	current_app.logger.info(f'Message status data: {callback_data}')
	# You might want to process the callback data here
	return json.dumps(callback_data)


@app.route('/callback_inbox', methods=['POST'])
def callback_inbox():
	callback_data = request.get_json()
	current_app.logger.info(f'Inbox data: {callback_data}')
	# You might want to process the callback data here
	return json.dumps(callback_data)

You can collect your Message Status and Inbox by registering your Callback URL.

Go to WA Official > Account from side menu to setting your callback URL.

Message Status

Callback data

• ref_no: your message ref_no
• status: message status
  values: sent, delivered, read and failed
• status_date: the time message status change to current status

Callback JSON Request Example

{
    "ref_no": "YOUR_MESSAGE_REF_NO",
    "status": "read",
    "status_date": "2022-08-12 10:22:50"
}

Inbox

Callback data

• room_id: Room is chat session between your channel and the recipient.
  NOTE: Room will expired if conversation not going on in some time.
• ref_no: Unique ID of the Inbox message
• text: the message text
• inbox_date: Date of the Inbox
• sender_number: Phone number of the inbox sender

Callback JSON Request Example

{
    "room_id": "xxxx-fb79-xxxx-b19e-546f761dfebf",
    "ref_no": "XXXX05224010031105891853",
    "text": "Pesan inbox",
    "inbox_date": "2022-08-12 10:50:13",
    "sender_number": "628XXXXXXXX"
}

WhatsApp

Introduction

Account Settings

Information

Tutorial Video: Send Message using PHP (Bahasa Indonesia)

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 "{
      \"queue\": \"{YOUR_QUEUE}\",
      \"destination\": \"628xxxxxxxxxx\",
      \"caption\": \"Caption text\",
      \"media_url\": \"https://example.com/image_name.png\",
      \"include_unsubscribe\": true
    }"
#     --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',
    # QUeue is optional
    'queue': 'YOUR_SENDER',
    'media_base64': base64_file,
    'file_name': 'your_image_file.png',
    'caption': 'Caption text',
    'include_unsubscribe': True
}

# 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/media';
$BASE_TEST_URL = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp/media';

$curl = curl_init();

$payload = json_encode(array(
    'caption' => 'Caption text',
    // Queue is optional
    'queue' => 'YOUR_QUEUE',
    'destination' => '628xxxxxxxxxx',
    'media_url' => 'https://example.com/image_name.png',
    'include_unsubscribe' => true,
));

curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $BASE_URL,
    // For testing
    // CURLOPT_URL => $BASE_TEST_URL,
    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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    echo $resp;
}
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]interface{}{
        // Optional
        // "queue": " YOUR_QUEUE ",
        "destination": "628xxxxxxxxxx",
        "caption": "Caption text",
        "media_url": "https://example.com/image_name.png",
        "include_unsubscribe": true,
    })
    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
  queue: 'YOUR_QUEUE',
  caption: 'Caption text',
  media_url: 'https://example.com/your-image.png',
  include_unsubscribe: true,
}
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',
    # Queue is optional
    'queue' => 'YOUR_QUEUE',
    'caption' => 'Caption text',
    'media_url' => 'https://example.com/your-image.png',
    'include_unsubscribe' => true,
}
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

• Queue is set of Senders. The Sender picked randomly from the set list for each message sent.

• If none of Queue or Sender argument is set, the sender will be randomly chosen from your WA Sender (if you have any) or from Blast WA Senders.
  Default: null (in seconds)

• timeout is the message timeout in seconds. If the message exceeds the timeout before it has being sent, the status of the message is going to be F (Failed).
  Default: 86400 (in seconds)

• include_unsubscribe is flag that if the value is true, an un-subscription text with an un-subscription link will be added and to be sent to the message recipient. Later on after the destination click the un-subscription link, You can not send message to the recipient because the number have been added to your recipient exclusion list.
  Default: false

• This endpoint will consume 2 WA Credits.

• Allowed file types are: docx, jpg, jpeg, png, pdf, webm, mp4.

• 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 1024.0 Kilobytes

• On using media_url as paramater, the maximum size of the media file is 1024.0 Kilobytes for JPG, JPEG, PNG, PDF and DOCX and 1 Megabytes for MP4, WEBM.

Body parameter

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

Parameters

Example responses

201 Response

{
  "error": false,
  "message": "Data message",
  "data": {
    "sender": "string",
    "queue": "string",
    "destination": "string",
    "ref_no": "string",
    "caption": "string",
    "media_url": "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\"
      \"include_unsubscribe\": true
    }"
#     --insecure     # Ignore SSL Verification
# Parameter `sender` is optional

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

$curl = curl_init();
$payload = json_encode(array(
    // 'queue' => 'YOUR_SENDER',
    'destination' => '628xxxxxxxxxx',
    'message' => 'Your message',
    'include_unsubscribe' => true,
));
curl_setopt_array($curl, array(
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $BASE_URL,
    // For testing
    // CURLOPT_URL => $BASE_TEST_URL,
    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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    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"
}
PAYLOADS = {
    'destination': '628xxxxxxxxxx',
    # Optional
    'queue': 'YOUR_QUEUE',
    'message': "your message here.\\nGrinning face emoticon: \\\\U0001F600",
    'include_unsubscribe': True
}

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]interface{}{
        // Queue is optional
        // "queue": "YOUR_QUEUE",
        "destination": "628xxxxxxxxxx",
        "message": "Message text",
        "include_unsubscribe": true
    })
    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 = {
  // queue: 'YOUR_QUEUE',
  destination: '628xxxxxxxxxx',
  message: 'Message text',
  include_unsubscribe: true,
}
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 = {
    # 'queue' => 'YOUR_QUEUE',
    'destination' => '628xxxxxxxxxx',
    'message' => 'Message text',
    'include_unsubscribe' => true
}
base_url = 'https://api.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

• Queue is set of Senders. The Sender picked randomly from the set list for each message sent.

• If none of Queue or Sender argument is set, the sender will be randomly chosen from your WA Sender (if you have any) or from Blast WA Senders.
  Default: null (in seconds)

• timeout is the message timeout in seconds. If the message exceeds the timeout before it has being sent, the status of the message is going to be F (Failed).
  Default: 86400 (in seconds)

• include_unsubscribe is flag that if the value is true, an un-subscription text with an un-subscription link will be added and to be sent to the message recipient. Later on after the destination click the un-subscription link, You can not send message to the recipient because the number have been added to your recipient exclusion list.
  Default: false

• If sender parameter is not set, random sender will be used to send the message.

• This endpoint will deduct 1 WA Credits per 2000 (updated) character message.

Body parameter

{
  "timeout": 86400,
  "queue": "string",
  "is_group": false,
  "destination": "string",
  "channel": 0,
  "include_unsubscribe": false,
  "sender": "string",
  "message": "string"
}

Parameters

Example responses

201 Response

{
  "error": false,
  "message": "Data message",
  "data": {
    "sender": "string",
    "queue": "string",
    "destination": "string",
    "ref_no": "string",
    "message": "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/status';
$BASE_TEST_URL = 'https://dev.nusasms.com/nusasms_api/1.0/whatsapp/stasus';

$curl = curl_init();
curl_setopt_array($curl, array(
    CURLOPT_URL => $BASE_URL . '/{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) {
    die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
} else {
    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}/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,
  "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

Delivery Status Callback

# 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_DR_callback_url', methods=['GET', 'POST'])
def get_push_callback():
	callback_data = {
		'ref_no': request.args.get('ref_no'),
		'status': request.args.get('status'),
		'sent_date': request.args.get('sent_date'),
		'err_code': request.args.get('err_code'),
	}
	# 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
 */

$ref_no = $_GET["ref_no"];
$status = $_GET["status"];
$sent_date = $_GET["sent_date"];
$err_code = $_GET["err_code"];

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

fwrite($myfile, "Ref No: " . $ref_no . PHP_EOL);
fwrite($myfile, "Status: " . $status . PHP_EOL);
fwrite($myfile, "Sent Date: " . $sent_date . PHP_EOL);
fwrite($myfile, "Error Code: " . $err_code . PHP_EOL);
fclose($myfile);

?>

Another method for collecting Delivery Status / Message status is by registering URL Call Back API in menu Account Setting on your web app account https://app.nusasms.com.

Open Account > Account Settings from side menu.

More documentation for Delivery Status Callback: https://nusasms.com/sms-api/

Push Inbox

Inbox message can be retrieved via push inbox.

Callback HTTP Request Info

• Content-Type: application/x-www-form-urlencoded

# 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($myfile, "Sender: " . $sender . PHP_EOL);
fwrite($myfile, "Receive Date: " . $receive_date . PHP_EOL);
fwrite($myfile, "Message: " . $message . PHP_EOL);
fclose($myfile);