Sei sulla pagina 1di 11

GENERATION OF VIRTUAL NUMBER

FOR B2B and B2C WEBSITES

Synopsis submitted in partial Fulfillment of the requirement

Front page

Attendance record

Acknowledgement

1.1 Purpose This specification document describes the capabilities and functionalities that will be provided by application API For Generation of Virtual Numbers for Websites.It also states the various required constraints bt which the system will abide.The intended audience for this document are the development team and end users of the product. 1.2 Scope The API product will be an application that will be used to generate the virtual number against users submitted original numbers. The API (Application Programmable Interface) will communicate with website and get users request to generate virtual number. This request will be passed to IVR System, which will generate and assign anew unique virtual number against users submitted original number.API will also generate reports like number of calls done on a particular Virtual number, by a virtual number, call duration will be send to website from IVR system using this API.Any transfer of data between websites and IVR system will be carried by API only. This API will greatly simplify the process to share the virtual numbers among webites and other internet enabled applications. 1.3 Definitions Acronyms And Abbreviations Following abbreviation have beeen used throught this document: API: Application Programmable Interface IT: Information Technology IVR: Integrated Voice Recognition PHP: Hypertext Preprocessor(Personal Home Page) REST: Representational State Transfer SOAP: Simple Object Access Protocol 1.4 References (books) 1. 2. 1.5 Overview The rest of this document describes the various system requirements, interfaces , features and functionality of PHP, MySQL database and APIs. Professional Web APIs by Paul Reinheimer. Pro.PHP.XML.and.Web.Services by Apress.

Overall Description

The API would connect the existing system with website to generate the virtual numbers that are mapped to users real mobile number.This numbers would be generated as per their availabilitywith the owing company.According to the users choice Secured virtual number,temporaryvirtual number, VIP virtual number can be allotted. Also demanding organization can demand pool of virtual numbers for their own private use.Using this API details such as Call history and details such as Call duration, Call cost, Calling number, Date and time can be pulled from IVRs database.

2.1 Product Functions This API can be used by websites that are build on PHP, and since this is an API its not restricted to any particular individual website.This API can be used by websites who want to integrated themselves with IVR systems.

Summary of the major function that API will perform. Based on the users request API will accept the request to generate the new virtual number. Authentication check will be performed on generated request. Users nature of request will be identified (general or special). Based on the availability from the pool of numbers and new random number will generated and mapped with users original phone number. After allotting the number it will taken off from the available pool of numbers and be added to the currently allocated pool of numbers.

Different notification will be send to the registered users in the form of text and emails to the contacts. For special numbers request,users requested numbers will be checked in the pool of availability numbers and the rest of the procedures would remain the same. Information details about the calls can be extracted from the IVR system on users request.

2.2 User characteristics Educational level : A computer and Internet literate is required. Experience : Should have basic experience with Internet and social networking websites. Technical Expertise : Should be comfortable with the general purpose applications on a computer.

2.3 Constraints

3 Specific Requirements This section contains software and hardware requirements to level of detail sufficient to enable designers to design the system, and testers to test that system

3.1 External Interface Requirement 1. User Interface : A web page were user need to enter his original number and get new virtual number. A textbox will be provided were user has to enter his original number. A Button will be provided to submit users request for geneartion of virtual numbers. This button will get enabled after accepting minimum 10 digits of users original phone number. API generated new virtual number will be displayed in a new text box. Another button can be provided for generation of user specified or v.i.p. number, as per availability. This additional functionality would be provided only to premium users, or at an additional cost.

Users Call Detail screen will be displayed

Users can view their call history, call cost on different web page. New notification message can be displayed on different web page. API configuration page for B2C and B2B websites

After admin successfully login in website control panel he can configure API according to its website specific requirements. Specific variables need to be assigned in API for its integration with websites.

2. Hardware Requirement : A computer or any portable device that can be connected to Internet at user's end. On the other end it shall be connected to web server and database, that can handle thousands of users at any given point of time 3. Software Requirement : For the API, mainly PHP would be used for the webpages that again are designed in PHP. Database and back-end are coded using MY SQL. The web pages can be viewed

on any browser viz. Microsoft's Internet Explorer, Apple's Safari, Mozilla Firefox, Google's Chrome, etc.We need offline WAMP server for hosting PHP applications.

4. Communication Requirement : An Internet Connection at user's end that may be connected using LAN card,or a MODEM or a Wi-Fi or any other connection medium. At server end 24/7 availability is expected, preferably a high speed access to all the hardware. So that the user can use his available bandwidth maximum.An IVR system will be connected with Lease Line that will be in-turn connected with telecom system.

3.2 System Features 3.2.1 APIs User requirements Description User will be provided with text box to enter its original phone number.After entering original number API will perform validity check functions,following this check it will ask for new virtual number from pool of numbers from its database.After getting new virtual number it will be displayed to user on web page.API will perform this whole communication using S-DES encryption.REST or SOAP services will be used for API transactions between website and IVR database. The system will allow creation,modification and deletion of new numbers and also have the ability to list all the available numbers for particular period.

Validity Checks As user enter its original number API will perform validity check for number,It should not have any other characters except numbers. No blank data will be accepted by API. User also need to enter the amount of period he want virtual number to be exist for him. User also have to submit its choice for special number or any other specific number. API will also check for uniqueness of virtual number. Sequencing Information Users number will be entered,it will select its choice of virtual number,after submitting its final request that particular number will assign to that user.

Error Handling / Response to abnormal situations

If any of the above validation/sequencing flow does not hold true.appropriate error message will be prompted to the user for doing the needful.

3.3 Design Constraints

3.3.1 API System Attributes Security: This API will used S-DES encryption algorithm,It will work with websites which run using SSL certificates and HTTPS protocol. Maintainability : API will use Object oriented approach,new class will be made and websites integrating with this API will use the objects of this class.As it uses Object oriented approach it will be easy to incorporate new requirements based on websites. Portability : The API will be easily portable with any websites which are made on PHP and support object oriented approach.

3.4 Logical Database Requirements The following information must be placed in the database USERID: Users id must be stored,this must be unique in database. USERNAME: Users name must be stored PASSWORD: Password will be stored in MD5 encryption format USER ORIGINAL NUMBER: Users original number will be stored USER VIRTUAL NUMBER: User new virtual number will be stored in numeric format USER CHOICE OF NUMBER: Users choice will be stored.

Schema Definition
Table Name:USER_REGISTRATION Sr. No. 1 2 3 4 5 6 7 Attribute User_id User_name User_address User_username User_orginalno User_proxyno User_choice Data Type Integer Varchar Varchar Varchar Integer Integer Integer Constraint Primary Key Not Null Not Null Not Null Not Null Not Null Not Null Domain {1,2,3.} 500 Characters 1000 Characters 15 Characters 10-15 digits 4-6 digits 2-4 digits

Table Name:USER_CALL_DETAILS Sr. No. 1 2 3 4 5 Attribute User_id Calling_number Call_duaration Call_date Call_cost Data Type Integer Integer Date/Time Date Integer Constraint Foreign Key Not Null Not Null Not Null Not Null Domain {1,2,3.} 10-15 digits 00:00:00 01-01-1901 2-6 digits

System Flow Diagram

API CLASS

Type of

Servic e

REST Services
Type of

SOAP Services Websit e

B2B Website

B2C Website

Type of

Operation s

ADD Original Number

New Virtual Number

Delete Virtual Number

Potrebbero piacerti anche