Bulk360 SMS API V1.4

Video Guide

Last Update: 16th Apr 2020

Developer Guide

Introduction

We can't wait to launch every new release and new features everytime after we complete the system test. This time we have implemented WhatsApp Message in the latest API and bulk sending features.

360 makes sending and receiving SMS easy. With Bulk360 SMS APIs, an enterprise level SMS Gateway capable to handle millions of transactions daily. Start creating your amazing application and leverage on our Digital Marketing Tools!

This document will cover the following areas of connectivity:

Summary Changes

This release aims to implement more features based on our customers' feedback and features requested

New features in V1.4:
Bulk Sender List
You can now trigger to send Multiple Recipients with only 1 request
WhatsApp Support
Enable send WhatsApp message with minimum changes
Balance Inquiry
You can now query your account balance with our latest API
Delivery Status
Provide more detailed data regarding failure transaction
For User in V1.3 Steps to migrate to V1.4:
  1. Change your API submission from:
    https://sms.360.my/gw/bulk360/v1.3
    to:
    https://sms.360.my/gw/bulk360/v1.4
  2. Understand how to check Balance and send Multiple Recipients in 1 request

Overview of One Way SMS Flow

Below figure shows One Way SMS call flow
  1. Client request send SMS via Bulk360 SMS API [MT].
  2. Bulk360 acknowledge upon MT received, and return a Unique Reference ID. The returning values as specified in Delivery Notification.
    Noted that the MT Status here is not final
  3. Bulk360 transmit the MT to the recipient's Telco, Acknowledgement and Reference ID return from Telco
  4. Delivery Notification [DN] return from Telco
  5. Bulk360 return DN with Final Status of the MT Sent, refers to Delivery Notification for returned values.

Sending Normal Text Messages

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

However, the POST method is recommended as opposed to the GET method due to the limitation of size and exposure of the HTTP request being exposed in the HTTP address bar.

To send SMS, all POST / GET request shall be submitted to following URL:
Actual working example with mandatory parameters:
Below table explanation for all Parameters:
# Parameter Description Mandatory Example
1 user Your registered email shall be used here. Yes mark@360.my
2 pass Your account password, the same password you used registering in the Bulk360 platform. Note that you shall change the password in your API after you change the account password in sms.360.my. Yes pass001
3 type This parameters is not needed in V1.4, however, it won't cause any problem even if you post No 0
4 to Recipient's mobile number in international format (without the "+" sign)

To send multiple recipeints in a single request, separate each recipient entry with comma (,)
eg. 60123240066,60102200533,60166600267

To send whatsapp message, just add 'whatsapp:' as prefix of the mobile entry
eg. 60123240066,60102200533,whatsapp:60166600267
Yes 60123240066
5 from The source name of the SMS, it accepts Maximum of 11 alphanumeric characters. [Not applicable in Malaysia] No AEONSales
6 text The SMS content. When sending MT to Malaysia prefix (60) is concerned, the system will auto append “RM0 ” at the beginning of the SMS. This will consume 4 characters from the total characters count of the message & credits will be deducted accordingly. Yes Message from Bulk360 Gateway
7 servid The service ID, set as 'Bulk360' No Bulk360
8 detail To show additional info of:
- Account Balance
The balance returned is the balance before you trigger send the transaction
- Charge for each MSISDN
- Currency for each charge
No 1
* All parameters shall be encoded in URL format if API triggered via GET Request
Following sample source code in different languages:

The API will return 3 values as specified in HTTP Response.

Sending UNICODE (UCS2) messages (Multi lingual)

You are able to send Unicode SMS such as Chinese, Hindi or Thai with ease. Simply encode your Double Characters content into URL format, and tunning the SMS type to 5.

Actual working example with mandatory parameters:

The API will return 3 values as specified in HTTP Response.

HTTP Response

Upon the Bulk360 SMS API is called, the API will return 3 values:
  • status - The real-time delivery status, refer to following table Response Code
  • msisdn - Recipient mobile number
  • msgid - Reference ID returned by 360
  • optional - [with parameter 'detail=1' in API request]
    • Currency
    • Account Balance
Response Code Description
200 OK
400 Missing parameters or invalid field type
401 Invalid Username or password
402 Insufficient SMS credit
403 SMS API not enabled, requested IP not whitelisted or not enabled
405 Invalid Msg Type
406 WhatsApp message content is not approved, please submit your WhatsApp message content for approval
412 Account suspended / Terminated / Not activated
500 Internal server error
DELIVERED Message successfully delivered to the mobile handset
UNDELIVERED Message failed to be delivered to the mobile handset
Example of HTTP response returning:
Example of HTTP response returning with parameter 'detail=1':
Example of HTTP response returning with multiple recipients (notice that msg reference ID is longer):
Example of HTTP response returning with multiple recipients and parameter 'detail=1':

Delivery Notification (DN)

Delivery Notification is the final status of your SMS 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:

Three parameters returns as below:
# Parameter Description Example
1 status Real-time DN Status DELIVERED or UNDELIVERED
2 error-code Error Details. Optional, we wouldn't return this parameter if non has return from Telco 000 or 50
3 msisdn MT recipient mobile number 60123240066
4 msgid The Reference ID enables client to tie the DN with the MT sent 5515023

Note:
- The total number of DNs returned will be based on the number of SMS 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 SMS (might happen for concatenated SMS), always consider the last DN received as the final DN.
- Depending on Telcos' configuration, retries attempt might be prolonged for 36 to 48 hours if cell phone is unreachable.

Error Code Description
000 No Error
50 Unknown Error / Not specific
501 Absent subscriber
502 Handset memory capacity exceeded. Handset has run out of free memory to store new message
503 Equipment protocol error
504 Equipment not equipped with short-message capability
505 Unknown subscriber. The IMSI is unknown in the HLR
506 Illegal subscriber. The mobile station failed authentication
507 Teleservice not provisioned. Mobile subscription identified by the MSISDN number does include the short message service
508 Illegal equipment. IMEI check failed, i.e. the IMEI is either black listed or not white listed
509 Call barred. Operator barred the MSISDN number
510 Facility not supported. VLR in the PLMN does not support MT short message service
511 Subscriber busy for MT short message
512 System failure. Task cannot be completed because of a problem in another entity
513 Data missing. Necessary parameter is not present in the primitive
514 Unexpected data value. Necessary data is badly formatted in the primitive
515 Unidentified subscriber
516 Absent subscriber. No paging response
517 Absent subscriber. IMSI detached
518 Absent subscriber. Roaming restriction
547 Application context not supported
550 Temporary error received from peer SMSC
551 SMS malformed. SMS is not formed correctly. This error is specific to IP-based protocols like SMPP
552 SMS expired
553 Insufficient credit. The user has insufficient credit/not allowed to send to that destination
554 Invalid destination. Receiver is not a valid number
555 Unable to find outbound route for this SMS
556 SMS buffered
557 Timeout waiting for response from peer
558 Throttling error. The user has exceeded allowed message limit
561 Subscriber blacklisted
562 Subscriber not white listed
569 Invalid sender ID
571 Subscriber opted out from receiving SMS
574 SMS rejected. Error received from peer SMSC
575 SMS rejected. Inappropriate SMS content
576 Sender ID blacklisted
577 Sender ID not while listed