WhatsApp API V3.0

Introduction

We can't wait to launch every new release and new features everytime after it pass thru Acceptance Test. This time we have increased API processing speed by 14 times faster compare to previous version.

Our objective is to make implementation easy and fun with our APIs.

• Template Message
• Session Message

Template Message

Pre-approved message templates for outbound notifications like delivery alerts and appointment reminders. They can not be used for marketing. You must use Template Message if more than 24 hours have elapsed since the user last responded to you. Any other type of message will fail.

Session Message

Within 24 hours from the user's last response, all messages sent and received are considered as Session Message. Any message can be send during this 24 hours session including marketing and promotion, video, image, audio, pdf and excel files.

• Summary Changes
• Overview of WhatsApp Message Flow
• Sending Normal Text Messages
• Sending Multi Lingual Messages
• HTTP Response
• Delivery Notification (DN)

Summary Changes

This release are launched based on our internal feedback and achievement to increase the capacity to handle more traffics. Upon your API request, we will accept the traffic as long as you have provided the correct credentials, IP whitelisted and enabled; we will return send status (such as Delivered, Failed, Insufficient balance, Account suspended) in Delivery Notification [DN].

Separate Credentials

API Credentials can be change anytime without any impact or down time

Handling Speed

14 times faster compare to previous version

1. Change your API submission from:
   

   https://sms.360.my/gw/bulk360/v1.4

   change to:
   

   https://sms.360.my/gw/bulk360/v3_0/send.php

2. Change API request by providing APP_KEY in user parameter and APP_SECRET in pass parameter
   Your APP_KEY and APP_SECRET is located at Configurations > APIs > Create Connection.
3. Understand and update system based on json object return from our system

Overview of WhatsApp Message Flow

1. Client request send Pre-Approved WhatsApp Template Message [MT] via Bulk360 SMS API V3.0
2. Bulk360 acknowledge upon MT received, and return a Unique Reference ID. The returning values as specified in HTTP Response
   Noted that the MT Status here is not final
3. Bulk360 transmit the MT to the WhatsApp, Acknowledgement and Reference ID return from WhatsApp
4. Delivery Notification [DN] return from WhatsApp
5. Bulk360 return DN with Final Status of the MT Sent, refers to Delivery Notification for returned values
6. If User response to your template message, WhatsApp will transmit the Incoming Message [MO] to Bulk360
7. Bulk360 will then transmit the MO by triggering your WhatsApp Incoming Message Hook
8. All conversations considered as Session Message within 24 hours from User's last response

Sending WhatsApp Template Messages

Mobile Terminated (MT) Message refers to a message being sent out from SMS Gateway to the mobile handset.

Our HTTP API is designed for developers with instructions to integrate 360 WhatsApp services into various solutions. This guide will walk you through the process of sending messages by simply submitting your information either a POST or GET request to our API.

However, the POST method is recommended as opposed to the GET method due to the limitation of size and credentials are exposed in the URL.

Copy
<?php

class bulk360{
    var $user   = 'API_KEY';
    var $pass   = 'API_SECRET';
    var $from   = '66688';
    var $to;
    var $text;

    var $url    = 'https://sms.360.my/gw/bulk360/v3_0/send.php';

    function __construct() {
        $this->user = urlencode($this->user);
        $this->pass = urlencode($this->pass);

        $this->url = $this->url . "?user=$this->user&pass=$this->pass&from=$this->from";
    }

    function sendsms($to, $text) {
        $this->url = $this->url . "&to=".$to."&text=".rawurlencode($text);

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $this->url);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
        $sentResult = curl_exec($ch);
        if ($sentResult == FALSE) {
            echo 'Curl failed for sending sms to crm.. '.curl_error($ch);
        }
        curl_close($ch);

        echo 'sentResult = ' . $sentResult;
    }
}

$sms = new bulk360();
$sms->sendsms('whatsapp:60123240066', 'This is a test message from Bulk360');

?>

Copy
<?php

class bulk360{
    var $user   = 'API_KEY';
    var $pass   = 'API_SECRET';
    var $from   = '66688';
    var $to;
    var $text;

    var $url    = 'https://sms.360.my/gw/bulk360/v3_0/send.php';

    function __construct() {
        $this->user = urlencode($this->user);
        $this->pass = urlencode($this->pass);

        $this->url = $this->url . "?user=$this->user&pass=$this->pass&from=$this->from";
    }

    function sendsms($to, $text) {
        $text = urlencode($text);
        $this->url = $this->url . "&to=$to&text=$text";

        $response = file_get_contents($this->url);
        echo 'this->url = ' . $this->url . '<br />';
        echo 'response = ' . $response;
    }
}

$sms = new bulk360();
$sms->sendsms('whatsapp:60123240066', 'This is a test message from Bulk360');

?>

Copy
Imports System.Net
Imports System.IO

Partial Public Class _Default
    Inherits System.Web.UI.Page

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load

    End Sub

    Protected Sub Send2Btn_Click(ByVal sender As Object, ByVal e As EventArgs) Handles Send2Btn.Click
        Dim resultCode As [String] = ""
        'Following are working sample, you may provide the correct user access details and phone no to test
        '1. user - API_KEY
        '2. pass - API_SECRET
        '3. to - Phone no, ex. 6012xxxyyyy

        Dim request As WebRequest = WebRequest.Create("https://sms.360.my/gw/bulk360/v3_0/send.php?user=admin&pass=12345&to=whatsapp:60123240066&from=admin&text=test%20message%20on%2024/03/2016")
        Using GWresponse As WebResponse = request.GetResponse()
            Using stream As New StreamReader(GWresponse.GetResponseStream())
                resultCode = stream.ReadLine
            End Using
        End Using
        Label1.Text = "Result Code: " & resultCode
    End Sub

End Class

Copy
<form method="get" action="https://sms.360.my/gw/bulk360/v3_0/send.php">
    <table>
        <tr>
            <td>
                Username (API_KEY):
            </td>
            <td>
                <input type="text" id="user" name="user" />
            </td>
        </tr>
        <tr>
            <td>
                Password (API_SECRET):
            </td>
            <td>
                <input type="text" id="pass" name="pass" />
            </td>
        </tr>
        <tr>
            <td>
                To:
            </td>
            <td>
                <input type="text" id="to" name="to" />
            </td>
        </tr>
        <tr>
            <td>
                From:
            </td>
            <td>
                <input type="text" id="from" name="from" />
            </td>
        </tr>
        <tr>
            <td>
                Text:
            </td>
            <td>
                <input type="text" id="text" name="text" />
            </td>
        </tr>
        <tr>
            <td colspan="2">
                <input type="submit" value="Submit Now" />
            </td>
        </tr>
    </table>
</form>

If detail=1 is provided, the API will return 4 values as specified in HTTP Response
If detail=1 is not provided, the API will only return 3 values without Currency and Account Balance

{
        "code"   : 401,
        "desc"   : "Invalid Username or password"
}

{
    "code"       : 200,
    "desc"       : "OK",
    "to"         : "whatsapp:60123240066",
    "ref"        : "78-1633193001.0602"
}

{
    "code"       : 200,
    "desc"       : "OK",
    "to"         : "whatsapp:60123240066",
    "ref"        : "78-1633193032.8416",
    "currency"   : "MYR",
    "balance"    : "187.9236"
}

{
    "code": 400,
    "desc": "Missing parameters or invalid field type"
}

Sending Multi Lingual Messages

You are able to send Message in any language such as Chinese, Hindi or Thai with ease. Simply encode your Double Characters content into URL format.

If detail=1 is provided, the API will return 4 values as specified in HTTP Response
If detail=1 is not provided, the API will only return 3 values without Currency and Account Balance

HTTP Response

• code - The real-time delivery status, refer to following table Response Code
• desc - Description of the code
• to - Recipient mobile number
• ref - Reference ID returned by 360
• optional - [with parameter 'detail=1']
  • Currency
  • Account Balance

Note that due to MT are queued for process later, the return Balance is not included the charges incur by current request.

{
    "code"       : 200,
    "desc"       : "OK",
    "to"         : "whatsapp:60123240066",
    "ref"        : "78-1633193001.0602"
}

{
    "code"       : 200,
    "desc"       : "OK",
    "to"         : "whatsapp:60123240066",
    "ref"        : "78-1633193001.0602",
    "currency"   : "MYR",
    "balance"    : "187.9236"
}

{
    "code"       : 200,
    "desc"       : "OK",
    "to"         : "whatsapp:60123240066,whatsapp:60176655668,whatsapp:60102200533,whatsapp:60102410102,whatsapp:60143600661",
    "ref"        : "78-1633193001.0602",
    "currency"   : "MYR",
    "balance"    : "187.9236"
}

Delivery Notification (DN)

Delivery Notification is the final status of your Message sent.

If Delivery Notification is required, please fill in the Delivery Notification Hook located at My Configurations > APIs tab. DNs will then be forwarded to your DN URL in real time in following format:

Note:
- The total number of DNs returned will be based on the number of Message broadcasted. E.g.: if a Group of broadcast consists of 10 MSISDNs, there will be 10 DNs returned. If there were more than 1 DN returned for the same Message, always consider the last DN received as the final DN.