Bulletin Connect - Examples - Public

HTTP API Examples

The following examples use HTML Form Encoding to send messages to the Bulletin Connect server.

Sample HTML Code

Basic HTML Form

This is a very basic HTML form that contains the minimum number of inputs required to send a message.

<!-- URL for SENDING messages only must use POST method-->
<form name="sendSMS" action="http://service.bulletinconnect.net/api/1/sms/out" method="post">

<!--Enter recipient in INTERNATIONAL format-->
   <input value="[number INTL format]" name="to">
   <br>

<!--Message BODY will be form ENCODED-->
   <textarea name="body" rows="4" cols="30">
      [Message Content]
   </textarea>

   <input type="reset" value="Clear">
   <input type="submit" value="Send">
</form>

This sample is intended for informational and testing purposes only. It can not be used on a public web page as your Bulletin Connect userId and password must be entered when the form is submitted.

WAP Push

The following sample can be seen in action here.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- saved from url=(0054)http://service.bulletinconnect.net/demo/indicator.html -->
<html>
<head>
    <title>Indicator</title>
    <script type="text/javascript">
        function pick() {
            var form1 = document.forms[0];
            var index = form1.s1.selectedIndex;
            form1.url.value = form1.s1.options[index].value;
            form1.subject.value = form1.s1.options[index].text;
        }

        function send() {
            var form1 = document.forms[0];
            var form2 = document.forms[1];
            var url = form1.url.value;
            var subject = form1.subject.value;
            var indication = '<si><indication href="' + url + '">' + subject + '</indication></si>';
            form2.body.value = indication;
            form2.to.value = form1.to.value;
            form2.submit();
        }
    </script>
</head>

<body onload="pick();">
<form action="javascript:send();">
    <table>
        <tr><td>To:</td><td><input type="text" name="to"></td></tr>
        <tr><td></td><td>
            <select id="s1" onchange="pick()">
                <option value="http://service.bulletinconnect.net/demo/news.xhtml">Breaking News</option>
                <option value="http://service.bulletinconnect.net/demo/mag-1.xhtml">New Issue: Woman's Day</option>
                <option value="http://service.bulletinconnect.net/demo/mag-2.xhtml">Headlines: Daily Telegraph</option>
                <option value="http://service.bulletinconnect.net/demo/indicator.html">Indicator Form</option>
                <option value="http://service.bulletinconnect.net/demo/toxic.xhtml">Download: "Toxic" by Britney Spears</option>
            </select>
        </td></tr>
        <tr><td>Sub:</td><td><input type="text" name="subject"></td></tr>
        <tr><td></td><td><input type="text" name="url"></td></tr>
    </table>

    <input type="submit" value="Send">
</form>


<form action="http://service.bulletinconnect.net/api/1/sms/out" method="POST">
    <input type="hidden" name="fragmentationLimit" value="0">
    <input type="hidden" name="contentType" value="application/vnd.wap.sic">
    <input type="hidden" name="body">
    <input type="hidden" name="to">
</form>

</body>
</html>

Example page

* use your bulletin connect ID and Password when prompted

Sample PHP Code

Simple Responder

This is a very basic PHP code to access Bulletin Connect from a PHP website

<?

/* Constants */
$bcUser = 'yourusernamehere';
$bcPass = 'yourpasswordhere';
$bcURL = 'http://service.bulletinconnect.net/api/1/sms/out';
$bcRatecode = FALSE;


/* Request parameters */
$phone = $_REQUEST['from'];
$request = $_REQUEST['body'];


/* Generate a reply - this is where you would hit the database */
$reply_id = 1;
$reply = "Hello $phone. I heard you say: $request";


/* Send the reply */
sendSMS($bcUser, $bcPass, $reply_id, $phone, $reply, $ratecode);


/* returns TRUE on success, FALSE on failure */
function sendSMS($user, $pass, $msgid, $recipient, $body, $ratecode = FALSE) {
	global $bcURL;
	
  $data = "userId=".urlencode($user)
    . "&password=".urlencode($pass)
    . "&messageId=".urlencode($msgid)
    . "&to=".urlencode($recipient)
    . ($ratecode ? "&rateCode=".urlencode($ratecode) : '')
    . "&body=".urlencode($body);

  $cUrl = curl_init();
  curl_setopt($cUrl, CURLOPT_URL, $bcURL);
  curl_setopt($cUrl, CURLOPT_HEADER, 'Content-type: application/x-www-form-urlencoded');
  curl_setopt($cUrl, CURLOPT_POST, 1);
  curl_setopt($cUrl, CURLOPT_POSTFIELDS, $data);
  curl_setopt($cUrl, CURLOPT_TIMEOUT, 30);
  curl_exec($cUrl);

  $code = curl_getinfo($cUrl, CURLINFO_HTTP_CODE);
        
  curl_close($cUrl);

  return ($code == 200 || $code == 204) ? TRUE : FALSE;
}

?>

Status Handler

The following sample can be used for retrieving status information if provided by Bulletin Connect.

<?

/* Request parameters */
$recipient = $_REQUEST['to'];
$my_id = $_REQUEST['inReplyToId'];
$status = $_REQUEST['statusCode'];
$error = $_REQUEST['error'];


/*	Do something with the status - this is where you would update the database

		Good statuses:
		SNT: Message passed to upstream carrier for delivery
		RCV: Message received on phone
		
		Bad statuses - check $error for further information
		ERR: Internal service error
		NUR: Number unreachable
		EXP: Message not delivered within allowable time period
*/


?>

Download

Download sample PHP client code here

Simple Message Sending and Receiving

Copy and paste the following code example to your local machine, substituting your username and password in the relevant method calls in main(). The following code example sends a message to Bulletin Connect, then requests a status message, then finally checks for an incoming message.
Change the code as necessary to loop through incoming messages and status messages until the queue is cleared. Alternatively break the code into distinct sections that can be used independantly.

package com.bulletinwireless.eg;

import sun.misc.BASE64Encoder;

import java.io.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.net.URLEncoder;

/**
 * SMS send example.
 */

public class SimplePost {
    public static void main(String[] args) throws IOException {
        int result = send("username", "*password*", "642......", "hello, world.");
        System.out.println("Result code: " + result);

        result = status("username", "*password*");
        System.out.println("Status result code: " + result);

        result = receive("username", "*password*");
        System.out.println("Receive result code: " + result);
    }

    /**
     * Send an sms message.
     *
     * @param user Bulletin Connect user name
     * @param pass Bulletin Connect password
     * @param to the number to send the message to
     * @param body the message
     * @throws IOException if the HTTP POST fails
     * @return the HTTP result code
     */

    public static int send(String user, String pass, String to, String body) throws IOException {
        URL url = new URL("http://service.bulletinconnect.net/api/1/sms/out");
        HttpURLConnection con = (HttpURLConnection) url.openConnection();
        try {
            con.setRequestMethod("POST");            
            con.setRequestProperty("Authorization", encodeBasicAuth(user, pass));
            con.setDoOutput(true);
            
            OutputStream out = con.getOutputStream();
            String form = "to=" + to + "&body=" + URLEncoder.encode(body, "UTF-8");
            try {
                out.write(form.getBytes("US-ASCII"));
            } finally {
                out.close();
            }
            return con.getResponseCode();
        } finally {
            con.disconnect();
        }
    }

    /**
     * Recieve an sms message.
     *
     * @param user Bulletin Connect user name
     * @param pass Bulletin Connect password
     * @return the HTTP result code
     */

   public static int receive(String user, String pass) throws IOException {
        URL url = new URL("http://service.bulletinconnect.net/api/1/sms/in");
        HttpURLConnection con = (HttpURLConnection) url.openConnection();
        try {
            con.setRequestProperty("Authorization", encodeBasicAuth(user, pass));
            return con.getResponseCode();
        } finally {
            con.disconnect();
        }

    }

    /**
     * Receive an sms status message.
     *
     * @param user Bulletin Connect user name
     * @param pass Bulletin Connect password
     * @return the HTTP result code
     */

   public static int status(String user, String pass) throws IOException {
        URL url = new URL("http://service.bulletinconnect.net/api/1/sms/status");
        HttpURLConnection con = (HttpURLConnection) url.openConnection();
        try {
            con.setRequestProperty("Authorization", encodeBasicAuth(user, pass));

            System.out.println(convertInputStreamToString(con.getInputStream()));

            return con.getResponseCode();
        } finally {
            con.disconnect();
        }

    }

    /**
     * Convert an InputStream into a String
     * @param inputStream An InputStream
     * @returns the contents of the stream as a String.
     */
    public static String convertInputStreamToString(InputStream inputStream) throws IOException {
        DataInputStream dis = new DataInputStream(inputStream);
        String inputLine;
        StringBuffer stringBuffer = new StringBuffer();

        while ((inputLine = dis.readLine()) != null) {
            stringBuffer.append(inputLine);
        }

        return stringBuffer.toString();
    }

   public static String encodeBasicAuth(String user, String pass) throws UnsupportedEncodingException {
        byte[] credentials = (user + ':' + pass).getBytes("US-ASCII");
        return "Basic " + new BASE64Encoder().encode(credentials);
    }
}

Sample Classic ASP code

The following is a simple example of building and submitting a wap push by HTTP post to Bulletin Connect using Classic ASP

The ASP code

'XML HTTP Post Code - ASP
'Declare variables
dim phone, strserveraddress, strserverstring, message

'Declare Service Indicator message variable
message = "<si><indication href="url to content">Subject for Service Message</indication></si>"

'Encode the message
message = server.urlencode(message)

'Complete the necessaries
phone = "012345678901"

strServerAddress = "http://service.bulletinconnect.net/api/1/sms/out?"

'Build up the posted string
strServerString = "userId=abc01"
strServerString = "&password=123456
strServerString = "&contentType=application/vnd.wap.sic"
strServerString = "&fragmentationLimit=0"
strServerString = "&to=" & phone 
strServerString = "&body="& message


'Perform the XML HTTP Post
Set xml = Server.CreateObject("MSXML2.ServerXMLHTTP")

strExecute = strServerAddress & strServerString
xml.Open "POST", strExecute, false

xml.send

'Get response back from the server
strReturnValue1 =  xml.responseText


set xml = Nothing

The result

The resulting string posted to the server will be similar to this:

http://service.bulletinconnect.net/api/1/sms/out?userID=abc01&password=123456&to=447777777777&fragmentationLimit=0&ContentType=application/vnd.wap.sic&body=%3Csi%3E%3Cindication%20href%3D%22http%3A%2F%2Fwww.test.com%2Fcontent%2Fwap.html%22%3EMy%20Message%3C%2Findication%3E%3C%2Fsi%3E

SOAP API Examples

The following examples use the deprecated SOAP service to send messages to the Bulletin Connect server.

Sample .NET Code

Consuming The Bulletin Connect Web Service

The easiest way to connect to the Bulletin Connect Web Service is to create a proxy. A proxy is a substitute, or local stand-in, for the web service.
Once the proxy is created and registered with the consuming application, then method calls can be made against the web service. In actuality those method calls will be made against the local proxy. It will seem to the consuming application that the web service is local to the application.

The .NET Framework takes care of all the intricacies of consuming web services by enabling the creation of proxies, with no need to fixate on the underlying plumbing.

Download the attached zip file and familerize yourself with the readme documents.

Download

Download sample .NET code here

Sample PERL Module

Accessing Bulletin Connect from a Perl script

Download the BulletinConnect directory to your application directory and 'use' the objects as shown in the perlsms.pl script below.

The Bulletin Connect client is written using the SOAP::Lite library available from
CPAN.

#!perl -w	

use BulletinConnect::BulletinConnect;
use BulletinConnect::BulletinServer;
use BulletinConnect::Message;

# Create proxy instance to server
#$server = BulletinServer->new;
$connect = BulletinConnect->new;

$messages = $connect->receive("My App", 0);

foreach my $msg (@$messages) {
	print "Received message: " . $msg->prettyprint . "\n";
}


# Populate a new message object
$message = Message->new;
$message->to("phone_to_send_to");
$message->messageId("message_id");
$message->body("Test from Perl");

# Send message

$connect->sendMessage("MyApp", 0, $message);

# Override the credentials checking routine and supply the required user/pass
# I realllly hate this method of handling authentication.
sub SOAP::Transport::HTTP::Client::get_basic_credentials {
	return 'username' => 'password';
}

Download

Download sample PERL module here

Unable to render {include} Couldn't find a page to include called: Bulletin Connect - Example Java API

Sample Java Web Application

Accessing Bulletin Connect with Java a Basic Web Application

Includes everything that you need to get started; the Bulletin Connect Java API, Apache Axis SOAP libraries, and the Apache Xerces XML parser

Download

Download sample Java example here