CA2337782C - Multi-service communication system and method - Google Patents
Multi-service communication system and method Download PDFInfo
- Publication number
- CA2337782C CA2337782C CA2337782A CA2337782A CA2337782C CA 2337782 C CA2337782 C CA 2337782C CA 2337782 A CA2337782 A CA 2337782A CA 2337782 A CA2337782 A CA 2337782A CA 2337782 C CA2337782 C CA 2337782C
- Authority
- CA
- Canada
- Prior art keywords
- service communication
- vod
- communication method
- phone
- endpoints
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Expired - Lifetime
Links
- 238000000034 method Methods 0.000 title claims abstract description 104
- 238000004891 communication Methods 0.000 title claims abstract description 101
- 230000006854 communication Effects 0.000 title claims abstract description 101
- 230000008569 process Effects 0.000 claims description 34
- 238000012545 processing Methods 0.000 claims description 34
- 230000004044 response Effects 0.000 claims description 5
- 230000003213 activating effect Effects 0.000 claims 15
- 238000004590 computer program Methods 0.000 claims 5
- 230000007175 bidirectional communication Effects 0.000 claims 1
- 230000006870 function Effects 0.000 abstract description 22
- 238000013515 script Methods 0.000 abstract description 12
- 230000010354 integration Effects 0.000 abstract description 5
- JAKVEOCMEMGHGB-YFKPBYRVSA-N (2r)-2-azaniumyl-3-prop-2-ynylsulfanylpropanoate Chemical compound OC(=O)[C@@H](N)CSCC#C JAKVEOCMEMGHGB-YFKPBYRVSA-N 0.000 description 53
- 101100150143 Homo sapiens SPRR3 gene Proteins 0.000 description 53
- 102100038979 Small proline-rich protein 3 Human genes 0.000 description 53
- 239000008186 active pharmaceutical agent Substances 0.000 description 21
- 230000008901 benefit Effects 0.000 description 4
- 238000010586 diagram Methods 0.000 description 4
- HTRJZMPLPYYXIN-UHFFFAOYSA-N 2-acetamido-3-[[4-[(2-acetamido-2-carboxyethyl)sulfanylcarbothioylamino]phenyl]carbamothioylsulfanyl]propanoic acid Chemical compound CC(=O)NC(C(O)=O)CSC(=S)NC1=CC=C(NC(=S)SCC(NC(C)=O)C(O)=O)C=C1 HTRJZMPLPYYXIN-UHFFFAOYSA-N 0.000 description 2
- 230000003190 augmentative effect Effects 0.000 description 2
- 239000003795 chemical substances by application Substances 0.000 description 2
- 230000006835 compression Effects 0.000 description 2
- 238000007906 compression Methods 0.000 description 2
- 230000000694 effects Effects 0.000 description 2
- 230000003993 interaction Effects 0.000 description 2
- 230000002452 interceptive effect Effects 0.000 description 2
- 238000010295 mobile communication Methods 0.000 description 2
- 238000012546 transfer Methods 0.000 description 2
- 230000002457 bidirectional effect Effects 0.000 description 1
- 230000000295 complement effect Effects 0.000 description 1
- 238000004883 computer application Methods 0.000 description 1
- 230000006837 decompression Effects 0.000 description 1
- 230000007812 deficiency Effects 0.000 description 1
- 238000005516 engineering process Methods 0.000 description 1
- 238000010348 incorporation Methods 0.000 description 1
- 230000000977 initiatory effect Effects 0.000 description 1
- 239000012092 media component Substances 0.000 description 1
- 238000007626 photothermal therapy Methods 0.000 description 1
- 229920002215 polytrimethylene terephthalate Polymers 0.000 description 1
- 208000019585 progressive encephalomyelitis with rigidity and myoclonus Diseases 0.000 description 1
- 230000009467 reduction Effects 0.000 description 1
- 230000001360 synchronised effect Effects 0.000 description 1
- 238000013519 translation Methods 0.000 description 1
Classifications
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04M—TELEPHONIC COMMUNICATION
- H04M7/00—Arrangements for interconnection between switching centres
- H04M7/12—Arrangements for interconnection between switching centres for working between exchanges having different types of switching equipment, e.g. power-driven and step by step or decimal and non-decimal
- H04M7/1205—Arrangements for interconnection between switching centres for working between exchanges having different types of switching equipment, e.g. power-driven and step by step or decimal and non-decimal where the types of switching equipement comprises PSTN/ISDN equipment and switching equipment of networks other than PSTN/ISDN, e.g. Internet Protocol networks
- H04M7/125—Details of gateway equipment
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04L—TRANSMISSION OF DIGITAL INFORMATION, e.g. TELEGRAPHIC COMMUNICATION
- H04L12/00—Data switching networks
- H04L12/66—Arrangements for connecting between networks having differing types of switching systems, e.g. gateways
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04M—TELEPHONIC COMMUNICATION
- H04M3/00—Automatic or semi-automatic exchanges
- H04M3/42—Systems providing special services or facilities to subscribers
- H04M3/428—Arrangements for placing incoming calls on hold
- H04M3/4285—Notifying, informing or entertaining a held party while on hold, e.g. Music On Hold
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04M—TELEPHONIC COMMUNICATION
- H04M3/00—Automatic or semi-automatic exchanges
- H04M3/42—Systems providing special services or facilities to subscribers
- H04M3/50—Centralised arrangements for answering calls; Centralised arrangements for recording messages for absent or busy subscribers ; Centralised arrangements for recording messages
- H04M3/53—Centralised arrangements for recording incoming messages, i.e. mailbox systems
- H04M3/533—Voice mail systems
-
- H—ELECTRICITY
- H04—ELECTRIC COMMUNICATION TECHNIQUE
- H04M—TELEPHONIC COMMUNICATION
- H04M3/00—Automatic or semi-automatic exchanges
- H04M3/42—Systems providing special services or facilities to subscribers
- H04M3/56—Arrangements for connecting several subscribers to a common circuit, i.e. affording conference facilities
Landscapes
- Engineering & Computer Science (AREA)
- Computer Networks & Wireless Communication (AREA)
- Signal Processing (AREA)
- Telephonic Communication Services (AREA)
- Data Exchanges In Wide-Area Networks (AREA)
Abstract
A multi-service communication system and method is disclosed which permits the integration of traditional PSTN functions and voice-over-IP/voice-over-data (VOIP/VOD) functions within the same communication system. The extension of scripting functions to support these features in general simultaneously permits the script to interact with PSTN and IP telephones within the context of the same services, to share the same service logic for both PSTN and IP media, to conference participants on both PSTN and IP, to store and forward information between the two media, to play on-hold media to the interface, and/or to monitor information between the two media. In general the disclosed invention is amenable to the integration of PSTN and VOIP networks, but other service functions may be integrated with no loss of generality.
Description
MULTI-SERVICE COMMUNICATION SYSTEM AND METHOD
Field of the Invention The present invention generally relates to public switched telephone networks (PSTN's) /
voice-over-IP telephony and particularly to the application of the extension of scripts to interact with PSTN and IP telephones within the context of the same services.
Background of the Invention Overview Today script based services are available to program interactive voice response devices when communicating with the public switched telephone network (PSTN). Today IP
networks are evolving and voice over IP telephony is being used for communication similar to that of PSTN
networks. The general problem with this scenario is that there is no common bridge to manage services that involved both PSTN and IP end-points in the same connection.
Description of the Prior Art For example, the IBM IVR platform Direct Talk (reference IBM Direct Talk for AIX, V2, R2: State Tables, Prompts and Voice Segments, SC33-1846, December 1998) provides the script language used for PSTN interaction. In the present invention the script needed for interacting with IP telephones was developed and uses the same script method as Direct Talk and can coexist.
Objects of the Invention Accordingly, the objects of the present invention are (among others) to circumvent the deficiencies in the prior art and affect the following objectives:
to extend the script to interact with PSTN and IP telephones within the context of the same services;
a. to share same service logic for both PSTN and IP media;
b. to conference participants on both PSTN and IP;
c. to store and forward information between the two media;
d. to play ON-HOLD media to with interface; and/or e. to monitor information between the two media.
While these objectives should not be understood to limit the teachings of the present invention, in general these objectives are achieved by the disclosed invention that is discussed in the following sections.
Brief Summary of the Invention Overview Referencing FIG. 1, in the present invention scripts have been extended to interact with PSTN
and IP telephones within the context of the same services. In, the present invention, the scalable PSTN gateway (104, 113, 123, 125) is a gateway that connects calls from a PC-based H.323 client application (102, 115) to the regular PSTN telephone system (105, 112, 122, 126). Inbound calls originating from the PSTN are connected through an IP connection (103, 114, 124) to a PC client application (102, 115). Outbound calls originating from a PC client application are sent through the gateway to the PSTN destination. In addition, as illustrated in FIG. 1, Voice Over Data (VOD) may provide an optional RISC-based solution for routing PSTN calls over a data network, allowing three types of voice connections:
PC-to-phone (100);
f. phone-to-PC (110); and/or g. phone-to-phone (120).
The gateway is scalable and has been reduced to practice to support up to 96 simultaneous calls, although any number is potentially realizable.
The following detailed discussion may serve as a guide for the VOD CS - Voice Over Data Custom Server and the SPN256 Port Resource Control Custom Server for VOD
(SPRC). These APIs developed for the VOD Custom Server serve as extensions to the DT (IBM's Direct Talk Interactive Voice Response System), i.e., they receive commands from the DT.
The Voice over Data custom server along with the DT form the basis of the scalabable PSTN Gateway.
This Gateway is a multi-service system and server that runs on the AIX operating system. While this system uses the AIX operating system, it is not limited to this and can be implemented on another operating system.
The multi-service system connects to the PSTN network. The multi-service system can also work without a telephone call. In addition, the multi-service system can service and IP call independently.
The set of exemplary state table APIs documented herein are designed as a DT
interface to the actual custom server functions which support a gateway capable of sending and receiving voice between a telephone PSTN interface card and the IP (Internet Protocol) network. Calls are generally controlled utilizing the H.323 standard. The SPRC is responsible for coordinating the SCBus connections between the DTQA (Direct Talk Quad Adapter) and the SPN256, managing resources of the SPN256 cards, allocating and deallocating them to the application. It is integrated with the DT Timeslot Manager, which uses Connection Servers to send low-level commands to the adapters sharing the SCBus (cable/logic standard for connecting time division multiplexed voice channels).
The operation of these APIs is designed especially for the requirements of the DT system, and are limited by its restrictions.
The VOD Custom Server is one component of a larger, more complex system and, in order to be able to use the VOD Custom Server, it is necessary to understand the DT
with all its built-in components as well as other custom servers, such as Time Slot Manager, and VOD
Gate Custom Server.
Exemplary Advantages Overall the present invention can in some exemplary embodiments provide one or more of the following advantages over the prior art. For example the IBM IVR platform Direct Talk (reference IBM Direct Talk for AIX, V2, R2: State Tables, Prompts and Voice Segments, SC33-1846, December 1998) provides the script language used for PSTN interaction.
In the present invention, the script needed for interacting with IP telephones was developed and uses the same script method as Direct Talk and can coexist with this application. A
description of those APIs follows.
Brief Description of the Drawings For a fuller understanding of the advantages provided by the invention, reference should be made to the following detailed description together with the accompanying drawings wherein:
FIG. 1 illustrates exemplary system embodiments of the present invention in PC-to-phone, phone-to-PC, and phone-to-phone applications;
FIG. 2 illustrates an exemplary system architecture diagram for the API
interfaces supporting the present invention teachings;
FIG. 3 illustrates an exemplary process flowchart for PSTN call processing;
FIG. 4 illustrates an exemplary process flowchart for IP call processing;
FIG. 5 illustrates an exemplary process flowchart for connecting call processing;
FIG. 6 illustrates an exemplary process flowchart for handle status notification processing.
FIG. 7 illustrates an exemplary process flowchart for ON-HOLD call processing;
FIG. 8 illustrates an exemplary system embodiment showing full integration of VOD and PSTN applications.
Description of the Presently Preferred Exemplary Embodiments Embodiments are Exemplary While this invention is susceptible of embodiment in many different forms, there is shown in the drawings and will herein be described in detailed preferred embodiment of the invention with the understanding that the present disclosure is to be considered as an exemplification of the principles of the invention and is not intended to limit the broad aspect of the invention to the embodiment illustrated.
The numerous innovative teachings of the present application will be described with particular reference to the presently preferred embodiments, wherein these innovative teachings are advantageously applied to the particular problems of a multi-service communication system and method. However, it should be understood that these embodiments are only examples of the many advantageous uses of the innovative teachings herein. In general, statements made in the specification of the present application do not necessarily limit any of the various claimed inventions.
Moreover, some statements may apply to some inventive features but not to others. In general, unless otherwise indicated, singular elements may be in the plural and visa versa with no loss of generality.
Definitions Throughout the discussion in this document the following definitions will be utilized:
Application Program Interface (API) The interface (calling conventions) by which an application program accesses operating system and other services. An API is defined at source code level and provides a level of abstraction between the application and the kernel (or other privileged utilities) to ensure the portability of the code.
E,1 64 Standard for representing phone numbers and their translation.
Endpoint A software entity that represents the source and/or sink of voice information.
Typically PSTN, network (H.323), or a file.
Gatekeeper A directory server that manages all authentication and name resolving of all users for the H.323. For more information, see "Gateway".
Gateway An interface that connects networks or system of different architecture. For example, a gateway may connect your computer to the World Wide Web, or your computer to the PSTN system - as it does in the case of the present invention.
GSM
Global System for Mobile Communication standardized by ETSI (European Telecommunications Standards Institute). A standard for pan-European digital mobile communication.
G.723.1 An ITU standard for voice compression.
H.323 Standard for telephony over IP.
Handle A number indicating an item (Endpoint or connection between Endpoints).
Public Switched Telephone Network (PSTN) The collection of interconnected systems operated by the various telephone companies and administrations (telcos and PTTs) around the world. Also known as the Plain Old Telephone System (POTS).
SubNetwork ID (SNID) The port through which the call is being connected. This information is provided by other custom servers.
SPN256 Card IBM Artic960 DSP Resource adapter, RS/6000 feature 2949. Used for Voice Compression and decompression between PSTN and IP voice traffic. This particular hardware is exemplary of functionality that may be readily substituted by one skilled in the art.
System Blocks / Procedural Steps Not Limitive The present invention may be aptly described in terms of exemplary system block diagrams and procedural flowcharts. While these items are sufficient to instruct one of ordinary skill in the art the teachings of the present invention, they should not be strictly construed as limiting the scope of the present invention. One skilled in the art will be aware that system block diagrams may be combined and rearranged with no loss of generality, and procedural steps may be added or subtracted, and rearranged in order to achieve the same effect with no loss of teaching generality.
Thus, it should be understood that the present invention as depicted in the attached exemplary system block diagrams and procedural flowcharts is for teaching purposes only and may be reworked by one skilled in the art depending on the intended target application.
Synchronous/Asynchronous Process Steps Not Limitive The present invention teaches a variety of processes and procedures that may be implemented to achieve the overall scope of the invention purpose. These steps may be performed either synchronously or asynchronously. Thus, the particular order of a given process is not Limitive of the scope of the present invention.
Personal Computer Not Limitive Throughout the discussion herein there will be examples provided that utilize personal computer (PC) technologies to illustrate the teachings of the present invention. The term `personal computer' should be given a broad meaning in this regard, as in general any computing device may be utilized to implement the teachings of the present invention, and the scope of the invention is not limited just to personal computer applications.
Operating System Not Limitive Additionally, while the present invention may be implemented to advantage using a variety of Microsoft operating systems (including a variety of WindowsTM variants), nothing should be construed to limit the scope of the invention to these particular software components. In particular, the system and method as taught herein may be widely implemented in a variety of systems, some of which may incorporate a graphical user interface. The present invention multi-services system is implemented in IBM'S AIX operating system but it should be understood that other operating systems are within the true scope and spirit of the present invention.
Data Structures Not Limitive The present invention may be embodied in a variety of data structures in some preferred embodiments. However, the form of such data structures as described herein is only exemplary. One skilled in the art would quickly realize that a wide variety of other data structures could be used equivalently in this application. Therefore, no data structure contained herein should be interpreted as limiting the scope of the present invention.
Voice Not Limitive Many preferred embodiments of the present invention will be described in the context of a VOIP application, in which voice is transmitted over the IP protocol. However, the teachings of the present invention can be applied to a wide variety of other audio, video, or multi-media applications, and thus while the VOIP application is illustrative of the teachings of the present invention, it is not Limitive as to the type of information communicated over the communications channel.
Exemplary Symbolics The present invention may make use of a variety of exemplary input parameters, return codes, and status indicators throughout the system as implemented or in pieces of the system as implemented. The following sections provide some of the exemplary symbolics and exemplary values as implemented in some preferred embodiments of the present invention.
One skilled in the art will quickly recognize that the complement of symbolics and their values may be reduced or augmented with no reduction in the scope of teachings of the present invention.
VOD Return Codes The following table illustrates Symbolics for VOD return codes and their exemplary numeric values:
Error Code Explanation Number 0 VOD_OK API successful -1 VOD ERROR General internal error -2 VOD_MORE_DATA Needs more space in the buffer -5 VOD_ILLEGAL_HANDLE Illegal handle -6 VOD_ILLEGAL_PARAM Illegal parameter -7 VOD_BAD_EP_TYPE Illegal Endpoint type -8 VOD_BAD_STATE The item is in a wrong state -9 VOD_TRY_AGAIN May try again later -10 VOD_BUSY Already created or busy doing something -11 VOD NOT FOUND The item was not found -50 VOD_CANT_OPEN_SOCKET Error opening sockets -51 VOD NO MORE RESOURCES No more resources -60 VOD_BAD_RESPOND Response is not in the correct format (internal error) -61 VOD_RESPOND_ERROR Response came with an error -62 VOD TIMEOUT Timeout has occurred for the operation -70 VOD_UNSUPPORTED This feature is not yet supported -100 VOD NOT_HANDLED Message was not handled.
Coder Capabilities The following table illustrates symbolics for coder capabilities and their exemplary numeric values:
coder-cap Value Explanation RTSE CODER NONE 0 Indicates the end of the list.
RTSE_CODER_GSM Ox0100 ETSI standard GSM coder 13.2 Kbit/sec.
RTSE_CODER_GSM_VQ Ox0110 HRL proprietary GSM product (not supported yet).
RTSE CODER G711 ULAW 0x0200 G.711 U-LAW.
RTSE CODER G711 ALAW 0x0210 G.711 A-LAW.
RTSE CODER G723 0x0300 G.723.1 in 6.4 Kbit/sec.
RTSE CODER G723 64 0x0310 G.723.1 in 6.4 Kbit/sec.
RTSE_CODER_G723_53 0x0320 G.723.1 in 5.3 Kbit/sec (not supported yet).
RTSE CODER G729A 0x0400 G.729 annex A (not supported yet).
VOD Net PreAns Possible Answers The following table illustrates symbolics for possible answers to the VOD_Net PreAns (217) function and their exemplary numeric values:
Answer Value Explanation VOD ANS ACCEPT Ox00 User has picked up and is accepting the call.
VOD ANS REJECT Ox01 User has rejected the call.
VOD ANS BUSY 0x02 Line is busy.
VOD INS NOANSWER 0x03 User did not pick up within an acceptable time interval.
VOD IP Status The following table illustrates symbolics for possible IP status values and their exemplary numeric values:
Status Value Explanation STAT FREE 0 This handle does not belong to any open item.
STAT_CREATED 1 The item's request is spawned and waiting to be handled (it is being processed).
STAT_SENT 2 The item's request is being processed.
STAT_READY 3 The item is ready to be connected (it is not already connected to any other Endpoint).
STAT_CONNECTED 4 STAT_SENT
Relevant only to an H.323 Endpoint STAT_H323_PROC 10 The Endpoint is in the call proceeding stage.
STAT H323_ALERT 11 The Endpoint is in the call alerting stage.
STAT_H323_CONF 12 The Endpoint is in the call confirm stage.
VOD Item Events The following table illustrates symbolics for possible VOD item events and their exemplary numeric values:
Answer Value Explanation VOD_OREQ_HANGUP 0x0120 The user at the remote side of the H.323 Endpoint hung up.
VOD_OREQ ERROR 0x0121 An error occurred for this item.
VOD_OREQ_STATUS 0x0122 The status of the item has changed.
VOD_OREQ_READY 0x0123 The status changed to READY for the first time.
VOD Hangup Reasons The following table illustrates symbolics for possible VOD hangup reasons and their exemplary numeric values:
Value Hangup Code Reason Explanation Provided 272 H323_RES_ Remote user Normal call clearing NORMAL hung up initiated by user.
273 H323_RES_ Remote station User busy.
BUSY busy 275 H323_RES_ No answer Called user has been NOANSWER alerted but did not answer within the timeout period.
277 H323_RES_ Call rejected Called user rejected the REJECTED call.
503 H323_RES_ Not enough The reservation of NO NW RSC network network resources failed.
resources 504 H323_RES_ Not enough The gatekeeper does not NO_GK_RSC gatekeeper have enough resources to resources forward the call.
505 H323_RES_ Destination The gateway could not UNREACH DEST unreachable forward the call.
506 H323_RES_ Destination The gateway forwarded DEST_REJ rejected the call, but the end user did not accept it.
507 H323 RES Invalid revision Invalid software revision INV REV on the other side detected.
508 H323_RES_ No permission The Endpoint did not get NO-PERM the permission from the gatekeeper to accept the call.
509 H323_RES_ Unreachable The gatekeeper could not NO GK gateway. be reached.
510 H323_RES_ Not enough The gateway does not NO_GW_RSC gateway resource have enough resources to forward the call.
511 H323_RES_ Malformed The gateway detected a BAD_FMT_ADDR address bad format of the e.164 number of the called user.
512 H323_RES_ Network The endpoint detected a BAD_NO_QOS overloaded very low QOS that made the media connection unusable.
267 H323_RES_ Protocol error. A protocol error was PROT_ERR detected or a ReleaseComplete message with this reason was received.
268 H323_RES_ Unspecified The local service provider RELCOMP_UNSPEC hangup reason got a ReleaseComplete message with a code it did not understand or was undefined.
769 H323_RES_ No control One of the control CTRL_CNX_EST_FAIL connection connections could not be established within a given timeout.
770 H323 RES Control The control connection CTRL CNX LOST connection lost was unexpectedly lost.
771 H323_RES_ Capability The capability selection CAPSEL_FAIL selection failed failed because no compatible set was found.
772 H323_RES_ Too many calls. The local service provider TOO_MANY_CALLS is not able to make a new outgoing call because there are too many already.
773 H323_RES_ H323 The local service provider BUG_SP implementation detected a software bug bug within itself.
774 H323_RES_ Application error The local service provider BUG_SU believes that the service user is not conforming to the present specifications.
Port Resource Control Custom Server (SPRC) Return Codes General Errors The following table illustrates symbolics for possible SPRC general errors and their exemplary numeric values:
General Errors Error Code Value SPRC_SUCCESS Ox00 SPRC GENERAL FAILURE Ox01 SPRC INVALID PARAMETER 0x02 SPRC_NOT_SUPPORTED 0x03 SPRC_ALREADY_IN_USE 0x04 SPRC_OUT_OF_RESOURCE 0x05 SPRC_OUT_OF_BOUNDS 0x06 SPRC NO MEMORY 0x07 SPRC_TIMEOUT 0x08 SPRC_ADAPTER NOT_FOUND 0x09 Shared Memory/Semaphore Errors The following table illustrates Symbolics for possible SPRC shared memory/semaphore errors and their exemplary numeric values:
Shared Memory/Semaphore Errors Error Code Value SPRC_UNABLE_DETTACH_SHM Ox 10 SPRC_UNABLE_DESTROY_SHM Ox11 SPRC_UNABLE_ATTACH_SHM Ox 12 SPRC_UNABLE_GET_SHM Ox 13 SPRC_UNABLE_LOCK_SHM Ox 14 SPRC_UNABLE_UNLOCK_SHM Ox15 SPRC_UNABLE_CREATE_SHM Ox16 SPRC_UNABLE_GET_SHM Ox 17 SPRC UNABLE DESTROY SHM Ox18 TDM Errors The following table illustrates symbolics for possible SPRC TDM errors and their exemplary numeric values:
TDM Errors Error Code Value SPRC TDM CONNECT FAILURE Ox1A (*) SPRC TDM DISCONNECT FAILURE Ox1B (*) SPRC CONN SERVER NOT READY Ox1C
(*) Note: return codes marked with (*) have the 8-digit hexadecimal format Ox'bb'0000'aa' where:
`aa' = is the error code of the table above (in hexadecimal) `bb' = is the CA errno variable from DirectTalk (in hexadecimal) Connection Errors The following table illustrates symbolics for possible SPRC connection errors and their exemplary numeric values:
Connection Errors Error Code Value SPRC_CONNECTION_ERROR 0x20 SPRC_ DISCONNECTION_ERROR 0x21 SPRC_DEALLOCATION_ERROR 0x22 SPRC_ ALLOCATION_ERROR 0x23 SPRC CONNECTION NOT POSSIBLE 0x24 SPRC DISCONNECTION NOTPOSSBILE 0x25 SPRC DEALLOCATION NOTPOSSIBLE 0x26 SPRC_ALLOCATION NOT_POSSBILE 0x27 SPRC_INVALID_PEER_CARD_TYPE 0x28 SPRC_INVALID_PEER CARD NUMBER 0x29 SPRC_PEER_CHANNEL_OUT_OFRANGE Ox2A
Port Errors The following table illustrates symbolics for possible SPRC port errors and their exemplary numeric values:
Port Errors Error Code Value SPRC_PORTPIOT_YREE 0x31 SPRC_PORT NOT_OPENED 0x32 SPRC_PORT_NOT_CONNECTED 0x33 Conference General Errors The following table illustrates symbolics for possible SPRC conference general errors and their exemplary numeric values:
Conference General Errors Error Code Value SPRC_CONFERENCE_ID_OUT_OF_RANGE 0x40 SPRC NO CONFERENCE AVAILABLE 0x41 SPRC NULL_CONFERENCE 0x42 Conference Queue Errors The following table illustrates symbolics for possible SPRC conference queue errors and their exemplary numeric values:
Conference Queue Errors Error Code Value SPRC_REMOVE_FROM_AVAIL_MIXER_QUEUE_ERROR 0x50 SPRC_REMOVE_FROM_USED_MIXER_QUEUE_ERROR 0x51 SPRC_REMOVE_FROM_BLOCKED_MIXERQUEUE_ERROR 0x52 SPRC_ADD_TO_AVAIL_MIXER_QUEUE_ERROR 0x53 SPRC ADD_TO USED_MIXER_QUEUE_ERROR 0x54 SPRC_ADD_TO_BLOCKED_MIXER_UEUE_ERROR 0x55 SPRC ADD_TO_AVAIL_CONFERENCE_QUEUE_ERROR 0x56 SPRC_ADD_TO_USED_CONFERENCE_QUEUE_ERROR 0x57 Mixer Errors The following table illustrates symbolics for possible SPRC mixer errors and their exemplary numeric values:
Mixer Errors Error Code Value SPRC_MIXER_OUT_OF_RANGE 0x60 SPRC_MIXER_STATE_ERROR 0x61 SPRC_MIXER NOT_ALLOCATED 0x62 SPRC_MIXER NOT_CONNECTED 0x63 SPRC_MIXER NOT_FREE 0x64 SPRC_MIXER NOT_BLOCKED 0x65 - -- - -----------SPRC NO MIXER ALLOCATED 0x66 SPRC NO MIXER AVAILABLE 0x67 SPRC NO_MIXER_BLOCKED 0x68 SPRC NULL_MIXER 0x69 SPRC_MIXER_CONNECTION NOT_POSSIBLE Ox6A
SPRC_MIXER ALLOCATION_NOT_POSSIBLE Ox6B
SPRC MIXER DISCONNECTION NOT POSSIBLE Ox6C
SPRC MIXER DEALLOCATION NOT POSSIBLE Ox6D
EEC Errors The following table illustrates symbolics for possible SPRC EEC errors and their exemplary numeric values:
EEC Errors Error Code Value SPRC_EEC NOT_FOUND 0x70 SPRC_EEC_OUT_OF_RANGE 0x71 SPRC_INVALID_EEC 0x72 SPRC NO EECS ALLOCATED 0x73 SPRC EEC NOT ALLOCATED 0x74 SPRC EEC NOT CONNECTED 0x75 SPRC EEC CONNECTED NOT FOUND 0x76 SPRC NO EECS AVAILABLE 0x77 WanDriver Errors The following table illustrates symbolics for possible SPRC WanDriver errors and their exemplary numeric values:
WanDriver Errors Error Code Value SPRC_OSP_NUMBERS_UNMATCHED 0x80 SPRC_UNABLE_TO_OPEN_DEVICE 0x81 SPRC_ERROR_TRANSMIT_TO_WAN_DRIVER 0x82 SPRC_ERROR_RECEIVING_FROM_WAN._DRIVER 0x83 SPRC_ INVALID_COMMANDFROIv_WAN_DRIVER 0x84 SPRC_UNMATCHED_COMMAND_FROM_WAN_DRIVER 0x85 SPRC_WAN_DRIVER EEC_ALREADY_CONNECTED 0x86 SPRC_WAN_DRIVER EEC_OUT_OF_RANGE 0x87 SPRC_WAN_DRIVER MIXER_OUT_OF_RANGE 0x88 SPRC_WAN_DRIVER_INVALID_COMMAND 0x89 SPRC_WAN_DRIVER_EEC NC_TO_THE_MIXER Ox8A
SPRC_WAN_DRIVER_EEC NC_TO_ANY_MIXER Ox8B
SPRC_WAN_DRIVER_IMPOSSIBLE_CONNECTION Ox8C
SPRC_WAN_DRIVER_UNKNOWN_RC Ox8D
SPRC_WAN_DRIVER_WAN_SID_ERROR WE
SPRC_WAN_DRIVER WAN_REG_ERROR Ox8F
SPRC WAN DRIVER WAN RX POLLED ERROR 0x90 SPRC WAN DRIVER WAN WC CONNECT ERROR 0x91 SPRC_WAN_DRIVER_WAN_WC_CONCNF_ERROR 0x92 DSP Errors The following table illustrates symbolics for possible SPRC DSP errors and their exemplary numeric values:
DSP Errors Error Code Value SPRC DSP OUT OF RANGE OxAO
System Overview The present invention generally can be viewed in terms of the exemplary system architecture. This exemplary architecture comprises the following components:
Voice-Over-Date (VOD) Components (201) VOD_Close (211);
1. VOD_Connect (212);
2. VOD_GetCaps (213);
Field of the Invention The present invention generally relates to public switched telephone networks (PSTN's) /
voice-over-IP telephony and particularly to the application of the extension of scripts to interact with PSTN and IP telephones within the context of the same services.
Background of the Invention Overview Today script based services are available to program interactive voice response devices when communicating with the public switched telephone network (PSTN). Today IP
networks are evolving and voice over IP telephony is being used for communication similar to that of PSTN
networks. The general problem with this scenario is that there is no common bridge to manage services that involved both PSTN and IP end-points in the same connection.
Description of the Prior Art For example, the IBM IVR platform Direct Talk (reference IBM Direct Talk for AIX, V2, R2: State Tables, Prompts and Voice Segments, SC33-1846, December 1998) provides the script language used for PSTN interaction. In the present invention the script needed for interacting with IP telephones was developed and uses the same script method as Direct Talk and can coexist.
Objects of the Invention Accordingly, the objects of the present invention are (among others) to circumvent the deficiencies in the prior art and affect the following objectives:
to extend the script to interact with PSTN and IP telephones within the context of the same services;
a. to share same service logic for both PSTN and IP media;
b. to conference participants on both PSTN and IP;
c. to store and forward information between the two media;
d. to play ON-HOLD media to with interface; and/or e. to monitor information between the two media.
While these objectives should not be understood to limit the teachings of the present invention, in general these objectives are achieved by the disclosed invention that is discussed in the following sections.
Brief Summary of the Invention Overview Referencing FIG. 1, in the present invention scripts have been extended to interact with PSTN
and IP telephones within the context of the same services. In, the present invention, the scalable PSTN gateway (104, 113, 123, 125) is a gateway that connects calls from a PC-based H.323 client application (102, 115) to the regular PSTN telephone system (105, 112, 122, 126). Inbound calls originating from the PSTN are connected through an IP connection (103, 114, 124) to a PC client application (102, 115). Outbound calls originating from a PC client application are sent through the gateway to the PSTN destination. In addition, as illustrated in FIG. 1, Voice Over Data (VOD) may provide an optional RISC-based solution for routing PSTN calls over a data network, allowing three types of voice connections:
PC-to-phone (100);
f. phone-to-PC (110); and/or g. phone-to-phone (120).
The gateway is scalable and has been reduced to practice to support up to 96 simultaneous calls, although any number is potentially realizable.
The following detailed discussion may serve as a guide for the VOD CS - Voice Over Data Custom Server and the SPN256 Port Resource Control Custom Server for VOD
(SPRC). These APIs developed for the VOD Custom Server serve as extensions to the DT (IBM's Direct Talk Interactive Voice Response System), i.e., they receive commands from the DT.
The Voice over Data custom server along with the DT form the basis of the scalabable PSTN Gateway.
This Gateway is a multi-service system and server that runs on the AIX operating system. While this system uses the AIX operating system, it is not limited to this and can be implemented on another operating system.
The multi-service system connects to the PSTN network. The multi-service system can also work without a telephone call. In addition, the multi-service system can service and IP call independently.
The set of exemplary state table APIs documented herein are designed as a DT
interface to the actual custom server functions which support a gateway capable of sending and receiving voice between a telephone PSTN interface card and the IP (Internet Protocol) network. Calls are generally controlled utilizing the H.323 standard. The SPRC is responsible for coordinating the SCBus connections between the DTQA (Direct Talk Quad Adapter) and the SPN256, managing resources of the SPN256 cards, allocating and deallocating them to the application. It is integrated with the DT Timeslot Manager, which uses Connection Servers to send low-level commands to the adapters sharing the SCBus (cable/logic standard for connecting time division multiplexed voice channels).
The operation of these APIs is designed especially for the requirements of the DT system, and are limited by its restrictions.
The VOD Custom Server is one component of a larger, more complex system and, in order to be able to use the VOD Custom Server, it is necessary to understand the DT
with all its built-in components as well as other custom servers, such as Time Slot Manager, and VOD
Gate Custom Server.
Exemplary Advantages Overall the present invention can in some exemplary embodiments provide one or more of the following advantages over the prior art. For example the IBM IVR platform Direct Talk (reference IBM Direct Talk for AIX, V2, R2: State Tables, Prompts and Voice Segments, SC33-1846, December 1998) provides the script language used for PSTN interaction.
In the present invention, the script needed for interacting with IP telephones was developed and uses the same script method as Direct Talk and can coexist with this application. A
description of those APIs follows.
Brief Description of the Drawings For a fuller understanding of the advantages provided by the invention, reference should be made to the following detailed description together with the accompanying drawings wherein:
FIG. 1 illustrates exemplary system embodiments of the present invention in PC-to-phone, phone-to-PC, and phone-to-phone applications;
FIG. 2 illustrates an exemplary system architecture diagram for the API
interfaces supporting the present invention teachings;
FIG. 3 illustrates an exemplary process flowchart for PSTN call processing;
FIG. 4 illustrates an exemplary process flowchart for IP call processing;
FIG. 5 illustrates an exemplary process flowchart for connecting call processing;
FIG. 6 illustrates an exemplary process flowchart for handle status notification processing.
FIG. 7 illustrates an exemplary process flowchart for ON-HOLD call processing;
FIG. 8 illustrates an exemplary system embodiment showing full integration of VOD and PSTN applications.
Description of the Presently Preferred Exemplary Embodiments Embodiments are Exemplary While this invention is susceptible of embodiment in many different forms, there is shown in the drawings and will herein be described in detailed preferred embodiment of the invention with the understanding that the present disclosure is to be considered as an exemplification of the principles of the invention and is not intended to limit the broad aspect of the invention to the embodiment illustrated.
The numerous innovative teachings of the present application will be described with particular reference to the presently preferred embodiments, wherein these innovative teachings are advantageously applied to the particular problems of a multi-service communication system and method. However, it should be understood that these embodiments are only examples of the many advantageous uses of the innovative teachings herein. In general, statements made in the specification of the present application do not necessarily limit any of the various claimed inventions.
Moreover, some statements may apply to some inventive features but not to others. In general, unless otherwise indicated, singular elements may be in the plural and visa versa with no loss of generality.
Definitions Throughout the discussion in this document the following definitions will be utilized:
Application Program Interface (API) The interface (calling conventions) by which an application program accesses operating system and other services. An API is defined at source code level and provides a level of abstraction between the application and the kernel (or other privileged utilities) to ensure the portability of the code.
E,1 64 Standard for representing phone numbers and their translation.
Endpoint A software entity that represents the source and/or sink of voice information.
Typically PSTN, network (H.323), or a file.
Gatekeeper A directory server that manages all authentication and name resolving of all users for the H.323. For more information, see "Gateway".
Gateway An interface that connects networks or system of different architecture. For example, a gateway may connect your computer to the World Wide Web, or your computer to the PSTN system - as it does in the case of the present invention.
GSM
Global System for Mobile Communication standardized by ETSI (European Telecommunications Standards Institute). A standard for pan-European digital mobile communication.
G.723.1 An ITU standard for voice compression.
H.323 Standard for telephony over IP.
Handle A number indicating an item (Endpoint or connection between Endpoints).
Public Switched Telephone Network (PSTN) The collection of interconnected systems operated by the various telephone companies and administrations (telcos and PTTs) around the world. Also known as the Plain Old Telephone System (POTS).
SubNetwork ID (SNID) The port through which the call is being connected. This information is provided by other custom servers.
SPN256 Card IBM Artic960 DSP Resource adapter, RS/6000 feature 2949. Used for Voice Compression and decompression between PSTN and IP voice traffic. This particular hardware is exemplary of functionality that may be readily substituted by one skilled in the art.
System Blocks / Procedural Steps Not Limitive The present invention may be aptly described in terms of exemplary system block diagrams and procedural flowcharts. While these items are sufficient to instruct one of ordinary skill in the art the teachings of the present invention, they should not be strictly construed as limiting the scope of the present invention. One skilled in the art will be aware that system block diagrams may be combined and rearranged with no loss of generality, and procedural steps may be added or subtracted, and rearranged in order to achieve the same effect with no loss of teaching generality.
Thus, it should be understood that the present invention as depicted in the attached exemplary system block diagrams and procedural flowcharts is for teaching purposes only and may be reworked by one skilled in the art depending on the intended target application.
Synchronous/Asynchronous Process Steps Not Limitive The present invention teaches a variety of processes and procedures that may be implemented to achieve the overall scope of the invention purpose. These steps may be performed either synchronously or asynchronously. Thus, the particular order of a given process is not Limitive of the scope of the present invention.
Personal Computer Not Limitive Throughout the discussion herein there will be examples provided that utilize personal computer (PC) technologies to illustrate the teachings of the present invention. The term `personal computer' should be given a broad meaning in this regard, as in general any computing device may be utilized to implement the teachings of the present invention, and the scope of the invention is not limited just to personal computer applications.
Operating System Not Limitive Additionally, while the present invention may be implemented to advantage using a variety of Microsoft operating systems (including a variety of WindowsTM variants), nothing should be construed to limit the scope of the invention to these particular software components. In particular, the system and method as taught herein may be widely implemented in a variety of systems, some of which may incorporate a graphical user interface. The present invention multi-services system is implemented in IBM'S AIX operating system but it should be understood that other operating systems are within the true scope and spirit of the present invention.
Data Structures Not Limitive The present invention may be embodied in a variety of data structures in some preferred embodiments. However, the form of such data structures as described herein is only exemplary. One skilled in the art would quickly realize that a wide variety of other data structures could be used equivalently in this application. Therefore, no data structure contained herein should be interpreted as limiting the scope of the present invention.
Voice Not Limitive Many preferred embodiments of the present invention will be described in the context of a VOIP application, in which voice is transmitted over the IP protocol. However, the teachings of the present invention can be applied to a wide variety of other audio, video, or multi-media applications, and thus while the VOIP application is illustrative of the teachings of the present invention, it is not Limitive as to the type of information communicated over the communications channel.
Exemplary Symbolics The present invention may make use of a variety of exemplary input parameters, return codes, and status indicators throughout the system as implemented or in pieces of the system as implemented. The following sections provide some of the exemplary symbolics and exemplary values as implemented in some preferred embodiments of the present invention.
One skilled in the art will quickly recognize that the complement of symbolics and their values may be reduced or augmented with no reduction in the scope of teachings of the present invention.
VOD Return Codes The following table illustrates Symbolics for VOD return codes and their exemplary numeric values:
Error Code Explanation Number 0 VOD_OK API successful -1 VOD ERROR General internal error -2 VOD_MORE_DATA Needs more space in the buffer -5 VOD_ILLEGAL_HANDLE Illegal handle -6 VOD_ILLEGAL_PARAM Illegal parameter -7 VOD_BAD_EP_TYPE Illegal Endpoint type -8 VOD_BAD_STATE The item is in a wrong state -9 VOD_TRY_AGAIN May try again later -10 VOD_BUSY Already created or busy doing something -11 VOD NOT FOUND The item was not found -50 VOD_CANT_OPEN_SOCKET Error opening sockets -51 VOD NO MORE RESOURCES No more resources -60 VOD_BAD_RESPOND Response is not in the correct format (internal error) -61 VOD_RESPOND_ERROR Response came with an error -62 VOD TIMEOUT Timeout has occurred for the operation -70 VOD_UNSUPPORTED This feature is not yet supported -100 VOD NOT_HANDLED Message was not handled.
Coder Capabilities The following table illustrates symbolics for coder capabilities and their exemplary numeric values:
coder-cap Value Explanation RTSE CODER NONE 0 Indicates the end of the list.
RTSE_CODER_GSM Ox0100 ETSI standard GSM coder 13.2 Kbit/sec.
RTSE_CODER_GSM_VQ Ox0110 HRL proprietary GSM product (not supported yet).
RTSE CODER G711 ULAW 0x0200 G.711 U-LAW.
RTSE CODER G711 ALAW 0x0210 G.711 A-LAW.
RTSE CODER G723 0x0300 G.723.1 in 6.4 Kbit/sec.
RTSE CODER G723 64 0x0310 G.723.1 in 6.4 Kbit/sec.
RTSE_CODER_G723_53 0x0320 G.723.1 in 5.3 Kbit/sec (not supported yet).
RTSE CODER G729A 0x0400 G.729 annex A (not supported yet).
VOD Net PreAns Possible Answers The following table illustrates symbolics for possible answers to the VOD_Net PreAns (217) function and their exemplary numeric values:
Answer Value Explanation VOD ANS ACCEPT Ox00 User has picked up and is accepting the call.
VOD ANS REJECT Ox01 User has rejected the call.
VOD ANS BUSY 0x02 Line is busy.
VOD INS NOANSWER 0x03 User did not pick up within an acceptable time interval.
VOD IP Status The following table illustrates symbolics for possible IP status values and their exemplary numeric values:
Status Value Explanation STAT FREE 0 This handle does not belong to any open item.
STAT_CREATED 1 The item's request is spawned and waiting to be handled (it is being processed).
STAT_SENT 2 The item's request is being processed.
STAT_READY 3 The item is ready to be connected (it is not already connected to any other Endpoint).
STAT_CONNECTED 4 STAT_SENT
Relevant only to an H.323 Endpoint STAT_H323_PROC 10 The Endpoint is in the call proceeding stage.
STAT H323_ALERT 11 The Endpoint is in the call alerting stage.
STAT_H323_CONF 12 The Endpoint is in the call confirm stage.
VOD Item Events The following table illustrates symbolics for possible VOD item events and their exemplary numeric values:
Answer Value Explanation VOD_OREQ_HANGUP 0x0120 The user at the remote side of the H.323 Endpoint hung up.
VOD_OREQ ERROR 0x0121 An error occurred for this item.
VOD_OREQ_STATUS 0x0122 The status of the item has changed.
VOD_OREQ_READY 0x0123 The status changed to READY for the first time.
VOD Hangup Reasons The following table illustrates symbolics for possible VOD hangup reasons and their exemplary numeric values:
Value Hangup Code Reason Explanation Provided 272 H323_RES_ Remote user Normal call clearing NORMAL hung up initiated by user.
273 H323_RES_ Remote station User busy.
BUSY busy 275 H323_RES_ No answer Called user has been NOANSWER alerted but did not answer within the timeout period.
277 H323_RES_ Call rejected Called user rejected the REJECTED call.
503 H323_RES_ Not enough The reservation of NO NW RSC network network resources failed.
resources 504 H323_RES_ Not enough The gatekeeper does not NO_GK_RSC gatekeeper have enough resources to resources forward the call.
505 H323_RES_ Destination The gateway could not UNREACH DEST unreachable forward the call.
506 H323_RES_ Destination The gateway forwarded DEST_REJ rejected the call, but the end user did not accept it.
507 H323 RES Invalid revision Invalid software revision INV REV on the other side detected.
508 H323_RES_ No permission The Endpoint did not get NO-PERM the permission from the gatekeeper to accept the call.
509 H323_RES_ Unreachable The gatekeeper could not NO GK gateway. be reached.
510 H323_RES_ Not enough The gateway does not NO_GW_RSC gateway resource have enough resources to forward the call.
511 H323_RES_ Malformed The gateway detected a BAD_FMT_ADDR address bad format of the e.164 number of the called user.
512 H323_RES_ Network The endpoint detected a BAD_NO_QOS overloaded very low QOS that made the media connection unusable.
267 H323_RES_ Protocol error. A protocol error was PROT_ERR detected or a ReleaseComplete message with this reason was received.
268 H323_RES_ Unspecified The local service provider RELCOMP_UNSPEC hangup reason got a ReleaseComplete message with a code it did not understand or was undefined.
769 H323_RES_ No control One of the control CTRL_CNX_EST_FAIL connection connections could not be established within a given timeout.
770 H323 RES Control The control connection CTRL CNX LOST connection lost was unexpectedly lost.
771 H323_RES_ Capability The capability selection CAPSEL_FAIL selection failed failed because no compatible set was found.
772 H323_RES_ Too many calls. The local service provider TOO_MANY_CALLS is not able to make a new outgoing call because there are too many already.
773 H323_RES_ H323 The local service provider BUG_SP implementation detected a software bug bug within itself.
774 H323_RES_ Application error The local service provider BUG_SU believes that the service user is not conforming to the present specifications.
Port Resource Control Custom Server (SPRC) Return Codes General Errors The following table illustrates symbolics for possible SPRC general errors and their exemplary numeric values:
General Errors Error Code Value SPRC_SUCCESS Ox00 SPRC GENERAL FAILURE Ox01 SPRC INVALID PARAMETER 0x02 SPRC_NOT_SUPPORTED 0x03 SPRC_ALREADY_IN_USE 0x04 SPRC_OUT_OF_RESOURCE 0x05 SPRC_OUT_OF_BOUNDS 0x06 SPRC NO MEMORY 0x07 SPRC_TIMEOUT 0x08 SPRC_ADAPTER NOT_FOUND 0x09 Shared Memory/Semaphore Errors The following table illustrates Symbolics for possible SPRC shared memory/semaphore errors and their exemplary numeric values:
Shared Memory/Semaphore Errors Error Code Value SPRC_UNABLE_DETTACH_SHM Ox 10 SPRC_UNABLE_DESTROY_SHM Ox11 SPRC_UNABLE_ATTACH_SHM Ox 12 SPRC_UNABLE_GET_SHM Ox 13 SPRC_UNABLE_LOCK_SHM Ox 14 SPRC_UNABLE_UNLOCK_SHM Ox15 SPRC_UNABLE_CREATE_SHM Ox16 SPRC_UNABLE_GET_SHM Ox 17 SPRC UNABLE DESTROY SHM Ox18 TDM Errors The following table illustrates symbolics for possible SPRC TDM errors and their exemplary numeric values:
TDM Errors Error Code Value SPRC TDM CONNECT FAILURE Ox1A (*) SPRC TDM DISCONNECT FAILURE Ox1B (*) SPRC CONN SERVER NOT READY Ox1C
(*) Note: return codes marked with (*) have the 8-digit hexadecimal format Ox'bb'0000'aa' where:
`aa' = is the error code of the table above (in hexadecimal) `bb' = is the CA errno variable from DirectTalk (in hexadecimal) Connection Errors The following table illustrates symbolics for possible SPRC connection errors and their exemplary numeric values:
Connection Errors Error Code Value SPRC_CONNECTION_ERROR 0x20 SPRC_ DISCONNECTION_ERROR 0x21 SPRC_DEALLOCATION_ERROR 0x22 SPRC_ ALLOCATION_ERROR 0x23 SPRC CONNECTION NOT POSSIBLE 0x24 SPRC DISCONNECTION NOTPOSSBILE 0x25 SPRC DEALLOCATION NOTPOSSIBLE 0x26 SPRC_ALLOCATION NOT_POSSBILE 0x27 SPRC_INVALID_PEER_CARD_TYPE 0x28 SPRC_INVALID_PEER CARD NUMBER 0x29 SPRC_PEER_CHANNEL_OUT_OFRANGE Ox2A
Port Errors The following table illustrates symbolics for possible SPRC port errors and their exemplary numeric values:
Port Errors Error Code Value SPRC_PORTPIOT_YREE 0x31 SPRC_PORT NOT_OPENED 0x32 SPRC_PORT_NOT_CONNECTED 0x33 Conference General Errors The following table illustrates symbolics for possible SPRC conference general errors and their exemplary numeric values:
Conference General Errors Error Code Value SPRC_CONFERENCE_ID_OUT_OF_RANGE 0x40 SPRC NO CONFERENCE AVAILABLE 0x41 SPRC NULL_CONFERENCE 0x42 Conference Queue Errors The following table illustrates symbolics for possible SPRC conference queue errors and their exemplary numeric values:
Conference Queue Errors Error Code Value SPRC_REMOVE_FROM_AVAIL_MIXER_QUEUE_ERROR 0x50 SPRC_REMOVE_FROM_USED_MIXER_QUEUE_ERROR 0x51 SPRC_REMOVE_FROM_BLOCKED_MIXERQUEUE_ERROR 0x52 SPRC_ADD_TO_AVAIL_MIXER_QUEUE_ERROR 0x53 SPRC ADD_TO USED_MIXER_QUEUE_ERROR 0x54 SPRC_ADD_TO_BLOCKED_MIXER_UEUE_ERROR 0x55 SPRC ADD_TO_AVAIL_CONFERENCE_QUEUE_ERROR 0x56 SPRC_ADD_TO_USED_CONFERENCE_QUEUE_ERROR 0x57 Mixer Errors The following table illustrates symbolics for possible SPRC mixer errors and their exemplary numeric values:
Mixer Errors Error Code Value SPRC_MIXER_OUT_OF_RANGE 0x60 SPRC_MIXER_STATE_ERROR 0x61 SPRC_MIXER NOT_ALLOCATED 0x62 SPRC_MIXER NOT_CONNECTED 0x63 SPRC_MIXER NOT_FREE 0x64 SPRC_MIXER NOT_BLOCKED 0x65 - -- - -----------SPRC NO MIXER ALLOCATED 0x66 SPRC NO MIXER AVAILABLE 0x67 SPRC NO_MIXER_BLOCKED 0x68 SPRC NULL_MIXER 0x69 SPRC_MIXER_CONNECTION NOT_POSSIBLE Ox6A
SPRC_MIXER ALLOCATION_NOT_POSSIBLE Ox6B
SPRC MIXER DISCONNECTION NOT POSSIBLE Ox6C
SPRC MIXER DEALLOCATION NOT POSSIBLE Ox6D
EEC Errors The following table illustrates symbolics for possible SPRC EEC errors and their exemplary numeric values:
EEC Errors Error Code Value SPRC_EEC NOT_FOUND 0x70 SPRC_EEC_OUT_OF_RANGE 0x71 SPRC_INVALID_EEC 0x72 SPRC NO EECS ALLOCATED 0x73 SPRC EEC NOT ALLOCATED 0x74 SPRC EEC NOT CONNECTED 0x75 SPRC EEC CONNECTED NOT FOUND 0x76 SPRC NO EECS AVAILABLE 0x77 WanDriver Errors The following table illustrates symbolics for possible SPRC WanDriver errors and their exemplary numeric values:
WanDriver Errors Error Code Value SPRC_OSP_NUMBERS_UNMATCHED 0x80 SPRC_UNABLE_TO_OPEN_DEVICE 0x81 SPRC_ERROR_TRANSMIT_TO_WAN_DRIVER 0x82 SPRC_ERROR_RECEIVING_FROM_WAN._DRIVER 0x83 SPRC_ INVALID_COMMANDFROIv_WAN_DRIVER 0x84 SPRC_UNMATCHED_COMMAND_FROM_WAN_DRIVER 0x85 SPRC_WAN_DRIVER EEC_ALREADY_CONNECTED 0x86 SPRC_WAN_DRIVER EEC_OUT_OF_RANGE 0x87 SPRC_WAN_DRIVER MIXER_OUT_OF_RANGE 0x88 SPRC_WAN_DRIVER_INVALID_COMMAND 0x89 SPRC_WAN_DRIVER_EEC NC_TO_THE_MIXER Ox8A
SPRC_WAN_DRIVER_EEC NC_TO_ANY_MIXER Ox8B
SPRC_WAN_DRIVER_IMPOSSIBLE_CONNECTION Ox8C
SPRC_WAN_DRIVER_UNKNOWN_RC Ox8D
SPRC_WAN_DRIVER_WAN_SID_ERROR WE
SPRC_WAN_DRIVER WAN_REG_ERROR Ox8F
SPRC WAN DRIVER WAN RX POLLED ERROR 0x90 SPRC WAN DRIVER WAN WC CONNECT ERROR 0x91 SPRC_WAN_DRIVER_WAN_WC_CONCNF_ERROR 0x92 DSP Errors The following table illustrates symbolics for possible SPRC DSP errors and their exemplary numeric values:
DSP Errors Error Code Value SPRC DSP OUT OF RANGE OxAO
System Overview The present invention generally can be viewed in terms of the exemplary system architecture. This exemplary architecture comprises the following components:
Voice-Over-Date (VOD) Components (201) VOD_Close (211);
1. VOD_Connect (212);
2. VOD_GetCaps (213);
3. VOD_GetGlobalEv (214);
4. VOD_GetItemEvt (215);
5. VOD Net_Call (216);
6. VOD_Net PreAns (217);
7. VOD NotifyEvent (218);
8. VOD_Open_FPlay (219); and 9. VOD_Open_Port (220).
Port Resource Control Custom Server (SPRC) Components (202) SPRC_Disc_SNID (221) 10. SPRC_Open_SNID (222) State Table APIs Overview Concept of the APIs Since the basic functionality of the VOD Custom Server is to transfer voice (in real time) from several kinds of sources to several kinds of targets, the concept of the APIs is built of Endpoints and the connections between these Endpoints. The connections between the Endpoints have a particular direction that indicates the direction of the voice streaming. For example, to maintain a standard IP to PSTN phone call, one must open two Endpoints: an IP
Endpoint and a PSTN Endpoint. To enable voice between them (in both directions) two Endpoints need to be connected in full duplex mode.
As another example, to record the PSTN side to a file, one must open the PSTN
Endpoint (if it is not already open), and then open the file record Endpoint and connect the PSTN Endpoint to the record Endpoint in one direction (from PSTN to record). A more complex structure can be created with the restriction that an Endpoint can only have one output connection and one input connection.
The following describes the IBM Voice Over Data (VOD) and SPN256 Voice Over IP
Port Resource Control (SPRC) state table APIs. They act as an interface between IBM's DirectTalk state Tables and the VOD/SPRC Custom Server API's. There are ten VOD state table APIs and two SPRC state table APIs Exemplary State Table API Usage PSTN Calls As illustrated in FIG. 3, when a call is received/made involving a PSTN port (300), the state table APIs used are:
SPRC_Open_SNID (222) (301); and a. VOD_Open_Port (220) (302).
When the call is completed (303), the state table APIs used to free the associated resources for the PSTN port are:
VOD_Close (211) (304); and b. SPRC_Disc_SNID (221) (305).
lP Calls As illustrated in FIG. 4, processing for inbound and outboud IP calls (400) is bifurcated (401). When a call is received involving an IP port (400), the state table APIs if the call is inbound (412) are:
VOD_GetGlobalEv (214) (402);
c. VOD Net_PreAns (217) (403); and d. VOD NotifyEvent (218) (404).
In the case where a VOD connection is to be established for an agent or an outbound call (415) to an IP address is to be made, the state table APIs used are:
VOD_GetCaps (213) (405); and e. VOD Net_Call (216) (406).
Connecting Calls As illustrated in FIG. 5, when two parties are to be connected (500), the state table APIs used are:
VOD NotifyEvent (218) (501).
When the call is completed (502), the state table APIs used to free the associated resources forth PSTN port are:
VOD_Close (211) (503).
Handle Status Notification As illustrated in FIG. 6, the VOD API has the ability to notify the state table of activity concerning a particular `handle' (600). The state table APIs used to establish and use this function are:
VOD NotifyEvent (218) (601) (this function may be called by or included in VOD_Connect (212) (611) and VOD_Open_Port (220) (612)); and f. VOD_GetItemEvt (215) (602).
ON-HOLD Transfers As illustrated in FIG. 7, here is an additional function that provides the ability to play a file to an endpoint (i.e. music, advertisement) (700). The file must first be opened and then connected to the `handle' that will hear the file. The state table APIs used to perform this function are:
VOD_Open_FPlay (219) (701); and 11. VOD_Connect (212) (702).
Exemplary Multi-Service System Referencing FIG. 8, the concepts presented in FIGs. 1-7 may be integrated such as to permit voice (801), telephonic information (802), as well as other types of multi-media data to be interfaced to a personal computer (803) over an IP network (804) to a PSTN
gateway (805) that interfaces with one (806) or more (807) PSTN networks to a variety of remote communication system(s) (808, 809, 810) which may or may not have a structure similar to that of the IP/PSTN gateway of FIG. 8. This figure illustrates the generic capabilities of the present invention extend beyond simple voice communication and may be utilized in some environments to include a wide variety of data, including but not limited to voice, video, and other multi-media components.
VOD State Table APIs VOD Close (211) Description This state table API will perform two functions:
Disable notification (optional); and a. Close an item (endpoint/handle or connection) The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters VOD_Handle (number): the handle representing the endpoint or connection to be closed. Must be greater than 0.
Notify_flag (string): Y or N to disable notification of handle status.
If notification was turned on when the handle was established, it should be turned off at this point.
Output Parameters re (number): return code from the Custom Server API.
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID-HANDLE = the input parameter VOD Handle was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_flag was not Y or N
VOD Problem = the SendData or ReceiveData to the VOD custom server returned to this state table API with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD Connect (212) Description This state table API will perform two functions:
Connects two endpoints/handles and starts the streaming between them.
b. Turn notification on for the connected handle (optional) The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Handlel (number): the handle representing one endpoint. Must be greater than 0.
Handle2 (number): the handle representing the other endpoint. Must be greater than 0.
Stream_dir (number): The direction of streaming where:
1 = information goes from Handle 1 to Handle2 2 = information goes from Handle2 to Handle l 3 = streaming goes in both directions between Handle 1 and Handle2 Notify_flag (string): Y or N to enable notification of handle status.
Output Parameters Connect handle (number): the handle representing the connection between the two endpoints/handles.
re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID_HANDLEI = the input parameter Handle 1 was less than or equal to 0.
INVALID_HANDLE2 = the input parameter Handle2 was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_flag was not Y or N
INVALID_STREAM_DIR = the input parameter Stream dir was not 1, 2 or 3.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD_GetCaps (213) Description This state table will get the currently configured `CODEC' (coder/encoder) (also referred to as coder capabilities).
Input Parameters NONE
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_API Name (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API.
caps (number): configuration of tasks running in the SPN256 (for more details refer to the "VOD Custom Server APIs Users Guide"
VOD GetGlobalEv (214) Description This state table API will poll for outbound request events. These requests indicate that some H.323 entity is trying to establish a connection to the gateway (is calling the application - for instance, an inbound call from an IP source).
Input Parameters NONE
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Event-Type (number): May be one of the following values:
0 = no events (requests) present 0x1110 = (int 65688) outbound call attempted Caller_uuid (number):
Caller_H323 (number):
Caller IP (string): IP address of the caller Caller number (string): the number of the PSTN call to be initiated.
VOD GetltemEvt (215) Description This state table API will get more information about an event that was reported to the calling state table via the `WaitEvent' DT function. If an item did not send an event, but an event was posted, this can be used to poll the event's status. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API
will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Handle (number): the handle to be used for the query of events.
Must be greater than 0.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_HANDLE = the input parameter Handle was less than or equal to 0.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API.
Event Type (number): When no event has been received, this field = 0.
Other values are:
VOD_OREQ_HANGUP = (0x0120 = 288) the user at the remote side of the H.323 endpoint hung up.
VOD_OREQ_ERROR = (0x0121 = 289) an error occurred for this item.
VOD_OREQ_STATUS = (0x0122 = 290) the status of the item has changed.
VOD_OREQ_READY = (0x0123 = 291) the status changed to READY
for the first time.
Event Infol (string): additional information pertaining to this event.
Event_Info2 (string): more information pertaining to this event.
VOD_Net Call (216) Description This state table API will initiate an IP outgoing call. In the Call Center scenario, this is used when indication is received that an outbound call is being initiated by an IP port via VOD_GetGlobalEv (214) (in other words, the initiating call is from an IP
address and connection with them as the inbound caller must be established). When the handshaking is finished, the state of the handle will go into READY and an event will be sent. Therefore, in order to know the outcome of the API, the status of the handle needs to be polled using VOD_GetltemEvt (215) or wait for the event after issuing VOD_NotifyEvent (218) and DT/6's WaitEvent. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of '1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Dest IP_Address (string): IP address of the party being called. Must not be blank.
Dest Phone Number (string): the phone number to be called when the party is a gateway. Leave blank, if party is not a gateway (i.e. agent).
Coder Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID_IP_ADDRESS = the input parameter Dest_IP_Address was invalid.
NO_IP_ADDRESS = the input parameter Dest_IP_Address was blank.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): if the call is successful, the handle of this IP
client endpoint.
VOD Net PreAns (217) Description This state table API will confirm that a request was received for an outbound call and is being processed. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters H323-Entry (number): H.323 of the client (received from VOD_GetGlobalEv (214)). Must be greater than 0.
Answer (number): Possible values are Accept (0x00 = 0), Reject (0x01 = 1), Busy (0x02 = 2), No Answer (0x03 = 3). Refer to Exemplary Symbolics (VOD_Net_PreAns (217) Possible Answers) for further details.
Coder_Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_H323_ENTRY = the input parameter H323_Entry was not greater than 0.
INVALID_ANSWER = the input parameter Answer was not greater than 0.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): if successful, the handle of this IP client endpoint.
VOD NotifyEvent (218) Description This state table API will enable or disable notification to the DT state table of events concerning VOD `handle'. Notification will be received by the DT `WaitEvent' function, as a Host Event. Once the Host Event has been detected, the state table must issue VOD GetltemEvt (215) to get details on the event. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of '1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters handle (number): handle for the endpoint for which event information is being retrieved. Must be greater than 0.
Notify_flag (string): 1 = enable, 0 = disable.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID-NOTIFY-FLAG = the input parameter Notify_flag was not Y or N
INVALID-HANDLE = the input parameter handle was not greater than 0.
VOD_Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD_Open_FPlay (219) Description This state table API will open a specified file and send the voice message from this file to the connected endpoint/handle. The file content must be in the correct voice format that is used in the connected endpoint/handle. This does not play the file, but rather 'open' it to be played. In order to actually play the file, this state table API should be followed by VOD_Connect (212), to connect the handle received from this API to the handle of the endpoint that should hear this file. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters File_Name (string): the name of the file to be played. Must not be blank.
Loop_Flag (string): how to play the file.
0 = play once 1 = repeat continuously.
Coder_Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID-FILE-NAME the input parameter File Name was blank.
INVALID-LOOP-FLAG the input parameter Loop_Flag was not 0 or 1.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): handle for this file endpoint. Will be used in the subsequent VOD_Connect.
VOD_Open_Port (220) Description This state table API will perform two functions:
Open a connection to the telephone interface card: opens a SNID with the appropriate number and all voice will pass through 12. Turn notification on for the new handle (optional). The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters snid (number): the port number of the call on the telephony hardware interface card. This is gotten via SPRC_Open_SNID (222). Must be greater than 0.
encoder (number): the output coder tO the PSTN. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
decoder (number): the input coder from the PSTN. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Notify_YN (string): Y or N to enable notification of handle status.
Output Parameters re (number): return code from the Custom Server API Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_YN was not Y or N
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
handle (number): the handle of this PSTN endpoint.
SPRC Disc SNID (221) Description This state table API will perform two functions:
close the connection between an SPACK (DTQA) port set and an SPN256 port set.
Port Resource Control Custom Server (SPRC) Components (202) SPRC_Disc_SNID (221) 10. SPRC_Open_SNID (222) State Table APIs Overview Concept of the APIs Since the basic functionality of the VOD Custom Server is to transfer voice (in real time) from several kinds of sources to several kinds of targets, the concept of the APIs is built of Endpoints and the connections between these Endpoints. The connections between the Endpoints have a particular direction that indicates the direction of the voice streaming. For example, to maintain a standard IP to PSTN phone call, one must open two Endpoints: an IP
Endpoint and a PSTN Endpoint. To enable voice between them (in both directions) two Endpoints need to be connected in full duplex mode.
As another example, to record the PSTN side to a file, one must open the PSTN
Endpoint (if it is not already open), and then open the file record Endpoint and connect the PSTN Endpoint to the record Endpoint in one direction (from PSTN to record). A more complex structure can be created with the restriction that an Endpoint can only have one output connection and one input connection.
The following describes the IBM Voice Over Data (VOD) and SPN256 Voice Over IP
Port Resource Control (SPRC) state table APIs. They act as an interface between IBM's DirectTalk state Tables and the VOD/SPRC Custom Server API's. There are ten VOD state table APIs and two SPRC state table APIs Exemplary State Table API Usage PSTN Calls As illustrated in FIG. 3, when a call is received/made involving a PSTN port (300), the state table APIs used are:
SPRC_Open_SNID (222) (301); and a. VOD_Open_Port (220) (302).
When the call is completed (303), the state table APIs used to free the associated resources for the PSTN port are:
VOD_Close (211) (304); and b. SPRC_Disc_SNID (221) (305).
lP Calls As illustrated in FIG. 4, processing for inbound and outboud IP calls (400) is bifurcated (401). When a call is received involving an IP port (400), the state table APIs if the call is inbound (412) are:
VOD_GetGlobalEv (214) (402);
c. VOD Net_PreAns (217) (403); and d. VOD NotifyEvent (218) (404).
In the case where a VOD connection is to be established for an agent or an outbound call (415) to an IP address is to be made, the state table APIs used are:
VOD_GetCaps (213) (405); and e. VOD Net_Call (216) (406).
Connecting Calls As illustrated in FIG. 5, when two parties are to be connected (500), the state table APIs used are:
VOD NotifyEvent (218) (501).
When the call is completed (502), the state table APIs used to free the associated resources forth PSTN port are:
VOD_Close (211) (503).
Handle Status Notification As illustrated in FIG. 6, the VOD API has the ability to notify the state table of activity concerning a particular `handle' (600). The state table APIs used to establish and use this function are:
VOD NotifyEvent (218) (601) (this function may be called by or included in VOD_Connect (212) (611) and VOD_Open_Port (220) (612)); and f. VOD_GetItemEvt (215) (602).
ON-HOLD Transfers As illustrated in FIG. 7, here is an additional function that provides the ability to play a file to an endpoint (i.e. music, advertisement) (700). The file must first be opened and then connected to the `handle' that will hear the file. The state table APIs used to perform this function are:
VOD_Open_FPlay (219) (701); and 11. VOD_Connect (212) (702).
Exemplary Multi-Service System Referencing FIG. 8, the concepts presented in FIGs. 1-7 may be integrated such as to permit voice (801), telephonic information (802), as well as other types of multi-media data to be interfaced to a personal computer (803) over an IP network (804) to a PSTN
gateway (805) that interfaces with one (806) or more (807) PSTN networks to a variety of remote communication system(s) (808, 809, 810) which may or may not have a structure similar to that of the IP/PSTN gateway of FIG. 8. This figure illustrates the generic capabilities of the present invention extend beyond simple voice communication and may be utilized in some environments to include a wide variety of data, including but not limited to voice, video, and other multi-media components.
VOD State Table APIs VOD Close (211) Description This state table API will perform two functions:
Disable notification (optional); and a. Close an item (endpoint/handle or connection) The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters VOD_Handle (number): the handle representing the endpoint or connection to be closed. Must be greater than 0.
Notify_flag (string): Y or N to disable notification of handle status.
If notification was turned on when the handle was established, it should be turned off at this point.
Output Parameters re (number): return code from the Custom Server API.
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID-HANDLE = the input parameter VOD Handle was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_flag was not Y or N
VOD Problem = the SendData or ReceiveData to the VOD custom server returned to this state table API with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD Connect (212) Description This state table API will perform two functions:
Connects two endpoints/handles and starts the streaming between them.
b. Turn notification on for the connected handle (optional) The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Handlel (number): the handle representing one endpoint. Must be greater than 0.
Handle2 (number): the handle representing the other endpoint. Must be greater than 0.
Stream_dir (number): The direction of streaming where:
1 = information goes from Handle 1 to Handle2 2 = information goes from Handle2 to Handle l 3 = streaming goes in both directions between Handle 1 and Handle2 Notify_flag (string): Y or N to enable notification of handle status.
Output Parameters Connect handle (number): the handle representing the connection between the two endpoints/handles.
re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID_HANDLEI = the input parameter Handle 1 was less than or equal to 0.
INVALID_HANDLE2 = the input parameter Handle2 was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_flag was not Y or N
INVALID_STREAM_DIR = the input parameter Stream dir was not 1, 2 or 3.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD_GetCaps (213) Description This state table will get the currently configured `CODEC' (coder/encoder) (also referred to as coder capabilities).
Input Parameters NONE
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_API Name (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API.
caps (number): configuration of tasks running in the SPN256 (for more details refer to the "VOD Custom Server APIs Users Guide"
VOD GetGlobalEv (214) Description This state table API will poll for outbound request events. These requests indicate that some H.323 entity is trying to establish a connection to the gateway (is calling the application - for instance, an inbound call from an IP source).
Input Parameters NONE
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Event-Type (number): May be one of the following values:
0 = no events (requests) present 0x1110 = (int 65688) outbound call attempted Caller_uuid (number):
Caller_H323 (number):
Caller IP (string): IP address of the caller Caller number (string): the number of the PSTN call to be initiated.
VOD GetltemEvt (215) Description This state table API will get more information about an event that was reported to the calling state table via the `WaitEvent' DT function. If an item did not send an event, but an event was posted, this can be used to poll the event's status. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API
will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Handle (number): the handle to be used for the query of events.
Must be greater than 0.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_HANDLE = the input parameter Handle was less than or equal to 0.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API.
Event Type (number): When no event has been received, this field = 0.
Other values are:
VOD_OREQ_HANGUP = (0x0120 = 288) the user at the remote side of the H.323 endpoint hung up.
VOD_OREQ_ERROR = (0x0121 = 289) an error occurred for this item.
VOD_OREQ_STATUS = (0x0122 = 290) the status of the item has changed.
VOD_OREQ_READY = (0x0123 = 291) the status changed to READY
for the first time.
Event Infol (string): additional information pertaining to this event.
Event_Info2 (string): more information pertaining to this event.
VOD_Net Call (216) Description This state table API will initiate an IP outgoing call. In the Call Center scenario, this is used when indication is received that an outbound call is being initiated by an IP port via VOD_GetGlobalEv (214) (in other words, the initiating call is from an IP
address and connection with them as the inbound caller must be established). When the handshaking is finished, the state of the handle will go into READY and an event will be sent. Therefore, in order to know the outcome of the API, the status of the handle needs to be polled using VOD_GetltemEvt (215) or wait for the event after issuing VOD_NotifyEvent (218) and DT/6's WaitEvent. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of '1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters Dest IP_Address (string): IP address of the party being called. Must not be blank.
Dest Phone Number (string): the phone number to be called when the party is a gateway. Leave blank, if party is not a gateway (i.e. agent).
Coder Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors:
INVALID_IP_ADDRESS = the input parameter Dest_IP_Address was invalid.
NO_IP_ADDRESS = the input parameter Dest_IP_Address was blank.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): if the call is successful, the handle of this IP
client endpoint.
VOD Net PreAns (217) Description This state table API will confirm that a request was received for an outbound call and is being processed. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters H323-Entry (number): H.323 of the client (received from VOD_GetGlobalEv (214)). Must be greater than 0.
Answer (number): Possible values are Accept (0x00 = 0), Reject (0x01 = 1), Busy (0x02 = 2), No Answer (0x03 = 3). Refer to Exemplary Symbolics (VOD_Net_PreAns (217) Possible Answers) for further details.
Coder_Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_H323_ENTRY = the input parameter H323_Entry was not greater than 0.
INVALID_ANSWER = the input parameter Answer was not greater than 0.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): if successful, the handle of this IP client endpoint.
VOD NotifyEvent (218) Description This state table API will enable or disable notification to the DT state table of events concerning VOD `handle'. Notification will be received by the DT `WaitEvent' function, as a Host Event. Once the Host Event has been detected, the state table must issue VOD GetltemEvt (215) to get details on the event. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of '1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters handle (number): handle for the endpoint for which event information is being retrieved. Must be greater than 0.
Notify_flag (string): 1 = enable, 0 = disable.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID-NOTIFY-FLAG = the input parameter Notify_flag was not Y or N
INVALID-HANDLE = the input parameter handle was not greater than 0.
VOD_Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
VOD_Open_FPlay (219) Description This state table API will open a specified file and send the voice message from this file to the connected endpoint/handle. The file content must be in the correct voice format that is used in the connected endpoint/handle. This does not play the file, but rather 'open' it to be played. In order to actually play the file, this state table API should be followed by VOD_Connect (212), to connect the handle received from this API to the handle of the endpoint that should hear this file. The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters File_Name (string): the name of the file to be played. Must not be blank.
Loop_Flag (string): how to play the file.
0 = play once 1 = repeat continuously.
Coder_Caps (number): the current CODEC of the SPN256. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID-FILE-NAME the input parameter File Name was blank.
INVALID-LOOP-FLAG the input parameter Loop_Flag was not 0 or 1.
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL_ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) VOD_APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
Handle (number): handle for this file endpoint. Will be used in the subsequent VOD_Connect.
VOD_Open_Port (220) Description This state table API will perform two functions:
Open a connection to the telephone interface card: opens a SNID with the appropriate number and all voice will pass through 12. Turn notification on for the new handle (optional). The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters snid (number): the port number of the call on the telephony hardware interface card. This is gotten via SPRC_Open_SNID (222). Must be greater than 0.
encoder (number): the output coder tO the PSTN. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
decoder (number): the input coder from the PSTN. Refer to Exemplary Symbolics (Coder Capabilities) for expected values.
Notify_YN (string): Y or N to enable notification of handle status.
Output Parameters re (number): return code from the Custom Server API Refer to Exemplary Symbolics (VOD Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID-NOTIFY-FLAG the input parameter Notify_YN was not Y or N
VOD Problem = the SendData or ReceiveData to the VOD
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
handle (number): the handle of this PSTN endpoint.
SPRC Disc SNID (221) Description This state table API will perform two functions:
close the connection between an SPACK (DTQA) port set and an SPN256 port set.
13. close the SPN256 port set and deallocate the SPN256 port The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters dtqa_chan (number): the DTQA channel to be disconnected. Must be greater than 0. In DT, typically use system parameter SV 165: Channel number.
snid (number): SNID associated to the SPN256 port to be disconnected and deallocated.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (SPRC Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID_DTQA_CHANNEL= the input parameter dtqa chan was not greater than 0.
SPRC PROBLEM = the SendData or ReceiveData to the SPRC
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
SPRC Open_SNID (222) Description This state table API will perform two functions:
allocate a bidirectional port in the SPN256.
a. connect an SPACK (DTQA) port set to a SPN256 port set.
The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters dtqa_chan (number): DTQA channel where call arrived, to be connected to the SPN256 port.
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (SPRC Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID_DTQA_CHANNEL= the input parameter dtga_chan was not greater than 0.
SPRC PROBLEM = the SendData or ReceiveData to the SPRC
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
snid (number): SNID associated to the preallocated SPN256 port to be connected.
Method As described previously in reference to the flowcharts of FIGs. 3-7, the present invention may incorporate a variety of methods to implement the functions described herein. While the API flowcharts detailed previously are exemplary of a preferred method of implementation, one skilled in the art will readily be able to augment these teachings, and as such they are not limitive of the scope of the present invention. One skilled in the art will recognize that these steps may be rearranged and/or augmented with no loss of generality in the teachings of the present invention.
The teachings of the present invention are sufficiently broad to not limit the manner in which the above-mentioned steps are to be performed as well as not limiting the method to any particular hardware, operating system, API, or graphical user interface. Thus, while the particular information gathered within the context of the flowcharts provided and the specific function calls listed in the exemplary flowcharts are preferred for some embodiments, they are by no means limitive of the present invention teachings or the scope thereof.
1s Computer Software As would be known by one skilled in the art and as indicated in the exemplary embodiments of FIGs. 1-8, the system and method described herein and generally illustrated in FIGs. 1-8 may be reduced to computer instruction codes and embodied on a computer readable storage means. This may take the form of a wide variety of storage media well known in the art and/or contemplated for future use. Thus, the present invention specifically anticipates the incorporation of the system and methods discussed herein in the form of tangible computer software products.
Furthermore, while not limiting the scope of the present invention, the present invention specifically anticipates that one or more components of the present invention may be implemented using the AIX operating environment in all its variations or its equivalent commercial embodiments, including but not limited to any system incorporating a graphical user interface.
CONCLUSION
A multi-service communication system and method has been disclosed which permits the integration of traditional PSTN functions and voice-over-IP/voice-over-data (VOIP/VOD) functions within the same communication system. The extension of scripting functions to support these features in general simultaneously permits the script to interact with PSTN and IP
telephones within the context of the same services, to share the same service logic for both PSTN
and IP media, to conference participants on both PSTN and IP, to store and forward information between the two media, to play on-hold media to the interface, and/or to monitor information between the two media. In general the disclosed invention is amenable to the integration of PSTN and VOIP networks, but other service functions may be integrated with no loss of generality.
Input Parameters dtqa_chan (number): the DTQA channel to be disconnected. Must be greater than 0. In DT, typically use system parameter SV 165: Channel number.
snid (number): SNID associated to the SPN256 port to be disconnected and deallocated.
Output Parameters rc (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (SPRC Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID_DTQA_CHANNEL= the input parameter dtqa chan was not greater than 0.
SPRC PROBLEM = the SendData or ReceiveData to the SPRC
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
SPRC Open_SNID (222) Description This state table API will perform two functions:
allocate a bidirectional port in the SPN256.
a. connect an SPACK (DTQA) port set to a SPN256 port set.
The state table will also do some preliminary checking of input parameters. If an input parameter is not valid, this state table API will return to the calling state table with a result of `1' and the `Reason' field will contain information about the invalid parameter.
Input Parameters dtqa_chan (number): DTQA channel where call arrived, to be connected to the SPN256 port.
Output Parameters re (number): return code from the Custom Server API
0 = successful. Refer to Exemplary Symbolics (SPRC Return Codes) for details on all other return codes.
Reason (string): if this state table returns to the calling state table with a RESULT = 1 (not `Return code'), this field will contain one of the following errors.
INVALID_SNID = the input parameter snid was less than or equal to 0.
INVALID_DTQA_CHANNEL= the input parameter dtga_chan was not greater than 0.
SPRC PROBLEM = the SendData or ReceiveData to the SPRC
custom server returned to this state table API
with an unexpected state.
INTERNAL-ERROR = the state table API had a system error (i.e. data mismatch, overflow, state table not invoked, etc.) APIName (string): this field contains the name of the custom server API that returned the `Return code' parameter value. This is mainly used for debugging when the state table API interacts with more than one custom server API
snid (number): SNID associated to the preallocated SPN256 port to be connected.
Method As described previously in reference to the flowcharts of FIGs. 3-7, the present invention may incorporate a variety of methods to implement the functions described herein. While the API flowcharts detailed previously are exemplary of a preferred method of implementation, one skilled in the art will readily be able to augment these teachings, and as such they are not limitive of the scope of the present invention. One skilled in the art will recognize that these steps may be rearranged and/or augmented with no loss of generality in the teachings of the present invention.
The teachings of the present invention are sufficiently broad to not limit the manner in which the above-mentioned steps are to be performed as well as not limiting the method to any particular hardware, operating system, API, or graphical user interface. Thus, while the particular information gathered within the context of the flowcharts provided and the specific function calls listed in the exemplary flowcharts are preferred for some embodiments, they are by no means limitive of the present invention teachings or the scope thereof.
1s Computer Software As would be known by one skilled in the art and as indicated in the exemplary embodiments of FIGs. 1-8, the system and method described herein and generally illustrated in FIGs. 1-8 may be reduced to computer instruction codes and embodied on a computer readable storage means. This may take the form of a wide variety of storage media well known in the art and/or contemplated for future use. Thus, the present invention specifically anticipates the incorporation of the system and methods discussed herein in the form of tangible computer software products.
Furthermore, while not limiting the scope of the present invention, the present invention specifically anticipates that one or more components of the present invention may be implemented using the AIX operating environment in all its variations or its equivalent commercial embodiments, including but not limited to any system incorporating a graphical user interface.
CONCLUSION
A multi-service communication system and method has been disclosed which permits the integration of traditional PSTN functions and voice-over-IP/voice-over-data (VOIP/VOD) functions within the same communication system. The extension of scripting functions to support these features in general simultaneously permits the script to interact with PSTN and IP
telephones within the context of the same services, to share the same service logic for both PSTN
and IP media, to conference participants on both PSTN and IP, to store and forward information between the two media, to play on-hold media to the interface, and/or to monitor information between the two media. In general the disclosed invention is amenable to the integration of PSTN and VOIP networks, but other service functions may be integrated with no loss of generality.
Claims (69)
1. A multi-service communication system comprising:
a PSTN interface means;
a PSTN gateway client application means;
an IP interface means;
wherein said PSTN gateway means permits at least one of a uni-directional and a bi-directional communication between said PSTN Interface means and said IP interface means, wherein one or more components of said system is implemented on a multi-services server wherein said multi-services server utilizes a graphical user interface;
wherein said graphical user interface utilizes a Unix-based operating environment.
a PSTN interface means;
a PSTN gateway client application means;
an IP interface means;
wherein said PSTN gateway means permits at least one of a uni-directional and a bi-directional communication between said PSTN Interface means and said IP interface means, wherein one or more components of said system is implemented on a multi-services server wherein said multi-services server utilizes a graphical user interface;
wherein said graphical user interface utilizes a Unix-based operating environment.
2. The multi-service communication system of claim 1 wherein said PSTN gateway means further comprises:
a VOD_Close means;
VOD_ Connect means;
VOD_GetCaps means;
VOD GetGlobalEv means;
VOD_GetltemEvt means;
VOD_Close means;
a VOD_Net_Call means;
a VOD_Net_PreAns means;
VOD_NotifyEvent means;
VOD_Open_FPlay means; and a VOD_Open Port means.
a VOD_Close means;
VOD_ Connect means;
VOD_GetCaps means;
VOD GetGlobalEv means;
VOD_GetltemEvt means;
VOD_Close means;
a VOD_Net_Call means;
a VOD_Net_PreAns means;
VOD_NotifyEvent means;
VOD_Open_FPlay means; and a VOD_Open Port means.
3. The multi-service communication system of claim 2 wherein one or more components of said system is implemented within an application programming interface (API).
4. The multi-service communication system of claim 2 wherein said communication occurs between PC-to-phone endpoints.
5. The multi-service communication system of claim 2 wherein said communication occurs between phone-to-PC endpoints.
6. The multi-service communication system of claim 2 wherein said communication occurs between phone-to-phone endpoints.
7. The multi-service communication system of claim 2 wherein one or more components of said system is implemented on a multi-services server.
8. The multi-service communication system of claim 7 wherein said multi-services server utilizes a graphical user interface.
9. The multi-service communication system of claim 8 wherein said graphical user interface utilizes a AIX®.operating environment
10. The multi-service communication system of claim 2 wherein said PSTN
gateway means further comprises:
a SPRC_Disc_SNID means; and a SPRC_Open_SNID means.
gateway means further comprises:
a SPRC_Disc_SNID means; and a SPRC_Open_SNID means.
11. The multi-service communication system of claim 10 wherein one or more components of said system is implemented within an application programming interface (API).
12. The multi-service communication system of claim 10 wherein said communication occurs between PC-to-phone endpoints.
13. The multi-service communication system of claim 10 wherein said communication occurs between phone-to-PC endpoints.
14. The multi-service communication system of claim 10 wherein said communication occurs between phone-to-phone endpoints.
15. The multi-service communication system of claim 10 wherein one or more components of said system is implemented on a multi-services server.
16. The multi-service communication system of claim 15 wherein said multi-services server utilizes a graphical user interface.
17. The multi-service communication system of claim 16 wherein said graphical user interface utilizes a AIXC operating environment.
18. A multi-service communication method comprising:
processing PSTN calls with a PSTN call processing process means;
processing IP calls with an IP call processing process means;
processing connecting calls with a connecting call processing process means;
processing handle status notifications with a handle status notification processing process means;
processing ON-HOLD calls with an ON-HOLD call processing process means, wherein said processing may be performed at least one of synchronously and asynchronously.
processing PSTN calls with a PSTN call processing process means;
processing IP calls with an IP call processing process means;
processing connecting calls with a connecting call processing process means;
processing handle status notifications with a handle status notification processing process means;
processing ON-HOLD calls with an ON-HOLD call processing process means, wherein said processing may be performed at least one of synchronously and asynchronously.
19. The multi-service communication method of claim 18 wherein one or more steps of said method is implemented within an application programming interface (API).
20. The multi-service communication method of claim 18 wherein said communication occurs between PC-to-phone endpoints.
21. The multi-service communication method of claim 18 wherein said communication occurs between phone-to-PC endpoints.
22. The multi-service communication method of claim 18 wherein said communication occurs between phone-to-phone endpoints.
23. The multi-service communication method of claim 18 wherein one or more steps is implemented on a multi-services server.
24. The multi-service communication method of claim 23 wherein said multi-services server utilizes a graphical user interface.
25. The multi-service communication method of claim 24 wherein said graphical user interface utilizes a AIX® operating environment.
26. The multi-service communication method of claim 18 wherein said PSTN call processing step further comprises:
activating a SPRC_Open_SNID process means;
activating a VOD_Open_Port process means;
waiting for call completion;
activating a VOD_Close process means; and activating a SPRC_Disc_SNID process means.
activating a SPRC_Open_SNID process means;
activating a VOD_Open_Port process means;
waiting for call completion;
activating a VOD_Close process means; and activating a SPRC_Disc_SNID process means.
27. The multi-service communication method of claim 26 wherein one or more steps of said method is implemented within an application programming interface (API).
28. The multi-service communication method of claim 26 wherein said communication occurs between PC-to-phone endpoints.
29. The multi-service communication method of claim 26 wherein said communication occurs between phone-to-PC endpoints.
30. The multi-service communication method of claim 26 wherein said communication occurs between phone-to-phone endpoints.
31. The multi-service communication method of claim 26 wherein one or more steps is implemented on a multi-services server.
32. The multi-service communication method of claim 31 wherein said multi-services server utilizes a graphical user interface.
33. The multi-service communication method of claim 32 wherein said graphical user interface utilizes a AIX operating environment.
34. The multi-service communication method of claim 18 wherein said IP call processing step further comprises:
(1) determining if said call is outbound, and if so, proceeding to step (5);
(2) activating a VOD_Get_GlobalEv process means;
(3) activating a VOD_Net_PreAns process means;
(4) activating a VOD_NotifyEvent process means and terminating processing;
(5) activating a VOD_GetCaps process means; and (6) activating a VOD_ Net_Call process means and terminating processing.
(1) determining if said call is outbound, and if so, proceeding to step (5);
(2) activating a VOD_Get_GlobalEv process means;
(3) activating a VOD_Net_PreAns process means;
(4) activating a VOD_NotifyEvent process means and terminating processing;
(5) activating a VOD_GetCaps process means; and (6) activating a VOD_ Net_Call process means and terminating processing.
35. The multi-service communication method of claim 34 wherein one or more steps of said method is implemented within an application programming interface (API).
36. The multi-service communication method of claim 34 wherein said communication occurs between PC-to-phone endpoints.
37. The multi-service communication method of claim 34 wherein said communication occurs between phone-to-PC endpoints.
38. The multi-service communication method of claim 34 wherein said communication occurs between phone-to-phone endpoints.
39. The multi-service communication method of claim 34 wherein one or more steps is implemented on a multi-services server.
40. The multi-service communication method of claim 39 wherein said multi-services server utilizes a graphical user interface.
41. The multi-service communication method of claim 40 wherein said graphical user interface utilizes a AIX® operating environment.
42. The multi-service communication method of claim 18 wherein said connecting call processing step further comprises:
activating a VOD_NotifyEvent process means;
waiting for call completion; and activating a VOD_Close process means.
activating a VOD_NotifyEvent process means;
waiting for call completion; and activating a VOD_Close process means.
43. The multi-service communication method of claim 42 wherein one or more steps of said method is implemented within an application programming interface (API).
44. The multi-service communication method of claim 42 wherein said communication occurs between PC-to-phone endpoints.
45. The multi-service communication method of claim 42 wherein said communication occurs between phone-to-PC endpoints.
46. The multi-service communication method of claim 42 wherein said communication occurs between phone-to-phone endpoints.
47. The multi-service communication method of claim 42 wherein one or more steps is implemented on a multi-services Server.
48. The multi-service communication method of claim 47 wherein said multi-services server utilizes a graphical user interface.
49. The multi-service communication method of claim 48 wherein said graphical user interface utilizes a AIX® operating environment.
50. The multi-service communication method of claim 18 wherein said handle status notification processing step further comprises:
activating a VOD_NotifyEvent process means in at least of one of singly and in response to at least one requests from a VOD_Connect process means and a VOD_Open_Port process means; and activating a VOD_GetltemEvt process means.
activating a VOD_NotifyEvent process means in at least of one of singly and in response to at least one requests from a VOD_Connect process means and a VOD_Open_Port process means; and activating a VOD_GetltemEvt process means.
51. The multi-service communication method of claim 50 wherein one or more steps of said method is implemented within an application programming interface (API).
52. The multi-service communication method of claim 50 wherein said communication occurs between PC-to-phone endpoints.
53. The multi-service communication method of claim 50 wherein said communication occurs between phone-to-PC endpoints.
54. The multi-service communication method of claim 50 wherein said communication occurs between phone-to-phone endpoints.
55. The multi-service communication method of claim 50 wherein one or more steps is implemented on a multi-services server.
56. The multi-service communication method of claim 55 wherein said multi-services server utilizes a graphical user interface.
57. The multi-service communication method of claim 56 wherein said graphical user interface utilizes a AIX® operating environment.
58. The multi-service communication method of claim 18 wherein said ON-HOLD
call processing step further comprises:
activating a VOD_Open_FPlay process means;
activating a VOD_Connect process means; and waiting for call completion.
call processing step further comprises:
activating a VOD_Open_FPlay process means;
activating a VOD_Connect process means; and waiting for call completion.
59. The multi-service communication method of claim 58 wherein one or more steps of said method is implemented within an application programming interface (API).
60. The multi-service communication method of claim 58 wherein said communication occurs between PC-to-phone endpoints.
61. The multi-service communication method of claim 58 wherein said communication occurs between phone-to-PC endpoints.
62. The multi-service communication method of claim 58 wherein said communication occurs between phone-to-phone endpoints.
63. The multi-service communication method of claim 58 wherein one or more steps is implemented on a multi-server.
64. The multi-service communication method of claim 63 wherein said multi-service utilizes a graphical user interface.
65. The multi-service communication method of claim 64 wherein said graphical user interface utilizes a AIX® operating environment.
66. A computer usable medium having computer-readable program code means providing multi-service communication embodied thereon, said computer-readable program means comprising:
computer program code means for processing PSTN calls with a PSTN call processing process means;
computer program code means for processing PSTN calls with a PSTN call processing process means;
67 computer program code means for processing IP calls with an IP call processing process means;
computer program code means for processing connecting calls with a connecting call processing process means;
computer program code means for processing handle status notifications with a handle status notification processing process means;
computer program code means for processing ON-HOLD calls with an ON-HOLD call processing process means.
67. The computer usable medium of claim 66 wherein said medium is compatible with a multi-services server.
computer program code means for processing connecting calls with a connecting call processing process means;
computer program code means for processing handle status notifications with a handle status notification processing process means;
computer program code means for processing ON-HOLD calls with an ON-HOLD call processing process means.
67. The computer usable medium of claim 66 wherein said medium is compatible with a multi-services server.
68. The computer usable medium of claim 67 wherein said computer code means utilizes a graphical user interface.
69. The computer usable medium of claim 68 wherein said graphical user interface utilizes a AIX® operating environment.
Applications Claiming Priority (2)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| US09/521,361 US6654456B1 (en) | 2000-03-08 | 2000-03-08 | Multi-service communication system and method |
| US09/521,361 | 2000-03-08 |
Publications (2)
| Publication Number | Publication Date |
|---|---|
| CA2337782A1 CA2337782A1 (en) | 2001-09-08 |
| CA2337782C true CA2337782C (en) | 2010-09-21 |
Family
ID=24076445
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CA2337782A Expired - Lifetime CA2337782C (en) | 2000-03-08 | 2001-02-15 | Multi-service communication system and method |
Country Status (7)
| Country | Link |
|---|---|
| US (1) | US6654456B1 (en) |
| EP (1) | EP1133140A3 (en) |
| JP (1) | JP2002009938A (en) |
| KR (1) | KR100398010B1 (en) |
| CN (1) | CN1199417C (en) |
| CA (1) | CA2337782C (en) |
| TW (1) | TW548948B (en) |
Families Citing this family (25)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| JP3764016B2 (en) * | 1999-05-10 | 2006-04-05 | 財団法人流通システム開発センタ− | Integrated IP transfer network |
| US7301952B2 (en) | 2000-04-06 | 2007-11-27 | The Distribution Systems Research Institute | Terminal-to-terminal communication connection control method using IP transfer network |
| SG101985A1 (en) * | 2000-07-12 | 2004-02-27 | Distribution Systems Res Inst | Integrated information communication system |
| US7095733B1 (en) * | 2000-09-11 | 2006-08-22 | Yahoo! Inc. | Voice integrated VOIP system |
| EP1265445A3 (en) | 2001-06-08 | 2007-05-30 | The Distribution Systems Research Institute | Terminal-to-terminal communication connection control system for IP full service |
| CN1172504C (en) | 2001-09-29 | 2004-10-20 | 华为技术有限公司 | Method of creating charging identification in internet one number link you |
| AU2002301409B2 (en) * | 2001-10-13 | 2003-11-06 | Samsung Electronics Co., Ltd. | Internet protocol telephony exchange system and call control method thereof |
| AU2002235084A1 (en) * | 2002-03-04 | 2003-09-16 | Telefonaktiebolaget Lm Ericsson (Publ) | An arrangement and a method for handling an audio signal |
| US7907550B1 (en) * | 2002-03-19 | 2011-03-15 | At&T Intellectual Property Ii, L.P. | Method and system for providing voice over IP conferencing service |
| US8072979B2 (en) * | 2002-06-07 | 2011-12-06 | The Distribution Systems Research Institute | Terminal-to-terminal communication control system for IP full service |
| CN100388743C (en) * | 2003-06-14 | 2008-05-14 | 华为技术有限公司 | An adapter and communication method and system implemented by using same |
| US20050157863A1 (en) * | 2004-01-21 | 2005-07-21 | Sizemore Rodney J.Jr. | Customizable proactively prompted IP telephone service |
| CN1310511C (en) * | 2004-02-11 | 2007-04-11 | 北京中视联数字系统有限公司 | Multiple-service data broadcast service platform and multiple-service integration method |
| CN100440968C (en) * | 2004-04-09 | 2008-12-03 | 华为技术有限公司 | System and method for broadcasting flow media data on demand |
| US7573988B2 (en) * | 2004-06-02 | 2009-08-11 | Dynalab Inc. | System and method for providing customized voice connection services via gatekeeper |
| US20060133596A1 (en) * | 2004-12-06 | 2006-06-22 | Steinlicht Joseph C | Centrex replacement ACD |
| US20060250976A1 (en) * | 2005-04-12 | 2006-11-09 | Cisco Technology, Inc. | Method and apparatus for media device correspondence |
| US8483100B2 (en) * | 2005-11-14 | 2013-07-09 | Broadcom Corporation | Communication device supporting both internet and public switched telephone network telephony |
| TW200729842A (en) * | 2006-01-25 | 2007-08-01 | Vastech Sa Proprietary Ltd | An electronic communications recording system |
| US20070223465A1 (en) * | 2006-03-21 | 2007-09-27 | Lee Wang | System, method and article for VOIP and PSTN communication |
| US8488599B2 (en) * | 2006-11-13 | 2013-07-16 | Sharp Laboratories Of America, Inc. | Auto-switching method and device for dual mode analog-VoIP device |
| US20080175232A1 (en) * | 2007-01-18 | 2008-07-24 | Tsai Wei K | System and method for multi-service virtual networks by integration, convergence, zero opportunity cost, and distributed user control |
| EP2063621A1 (en) * | 2007-11-23 | 2009-05-27 | Axalto S.A. | A mobile telephone call-back method run on the SIM card |
| CN101321140B (en) * | 2008-07-11 | 2011-07-20 | 东南大学 | Digital relay gateway and its implementing method |
| US20100199320A1 (en) * | 2009-02-02 | 2010-08-05 | Microsoft Corporation | Multimodal escalation to endpoints in enhanced communication systems |
Family Cites Families (8)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US5619554A (en) * | 1994-06-08 | 1997-04-08 | Linkusa Corporation | Distributed voice system and method |
| SE511342C2 (en) * | 1996-12-09 | 1999-09-13 | Telia Ab | Method and device for telephony via the Internet |
| US6292481B1 (en) * | 1997-09-16 | 2001-09-18 | Bell Atlantic Network Services, Inc. | Inter-carrier signaling and usage accounting architecture for internet telephony |
| KR100230548B1 (en) * | 1997-08-14 | 1999-11-15 | 구자홍 | Computer-telephone integrating system and spreading method using thereof |
| US6337899B1 (en) * | 1998-03-31 | 2002-01-08 | International Business Machines Corporation | Speaker verification for authorizing updates to user subscription service received by internet service provider (ISP) using an intelligent peripheral (IP) in an advanced intelligent network (AIN) |
| WO1999052237A1 (en) * | 1998-04-03 | 1999-10-14 | Vertical Networks Inc. | System and method for transmitting voice and data using intelligent bridged tdm and packet buses |
| EP0966145A3 (en) * | 1998-06-19 | 2003-07-16 | Nortel Networks Limited | IP telephony gateway |
| US6438105B1 (en) * | 1999-02-08 | 2002-08-20 | 3Com Corporation | Reliable internet facsimile protocol |
-
2000
- 2000-03-08 US US09/521,361 patent/US6654456B1/en not_active Expired - Lifetime
- 2000-11-20 TW TW089124579A patent/TW548948B/en not_active IP Right Cessation
-
2001
- 2001-02-15 CA CA2337782A patent/CA2337782C/en not_active Expired - Lifetime
- 2001-02-15 EP EP01480014A patent/EP1133140A3/en not_active Ceased
- 2001-02-17 KR KR10-2001-0008014A patent/KR100398010B1/en not_active IP Right Cessation
- 2001-03-07 CN CNB011109645A patent/CN1199417C/en not_active Expired - Lifetime
- 2001-03-08 JP JP2001064325A patent/JP2002009938A/en active Pending
Also Published As
| Publication number | Publication date |
|---|---|
| TW548948B (en) | 2003-08-21 |
| KR20010088344A (en) | 2001-09-26 |
| CA2337782A1 (en) | 2001-09-08 |
| KR100398010B1 (en) | 2003-09-19 |
| EP1133140A3 (en) | 2006-03-22 |
| CN1199417C (en) | 2005-04-27 |
| EP1133140A2 (en) | 2001-09-12 |
| US6654456B1 (en) | 2003-11-25 |
| JP2002009938A (en) | 2002-01-11 |
| CN1312635A (en) | 2001-09-12 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CA2337782C (en) | Multi-service communication system and method | |
| US6754180B1 (en) | System, method, and computer program product for support of bearer path services in a distributed control network | |
| US9794411B2 (en) | Call transfer using session initiation protocol (SIP) | |
| EP1254583B1 (en) | Circuit switched private communication network with integrated packet switched multimedia extensions | |
| US6996094B2 (en) | System and method for packet network media redirection | |
| US7986684B2 (en) | Multi-mode endpoint in a communication network system and methods thereof | |
| US8218457B2 (en) | Apparatus and method for providing communication services using multiple signaling protocols | |
| US20050091407A1 (en) | Multi-network exchange system for telephony applications | |
| US20100290453A1 (en) | Method and Communication Terminal for Providing VOIP | |
| JP2000032146A (en) | Automatic callout distribution system and communication network | |
| WO2001065808A2 (en) | Apparatus and method for telephony service interface | |
| EP0986881A4 (en) | Switchless call processing | |
| CA2439615C (en) | Apparatus and method for computer controlled call processing applications in packet switched telephone networks | |
| CN1487700A (en) | Intercommunication deputizing device and system and method for intercommunicating networks of different protocol | |
| US7319693B2 (en) | Integrate network switching system | |
| US6785741B1 (en) | Call director system and method | |
| US20050135339A1 (en) | System architecture for internet telephone | |
| MXPA03002884A (en) | Network telephony appliance and system supporting wireless internet telephony. | |
| Cisco | Cisco JTAPI Extensions | |
| Kumar et al. | A multi-signaling protocol architecture for voice over IP terminal | |
| Ackermann et al. | An Open Source H. 323-SIP Gateway as Basis for Supplementary Service Interworking | |
| Ohaegbu et al. | Customer relationship management in e-commerce: the call center solution | |
| US8184557B2 (en) | Apparatus and method for computer controlled call processing applications in packet switched telephone networks | |
| Muslim | Software Engineering 4C03 VoIP: The Next Telecommunication Frontier | |
| WO2007131456A1 (en) | An apparatus for the communication between the computer and the wired phone through the internet |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| EEER | Examination request | ||
| MKEX | Expiry |
Effective date: 20210215 |
|
| MKEX | Expiry |
Effective date: 20210215 |