Bulk360 sms mt api v1
0 likes216 views
The Bulk360 SMS API document provides developers with a guide for integrating SMS services, detailing how to send normal and Unicode messages, manage delivery notifications, and interpret response codes. It outlines the required parameters for making requests and instructs users to utilize the POST method for sending texts. Additionally, it explains the API's functionality for tracking message delivery and generates real-time reports via the associated CRM platform.
Bulk360 sms mt api v1
- 1. AUG 2014 | V1.0
- 2. 2 | P a g e Document Revision History Version Date Author Description 1.0 26/08/14 Mark Khor Initial Version
- 3. 3 | P a g e Table of Contents Document Revision History ................................................................... 2 Table of Contents .............................................................................. 3 Glossary........................................................................................... 4 1. Introduction ................................................................................ 5 2. Sending Normal Text Messages ....................................................... 6 3. Sending Unicode (UCS2) Messages (Multilingual) ............................... 7 4. Delivery Notification (DN) ............................................................... 8 5. Response Code............................................................................ 9
- 4. 4 | P a g e Glossary Terms Definition API Application Protocol Interface The interface that a computer system, library or application provided in order to allow requests for services to be made out of it by other computer programs, and/or to allow data to be exchanged between them. Client Content Provider (CP) 360 360 Interactive MT Mobile Terminating Refers to a message being sent to a mobile handset. The message is TERMINATED at the mobile/cellphone end DN Delivery Notification An information returns that contain the delivery status of the message sent
- 5. 5 | P a g e 1. Introduction This Bulk360 SMS API document is specifically designed for developers and implementers with instructions to integrate Bulk360 SMS services into various solutions using Bulk360 SMS HTTP API. 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. This document will cover the following areas of connectivity: • Sending normal text messages • Sending UNICODE (UCS2) messages (Multi lingual) • Sending MMS (V2.0) • Delivery Notification (V1.1) • Response Code 360 Interactive offers real-time transaction reports via our 360CRM platform: http://crm.360-creation.com/
- 6. 6 | P a g e 2. Sending Normal Text Messages In order to send normal text messages / MT (Mobile Terminating), all POST / GET request shall be submitted to following URL: http://54.254.251.99/360crm/gw/bulk360.aspx Parameters listed below are required to request to send a successful text message No Parameter Name Description Example 1 user Username will be provided once account is activated user001 2 pass Account password, this password may be changed under 360CRM platform pass001 3 type Transaction type 0 = normal message 5 = Unicode message 6 = MMS message 0 4 to Recipient’s mobile number in international format (without the “+” sign) 60121234567 5 from The source name or sender’s number. ADMINDEPT 6 text The content of the message Message from 360 Gateway 7 servid The service ID Bulk360 Example of GET request based on above sample value: http://54.254.251.99/360crm/gw/bulk360.aspx?user=user001&pass=pass001&type=0&t o=60121234567&from=ADMINDEPT&text=Message from 360 Gateway&servid=Bulk360 Note: 1. Bulk360 SMS API will return 3 values as specified in Chapter 4 Delivery Notification The 3 parameters are: • status – The real-time delivery notification • msisdn – The mobile number of the recipient when MT is sent • msgID – The reference id returned to the application when MT is sent 2. In accordance to the Malaysian Telco guidelines, where sending to Malaysia prefix (60) is concerned, the system will auto append “RM0.00” at the beginning of the SMS. This will consume 7 characters (i.e., RM0.00<space>) from the total characters count of the message & credits will be deducted accordingly.
- 7. 7 | P a g e 3. Sending Unicode (UCS2) Messages (Multilingual) In order to send normal text messages, all POST / GET request shall be submitted to following URL: http://54.254.251.99/360crm/gw/bulk360.aspx Parameters listed below are required to request to send a successful text message No Parameter Name Description Example 1 user Username will be provided once account is activated user001 2 pass Account password, this password may be changed under 360CRM platform pass001 3 type Transaction type 0 = normal message 5 = Unicode message 6 = MMS message 5 4 to Recipient’s mobile number in international format (without the “+” sign) 60121234567 5 from The source name or sender’s number. ADMINDEPT 6 text The content of the message Message from 360 Gateway 7 servid The service ID Bulk360 Example of GET request based on above sample value: http://54.254.251.99/360crm/gw/bulk360.aspx?user=user001&pass=pass001&type=5&t o=60121234567&from=ADMINDEPT&text=Message from 360 Gateway&servid=Bulk360 Note: 1. Bulk360 SMS API will return 3 values as specified in Chapter 4 Delivery Notification The 3 parameters are: • status – The real-time delivery notification • msisdn – The mobile number of the recipient when MT is sent • msgID – The reference id returned to the application when MT is sent 2. In accordance to the Malaysian Telco guidelines, where sending to Malaysia prefix (60) is concerned, the system will auto append “RM0.00” at the beginning of the SMS. This will consume 7 characters (i.e., RM0.00<space>) from the total characters count of the message & credits will be deducted accordingly.
- 8. 8 | P a g e 4. Delivery Notification (DN) 1. For real-time transaction reports, please login to http://crm.360-creation.com with the assigned user name and password. 2. Alternatively, upon request, DNs may be forwarded to your DN URL in real time in the following format: http://www.yourdomainDNurl/receive.aspx The three parameters that will be needed as below: No Parameter Name Description Example 1 status The real-time status DELIVERED 2 msisdn The mobile number of the recipient that MT is sent 60121234567 3 msgID The reference id returned to the application when MT is sent 51530 Example of GET request based on above sample value: http://www.yourdomainDNurl/receive.aspx?status=DELIVERED&msisdn=60121234567 &msgID=51530 Note: 1. 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.
- 9. 9 | P a g e 5. Response Code Response Code Description 200 OK 400 Missing parameters or invalid field type 401 Invalid User name or password or ServID 402 Insufficient SMS credit 405 Invalid Msg Type (only applicable for message type 0, 5 & 6 for all countries. Malaysia's 6 series short code does not support Message type 6). 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. ACCEPTED Message has been delivered to SMSC (Short Messaging Service Centre). PROCESSING Message is yet to be delivered to SMSC, and still on queue at MK gateway.