Professional Documents
Culture Documents
0
File Upload Interface Guide
v1.0
Client: Idea
Reference:BulkSMS3.0-File Upload Interface Guide1.0-Idea
Confidentiality Statement
Copyright © 2009-2010, Bharti Telesoft Ltd. All rights reserved. This product or document may not, in
whole or in part, be copied, photocopied, reproduced, translated, or reduced to any electronic medium
or machine readable form, by any means electronic, mechanical, photographic, optic recording or
otherwise without prior consent, in writing, of the copyright owner. Statutory declaration under section
52A of the Copyright Act 1957.
i
Restrictions and Copyright Declaration
The information in this document is subject to change without notice and describes only the product defined in the introduction of this
documentation. This document is intended for the use of prospective Bharti Telesoft customers for the sole purpose of the agreement under
which the document is submitted. No part of it may be reproduced or transmitted in any form or means without the prior written permission of
Bharti Telesoft. The intended audience for this document is professional personnel, who assume full responsibility for using the document
appropriately. Bharti Telesoft welcomes customer comments as part of the process of continuous development and improvement of its
documentation. The information or statements given in this document concerning the suitability, capacity, or performance of the mentioned
hardware or software products cannot be considered binding, but shall be defined in contextual specific eventual agreement made between Bharti
Telesoft and the customer.
However, Bharti Telesoft has made all reasonable efforts to ensure that the instructions contained in the document are adequate, sufficient and
free of material errors and omissions. Bharti Telesoft will, if necessary, explain issues, which may not be covered by the document. Bharti
Telesoft’s liability for any errors in the document is limited to the documentary correction of errors. Bharti Telesoft will not be responsible, in any
event, for errors in this document or for any damages, incidental or consequential, including monetary losses, that might arise from the use of this
document or the information in it.
This document and the product it describes are considered protected by Patent, Copyright and Trademark laws in accordance with relevant
Indian laws.
The only warranties for Bharti Telesoft products and services are set forth in the express warranty statements accompanying its products and
services. Nothing herein should be construed as constituting an additional warranty. Bharti Telesoft shall not be liable for technical or editorial
errors or omissions contained herein.
The Bharti Telesoft logo is a registered trademark of Bharti Telesoft Ltd. Other product names mentioned in this document may be trademarks of
their respective companies and they are mentioned for identification purposes only.
Copyright © 2009Bharti Telesoft Ltd. All rights reserved.
Document Overview ................................................................................................................................. 1
Introduction .............................................................................................................................................. 3
iii
3.7.13 ERROR: 716 - FILE DOESN’T HAVE A <END> TAG ............................................................................. 25
3.7.14 ERROR: 718 - THERE SHOULDN’T BE ANY LINE AFTER <END> TAG ................................................... 25
3.7.15 ERROR: 721 - INVALID TAG $TAG AT <LINE_NO> ........................................................................... 25
3.7.16 ERROR: 723 - MESSAGE IS NOT BINARY THOUGH MESSAGE TYPE IS B............................................... 26
3.7.17 ERROR: 724 - MOBILE NUMBER TAG N: SHOULD NOT BE SPECIFIED AT LINE 1 .................................... 26
3.7.18 ERROR: 728 - ACCOUNT IS CROSSING THE RATE LIMIT <RATE_LIMIT> YOU ARE LEFT WITH ONLY
<REMAINING QUOTA> MESSAGES ....................................................................................................................... 26
3.7.19 ERROR: 729 - THE SCHEDULED DATE IS GREATER THAN THE ACCOUNT EXPIRY DATE!....................... 27
3.7.20 ERROR: 733 - ONLY 1,00,000 MESSAGES CAN BE UPLOADED PER JOB ............................................. 27
3.7.21 ERROR: 736 - VALIDITY PERIOD IS GREATER THAN 1 WEEK ............................................................... 27
3.7.22 ERROR: 737 - DUPLICATION OF TAG<TAG_NAME> ............................................................................ 27
3.7.23 ERROR: 738 - DELIVERY DATE IS GREATER THAN ONE YEAR AT <LINE_NO> ...................................... 28
3.7.24 ERROR: 740 - INVALID FORMAT 1 TYPE FILE .................................................................................... 28
3.7.25 ERROR 741 INVALID FORMAT 2 TYPE FILE ....................................................................................... 28
Contact Us .............................................................................................................................................. 31
v
vi
vii
1
Document Overview
This chapter gives a brief introduction to the scope and organization of this manual.
1.1 Scope
This document describes the procedure to use various interfaces supported by Bulk SMS.
1.2 Conventions
Click OK to continue.
Warning Message
Notes
Document Overview 1
Interface Guide: BulkSMS – 3.0
2 Document Overview
2
Introduction
2.1 Overview
Bulk Short Message Service (Bulk SMS), as the name suggests, is designed for mass
message delivery. An intermediary gateway between applications and the SMSC, Bulk Short
Message Service is designed to cater to high-volume, high-throughput requirements of
application-to-person (A2P) messaging over the mobile network. Bulk SMS accepts incoming
messages from authorized applications over interfaces such as FTP, CIMD, SMPP, HTTP
and based on predefined business rules directs the messages to the least congested SMSC
on the network. By balancing traffic over multiple SMSCs, Bulk SMS scales existing network
capacity, prevents network overloads and ensures secure, accelerated and optimized delivery
of application messages over the network.
Introduction 3
3
File Upload Interface
File Upload Interface supports manual submission of messages to Bulk SMS web interface.
Clients can manually upload a single message to multiple destinations or personalized
messages to multiple destinations. The message file has to be formatted in accordance with
predefined specifications. The product is intended for clients who can build up a text file
based on an existing database of recipients. As soon as the file is successfully transferred,
Bulk SMS responds with a job ID. The job ID could later be used for referring the status of
each message on the Bulk SMS GUI.
3.1 Features
Bulk SMS supports the following features over the File Upload Interface:
Text Messaging
Clients can send text messages over the File Upload interface.
Binary Messaging
Clients can send binary messages like a ring tone or a logo over the File
Upload interface.
Single Message to Multiple Destinations
Clients can send a single message to multiple recipients over the File
Upload interface.
Personalized Messages to Multiple Destinations
Clients can send personalized messages to multiple recipients over the File
Upload interface.
Multi-lingual Messaging
Clients can send messages in English and other languages over the File
Upload interface.
Deferred Delivery of Messages
Clients can schedule message delivery to a later date over the File Upload
interface.
Content Filtering
Bulk SMS filters the message content for censored words.
Login account users can transmit a single message to multiple destinations using the file
format 1.
The following table lists the mandatory and optional parameters for the header and the body
in file format 1.
F Format Type M X 1
I Protocol O X 1 to 255
Identifier
Tag:Value
Example
Format Type
F:1
First Delivery attempt
D:31072001152000
D:12082001115500
Type of message
T:T
T:B
Absolute format
ddmmyyyyhhmiss
where, dd=date, mm=month, yyyy=year, hh=hour, mi=minute,
ss=second
Example
F:1 M:This is a test message V:25112005153000
<START>
919845065683
919845032999
<END>
Relative format
Numeric value in the range 0-255.
Example
F:1 M:This is a test message V:15
<START>
919845065683
919845032999
<END>
Example
F:1 M:This is a test message D:25112005153000
<START>
919845065683
919845032999
<END>
Arabic Messages
Specify the following parameters to send an Arabic message:
T:U
C:8
Example
F:1
M:06340633064A06280633064A0628062806340633064A06280633062806
33064A06280633064A06280633064A062806340633064A06280633062806
280633064A06280633064A06280633064A06280633064A06280633062806
33063306280633064A06280633064A06280633064A06280633064A062806
3306280633064A06280633064A0628063406330628 T:U C:8
<START>
919845071843
919845447256
Binary Messages
Specify the following parameters to send a binary message like a ring tone or a logo:
C=8
U:(binary data header)
T=B
Example
F:1
M:024A3A59059D8591BDBC0400391C938C32C2A82AC2AC2A82AC2AC2AC2A
C28C2AC2E834C2EC28828C28C2882828C28C28C24C28C2A8000
U:06050415810000 T:B
<START>
919845071843
919845447256
<END>
Login account users can transmit multiple messages to multiple destinations using the file
format 2.
The following table lists mandatory and optional parameters for the header and the body in
file format 2.
F Format Type M X 1
Relative: 1 – 165
Absolute:
DdMmYyyyHhMi
Ss
Tag:Value
Example
Format Type
F:1
Type of message
T:T
T:B
Absolute format
ddmmyyyyhhmiss
where, dd=date, mm=month, yyyy=year, hh=hour, mi=minute,
ss=second
Example
F:2
<START>
M:Test message N:919845065683 V:25112005153000
M:Hello! N:919845032999 V:23122005153000
<END>
Relative format
Numeric value in the range 0-255.
Example
F:2
<START>
M:Test message. N:919845065683 V:15
M:Hello! N:919845032999 V:12
<END>
Messages for Deferred Delivery
Specify the First Delivery Attempt time for deferred message delivery.
Example
F:2 D:25112005153000
<START>
M:This is a test message N:919845065683
M:This is a test message N:919845032999
<END>
Arabic Messages
Specify the following parameters to send an Arabic message:
T:U
C:8
Example
F:2
<START>
M:06340633064A06280633064A0628062806340633064A06280633062806
33064A06280633064A06280633064A062806340633064A06280633062806
280633064A06280633064A06280633064A06280633064A06280633062806
33063306280633064A06280633064A06280633064A06280633064A062806
3306280633064A06280633064A0628063406330628 N:919845071843
T:U C:8
<END>
Binary Messages
Specify the following parameters to send a binary message like a ring tone or a logo:
C=8
U:(binary data header)
T=B
Example
F:2
<START>
M:024A3A59059D8591BDBC0400391C938C32C2A82AC2AC2A82AC2AC2AC2A
C28C2AC2E834C2EC28828C28C2882828C28C28C24C28C2A8000
N:919845447256 U:06050415810000 T:B
M:024A3A59059D8591BDBC0400391C938C32C2A82AC2AC2A82AC2AC2AC2A
C28C2AC2E834C2EC28828C28C2882828C28C28C24C28C2A8000
N:919880085656 U:06050415810000 T:B
<END>
3.4.1 Login
Connect to Bulk SMS Web Interface. The URL for connecting to Bulk SMS Web
Interface is as follows:
http://<ip_address>:<port>
where,
ip_address refers to the IP address of Bulk SMS server.
port refers to the HTTP port on the Bulk SMS server.
Example
http://172.16.1.12:91
Bulk SMS returns the following web page:
Login to File Upload Interface. (See Section 3.4.1 of Bulk SMS Interface Guide for
more information).
Click “Browse”.
Click “Upload”.
Bulk SMS returns the number of messages left, out of the quota assigned to the
login account and a job ID that can be used later to check job status.
(See Section 3.5 of Bulk SMS Interface Guide for more information on
Checking Job Status).
3.4.3 Logout
Click “Search”.
You can suspend or delete a job only if Bulk SMS has not yet concluded it.
Admin account user can allow binary messaging to a login account user only if the admin
account has the binary messaging privilege.
If the admin account does not have the privilege for binary messaging, admin account user
should contact the operator to obtain permission for binary messaging.
You cannot set the “Message Size” to a value greater than the “Maximum Message Size”
allotted to your admin account.
Contact the operator to increase the maximum allowed message size for your admin account.
(See Section 3.3 of Bulk SMS Interface Guide for more information on Web file formats).
(See Section 3.4.2 of Bulk SMS Interface Guide for more information on file upload).
Possible Reason
Web login account user has included text after the <END> tag in the job file.
Click “Done”.
Bangalore Office
Bharti Telesoft Ltd.
Maruti Towers
138, Airport Road
Bangalore – 560 008
INDIA
Tel: +91 80 4030 1550
Fax: +91 80 4115 0552
Mumbai Office
Unit No1234, Ist Floor
Paradigm Tower, Tower B
Mindspace, Off New Link Road
Malad-West – 400064
India
Tel: +91 22 40774300
Fax: +91 22 40774333
Contact Us 31