Scribd
Upload
54 views

Ims Answerit HTTP Gateway API

The document describes an HTTP interface for an SMS gateway. It will use a web servlet and backend processing module to provide a HTTP GET request interface for incoming and outgoing messages. It lists the server connection details and parameters in the query string including username, password, phone number, message, network, unique ID, and timestamp. An example URL and possible responses are provided.

Uploaded by

Daud Suleiman
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
54 views

Ims Answerit HTTP Gateway API

The document describes an HTTP interface for an SMS gateway. It will use a web servlet and backend processing module to provide a HTTP GET request interface for incoming and outgoing messages. It lists the server connection details and parameters in the query string including username, password, phone number, message, network, unique ID, and timestamp. An example URL and possible responses are provided.

Uploaded by

Daud Suleiman
Copyright
© © All Rights Reserved
Available Formats
Download as DOC, PDF, TXT or read online on Scribd
You are on page 1/ 2

1.

IMS HTTP Interface Specification


1.1. Overview
The SMS Gateway will provide a HTTP interface into the system for online votes. This
interface will consist of a web servlet transceiver and a back-end processing module. In case
of two way communication, both will be required on the client and IMS side.

Technically, the HTTP interface will process a normal HTTP GET request for both incoming
and outgoing messages.

1.2. Connection Info


The table below lists the connection details for the IMS SMS Gateway HTTP interface.

Description Value
Server IP 41.215.137.246 (primary), 41.220.121.82 (secondary)
Port 80
User Name ansrit
User Password Webvt2013
Send URL http://41.215.137.246/answerit/receive.php
or
http://41.220.121.82/answerit/receive.php

1.3. Query String Parameters


The Query String part of the request URL must include a list of parameters, which will be
either passed to the processing module or parsed before the URL is fetched. See the table
below for these parameters.

Parameter Data Types Description


usr [m] an 12 Username of the connection account. Specific for each
implementation.
paswd [m] ans 12 Password in the connection account. Specific for each
implementation.
msisdn [m] n 12 The phone number of the voter
message [m] ans 160 This is the contestant id of the vote e.g. Tusker 7, Tusker
15 e.t.c.
Network [m] a 2 Network Code i.e.
MTNRW - MTN
TIGRW - TIGO
AIRRW - AIRTEL
uniqueid [m] n 12 The Unique ID of the internal message structure. Only
used if the service provider needs an identification of the
original message.
datetime [m] n 16 The timestamp the message was initially received,
formatted as "YYYY-MM-DD HH:MM", e.g., "2012-05-21
14:18". Only used if extensive audit trail is required.

The following notation conventions have been used:

a Alphabetic characters, A through Z and a through z


n Numeric digits, 0 through 9
an Alphabetic and Numeric characters
ans Alphabetic, numeric and special characters
[m] Mandatory field
[o] Optional field

1.4. Example
A typical URL containing a query string is as follows:

Messages from Answerit to IMS

The structure is decided by the client based on the variables discussed above or based on
the client’s model. This can be modified to suit the client

http://41.215.137.246/answerit/receive.php?
usr=<username>&paswd=<password>&msisdn=<mobile
number>&message=<contestant id >&network=< network>&uniqueid=<Unique ID
>&datetime=< TimeStamp>

Live Example

http://41.215.137.246/answerit/receive.php?
usr=ansrit&paswd=webvt2013&msisdn=254733590665&message=Tusker
10&network=MTNRW&uniqueid=123456799&datetime=2012-05-11 12:00

http://41.215.137.246/answerit/receive.php?
usr=ansrit&paswd=webvt2013&msisdn=251733590665&message=Tusker 7&
network=MTNRW&uniqueid=654987&datetime=2012-05-11 12:00

Possible responses:

FAILED - INVALID CONTESTANT NUMBER


FAILED - INVALID COUNTRY ID
FAILED - INVALID USERNAME
FAILED - INVALID PASSWORD
FAILED - POST DB ERROR

COMPLETE

You might also like