Page 1 ReadiVoice ® PSPI Reference...
Page 2 (e.g. a book or sound recording). Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not responsible for printing or clerical errors. Information in this document is subject to change without notice.
Page 3: Table Of Contents
Contents 1 Introduction to PSPI Overview of PSPI ..........1 Legacy vs.
Page 4 ReadiVoice PSPI Reference GetSubByEIdB() ..........56 GetSub_v2500() .
Page 5 4 Legacy v. 2.13.0/2.30.0 PSPI Functions AddGroupAcm() ..........128 AddGrpAccessClass() .
Page 6 ReadiVoice PSPI Reference DelAssignedPN() ..........198 DeleteSubscriber() .
Page 7 GetSub_v2000() ..........250 GetSysConfig() .
Page 8 ReadiVoice PSPI Reference A Defines and Return Codes PSPI Return Codes ..........305 Database Length Defines .
Page 9: Introduction To Pspi
Caution! Polycom authorizes the use of only the stored procedures described in this publication. Other .sp files reside in the ReadiVoice file system; however, those not included here are designed for Polycom internal use only and may cause unforeseen problems if used otherwise.
Page 10: Legacy Vs. Current Pspi Functions
(to the extent possible) in newer versions of the software. If you developed an interface for an earlier version of ReadiVoice/ConferenceNow!, you can continue using it with ReadiVoice v. 2.50.0 or later, with little or no code modifications. Caution! If two-passcode call flow is enabled, then you can’t use any pre-v.2.10.0 stored...
Page 11 If you want to provision the new options and features available in ReadiVoice v. 2.5x.x., rewrite your legacy code to use only the current PSPI functions. Each of the subsequent chapters is a PSPI reference for a specific version of the ReadiVoice stored procedures.
Page 12: Setting Up To Use Pspi
Install an ODBC (open database connectivity) or JDBC (Java database connectivity) driver on the client computer. Properly set up the environment on the client computer. Configure the ODBC/JDBC driver to access your ReadiVoice database on the server. Set up your application to talk to the ODBC/JDBC driver.
Page 13 On the server side, you can execute a stored procedure call as a stand-alone entity with INFORMIX-SQL. Caution! Polycom strongly advises against server-side access in a production environment. For this kind of testing and debugging, the system should be off line. You can use INFORMIX-SQL in two ways: •...
Page 14 ReadiVoice PSPI Reference For information about additional options, including saving your SPC as a command file or sending the output to a printer or file, see the INFORMIX-SQL User Guide. To execute an SPC query from the command line using a command file: isql databaseName -qr commandfilename [| pg,more,head] You can, of course, pipe the output to a file.
Page 15: Current Pspi Functions
ReadiVoice-IP functionality was merged into the standard release of ReadiVoice v. 2.30.0, so the same stored procedures are used for both the ReadiVoice-PSTN and ReadiVoice-IP configurations. Do not, however, “mix and match” current and legacy functions (or two different levels of legacy functions, such as v.
Page 16: Addgroupacm()
Caution! Polycom authorizes the use of only the stored procedures described in this publication. Other .sp files reside in the ReadiVoice file system; however, those not included here are designed for Polycom internal use only and may cause unforeseen problems if used otherwise.
Page 17: Addgrpaccessclass()
AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 18: Addmodsubgroup_V2500()
ReadiVoice PSPI Reference AddModSubGroup_v2500() Stored procedure for adding a subscriber group to the database or modifying an existing group. If you set vCheckParms to 1, the SPC verifies that: • • • • Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 19 Parameter Data Type vBillingType SMALLINT vBillingPhone CHAR (30) vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vPromptSet vCarrierId vClientGrpA CHAR (255) vClientGrpB CHAR (255) vOperNotes CHAR (512) vRollCall SMALLINT vDialOut SMALLINT vContinuation...
Page 20 ReadiVoice PSPI Reference Parameter Data Type vRollCallEnable SMALLINT vQuickStartEnable SMALLINT vPasswordEnable SMALLINT vContinueEnable SMALLINT vNameRecord SMALLINT vAutoContinuation SMALLINT vNameRecordEnable SMALLINT vLOEntryEnable SMALLINT vWROptionEnable SMALLINT vConfRecAvailable SMALLINT vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount...
Page 21 Parameter Data Type vDialOutPostFix CHAR (30) vLOEntry SMALLINT vWROption SMALLINT vLanguage CHAR (4) vCity CHAR (20) vState CHAR (20) vZip CHAR (15) vTimezone vEmail CHAR (120) vCountry CHAR (60) vFax CHAR (30) Return Values Data Type CHAR (256) Proprietary & Confidential Constraints Description Number to dial after dialing out (numeric chars...
Page 22: Addphonenum()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 23 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT vAccessNum CHAR (60) vHiddenNum CHAR (60) vSharedFlag SMALLINT vNumberType SMALLINT vNumberGroup SMALLINT SubscriberId Return Values DataType Proprietary & Confidential Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 24: Addsubacm()
ReadiVoice PSPI Reference AddSubAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 25: Addsubandan_V2500()
AddSubAndAN_v2500() Stored procedure for adding a new subscriber and, optionally, new access number(s) to the database at the same time. You can specify up to three access numbers for a new subscriber even if those access numbers don’t currently exist in the database. There is no AddSub_v2500() procedure.
Page 26 Caution! The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate.pl script, as described in the ReadiVoice Administration & Maintenance Guide. If your system uses fixed translation numbers (see the bridge administration If vExternalId is used for and system configuration topics in the ReadiVoice Administration &...
Page 27 Parameter Data Type vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT...
Page 28 ReadiVoice PSPI Reference Parameter Data Type vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30)
Page 29 Parameter Data Type vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vWROption SMALLINT vWROptionEnable SMALLINT Proprietary & Confidential Constraints Description VIP conference option (guaranteed ports). 0, 1 0: Off;...
Page 30 ReadiVoice PSPI Reference Parameter Data Type vAccessCode CHAR (20) vAccessNumber1 CHAR (60) vHiddenNum1 CHAR (60) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (60) vHiddenNum2 CHAR (60) vSharedFlag2 SMALLINT vNumberType2 SMALLINT vAccessNumber3 CHAR (60) vHiddenNum3 CHAR (60) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Constraints...
Page 31: Addsubandan_V2550()
You can specify up to three access numbers for a new subscriber even if those access numbers don’t currently exist in the database. This procedure requires ReadiVoice v. 2.55.0 or later. There is no AddSub_v2550() procedure. Use this procedure for all add subscriber operations;...
Page 32 ReadiVoice PSPI Reference Parameter Data Type AccessNumVerify SMALLINT vEntryDate DATETIME YEAR TO MINUTE vActivationDate DATETIME YEAR TO MINUTE vBillingId vBillingType SMALLINT vBillingPhone CHAR (30) vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255)
Page 33 Parameter Data Type vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT Proprietary & Confidential Constraints Description Subscriber password.
Page 34 ReadiVoice PSPI Reference Parameter Data Type vExternalId CHAR (30) vExternalIdB CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT...
Page 35 Parameter Data Type vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vWROption SMALLINT vWROptionEnable SMALLINT vAccessCode CHAR (20) vAccessNumber1 CHAR (60) vHiddenNum1 CHAR (60) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (60) vHiddenNum2 CHAR (60) Proprietary & Confidential Constraints Description Conference entry with participant count.
Page 36 ReadiVoice PSPI Reference Parameter Data Type vSharedFlag2 SMALLINT vNumberType2 SMALLINT vAccessNumber3 CHAR (60) vHiddenNum3 CHAR (60) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Return Values Data Type Constraints Description Type of access number. 0: Private; 1: Shared. 0, 1 Set to 0 if not specifying second access number.
Page 37: Addsubandanstring()
CACS then updates the call router with the data from the temporary table every ten seconds. Caution! The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate.pl script, as described in the ReadiVoice Administration & Maintenance Guide. Proprietary & Confidential Description Access number (numeric characters only).
Page 38 ReadiVoice PSPI Reference Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures” Parameter Data Type AccessNumVerify SMALLINT vEntryDate DATETIME YEAR TO MINUTE vActivationDate...
Page 39 Parameter Data Type vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption...
Page 40 ReadiVoice PSPI Reference Parameter Data Type vQuickStartEnable SMALLINT vExternalId CHAR (30) vExternalIdB CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT...
Page 41 Parameter Data Type vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vWROption SMALLINT vWROptionEnable SMALLINT vAccessCode CHAR (20) vAccessNumberString CHAR (720) Return Values Data Type Proprietary & Confidential Constraints Description Conference termination time (in minutes) that 5–480 governs automatic termination of conferences (if conference termination option is 1 or 2).
Page 42: Assignnumtosub()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 43 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT SubscriberId AccessNum CHAR (60) SharedFlag NumberType SMALLINT HiddenNum CHAR (60) Return Values Data Type Proprietary & Confidential Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 44: Assignphonenum()
ReadiVoice PSPI Reference AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code. This procedure is compatible with v. 1.30.0 or later of the software. The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class...
Page 45: Delassignedpn()
DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 46: Deletegroup()
There is no option to notify the call router immediately. Caution! The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate.pl script, as described in the ReadiVoice Administration & Maintenance Guide. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 47: Deletesub_V2320()
CACS then updates the call router with the data from the temporary table every ten seconds. Caution! The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate.pl script, as described in the ReadiVoice Administration & Maintenance Guide. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 48: Delgroupacm()
ReadiVoice PSPI Reference Return Values Data Type DelGroupAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 49: Delgrpaccessclass()
DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 50: Delsubacm()
ReadiVoice PSPI Reference DelSubAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 51: Getaccoptchanges()
AccOptChanges table in the database. This procedure is only for systems configured for the Account Options Updates feature. The ReadiVoice Administration & Maintenance Guide describes how to configure and use this feature. This procedure returns each account options change record that hasn’t been flagged as read and then flags it as read.
Page 52: Getgroupacm()
ReadiVoice PSPI Reference GetGroupAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber group. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 53: Getgroupinfo_V2500()
GetGroupInfo_v2500() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups. This procedure is similar to GetGroupInfo_v2320(), but has two additional return values at the end of the record: •...
Page 54 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (255) CHAR (512) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Description Prompt set. Carrier ID. Group notes A. Group notes B. Operator notes.
Page 55 Data Type SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) SMALLINT Proprietary & Confidential Current PSPI Functions Description Prompt to identify subscriber. 0: No; 1: Yes. Terminate minimum-participant conference (set in SysConfig table) after auto termination time.
Page 56: Getgrpaccessclass
ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT GetGrpAccessClass Stored procedure for retrieving a list of access classes associated with a subscriber group. A return code of 100 flags the end of the subscriber group’s access classes. Compatible with v. 1.30.0 or later of the software.
Page 57: Getpromptinfo()
Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software. Parameters None...
Page 58: Getsubacm()
ReadiVoice PSPI Reference Return Values Data Type CHAR (60) CHAR (30) GetSubAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber. A return code of 100 flags the end of the list of ACM options.
Page 59: Getsuban_V2520()
GetSubAN_v2520() Stored procedure for retrieving a list of all access phone numbers assigned to a subscriber, along with related information about those access numbers. This procedure is similar to GetSubAccNums(), but it also returns the associated hidden number, access number type, and number group for each access phone number.
Page 60: Getsubbyeid_V2500()
ReadiVoice PSPI Reference GetSubByEId_v2500() Stored procedure for retrieving a subscriber’s record from the database using the subscriber’s external ID. To retrieve a subscriber’s record using the subscriber ID, use GetSub_v2500(). Both procedures return the same set of data. Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures”...
Page 61 Data Type CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) Proprietary & Confidential Current PSPI Functions Description Subscriber’s last name.
Page 62 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) Description User-defined subscriber field 1. User-defined subscriber field 2. Application provider ID.
Page 63 Data Type SMALLINT CHAR (30) CHAR (30) SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Current PSPI Functions Description Password changeable by subscriber. 0: No; 1: Yes. Dial-Out Prefix, a number to dial before the dial-out number when dialing out. Dial- Out Postfix, a number to dial after the dial-out number when dialing out.
Page 64: Getsubbyeidb()
GetSubByEIdB() Stored procedure for retrieving a subscriber’s record from the database using the subscriber’s external ID B, added in ReadiVoice v. 2.55.0. This procedure requires ReadiVoice v. 2.55.0 or later. To retrieve a subscriber’s record using the subscriber ID, use GetSub_v2550().
Page 65 Data Type CHAR (30) CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT Proprietary & Confidential Current PSPI Functions Description Group ID. Prompt set. Subscriber’s first name.
Page 66 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) Description Subscriber’s address. Subscriber’s phone number.
Page 67 Data Type CHAR (30) SMALLINT CHAR (30) CHAR (30) SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Current PSPI Functions Description Fax number (Metratech billing field) if the corresponding table is defined on the CACS. Metratech billing account flag. 0: Not processed;1: Being processed, but not completed yet;...
Page 68: Getsub_V2500()
ReadiVoice PSPI Reference GetSub_v2500() Stored procedure for retrieving a subscriber’s record from the database using the subscriber ID. To retrieve a subscriber’s record using the subscriber’s external ID, use GetSubByEId_v2500(). Both procedures return the same set of data. This procedure is similar to GetSub_v2320(), but has two additional return values at the end of the record: •...
Page 69 Data Type SMALLINT CHAR (20) DATETIME YEAR TO MONTH CHAR (255) CHAR (255) CHAR (30) CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Current PSPI Functions Description Credit card type.
Page 70 ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) Description Conference starts with continuation enabled.
Page 71 Data Type CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Current PSPI Functions Description ZIP code (Metratech billing field) if the corresponding table is defined on the CACS. Time zone (Metratech billing field) if the corresponding table is defined on the CACS.
Page 72: Getsub_V2550()
GetSub_v2550() Stored procedure for retrieving a subscriber’s record from the database using the subscriber ID. This procedure requires ReadiVoice v. 2.55.0 or later. To retrieve a subscriber’s record using the subscriber’s external ID B, use GetSubByEIdB(). Both procedures return the same set of data.
Page 73 Data Type CHAR (30) CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) CHAR (30) Proprietary & Confidential Current PSPI Functions Description Group ID. Prompt set.
Page 74 ReadiVoice PSPI Reference Data Type SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) Description Conference recording available. 0: No; 1: Yes.
Page 75 Data Type CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Current PSPI Functions Description Country (Metratech billing field) if the corresponding table is defined on the CACS. Fax number (Metratech billing field) if the corresponding table is defined on the CACS.
Page 76: Getsysconfig_V2320()
For an explanation of which call flows are available with various combinations of routing options and translation number types, see “Changing System Configuration” in the ReadiVoice Administration & Maintenance Guide. Caution! If your system has either of the two-password call flows enabled, then you can’t use any pre-v.2.10.0 stored procedures except those included in chapters 2–5.
Page 77 Use hidden numbers. 0: No; 1: Yes. Validate on access code only. 0: No; 1: Yes. System type. “RVIP”: ReadiVoice-IP; “RV_PSTN”: ReadiVoice-PSTN. SIP domain name, if ReadiVoice-IP system. Otherwise, empty string. Translation number type. 0: Random; 1: Fixed; 2: Fixed with 3-digit code.
Page 78: Reassignacccode()
ReadiVoice PSPI Reference ReAssignAccCode() Stored procedure for changing the access code assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. Note that, with v. 2.10.0, the system configuration setting for code length changed from a maximum value constraint to a minimum.
Page 79: Reassignphonenum()
ReAssignPhoneNum() Stored procedure for removing or replacing an existing access phone number assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. To remove an access number without replacing it, set LocalNewAccNum to an empty string. The procedure fails if the number you’re removing is the subscriber’s only access number (a subscriber must have at least one access phone number).
Page 80: Updatemtbilling()
ReadiVoice PSPI Reference UpdateMTBilling() Stored procedure for updating a subscriber’s Metratech billing data in the database. Compatible with v. 2.00.0 or later of the software if the MetraTechSubInfo table exists. This procedure replaces all existing values for the specified subscriber. If you set vCity, vState, vZip, vEmail, or vFax to an empty string, the value “None”...
Page 81: Updatenumgrprlist()
UpdateNumGrpRList() Stored procedure for assigning number groups to routing lists. To be used only after using non-routed. Refer to the description of that procedure and especially to the cautions it contains. When a routed system is converted to non-routed, the existing bridge groups and routing lists are deleted.
Page 82 ReadiVoice PSPI Reference Parameter Data Type vNumGroup5 vRoutingList5 vNumGroup6 vRoutingList6 vNumGroup7 vRoutingList7 vNumGroup8 vRoutingList8 vNumGroup9 vRoutingList9 vNumGroup10 vRoutingList10 Return Values Data Type Constraints Description Number Group 5. Set to 0 if not assigning another number group. New routing list ID for number group 5. Set to 0 if not assigning another number group.
Page 83: Updatesub_V2500()
UpdateSub_v2500() Stored procedure for updating a subscriber’s record in the database. This procedure is similar to UpdateSub_v2320(), but has two additional parameters: • • Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 84 ReadiVoice PSPI Reference Parameter Data Type vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT...
Page 85 Parameter Data Type vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu...
Page 86 ReadiVoice PSPI Reference Parameter Data Type vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vWROption SMALLINT vWROptionEnable SMALLINT Return Values Data Type Constraints Description Terminate minimum-participant conference 0–2 (set in SysConfig table) after auto termination time.
Page 87: Updatesub_V2550()
UpdateSub_v2550() Stored procedure for updating a subscriber’s record in the database. This procedure requires ReadiVoice v. 2.55.0 or later. This procedure is similar to UpdateSub_v2500(), but has: • • Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 88 ReadiVoice PSPI Reference Parameter Data Type vClientBillA CHAR (255) vClientBillB CHAR (255) vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall...
Page 89 Parameter Data Type vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vExternalIdB CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT...
Page 90 ReadiVoice PSPI Reference Parameter Data Type vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vWROption SMALLINT vWROptionEnable SMALLINT Return Values Data Type Constraints Description Auto termination time in minutes. Set to 480 if 5–480 not using.
Page 91: Updatesysconfig_V2500()
Use the System Administration interface to set up your bridge groups and routing lists to route calls among bridges as desired. For an explanation of which call flows are available with various combinations of routing options and translation number types, see the ReadiVoice Administration & Maintenance Guide. Caution! If your system has either of the two-password call flows enabled, then you can’t use...
Page 92 ReadiVoice PSPI Reference Parameter Data Type vTransNumberType SMALLINT vTradShrdCallflow SMALLINT vTradPrvCallFlow SMALLINT vTwoPsShrdCallFlow SMALLINT vTwoPsPrvCallFlow SMALLINT vConfTermPartCount SMALLINT Return Values Data Type CHAR (256) Constraints Description Translation number type. 0: Random; 1: Fixed; 0–2 2: Fixed with 3-digit code. Traditional shared call flow. 0: Unavailable;...
Page 93: Legacy V. 2.32.0 Pspi Functions
ReadiVoice v. 2.32.x. ReadiVoice-IP functionality was merged into the standard release of ReadiVoice v. 2.30.0, so the same stored procedures are used for both the ReadiVoice-TSP and ReadiVoice-IP configurations. For your convenience, this chapter also includes functions that remain unchanged from previous versions.
Page 94: Addgroupacm()
ReadiVoice PSPI Reference AddGroupACM() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 95: Addgrpaccessclass()
AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 96: Addphonenum()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 97 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT vAccessNum CHAR (60) vHiddenNum CHAR (60) vSharedFlag SMALLINT vNumberType SMALLINT vNumberGroup SMALLINT SubscriberId Return Values DataType Proprietary & Confidential Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 98: Addsubacm()
ReadiVoice PSPI Reference AddSubAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 99 (NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 100 ReadiVoice PSPI Reference Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures” Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT vEntryDate DATETIME YEAR TO...
Page 101 Parameter Data Type vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT Proprietary &...
Page 102 ReadiVoice PSPI Reference Parameter Data Type vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu...
Page 103 Parameter Data Type vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT vAccessCode CHAR (20) vAccessNumber1 CHAR (30) vHiddenNum1 CHAR (30) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (30) vHiddenNum2 CHAR (30) vSharedFlag2 SMALLINT vNumberType2 SMALLINT Proprietary & Confidential Constraints Description Number to dial before dialing out (numeric characters only).
Page 104 ReadiVoice PSPI Reference Parameter Data Type vAccessNumber3 CHAR (30) vHiddenNum3 CHAR (30) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Return Values Data Type Constraints Description Third access number (numeric characters only). Set to empty string if not using. Hidden number for third access number (numeric characters only).
Page 105: Assignnumtosub()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 106 ReadiVoice PSPI Reference Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT SubscriberId AccessNum CHAR (60) SharedFlag NumberType SMALLINT HiddenNum CHAR (60) Return Values Data Type Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 107: Assignphonenum()
AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code. This procedure is compatible with v. 1.30.0 or later of the software. The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class must not match an existing phone number’s access class (a subscriber can have only one access number per access class).
Page 108: Delassignedpn()
ReadiVoice PSPI Reference DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive.
Page 109 Caution! The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate.pl script, as described in the ReadiVoice Administration & Maintenance Guide. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 110: Delgroupacm()
ReadiVoice PSPI Reference DelGroupAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 111: Delgrpaccessclass()
DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 112: Delsubacm()
ReadiVoice PSPI Reference DelSubAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 113: Getaccoptchanges()
AccOptChanges table in the database. This procedure is only for systems configured for the Account Options Updates feature. The ReadiVoice Administration & Maintenance Guide describes how to configure and use this feature. This procedure returns each account options change record that hasn’t been flagged as read and then flags it as read.
Page 114: Getgroupacm()
ReadiVoice PSPI Reference GetGroupAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber group. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 115: Getgroupinfo_V2320()
GetGroupInfo_v2320() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups. This procedure is similar to GetGroupInfo_v2110(), but has two additional return values: •...
Page 116 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (512) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Description Group notes B. Operator notes. Roll call (entry/exit announcement) option. 0: Tone; 1: Name; 2: Silence.
Page 117 Data Type CHAR (255) CHAR (512) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v. 2.32.0 PSPI Functions Description Group notes B. Operator notes. Roll call (entry/exit announcement) option. 0: Tone;...
Page 118 ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) SMALLINT SMALLINT Description Auto termination time in minutes. Conference entry with participant count (PartPlayCount). 0: No; 1: Yes.
Page 119: Getgrpaccessclass
Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software. Parameters None Proprietary &...
Page 120: Getsubaccnums()
ReadiVoice PSPI Reference Return Values Data Type CHAR (30) GetSubAccNums() Stored procedure for retrieving a list of all access phone numbers assigned to a subscriber. For each of the subscriber’s access numbers, it returns the phone number, its class ID, and its class name. The end of the list is marked by a list member with the CHAR values set to empty strings and the INT values set to 0.
Page 121: Getsubacm()
GetSubAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 122 ReadiVoice PSPI Reference Parameters Note: The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Stored Procedures” Parameter Data Type vSubscriberId Return Values Data Type SMALLINT CHAR (30) CHAR (255) SMALLINT...
Page 123 Data Type CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) Proprietary & Confidential Legacy v. 2.32.0 PSPI Functions Description Subscriber password.
Page 124 ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) Description VIP conference option (guaranteed ports). 0: Off; 1: On. Conference security code.
Page 125: Getsysconfig_V2320()
For an explanation of which call flows are available with various combinations of routing options and translation number types, see “Changing System Configuration” in the ReadiVoice Administration & Maintenance Guide. Caution! If your system has either of the two-password call flows enabled, then you can’t use any pre-v.2.10.0 stored procedures except those included in chapters 2–5.
Page 126 Use hidden numbers. 0: No; 1: Yes. Validate on access code only. 0: No; 1: Yes. System type. “RVIP”: ReadiVoice-IP; “RV_PSTN”: ReadiVoice-TSP. SIP domain name, if ReadiVoice-IP system. Otherwise, empty string. Translation number type. 0: Random; 1: Fixed; 2: Fixed with 3-digit code.
Page 127: Reassignacccode()
ReAssignAccCode() Stored procedure for changing the access code assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. Note that, with v. 2.10.0, the system configuration setting for code length changed from a maximum value constraint to a minimum. Parameters Specify all parameters.
Page 128 ReadiVoice PSPI Reference Parameter Data Type LocalSubId LocalOldAccNum CHAR (60) LocalNewAccNum CHAR (60) Return Values Data Type Constraints Description ID of subscriber. Must be in database. >0 Existing access phone number. Must be in database. New access phone number. Must be in database or an empty string.
Page 129: Updatemtbilling()
UpdateMTBilling() Stored procedure for updating a subscriber’s Metratech billing data in the database. Compatible with v. 2.00.0 or later of the software if the MetraTechSubInfo table exists. This procedure replaces all existing values for the specified subscriber. If you set vCity, vState, vZip, vEmail, or vFax to an empty string, the value “None” is written to the database.
Page 130: Updatesub_V2320()
ReadiVoice PSPI Reference UpdateSub_v2320() Stored procedure for updating a subscriber’s record in the database. This procedure is similar to UpdateSub_v2130(), but has two additional parameters: • • Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 131 Parameter Data Type vClientBillB CHAR (255) vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT...
Page 132 ReadiVoice PSPI Reference Parameter Data Type vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu...
Page 133 Parameter Data Type vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vLOEntry SMALLINT vLOEntryEnable SMALLINT Return Values Data Type Proprietary & Confidential Constraints Description Number to dial before dialing out (numeric characters only). Set to empty string if not used. Number to dial after dialing out (numeric characters only).
Page 134 ReadiVoice PSPI Reference Proprietary & Confidential...
Page 135: Legacy V. 2.13.0/2.30.0 Pspi Functions
ReadiVoice v. 2.13.x, v. 2.14.x, v. 2.30.x, or v. 2.31.x. ReadiVoice-IP functionality was merged into the standard release of ReadiVoice v. 2.30.0, so the same stored procedures are used for both the ReadiVoice-PSTN and ReadiVoice-IP configurations. For your convenience, this chapter also includes functions that remain unchanged from previous versions.
Page 136: Addgroupacm()
ReadiVoice PSPI Reference AddGroupAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 137: Addgrpaccessclass()
AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 138: Addphonenum()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 139 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT vAccessNum CHAR (60) vHiddenNum CHAR (60) vSharedFlag SMALLINT vNumberType SMALLINT vNumberGroup SMALLINT SubscriberId Return Values DataType Proprietary & Confidential Legacy v. 2.13.0/2.30.0 PSPI Functions Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 140: Addsubacm()
ReadiVoice PSPI Reference AddSubAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 141: Addsubandan_V2130()
• • The prefix and postfix parameters accommodate the Dial-Out Billing (UDO) configuration, described in the ReadiVoice Administration & Maintenance Guide. Using this procedure, or its siblings AddSubAndAccNum(), reduces the traffic through the ODBC interface, since a single SPC accomplishes what required two to four SPCs in earlier versions of PSPI.
Page 142 (NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 143 Parameter Data Type vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT...
Page 144 ReadiVoice PSPI Reference Parameter Data Type vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30)
Page 145 Parameter Data Type vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) vAccessCode CHAR (20) vAccessNumber1 CHAR (30) vHiddenNum1 CHAR (30) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (30) Proprietary & Confidential Legacy v.
Page 146 ReadiVoice PSPI Reference Parameter Data Type vHiddenNum2 CHAR (30) vSharedFlag2 SMALLINT vNumberType2 SMALLINT vAccessNumber3 CHAR (30) vHiddenNum3 CHAR (30) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Return Values Data Type Constraints Description Hidden number for second access number (numeric characters only). If not using hidden numbers, duplicate the second access number.
Page 147: Addsub_V2130()
• • The prefix and postfix parameters accommodate the Dial-Out Billing (UDO) configuration, described in the ReadiVoice Administration & Maintenance Guide. Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30).
Page 148 ReadiVoice PSPI Reference Parameter Data Type vEntryDate DATETIME YEAR TO MINUTE vActivationDate DATETIME YEAR TO MINUTE vBillingId vBillingType SMALLINT vBillingPhone CHAR (30) vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255)
Page 149 Parameter Data Type vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT Proprietary & Confidential Legacy v.
Page 150 ReadiVoice PSPI Reference Parameter Data Type vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vAccessCode CHAR (20) vAccessNumber CHAR (30) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber...
Page 151 Parameter Data Type vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) Return Values Data Type CHAR (30) CHAR (20) Proprietary & Confidential Legacy v. 2.13.0/2.30.0 PSPI Functions Constraints Description Conference entry with participant count. 0, 1 0: Off; 1: On. Number to dial before dialing out (numeric characters only).
Page 152: Assignnumtosub()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 153 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT SubscriberId AccessNum CHAR (60) SharedFlag NumberType SMALLINT HiddenNum CHAR (60) Return Values Data Type Proprietary & Confidential Legacy v. 2.13.0/2.30.0 PSPI Functions Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 154: Assignphonenum()
ReadiVoice PSPI Reference AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code. This procedure is compatible with v. 1.30.0 or later of the software. The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class...
Page 155: Delassignedpn()
DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 156: Deletesubscriber()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 157: Delgroupacm()
Return Values Data Type DelGroupAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 158: Delgrpaccessclass()
ReadiVoice PSPI Reference DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 159: Getaccoptchanges()
AccOptChanges table in the database. This procedure is only for systems configured for the Account Options Updates feature. The ReadiVoice Administration & Maintenance Guide describes how to configure and use this feature. This procedure returns each account options change record that hasn’t been flagged as read and then flags it as read.
Page 160: Getgroupacm()
ReadiVoice PSPI Reference GetGroupAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber group. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 161: Getgroupinfo_V2130()
The Dial-Out Postfix parameter specifies a number to be dialed after the telephone number when dialing out. The prefix and postfix parameters accommodate the Dial-Out Billing (UDO) configuration, described in the ReadiVoice Administration & Maintenance Guide. Description Return code (0: OK; 100: end of list).
Page 162 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (255) CHAR (512) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Description Prompt set. Carrier ID. Group notes A. Group notes B. Operator notes.
Page 163 Data Type SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) Proprietary & Confidential Legacy v. 2.13.0/2.30.0 PSPI Functions Description Prompt to identify subscriber. 0: No; 1: Yes. Terminate minimum-participant conference (set in SysConfig table) after auto termination time.
Page 164: Getgrpaccessclass
ReadiVoice PSPI Reference GetGrpAccessClass Stored procedure for retrieving a list of access classes associated with a subscriber group. A return code of 100 flags the end of the subscriber group’s access classes. Compatible with v. 1.30.0 or later of the software.
Page 165: Getsubaccnums()
Return Values Data Type CHAR (30) GetSubAccNums() Stored procedure for retrieving a list of all access phone numbers assigned to a subscriber. For each of the subscriber’s access numbers, it returns the phone number, its class ID, and its class name. The end of the list is marked by a list member with the CHAR values set to empty strings and the INT values set to 0.
Page 166: Getsubacm()
ReadiVoice PSPI Reference GetSubAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 167: Getsub_V2130()
• • • The prefix and postfix parameters accommodate the Dial-Out Billing (UDO) configuration, described in the ReadiVoice Administration & Maintenance Guide. Parameters Note: The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Stored Procedures”...
Page 168 ReadiVoice PSPI Reference Data Type CHAR (20) DATETIME YEAR TO MONTH CHAR (255) CHAR (255) CHAR (30) CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Description Credit card number.
Page 169 Data Type SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) Proprietary & Confidential Legacy v. 2.13.0/2.30.0 PSPI Functions Description Quick start enabled.
Page 170 ReadiVoice PSPI Reference Data Type CHAR (120) CHAR (60) CHAR (30) SMALLINT CHAR (30) CHAR (30) Description Time zone (Metratech billing field) if the corresponding table is defined on the CACS. Email address (Metratech billing field) if the corresponding table is defined on the CACS.
Page 171: Getsysconfig_V2300()
SMALLINT SMALLINT SMALLINT Proprietary & Confidential The system type flag, which reports whether this is a ReadiVoice-IP or ReadiVoice-PSTN system. The SIP domain name, if this is a ReadiVoice-IP system. Otherwise, an empty string. The access code required flag (AccessCode4Shared). A setting of 0 indicates two-password call flow, while a setting of 1 indicates that an access code is required (two-password call flow is disabled).
Page 172: Reassignacccode()
Compatible with v. 1.30.0 or later of the software. Description System type. “RVIP”: ReadiVoice-IP; “RV_PSTN”: ReadiVoice-PSTN. SIP domain name, if ReadiVoice-IP system. Otherwise, empty string. Access code required (AccessCode4Shared) flag. 0: No; 1: Yes. on page 4.
Page 173 To remove an access number without replacing it, set LocalNewAccNum to an empty string. The procedure fails if the number you’re removing is the subscriber’s only access number (a subscriber must have at least one access phone number). Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 174: Updatemtbilling()
ReadiVoice PSPI Reference UpdateMTBilling() Stored procedure for updating a subscriber’s Metratech billing data in the database. Compatible with v. 2.00.0 or later of the software if the MetraTechSubInfo table exists. This procedure replaces all existing values for the specified subscriber. If you set vCity, vState, vZip, vEmail, or vFax to an empty string, the value “None”...
Page 175: Updatesub_V2130()
• • The prefix and postfix parameters accommodate the Dial-Out Billing (UDO) configuration, described in the ReadiVoice Administration & Maintenance Guide. Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30).
Page 176 ReadiVoice PSPI Reference Parameter Data Type vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT...
Page 177 Parameter Data Type vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu...
Page 178 ReadiVoice PSPI Reference Parameter Data Type vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT vDialOutPreFix CHAR (30) vDialOutPostFix CHAR (30) Return Values Data Type Constraints Description Terminate minimum-participant conference 0–2 (set in SysConfig table) after auto termination time. 0: No; 1: Send to operator queue first;...
Page 179: Legacy V. 2.10.0 Pspi Functions
2.1x.x prior to v. 2.13.0, all the PSPI functions you need are in this one chapter. For ReadiVoice v. 2.50.0 and later, the vExternalId parameter must have a data type of CHAR(30), even if you’re using legacy SPs.
Page 180: Addgroupacm()
ReadiVoice PSPI Reference AddGroupAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 181: Addgrpaccessclass()
AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 182: Addphonenum()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 183 Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT vAccessNum CHAR (60) vHiddenNum CHAR (60) vSharedFlag SMALLINT vNumberType SMALLINT vNumberGroup SMALLINT SubscriberId Return Values DataType Proprietary & Confidential Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 184: Addsubacm()
ReadiVoice PSPI Reference AddSubAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 185 (NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 186 ReadiVoice PSPI Reference Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30). For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 187 Parameter Data Type vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT Proprietary &...
Page 188 ReadiVoice PSPI Reference Parameter Data Type vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu...
Page 189 Parameter Data Type vAccessCode CHAR (20) vAccessNumber1 CHAR (30) vHiddenNum1 CHAR (30) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (30) vHiddenNum2 CHAR (30) vSharedFlag2 SMALLINT vNumberType2 SMALLINT vAccessNumber3 CHAR (30) vHiddenNum3 CHAR (30) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Proprietary & Confidential Constraints Description Desired access code (numeric characters only).
Page 190: Addsubandan_V2110()
ReadiVoice PSPI Reference Return Values Data Type AddSubAndAN_v2110() Stored procedure for adding a new subscriber and new access number(s) to the database at the same time. For a description, refer to AddSubAndAccNum(), which is very similar. This procedure adds one new parameter: the vPartPlayCount flag. If it’s set to 1, participants entering a conference hear a message telling them the number of people (including themselves) in conference.
Page 191 Parameter Data Type vBillingPhone CHAR (30) vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20)
Page 192 ReadiVoice PSPI Reference Parameter Data Type vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255)
Page 193 Parameter Data Type vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT vAccessCode CHAR (20) vAccessNumber1 CHAR (30) vHiddenNum1 CHAR (30) vSharedFlag1 SMALLINT vNumberType1 SMALLINT vAccessNumber2 CHAR (30) Proprietary & Confidential Constraints Description User-defined subscriber field 2.
Page 194 ReadiVoice PSPI Reference Parameter Data Type vHiddenNum2 CHAR (30) vSharedFlag2 SMALLINT vNumberType2 SMALLINT vAccessNumber3 CHAR (30) vHiddenNum3 CHAR (30) vSharedFlag3 SMALLINT vNumberType3 SMALLINT Return Values Data Type Constraints Description Hidden number for second access number (numeric characters only). If not using hidden numbers, duplicate the second access number.
Page 195: Addsub_V2100()
AddSub_v2100() Stored procedure for adding a subscriber to the database. The access phone number specified for the new subscriber must already exist in the database. To add a new subscriber and a new access number at the same time, use This procedure is similar to AddSub_v2000(), but adds three new parameters: •...
Page 196 ReadiVoice PSPI Reference Parameter Data Type vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin...
Page 197 Parameter Data Type vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB...
Page 198 ReadiVoice PSPI Reference Parameter Data Type vAccessCode CHAR (20) vAccessNumber CHAR (30) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT Return Values Data Type CHAR (30) CHAR (20) Constraints Description Desired access code (numeric characters only).
Page 199: Addsub_V2110()
AddSub_v2110() Stored procedure for adding a subscriber to the database. The access phone number specified for the new subscriber must already exist in the database. To add a new subscriber and a new access number at the same time, use AddSubAndAN_v2110(). This procedure is similar to AddSub_v2100(), but adds one new parameter: vPartPlayCount.
Page 200 ReadiVoice PSPI Reference Parameter Data Type vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable...
Page 201 Parameter Data Type vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vAccessCode CHAR (20) vAccessNumber CHAR (30) vProviderId vVipConf SMALLINT...
Page 202 ReadiVoice PSPI Reference Parameter Data Type vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount SMALLINT Return Values Data Type CHAR (30) CHAR (20) Constraints Description Conference security code. 0–2 0: Unavailable; 1: Optional; 2: Required. Account options menu.
Page 203: Assignnumtosub()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 204 ReadiVoice PSPI Reference Parameter Data Type AccessNumVerify SMALLINT NotifyCallRouter SMALLINT SubscriberId AccessNum CHAR (60) SharedFlag NumberType SMALLINT HiddenNum CHAR (60) Return Values Data Type Constraints Description Validate access number integrity. 0, 1 0: No; 1: Yes. Parameter remains only to maintain backward 0, 1 compatibility.
Page 205: Assignphonenum()
AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code. This procedure is compatible with v. 1.30.0 or later of the software. The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class must not match an existing phone number’s access class (a subscriber can have only one access number per access class).
Page 206: Delassignedpn()
ReadiVoice PSPI Reference DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive.
Page 207: Deletesubscriber()
(NotifyCallRouter = 1) or write it to the CacsEventUpdate table (NotifyCallRouter = 0). In ReadiVoice v. 2.50.0 and later, this choice has been removed, and the NotifyCallRouter parameter remains only to ensure backward compatibility. Regardless of how you set this flag, the SPC puts the new data into the CacsEventUpdate table in the database;...
Page 208: Delgroupacm()
ReadiVoice PSPI Reference Return Values Data Type DelGroupAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 209: Delgrpaccessclass()
DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 210: Delsubacm()
ReadiVoice PSPI Reference DelSubAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 211: Getaccoptchanges()
AccOptChanges table in the database. This procedure is only for systems configured for the Account Options Updates feature. The ReadiVoice Administration & Maintenance Guide describes how to configure and use this feature. This procedure returns each account options change record that hasn’t been flagged as read and then flags it as read.
Page 212: Getgroupacm()
ReadiVoice PSPI Reference GetGroupAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber group. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 213: Getgroupinfo_V2100()
GetGroupInfo_v2100() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups. Parameters None Return Values Data Type SMALLINT CHAR (50)
Page 214 ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) Description Conference continuation option changeable for current conference. 0: No; 1: Yes. Account status. 0: Inactive; 1: Active;...
Page 215: Getgroupinfo_V2110()
Data Type CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT GetGroupInfo_v2110() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups.
Page 216 ReadiVoice PSPI Reference Data Type CHAR (50) CHAR (30) CHAR (30) CHAR (50) CHAR (30) CHAR (255) CHAR (255) CHAR (512) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Description Company name. Company phone number. Company fax number.
Page 217 Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT Proprietary & Confidential Legacy v. 2.10.0 PSPI Functions Description Conference recording available. 0: No; 1: Yes. Application provider ID.
Page 218: Getgrpaccessclass
ReadiVoice PSPI Reference GetGrpAccessClass Stored procedure for retrieving a list of access classes associated with a subscriber group. A return code of 100 flags the end of the subscriber group’s access classes. Compatible with v. 1.30.0 or later of the software.
Page 219: Getsubaccnums()
Return Values Data Type CHAR (30) GetSubAccNums() Stored procedure for retrieving a list of all access phone numbers assigned to a subscriber. For each of the subscriber’s access numbers, it returns the phone number, its class ID, and its class name. The end of the list is marked by a list member with the CHAR values set to empty strings and the INT values set to 0.
Page 220: Getsubacm()
ReadiVoice PSPI Reference GetSubAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 221: Getsub_V2100()
GetSub_v2100() Stored procedure for retrieving a subscriber’s record from the database. Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures” Parameter Data Type vSubscriberId Return Values Data Type SMALLINT CHAR (30) CHAR (255)
Page 222 ReadiVoice PSPI Reference Data Type CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) Description Subscriber’s middle name.
Page 223 Data Type CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) SMALLINT Proprietary & Confidential Legacy v. 2.10.0 PSPI Functions Description User-defined subscriber field 2. Application provider ID. VIP conference option (guaranteed ports).
Page 224: Getsub_V2110()
ReadiVoice PSPI Reference GetSub_v2110() Stored procedure for retrieving a subscriber’s record from the database. This procedure is similar to GetSub_v2100(), but adds one new return value: the conference entry with participant count (PartPlayCount) flag. Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures”...
Page 225 Data Type CHAR (30) CHAR (30) CHAR (50) CHAR (20) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) Proprietary & Confidential Legacy v. 2.10.0 PSPI Functions Description Subscriber’s last name.
Page 226 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) Description User-defined subscriber field 1. User-defined subscriber field 2. Application provider ID.
Page 227: Getsysconfig_V2100()
Data Type CHAR (30) SMALLINT GetSysConfig_v2100() Stored procedure for retrieving the system configuration settings from the database. Parameters None Return Values Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v. 2.10.0 PSPI Functions Description Fax number (Metratech billing field) if the corresponding table is defined on the CACS.
Page 228: Getsysconfig_V2110()
ReadiVoice PSPI Reference GetSysConfig_v2110() Stored procedure for retrieving the system configuration settings from the database. This procedure is similar to GetSysConfig_v2100(), but adds one new return value, the validate on access code only flag. Parameters None Return Values Data Type...
Page 229: Reassignacccode()
ReAssignAccCode() Stored procedure for changing the access code assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. Note that, with v. 2.10.0, the system configuration setting for code length changed from a maximum value constraint to a minimum. Parameters Specify all parameters.
Page 230: Reassignphonenum()
ReadiVoice PSPI Reference ReAssignPhoneNum() Stored procedure for removing or replacing an existing access phone number assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. To remove an access number without replacing it, set LocalNewAccNum to an empty string.
Page 231: Updatemtbilling()
UpdateMTBilling() Stored procedure for updating a subscriber’s Metratech billing data in the database. Compatible with v. 2.00.0 or later of the software if the MetraTechSubInfo table exists. This procedure replaces all existing values for the specified subscriber. If you set vCity, vState, vZip, vEmail, or vFax to an empty string, the value “None” is written to the database.
Page 232: Updatesub_V2100()
ReadiVoice PSPI Reference UpdateSub_v2100() Stored procedure for updating a subscriber’s record in the database. Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30). For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 233 Parameter Data Type vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vPasswordEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT...
Page 234 ReadiVoice PSPI Reference Parameter Data Type vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT Return Values...
Page 235: Updatesub_V2110()
UpdateSub_v2110() Stored procedure for updating a subscriber’s record in the database. This procedure is similar to UpdateSub_v2100(), but adds one new parameter: vPartPlayCount. If it’s set to 1, participants entering a conference hear a message telling them the number of people (including themselves) in conference.
Page 236 ReadiVoice PSPI Reference Parameter Data Type vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vParticipantPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable...
Page 237 Parameter Data Type vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT vPromptSubscriber SMALLINT vConfTermOption SMALLINT vConfTermTime SMALLINT vPartPlayCount...
Page 238 ReadiVoice PSPI Reference Return Values Data Type Description Return code (0: OK; otherwise, error code). Proprietary & Confidential...
Page 239: Legacy V. 2.00.0 Pspi Functions
If you’re maintaining code originally developed for v. 2.00.x, all the PSPI functions you need are in this one chapter. For ReadiVoice v. 2.50.0 and later, the vExternalId parameter must have a data type of CHAR(30), even if you’re using legacy SPs.
Page 240: Addgroupacm()
ReadiVoice PSPI Reference AddGroupAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 241: Addgrpaccessclass()
AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 242: Addsubacm()
ReadiVoice PSPI Reference AddSubAcm() Stored procedure for adding an Application Control Mode (ACM) option to a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 243 Parameter Data Type vEntryDate DATETIME YEAR TO MINUTE vActivationDate DATETIME YEAR TO MINUTE vBillingId vBillingType SMALLINT vBillingPhone CHAR (30) vBillingAddress CHAR (255) vCreditCardType SMALLINT vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName...
Page 244 ReadiVoice PSPI Reference Parameter Data Type vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255)
Page 245: Assignphonenum()
Parameter Data Type vClientSubB CHAR (255) vAccessCode CHAR (20) vAccessNumber CHAR (30) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT Return Values Data Type CHAR (30) CHAR (20) AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code.
Page 246 ReadiVoice PSPI Reference The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class must not match an existing phone number’s access class (a subscriber can have only one access number per access class).
Page 247: Delassignedpn()
DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 248: Delgroupacm()
ReadiVoice PSPI Reference DelGroupAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 249: Delgrpaccessclass()
DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 250: Delsubacm()
ReadiVoice PSPI Reference DelSubAcm() Stored procedure for removing an Application Control Mode (ACM) option from a subscriber. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 251: Getaccoptchanges()
AccOptChanges table in the database. This procedure is only for systems configured for the Account Options Updates feature. The ReadiVoice Administration & Maintenance Guide describes how to configure and use this feature. This procedure returns each account options change record that hasn’t been flagged as read and then flags it as read.
Page 252: Getgroupacm()
ReadiVoice PSPI Reference GetGroupAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber group. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 253: Getgroupinfo_V2000()
GetGroupInfo_v2000() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups. Parameters None Return Values Data Type SMALLINT CHAR (50)
Page 254 ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) Description Conference continuation option changeable for current conference. 0: No; 1: Yes. Account status. 0: Inactive; 1: Active;...
Page 255: Getgrpaccessclass
Data Type CHAR (120) CHAR (60) CHAR (30) GetGrpAccessClass Stored procedure for retrieving a list of access classes associated with a subscriber group. A return code of 100 flags the end of the subscriber group’s access classes. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters.
Page 256: Getpromptinfo()
ReadiVoice PSPI Reference GetPromptInfo() Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software.
Page 257: Getsubacm()
Return Values Data Type CHAR (60) CHAR (30) GetSubAcm() Stored procedure for retrieving a list of the Application Control Mode (ACM) options enabled for a subscriber. A return code of 100 flags the end of the list of ACM options. Compatible with v. 2.00.0 or later of the software if ACM is installed and configured.
Page 258: Getsub_V2000()
ReadiVoice PSPI Reference GetSub_v2000() Stored procedure for retrieving a subscriber’s record from the database. Parameters Note: The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Stored Procedures” Parameter Data Type...
Page 259 Data Type CHAR (30) CHAR (30) CHAR (50) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) Proprietary & Confidential Legacy v. 2.00.0 PSPI Functions Description Subscriber’s last name.
Page 260 ReadiVoice PSPI Reference Data Type CHAR (255) CHAR (255) SMALLINT SMALLINT SMALLINT CHAR (4) CHAR (20) CHAR (20) CHAR (15) CHAR (120) CHAR (60) CHAR (30) Description User-defined subscriber field 1. User-defined subscriber field 2. Application provider ID. VIP conference option (guaranteed ports).
Page 261: Getsysconfig()
GetSysConfig() Stored procedure for retrieving the system configuration settings from the database. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v. 2.00.0 PSPI Functions Description Return code (0: OK;...
Page 262: Reassignacccode()
ReadiVoice PSPI Reference ReAssignAccCode() Stored procedure for changing the access code assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. Note that, with v. 2.10.0, the system configuration setting for code length changed from a maximum value constraint to a minimum.
Page 263: Reassignphonenum()
ReAssignPhoneNum() Stored procedure for removing or replacing an existing access phone number assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. To remove an access number without replacing it, set LocalNewAccNum to an empty string. The procedure fails if the number you’re removing is the subscriber’s only access number (a subscriber must have at least one access phone number).
Page 264: Updatemtbilling()
ReadiVoice PSPI Reference UpdateMTBilling() Stored procedure for updating a subscriber’s Metratech billing data in the database. Compatible with v. 2.00.0 or later of the software if the MetraTechSubInfo table exists. This procedure replaces all existing values for the specified subscriber. If you set vCity, vState, vZip, vEmail, or vFax to an empty string, the value “None”...
Page 265: Updatesub_V2000()
UpdateSub_v2000() Stored procedure for updating a subscriber’s record in the database. Parameters Note: Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30). For syntax rules and constraints applicable to all parameters, see Parameter Data Type...
Page 266 ReadiVoice PSPI Reference Parameter Data Type vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vAutoContinuation SMALLINT...
Page 267 Parameter Data Type vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId vVipConf SMALLINT vPromptSecurity SMALLINT vPromptMenu SMALLINT Return Values Data Type Proprietary & Confidential Constraints Description Subscriber’s phone number or empty string. Subscriber’s title or empty string. User-defined subscriber field 1.
Page 268 ReadiVoice PSPI Reference Proprietary & Confidential...
Page 269: Legacy V. 1.30.0 Pspi Functions
If you’re maintaining code originally developed for v. 1.3x.x, all the PSPI functions you need are in this one chapter. For ReadiVoice v. 2.50.0 and later, the vExternalId parameter must have a data type of CHAR(30), even if you’re using legacy SPs.
Page 270: Addgrpaccessclass()
ReadiVoice PSPI Reference AddGrpAccessClass() Stored procedure for adding an access class to a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 271: Addsub_V1300()
AddSub_v1300() Stored procedure for adding a subscriber to the database. Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30). For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 272 ReadiVoice PSPI Reference Parameter Data Type vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT...
Page 273 Parameter Data Type vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vAccessNumType vAccessCode CHAR (20) vNumberClassId vProviderId Return Values Data Type CHAR (30) CHAR (20) Proprietary & Confidential Constraints Description External ID (numeric characters only) or “-1”...
Page 274: Assignphonenum()
ReadiVoice PSPI Reference AssignPhoneNum() Stored procedure for adding an access phone number to a subscriber’s account and, optionally, changing the subscriber’s access code. This procedure is compatible with v. 1.30.0 or later of the software. The new number’s access number type (private or shared) must match the number type of the subscriber’s existing phone number(s), and its access class...
Page 275: Delassignedpn()
DelAssignedPN() Stored procedure for deleting an access phone number from a subscriber’s account. Compatible with v. 1.30.0 or later of the software. If all the access phone numbers for a subscriber are deleted, the subscriber is marked inactive. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 276: Delgrpaccessclass()
ReadiVoice PSPI Reference DelGrpAccessClass() Stored procedure for removing an access class from a subscriber group. Compatible with v. 1.30.0 or later of the software. Parameters Specify all parameters. The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 277: Getgroupinfo_V1300()
GetGroupInfo_v1300() Stored procedure for retrieving all subscriber group data. For each group in the database, it returns the set of values shown below. A return code of 100 flags the end of the list of groups. Parameters None Return Values Data Type SMALLINT CHAR (50)
Page 278: Getgrpaccessclass
ReadiVoice PSPI Reference Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT GetGrpAccessClass Stored procedure for retrieving a list of access classes associated with a subscriber group. A return code of 100 flags the end of the subscriber group’s access classes.
Page 279: Getpromptinfo()
Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software. Parameters None...
Page 280: Getsubaccnums()
ReadiVoice PSPI Reference GetSubAccNums() Stored procedure for retrieving a list of all access phone numbers assigned to a subscriber. For each of the subscriber’s access numbers, it returns the phone number, its class ID, and its class name. The end of the list is marked by a list member with the CHAR values set to empty strings and the INT values set to 0.
Page 281: Getsub_V1300()
GetSub_v1300() Stored procedure for retrieving a subscriber’s record from the database. Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures” Parameter Data Type vSubscriberId Return Values Data Type SMALLINT CHAR (30) CHAR (255)
Page 282 ReadiVoice PSPI Reference Data Type CHAR (30) CHAR (50) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (30) SMALLINT CHAR (255) CHAR (30) CHAR (30) Description Subscriber’s middle name. Subscriber’s company name.
Page 283: Getsysconfig()
Data Type CHAR (255) CHAR (255) GetSysConfig() Stored procedure for retrieving the system configuration settings from the database. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v.
Page 284: Reassignacccode()
ReadiVoice PSPI Reference ReAssignAccCode() Stored procedure for changing the access code assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. Note that, with v. 2.10.0, the system configuration setting for code length changed from a maximum value constraint to a minimum.
Page 285: Reassignphonenum()
ReAssignPhoneNum() Stored procedure for removing or replacing an existing access phone number assigned to a subscriber. Compatible with v. 1.30.0 or later of the software. To remove an access number without replacing it, set LocalNewAccNum to an empty string. The procedure fails if the number you’re removing is the subscriber’s only access number (a subscriber must have at least one access phone number).
Page 286: Updatesub_V1300()
ReadiVoice PSPI Reference UpdateSub_v1300() Stored procedure for updating a subscriber’s record in the database. Parameters Specify all parameters. The constraints column shows specific value or range constraints. Note that the vExternalId parameter must have a data type of CHAR(30). For syntax rules and constraints applicable to all parameters, see “Calling Stored Procedures”...
Page 287 Parameter Data Type vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption SMALLINT vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress...
Page 288 ReadiVoice PSPI Reference Parameter Data Type vClientSubA CHAR (255) vClientSubB CHAR (255) vProviderId Return Values Data Type Constraints Description User-defined subscriber field 1. Set to empty string if not using. User-defined subscriber field 2. Set to empty string if not using.
Page 289: Legacy V. 1.20.0 Pspi Functions
For ReadiVoice v. 2.50.0 and later, the vExternalId parameter must have a data type of CHAR(30), even if you’re using legacy SPs. You can use the v. 1.20.0 PSPI functions with newer versions of the ReadiVoice software to avoid rewriting your code. However, you can’t access the newer options and features.
Page 290: Addsub_V1200()
ReadiVoice PSPI Reference AddSub_v1200() Stored procedure for adding a subscriber to the database. This SP is similar to AddSubscriber(), but adds parameters for several additional options and features. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 291 Parameter Data Type vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable SMALLINT vAutoContinuation SMALLINT vQuickStartOption...
Page 292 ReadiVoice PSPI Reference Parameter Data Type vQuickStartEnable SMALLINT vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vAccessNumType vAccessCode CHAR (20) Return Values Data Type CHAR (30) CHAR (20)
Page 293: Getgroupinfo()
GetGroupInfo() Stored procedure for extracting records of all subscriber groups from the database. For each subscriber group, it returns the values shown below. A return code of 100 flags the end of the list of subscriber groups. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values...
Page 294: Getpromptinfo()
ReadiVoice PSPI Reference GetPromptInfo() Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software.
Page 295 Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures” Parameter Data Type vSubscriberId vBillingId vSubscriberPin CHAR(20) vAccessCode CHAR(20) Return Values Data Type SMALLINT CHAR (30) CHAR (255) SMALLINT CHAR (20) DATETIME YEAR TO MONTH CHAR (255)
Page 296 ReadiVoice PSPI Reference Data Type CHAR (30) CHAR (30) CHAR (30) CHAR (50) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) CHAR (20) CHAR (30) Description Subscriber’s first name. Subscriber’s last name.
Page 297: Getsysconfig()
GetSysConfig() Stored procedure for retrieving the system configuration settings from the database. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v. 1.20.0 PSPI Functions Description Return code (0: OK;...
Page 298: Updatesub_V1200()
ReadiVoice PSPI Reference UpdateSub_v1200() Stored procedure for updating a subscriber’s record in the database. This SP is similar to UpdateSubscriber(), but adds parameters for several additional options and features. Parameters Specify all parameters. The constraints column shows specific value or range constraints.
Page 299 Parameter Data Type vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccessCode CHAR (20) vAccessNum CHAR (30) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall SMALLINT vRollCallEnable SMALLINT vNameRecord SMALLINT vNameRecordEnable SMALLINT vContinuation SMALLINT vContinueEnable...
Page 300 ReadiVoice PSPI Reference Parameter Data Type vExternalId CHAR (30) vConfRecAvailable SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) Return Values Data Type Constraints Description External ID (numeric characters only) or “-1” if not using.
Page 301: Legacy V. 1.10.0 Pspi Functions
Caution! Polycom authorizes the use of only the stored procedures described in this publication. Other .sp files reside in the ReadiVoice file system; however, those not included here are designed for Polycom internal use only and may cause unforeseen problems if used otherwise.
Page 302: Addsubscriber()
ReadiVoice PSPI Reference AddSubscriber() Stored procedure for adding a subscriber to the database. Compatible with v. 1.10.0 or later of the software. This procedure expects the v. 1.10.0-compatible values for the Roll Call feature (0-3). It maps these to current values as follows:...
Page 303 Parameter Data Type vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vGroupId vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccountStatus SMALLINT vMaxParticipants SMALLINT vOperatorAvailable SMALLINT vDialOut SMALLINT vRollCall...
Page 304 ReadiVoice PSPI Reference Parameter Data Type vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) vAccessNumType vAccessCode CHAR (20) Return Values Data Type CHAR (30) CHAR (20) Constraints Description Subscriber’s address or empty string.
Page 305: Getgroupinfo()
GetGroupInfo() Stored procedure for extracting records of all subscriber groups from the database. For each subscriber group, it returns the values shown below. A return code of 100 flags the end of the list of subscriber groups. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values...
Page 306: Getpromptinfo()
ReadiVoice PSPI Reference GetPromptInfo() Stored procedure for retrieving a list of all prompt sets in the database. For each prompt set, it returns both the ID and the name. A return code of 100 flags the end of the list of prompt sets. Compatible with all versions of the ReadiVoice/ConferenceNow! software.
Page 307 Parameters The constraints column shows specific value or range constraints. For syntax rules and constraints applicable to all parameters, see Procedures” Parameter Data Type vSubscriberId vBillingId vSubscriberPin CHAR(20) vAccessCode CHAR(20) Return Values Data Type SMALLINT CHAR (30) CHAR (255) SMALLINT CHAR (20) DATETIME YEAR TO MONTH CHAR (255)
Page 308 ReadiVoice PSPI Reference Data Type CHAR (30) CHAR (30) CHAR (50) CHAR (20) SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT CHAR (255) CHAR (30) CHAR (30) CHAR (255) CHAR (255) CHAR (20) CHAR (30) Description Subscriber’s last name. Subscriber’s middle name.
Page 309: Getsysconfig()
GetSysConfig() Stored procedure for retrieving the system configuration settings from the database. Compatible with v. 1.10.0 or later of the software. Parameters None Return Values Data Type SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT SMALLINT Proprietary & Confidential Legacy v. 1.10.0 PSPI Functions Description Return code (0: OK;...
Page 310: Updatesubscriber()
ReadiVoice PSPI Reference UpdateSubscriber() Stored procedure for updating subscriber information in the database. Compatible with v. 1.10.0 or later of the software. This procedure expects the v. 1.10.0-compatible values for the Roll Call feature (0-3). It maps these to current values as follows:...
Page 311 Parameter Data Type vCreditCardNumber CHAR (20) vCreditCardExpire DATETIME YEAR TO MONTH vClientBillA CHAR (255) vClientBillB CHAR (255) vPromptSet vFirstName CHAR (30) vLastName CHAR (30) vMiddleName CHAR (30) vCompanyName CHAR (50) vSubscriberPin CHAR (20) vAccessCode CHAR (20) vAccessNum CHAR (30) vAccountStatus SMALLINT vMaxParticipants SMALLINT...
Page 312 ReadiVoice PSPI Reference Parameter Data Type vContinuation SMALLINT vAddress CHAR (255) vPhone CHAR (30) vTitle CHAR (30) vClientSubA CHAR (255) vClientSubB CHAR (255) Return Values Data Type Constraints Description Conference continuation option changeable for 0, 1 current conference. 0: No; 1: Yes.
Page 313 Defines and Return Codes This appendix documents the return (error) codes returned by PSPI functions and the database length defines used by PSPI function parameters. PSPI Return Codes All stored procedure calls (SPCs) pass back a return (error) code in the first return value.
Page 314 ReadiVoice PSPI Reference Return Code Description Invalid RollCall. Must be one of the following: 0: Entry tone 1: Name entry 2: Silence The specified RollCall setting, 1, isn’t compatible with the specified NameRecord setting, 0. Invalid NameRecordEnable. Must be one of the following:...
Page 315 Return Code Proprietary & Confidential Description Invalid password enable. Must be one of the following: 0: Password not changeable by subscriber 1: Password changeable by subscriber Invalid ConfRecAvailable. Must be one of the following: 0: Conference recording not available 1: Conference recording available Invalid AccountStatus.
Page 316 ReadiVoice PSPI Reference Return Code Description For AssignPhoneNum procedure only. The specified access class isn’t in the database. For AssignPhoneNum procedure only. The specified access number type is private, but the subscriber already has one or more shared access phone numbers.
Page 317 Return Code Proprietary & Confidential Description Invalid ConfTermTime. Must be between 5 and 480, inclusive. AccountStatus can’t be 2 (deleted) for new subscriber. For ReAssignPhoneNum procedure only. No new access number is specified and the old access number is the subscriber’s only access number.
Page 318 ReadiVoice PSPI Reference Return Code Description RoutedMode isn’t set properly in database. For GetSubscriber procedure only. The specified BillingId does not exist in database. For GetSubscriber procedure only. Multiple subscriber records have this BillingId. The specified access phone number isn’t in the database.
Page 319 Return Code Proprietary & Confidential Description For AddSubAndAccNum procedure only. The system is configured to accept only private numbers. If the system uses hidden numbers, this hidden number and access code combination is already in use. If the system doesn’t use hidden numbers, this access number and access code combination is already in use.
Page 320 ReadiVoice PSPI Reference Return Code Description Can’t specify both AccessCode and ParticipantPin. Both AccessCode and ParticipantPin are blank. Can’t specify ParticipantPin in traditional call flow setting. Duplicate AccessNum in stored procedure call. AccessCode is specified, but traditional call flow isn’t enabled.
Page 321 Return Code Proprietary & Confidential Description For UpdateSub_v1200 and UpdateSubscriber procedures. The new access number isn’t in the same number class as the existing access number. The specified access code isn’t available. The specified sessionId and appId combination isn’t in the database.
Page 322 ReadiVoice PSPI Reference Return Code Description Pair (AccessNum, ParticipantPin) must be unique. Invalid StartLO. Must be 0 or 1. Invalid StartLOEnable. Must be 0 or 1. Internal Error. Unknown password type in call to IsPinUnique. For UpdateSysConfig_v2500 procedure only. Confidence must be between 0 and 100.
Page 323 Return Code Proprietary & Confidential Description For UpdateSysConfig_v2500 procedure only. Invalid UseHiddenNumber. Must be 0 or 1. For UpdateSysConfig_v2500 procedure only. Invalid ValidateOnAccCode. Must be 0 or 1. For UpdateSysConfig_v2500 procedure only. Invalid TransNumberType. Must be 0, 1, or 2. For UpdateSysConfig_v2500 procedure only.
Page 324 ReadiVoice PSPI Reference Return Code Description For AddModSubGrp_v2500 procedure only. Contact name can’t be empty string if GroupType is 1 (corporate). For AddModSubGrp_v2500 procedure only. Contact phone can’t be empty string if GroupType is 1 (corporate). For AddModSubGrp_v2500 procedure only. Credit card number can’t be empty string if GroupType is 1 (corporate) and...
Page 325 Database Length Defines Many stored procedures take CHAR parameters with defined lengths. For your convenience, the parameter tables in the reference chapters show the values of the defines, not the names of the defines. The table below cross-references the names of the defines with their defined values. Define DB_ACC_NUMS_STR_LEN DB_ACCESS_LEN...
Page 326 ReadiVoice PSPI Reference Define DB_OPERNOTE_LEN DB_PASSWORD_LEN DB_PHONE_LEN DB_PIN_LEN DB_PROMPT_LEN DB_SHORT_ADDR_LEN DB_STATE_LEN DB_SYSTYPE_LEN DB_TITLE_LEN DB_UNAME_LEN DB_USERFIELD_LEN DB_VERSION_LEN DB_ZIP_LEN Value Proprietary & Confidential...

Polycom ReadiVoice Reference Manual

1 Introduction to PSPI

2 Current PSPI Functions

3 Legacy V. 2.32.0 PSPI Functions

4 Legacy V. 2.13.0/2.30.0 PSPI Functions

5 Legacy V. 2.10.0 PSPI Functions

6 Legacy V. 2.00.0 PSPI Functions

7 Legacy V. 1.30.0 PSPI Functions

8 Legacy V. 1.20.0 PSPI Functions

9 Legacy V. 1.10.0 PSPI Functions

Quick Links

Need help?

Questions and answers

Related Manuals for Polycom ReadiVoice

Summary of Contents for Polycom ReadiVoice