manualshive.com logo in svg

Polycom ReadiVoice, Reference Manual

Introducing Polycom ReadiVoice, an advanced communication solution. This innovative product features a comprehensive "Provisioning Manual" that can be easily downloaded for free from our website. Unlock the full potential of your Polycom ReadiVoice with this user-friendly "manual" - available for immediate "download" at manualshive.com.

Share
Download
background image

ReadiVoice PSPI Reference

iv

Proprietary & Confidential

  

GetSubByEIdB() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  56
GetSub_v2500()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  60
GetSub_v2550()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  64
GetSysConfig_v2320() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  68
ReAssignAccCode()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  70
ReAssignPhoneNum()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  71
UpdateMTBilling()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  72
UpdateNumGrpRList()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  73
UpdateSub_v2500()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  75
UpdateSub_v2550()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  79
UpdateSysConfig_v2500()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  83

3 Legacy v. 2.32.0 PSPI Functions 

AddGroupACM()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  86
AddGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  87
AddPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  88
AddSubAcm()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  90
AddSubAndAN_v2320()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  90
AssignNumToSub()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  97
AssignPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  99
DelAssignedPN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  100
DeleteSub_v2320()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  100
DelGroupAcm()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  102
DelGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  103
DelSubAcm()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  104
GetAccOptChanges()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  105
GetGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  106
GetGroupInfo_v2320()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  107
GetGrpAccessClass  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
GetPromptInfo()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  111
GetSubAccNums() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  112
GetSubAcm()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  113
GetSub_v2320()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
GetSysConfig_v2320() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
ReAssignAccCode()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  119
ReAssignPhoneNum()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  119
UpdateMTBilling()   . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
UpdateSub_v2320()  . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .  122

Summary of Contents for ReadiVoice

Page 1: ...ReadiVoice PSPI Reference ...

Page 2: ...this document may be reproduced or transmitted in any form or by any means electronic or mechanical for any purpose without the express written permission of Polycom Inc Under the law reproducing includes translating into another language or format As between the parties Polycom Inc retains title to and ownership of all proprietary rights with respect to the software contained within its products ...

Page 3: ...lass 9 AddModSubGroup_v2500 10 AddPhoneNum 14 AddSubAcm 16 AddSubAndAN_v2500 17 AddSubAndAN_v2550 23 AddSubAndANString 29 AssignNumToSub 34 AssignPhoneNum 36 DelAssignedPN 37 DeleteGroup 38 DeleteSub_v2320 39 DelGroupAcm 40 DelGrpAccessClass 41 DelSubAcm 42 GetAccOptChanges 43 GetGroupAcm 44 GetGroupInfo_v2500 45 GetGrpAccessClass 48 GetPromptInfo 49 GetSubAccNums 49 GetSubAcm 50 GetSubAN_v2520 51...

Page 4: ...2 0 PSPI Functions AddGroupACM 86 AddGrpAccessClass 87 AddPhoneNum 88 AddSubAcm 90 AddSubAndAN_v2320 90 AssignNumToSub 97 AssignPhoneNum 99 DelAssignedPN 100 DeleteSub_v2320 100 DelGroupAcm 102 DelGrpAccessClass 103 DelSubAcm 104 GetAccOptChanges 105 GetGroupAcm 106 GetGroupInfo_v2320 107 GetGrpAccessClass 111 GetPromptInfo 111 GetSubAccNums 112 GetSubAcm 113 GetSub_v2320 113 GetSysConfig_v2320 11...

Page 5: ...lass 150 DelSubAcm 150 GetAccOptChanges 151 GetGroupAcm 152 GetGroupInfo_v2130 153 GetGrpAccessClass 156 GetPromptInfo 156 GetSubAccNums 157 GetSubAcm 158 GetSub_v2130 159 GetSysConfig_v2300 163 ReAssignAccCode 164 ReAssignPhoneNum 164 UpdateMTBilling 166 UpdateSub_v2130 167 5 Legacy v 2 10 0 PSPI Functions AddGroupAcm 172 AddGrpAccessClass 173 AddPhoneNum 174 AddSubAcm 176 AddSubAndAccNum 176 Add...

Page 6: ...etSub_v2100 213 GetSub_v2110 216 GetSysConfig_v2100 219 GetSysConfig_v2110 220 ReAssignAccCode 221 ReAssignPhoneNum 222 UpdateMTBilling 223 UpdateSub_v2100 224 UpdateSub_v2110 227 6 Legacy v 2 00 0 PSPI Functions AddGroupAcm 232 AddGrpAccessClass 233 AddSubAcm 234 AddSub_v2000 234 AssignPhoneNum 237 DelAssignedPN 239 DelGroupAcm 240 DelGrpAccessClass 241 DelSubAcm 242 GetAccOptChanges 243 GetGroup...

Page 7: ...cessClass 268 GetGroupInfo_v1300 269 GetGrpAccessClass 270 GetPromptInfo 271 GetSubAccNums 272 GetSub_v1300 273 GetSysConfig 275 ReAssignAccCode 276 ReAssignPhoneNum 277 UpdateSub_v1300 278 8 Legacy v 1 20 0 PSPI Functions AddSub_v1200 282 GetGroupInfo 285 GetPromptInfo 286 GetSubscriber 286 GetSysConfig 289 UpdateSub_v1200 290 9 Legacy v 1 10 0 PSPI Functions AddSubscriber 294 GetGroupInfo 297 Ge...

Page 8: ...ReadiVoice PSPI Reference viii Proprietary Confidential A Defines and Return Codes PSPI Return Codes 305 Database Length Defines 317 ...

Page 9: ...erefore is available to every application that runs on the database For instance PSPI can be used in conjunction with the ReadiVoice Moderator API MAPI or with alternate applications designed by the user Stored procedure calls SPCs are used to execute frequently repeated or complex tasks more efficiently than straight SQL code Like function calls they return a set of values in response to a query ...

Page 10: ...e The legacy add functions such as AddSubscriber and AddSub_v1200 default the new options and features such as PartPlayCount to zero or an empty string as appropriate The legacy update functions such as UpdateSubscriber and UpdateSub_v1200 can t modify the new options and features settings The legacy get functions such as GetSubscriber and GetSub_v1300 can t retrieve the new options and features s...

Page 11: ...rmation you need All the stored procedures appropriate for a specific release level are in one chapter See the table below for release levels Appendix A documents the return error codes returned by PSPI functions and the database length defines If your code is for See ReadiVoice v 2 50 0 and later including the ReadiVoice IP version Chapter 2 ReadiVoice v 2 32 0 and later including the ReadiVoice ...

Page 12: ...formix database server Calling Stored Procedures You can execute an SPC From your code on the client side From within the Informix environment on the server side Running a query alone before incorporating it into your code may be helpful to you in programming And running it alone may be useful in debugging a problem Regardless of how you call a stored procedure you must specify all parameters You ...

Page 13: ... selecting the database is Execute procedure SPname parameter1 parameter2 For example Execute procedure GetSub_v2100 2143 This retrieves the subscriber data for the subscriber whose ID is 2143 Execute procedure AddGroupAcm 45 2 This adds the ACM option ID 2 to the subscriber group with ID 45 Using INFORMIX SQL to Execute SPCs On the server side you can execute a stored procedure call as a stand al...

Page 14: ...User Guide To execute an SPC query from the command line using a command file 1 In the editor of your choice write the SPC query and save it with a sql extension 2 At the command line enter isql databaseName qr commandfilename pg more head Don t include the sql extension in the command file name The output of the stored procedure is sent to the screen You can of course pipe the output to a file Fo...

Page 15: ... the new field be sure you use the v 2 55 0 procedures For v 2 56 0 there is a new procedure AddSubAndANString that enables you to add a subscriber and assign more than threee access phone numbers to that subscriber at the same time If you have an application originally developed for earlier versions you must modify your code to use the new functions Alternatively you can use the legacy functions ...

Page 16: ...le to all parameters see Calling Stored Procedures on page 4 Return Values 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 Parameter Data Type Constraints Description vGroupI...

Page 17: ...e constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return code 0 O...

Page 18: ...l parameters see Calling Stored Procedures on page 4 Parameter Data Type Constraints Description vGroupId INT 0 ID number of subscriber group to update or 0 to add a new subscriber group vCheckParms INT 0 1 Perform general error checking 0 No 1 Yes vGroupType SMALLINT 0 1 Type of group 0 Personal 1 Corporate vGroupName CHAR 50 Group name Can t be empty string Must be unique vUserName CHAR 50 Leave...

Page 19: ...ing information vPromptSet INT 0 Default prompt set for this subscriber group vCarrierId INT 0 Default number group for this subscriber group vClientGrpA CHAR 255 User defined group note field A Set to empty string if not using vClientGrpB CHAR 255 User defined group note field B Set to empty string if not using vOperNotes CHAR 512 Operator notes field or empty string vRollCall SMALLINT 0 2 Roll c...

Page 20: ...pe changeable 0 No 1 Yes vConfRecAvailable SMALLINT 0 1 Conference recording available 0 No 1 Yes vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unava...

Page 21: ... Metratech billing field Set to empty string if not using vState CHAR 20 State Metratech billing field Set to empty string if not using vZip CHAR 15 ZIP code Metratech billing field Set to empty string if not using vTimezone INT Time zone Metratech billing field Set to 0 if not using Can t be 0 unless all other Metratech billing fields are empty strings vEmail CHAR 120 Email address Metratech bill...

Page 22: ...nd access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate table...

Page 23: ...his table vAccessNum CHAR 60 Access phone number numeric characters only vHiddenNum CHAR 60 Hidden number for access phone number numeric characters only Can t be empty string vSharedFlag SMALLINT 0 1 Access number type 0 Private 1 Shared vNumberType SMALLINT 0 Access class for access phone number must be in numberclasses table vNumberGroup SMALLINT 0 Number group for access phone number must be i...

Page 24: ...meters 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber must be in subscriberinfo table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Description INT...

Page 25: ...he Waiting Room isn t available when the subscriber locks a conference callers are turned away Lock with WR The Waiting Room is available when the subscriber locks a conference callers wait to be admitted by the subscriber WR on Entry Conferences start out locked with the Waiting Room available All callers must wait to be admitted by the subscriber The vWROptionEnable parameter specifies whether t...

Page 26: ... range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Caution The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate pl script as described in the ReadiVoice Administration Maintenance Guide If Translation Number Type is Length of vExternalId must be Fixed Translation Number Exactly equal to the number o...

Page 27: ...o assign default prompt set vFirstName CHAR 30 Subscriber s first name or empty string vLastName CHAR 30 Subscriber s last name or empty string vMiddleName CHAR 30 Subscriber s middle name or empty string vCompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscriber password Can t be empty string Must be at least AccessCodeLength characters set in SysConfig Numer...

Page 28: ... No 1 Yes vAutoContinuation SMALLINT 0 1 Conference starts with continuation enabled 0 No 1 Yes vQuickStartOption SMALLINT 0 1 Quick start enabled 0 No 1 Yes vQuickStartEnable SMALLINT 0 1 Quick start changeable by subscriber 0 No 1 Yes vExternalId CHAR 30 External ID numeric characters only or 1 if not using For systems using fixed translation numbers see the additional requirements specified in ...

Page 29: ...5 480 Conference termination time in minutes that governs automatic termination of conferences if conference termination option is 1 or 2 Set to 480 if not using vPartPlayCount SMALLINT 0 1 Conference entry with participant count 0 Off 1 On vDialOutPreFix CHAR 30 Number to dial before dialing out numeric characters only Set to empty string if not used vDialOutPostFix CHAR 30 Number to dial after d...

Page 30: ...y If not using hidden numbers duplicate the second access number Set to empty string if not specifying second access number vSharedFlag2 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not specifying second access number Otherwise must be same type as first access number vNumberType2 SMALLINT Number class of second access number Must be in numberclasses table Set to 0 if not spec...

Page 31: ... this parameter to 1 if not using One new validity check If Name Record is on and configurable but Entry Exit Announcement is Name and not configurable then the subscriber can turn off Name Record but the Announcement setting must remain Name To prevent this undesirable combination the procedure returns an error if vNameRecord vNameRecordEnable and vRollCall are all set to 1 but vRollCallEnable is...

Page 32: ...ing vCreditCardNumber CHAR 20 Credit card number numeric characters only Set to 999999 if not using vCreditCardExpire DATETIME YEAR TO MONTH Credit card expiration date Set to 1999 12 if not using vClientBillA CHAR 255 User defined billing field 1 Set to empty string if not using vClientBillB CHAR 255 User defined billing field 2 Set to empty string if not using vGroupId INT 1 0 ID number of subsc...

Page 33: ...ay request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disabled 1 Enabled vNameRecordEnable SMALLINT 0 1 N...

Page 34: ...ers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unavailable 1 Available vPromptSubscriber SMALLINT 0 1 Prompt to identify subscriber 0 No 1 Yes vConfTermOption SMALLINT 0 2 Conference termination option handlin...

Page 35: ...rence lock type changeable 0 No 1 Yes vAccessCode CHAR 20 Desired access code numeric characters only For shared access numbers this is required and must be at least AccessCodeLength characters set in SysConfig table For private access numbers set to empty string vAccessNumber1 CHAR 60 First access number numeric characters only Can t be empty string vHiddenNum1 CHAR 60 Hidden number for first acc...

Page 36: ...t using vHiddenNum3 CHAR 60 Hidden number for third access number numeric characters only If not using hidden numbers duplicate the third access number Set to empty string if not specifying third access number vSharedFlag3 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not specifying third access number Otherwise must be same type as first access number vNumberType3 SMALLINT Num...

Page 37: ...er record is flagged as deleted and the SPC returns an error After the string has been parsed validated and written to the temporary table the SP adds each access number to the database if it doesn t already exist removes it from the temporary table and assigns it to the subscriber If you set AccessNumVerify to 1 the SPC performs access number integrity checking See page 17 for a description If yo...

Page 38: ...Phone number to bill or empty string vBillingAddress CHAR 255 Billing address or empty string vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not using vCreditCardNumber CHAR 20 Credit card number numeric characters only Set to 999999 if not using vCreditCardExpire DATETIME YEAR TO MONTH Credit card expiration date Set to 1999 12 if not using vClientBillA...

Page 39: ... participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call cha...

Page 40: ...HAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unavailable 1 Available vPromp...

Page 41: ...ten Only Entry option changeable by subscriber for future conferences 0 No 1 Yes vWROption SMALLINT 0 2 WR option conference lock type 0 Normal lock 1 Lock w WR Waiting Room available when conf is locked 2 WR on entry conf starts out locked with Waiting Room enabled vWROptionEnable SMALLINT 0 1 WR Enable flag conference lock type changeable 0 No 1 Yes vAccessCode CHAR 20 Desired access code numeri...

Page 42: ...mber and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate...

Page 43: ...bility Regardless of setting the SPC puts new data into the CacsEventUpdate table See caution above about maintaining this table SubscriberId INT 0 ID of subscriber Must be in database AccessNum CHAR 60 New access phone number to assign to subscriber Must be in database SharedFlag INT 0 1 Access number type 0 Used shared 1 Used private NumberType SMALLINT 0 Not used HiddenNum CHAR 60 Hidden number...

Page 44: ...r access class 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not valid f...

Page 45: ...er is marked inactive 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalDelAccNum CHAR 60 Access phone number to delete Must be in d...

Page 46: ...able in the database the CACS then updates the call router with the data from the temporary table every ten seconds There is no option to notify the call router immediately 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 on page 4 Return Values Caution The ...

Page 47: ... 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 on page 4 Caution The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate pl script as described in the ReadiVoice Administration Maintenance Guide Parameter Data Type Constraints D...

Page 48: ...y all parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database vAcmId INT 0 ID of ACM option Must b...

Page 49: ...meters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must be in database LocalNumClassId INT 0 ID of access class Must be in database Data Type Description INT Return code 0 OK ot...

Page 50: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT Return ...

Page 51: ...e This procedure returns each account options change record that hasn t been flagged as read and then flags it as read A return code of 100 flags the end of the list of account options change records Compatible with v 2 02 0 or later of the software if the Account Options Updates feature is enabled Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Subscri...

Page 52: ...ater of the software if ACM is installed and configured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database Data Type Description INT R...

Page 53: ...scriber locks a conference callers are turned away Lock with WR The Waiting Room is available when the subscriber locks a conference callers wait to be admitted by the subscriber WR on Entry Conferences start out locked with the Waiting Room available All callers must wait to be admitted by the subscriber The WR Option Enable flag specifies whether by default this group s subscribers can change th...

Page 54: ...Operator available 0 No 1 Yes SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Quick start changeable by subscriber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference...

Page 55: ...n the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60 Country Metratech billing field if the corresponding table is defined on the CACS CHAR 30 Fax number Metr...

Page 56: ...to all parameters see Calling Stored Procedures on page 4 Return Values SMALLINT Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes SMALLINT WR option conference lock type 0 Normal lock 1 Lock w WR Waiting Room available when conf is locked 2 WR on entry conf starts out locked with Waiting Room enabled SMALLINT WR Enable flag conference lock type changeable 0 No 1 ...

Page 57: ...riber 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 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to ...

Page 58: ...d Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK otherwise error code CHAR 60 Access phone number INT Access class ID CHAR 30 Access class name Parameter Data Type Constraints Description vSubId INT 0 ID of subsc...

Page 59: ...d by a list member with the CHAR values set to empty strings and the INT values set to 0 Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database Data Type Description...

Page 60: ... see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vExternalId CHAR 30 External ID of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa ...

Page 61: ...tion 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled 0 N...

Page 62: ...PartCount 0 No 1 Yes CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech...

Page 63: ...ing out SMALLINT Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On SMALLINT Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes SMALLINT WR option conference lock type 0 Normal lock 1 Lock w WR Waiting Room available when conf is locked 2 WR on entry conf starts out locked with Waiting Room enabled SMALLINT WR Enable f...

Page 64: ...ID B Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vExternalIdB CHAR 30 External ID B of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Bill...

Page 65: ...pability 0 Disabled 1 Enabled SMALLINT Roll call entry exit announcement option 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by sub...

Page 66: ...queue first 2 Terminate SMALLINT Auto termination time in minutes Set to 480 if not using SMALLINT Conference entry with participant count PlayPartCount 0 No 1 Yes CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding ...

Page 67: ...ber when dialing out CHAR 30 Dial Out Postfix a number to dial after the dial out number when dialing out SMALLINT Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On SMALLINT Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes SMALLINT WR option conference lock type 0 Normal lock 1 Lock w WR Waiting Room available when ...

Page 68: ... available when the subscriber locks a conference callers wait to be admitted by the subscriber WR on Entry Conferences start out locked with the Waiting Room available All callers must wait to be admitted by the subscriber The WR Option Enable flag specifies whether the subscriber can change the Waiting Room setting for future conferences Parameters The constraints column shows specific value or ...

Page 69: ...cipant password SMALLINT Account status 0 Inactive 1 Active 2 Deleted SMALLINT Maximum number of participants SMALLINT Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither SMALLINT Dialout capability 0 Disabled 1 Enabled SMALLINT Roll call entry exit announcement option 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record...

Page 70: ...ALLINT Conference security code 0 Unavailable 1 Optional 2 Required SMALLINT Account options menu 0 Unavailable 1 Available SMALLINT Prompt to identify subscriber 0 No 1 Yes SMALLINT Terminate minimum participant conference set in SysConfig table after auto termination time 0 No 1 Send to operator queue first 2 Terminate SMALLINT Auto termination time in minutes Set to 480 if not using SMALLINT Co...

Page 71: ...ot processed 1 Being processed but not completed yet 2 Completed SMALLINT Password changeable by subscriber 0 No 1 Yes CHAR 30 Dial Out Prefix a number to dial before the dial out number when dialing out CHAR 30 Dial Out Postfix a number to dial after the dial out number when dialing out SMALLINT Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On SMAL...

Page 72: ...rn value which is the contents of the new External ID B field Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber Must be in database Data Type Description INT Return code 0 OK ot...

Page 73: ...LINT Dialout capability 0 Disabled 1 Enabled SMALLINT Roll call entry exit announcement option 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option ch...

Page 74: ...in SysConfig table after auto termination time 0 No 1 Send to operator queue first 2 Terminate SMALLINT Auto termination time in minutes Set to 480 if not using SMALLINT Conference entry with participant count PlayPartCount 0 No 1 Yes CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined ...

Page 75: ...efix a number to dial before the dial out number when dialing out CHAR 30 Dial Out Postfix a number to dial after the dial out number when dialing out SMALLINT Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On SMALLINT Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes SMALLINT WR option conference lock type 0 Normal ...

Page 76: ...ree digit code Four call flow flags indicate which call flows are enabled Traditional shared Traditional private Two password shared Two password private 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 The sixth new parameter is the con...

Page 77: ...1 Routed 2 Non routed private SMALLINT Use hidden numbers 0 No 1 Yes SMALLINT Validate on access code only 0 No 1 Yes CHAR 20 System type RVIP ReadiVoice IP RV_PSTN ReadiVoice PSTN CHAR 128 SIP domain name if ReadiVoice IP system Otherwise empty string SMALLINT Translation number type 0 Random 1 Fixed 2 Fixed with 3 digit code SMALLINT Traditional shared call flow 0 Unavailable 1 Available SMALLIN...

Page 78: ...nimum 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalNewAccCode CHAR 20 New access code Can t be empty string Must be at least Ac...

Page 79: ...r a subscriber must have at least one access phone number 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 Existi...

Page 80: ...s column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber to update Must be in database vLanguage CHAR 4 Language or empty string vCity CHAR 20 City or empty string vState CHAR 20 State or empty string vZip CHAR 15 ZI...

Page 81: ...ist ID 3 You can assign up to ten number groups to routing lists in one SPC To assign fewer than that set the parameters you re not using to 0 All the number group IDs and routing list IDs that you specify must exist in the database Parameters Specify all parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Ca...

Page 82: ... number group vNumGroup8 INT Number Group 8 Set to 0 if not assigning another number group vRoutingList8 INT New routing list ID for number group 7 Set to 0 if not assigning another number group vNumGroup9 INT Number Group 8 Set to 0 if not assigning another number group vRoutingList9 INT New routing list ID for number group 7 Set to 0 if not assigning another number group vNumGroup10 INT Number G...

Page 83: ...re conferences 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 on page 4 Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber to update vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number Set to 0 if not updati...

Page 84: ...t least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vParticipantPin CHAR 20 Participant password dual password call flow or empty string If used must be at least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vAccountStatus SMALLINT 0 2 Account status...

Page 85: ...see the additional requirements specified in If vExternalId is used for translation numbers on page 18 vConfRecAvailable SMALLINT 0 1 Conference recording available 0 No 1 Yes vAddress CHAR 255 Subscriber s address or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to em...

Page 86: ...lOutPostFix CHAR 30 Number to dial after dialing out numeric characters only Set to empty string if not used vLOEntry SMALLINT 0 1 Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On vLOEntryEnable SMALLINT 0 1 Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes vWROption SMALLINT 0 2 WR option conference lock type 0 Nor...

Page 87: ...shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber to update vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number Set to 0 if not updating billing information vBillingPhone CHAR 30 Phone number to bill or emp...

Page 88: ... Participant password dual password call flow or empty string If used must be at least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vAccountStatus SMALLINT 0 2 Account status 0 Inactive 1 Active 2 Deleted vMaxParticipants SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value i...

Page 89: ...rding available 0 No 1 Yes vAddress CHAR 255 Subscriber s address or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ...

Page 90: ...mpty string if not used vLOEntry SMALLINT 0 1 Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On vLOEntryEnable SMALLINT 0 1 Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes vWROption SMALLINT 0 2 WR option conference lock type 0 Normal lock 1 Lock w WR Waiting Room available when conf is locked 2 WR on entry conf st...

Page 91: ...e Calling Stored Procedures on page 4 Caution Polycom configures your system properly during installation Before making any changes contact your Polycom Global Services representative Changes in routing mode hidden number usage translation number type and call flow options may render your system inoperable without additional changes to your telephone network connections your ReadiVoice configurati...

Page 92: ...allFlow SMALLINT 0 1 Traditional private call flow 0 Unavailable 1 Available vTwoPsShrdCallFlow SMALLINT 0 1 Two password shared call flow 0 Unavailable 1 Available vTwoPsPrvCallFlow SMALLINT 0 1 Two password private call flow 0 Unavailable 1 Available vConfTermPartCount SMALLINT 1 3 Conference termination participant count Data Type Description INT Return code 0 OK otherwise error code CHAR 256 E...

Page 93: ...tures added since v 2 32 x rewrite your code to use the functions described in Chapter 2 Do not however mix and match current and legacy functions or two different levels of legacy functions such as v 2 10 0 and v 1 30 0 For instance don t use AddSubAndAN_v2320 to add subscribers and then try to update them with the legacy UpdateSubscriber function ReadiVoice IP functionality was merged into the s...

Page 94: ...ameters 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group must be in groupdetail table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Descripti...

Page 95: ...s The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return code...

Page 96: ...nd access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate table...

Page 97: ...ng this table vAccessNum CHAR 60 Access phone number numeric characters only vHiddenNum CHAR 60 Hidden number for access phone number numeric characters only Can t be empty string vSharedFlag SMALLINT 0 1 Access number type 0 Private 1 Shared vNumberType SMALLINT 0 Access class for access phone number must be in numberclasses table vNumberGroup SMALLINT 0 Number group for access phone number must ...

Page 98: ...numbers for a new subscriber even if those access numbers don t currently exist in the database First the procedure attempts to add the first access number to the database If this access number already exists the procedure simply skips the add process and continues Next the procedure adds the subscriber to the database and assigns the first access number to the new subscriber If you specified Para...

Page 99: ...erent access class For a shared access number checking that the combination of hidden number and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data i...

Page 100: ...vBillingId INT 1 0 Existing billing ID from database or 1 to let system generate a new billing ID vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number vBillingPhone CHAR 30 Phone number to bill or empty string vBillingAddress CHAR 255 Billing address or empty string vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not using vCreditCardNum...

Page 101: ...alid password list BadPins table vAccountStatus SMALLINT 0 1 Account status 0 Inactive 1 Active account status 2 deleted isn t valid for a new subscription vMaxParticipants SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2...

Page 102: ...Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Confe...

Page 103: ...s only Can t be empty string vHiddenNum1 CHAR 30 Hidden number for first access number numeric characters only Can t be empty string If not using hidden numbers duplicate the first access number vSharedFlag1 SMALLINT 0 1 Type of access number 0 Private 1 Shared vNumberType1 SMALLINT Number class of first access number Must be in numberclasses table vAccessNumber2 CHAR 30 Second access number numer...

Page 104: ...Set to empty string if not specifying third access number vSharedFlag3 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not specifying third access number Otherwise must be same type as first access number vNumberType3 SMALLINT Number class of third access number Must be in numberclasses table Set to 0 if not specifying third access number Data Type Description INT Return code 0 O...

Page 105: ...number and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpda...

Page 106: ...tibility Regardless of setting the SPC puts new data into the CacsEventUpdate table See caution above about maintaining this table SubscriberId INT 0 ID of subscriber Must be in database AccessNum CHAR 60 New access phone number to assign to subscriber Must be in database SharedFlag INT 0 1 Access number type 0 Used shared 1 Used private NumberType SMALLINT 0 Not used HiddenNum CHAR 60 Hidden numb...

Page 107: ... per access class 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not vali...

Page 108: ...u can run a purge script to periodically remove deleted accounts from the database Identify the subscriber by one of the following The subscriber ID The access phone number alone if it s private The access phone number and access code if the access number is shared If you set DeletePhoneNum to 1 and if the access phone number isn t being used by any other subscribers it s removed from the database...

Page 109: ...aintenance Guide Parameter Data Type Constraints Description vSubscriberId INT 0 0 ID of subscriber Set to 0 if not querying by subscriber ID Otherwise must be in database vAccessNum CHAR 60 Access phone number of subscriber numeric characters only Set to empty string if not querying by access number vAccessCode CHAR 20 Access code of subscriber numeric characters only Set to empty string if not q...

Page 110: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT...

Page 111: ...parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must be in database LocalNumClassId INT 0 ID of access class Must be in database Data Type Description INT Return code 0 O...

Page 112: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT Return ...

Page 113: ...eature This procedure returns each account options change record that hasn t been flagged as read and then flags it as read A return code of 100 flags the end of the list of account options change records Compatible with v 2 02 0 or later of the software if the Account Options Updates feature is enabled Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Su...

Page 114: ...ater of the software if ACM is installed and configured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database Data Type Description INT R...

Page 115: ...ult this group s conferences start in Listen Only mode all ordinary participants are muted and can t unmute themselves The Listen Only Entry changeable flag specifies whether by default this group s subscribers can turn the Listen Only Entry option on or off for future conferences Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group t...

Page 116: ...riber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference recording available 0 No 1 Yes INT Application provider ID SMALLINT VIP conference option guaranteed ports 0 Off 1 On SMALLI...

Page 117: ...scriber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference recording available 0 No 1 Yes INT Application provider ID SMALLINT VIP conference option guaranteed ports 0 Off 1 On SMAL...

Page 118: ...he corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60 Country Metratech billing field if the corresponding table is defined on the CACS CHAR 30 Fax number Metratech billing field if the corresponding table is defined on the CACS SMALLINT Password changeable by subscriber 0 No 1 Yes CHAR 30 Dial Out Pre...

Page 119: ... rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values 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 Pa...

Page 120: ...t to 0 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set Parameter Data Type Constraints Description ...

Page 121: ...e 4 Return Values GetSub_v2320 Stored procedure for retrieving a subscriber s record from the database This procedure is similar to GetSub_v2130 but has two additional return values at the end of the record The Listen Only Entry parameter specifies whether conferences start in Listen Only mode all ordinary participants are muted and can t unmute themselves The Listen Only Entry changeable flag spe...

Page 122: ...pe Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa 1 MC 2 Amex 3 Discover CHAR 20 Credit card number DATETIME YEAR TO MONTH Credit card expiration date CHAR 255 User defined billing field 1 CHAR 255 User defined billing fie...

Page 123: ...cord option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Quick start enabled 0 No 1 Yes SMALLINT Quick start changeable by subscriber 0 No 1...

Page 124: ...Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corre...

Page 125: ...ord private 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 The sixth new parameter is the conference termination participant count This sets the minimum participant threshold that triggers the automatic conference termination process i...

Page 126: ...ted shared 1 Routed 2 Non routed private SMALLINT Use hidden numbers 0 No 1 Yes SMALLINT Validate on access code only 0 No 1 Yes CHAR 20 System type RVIP ReadiVoice IP RV_PSTN ReadiVoice TSP CHAR 128 SIP domain name if ReadiVoice IP system Otherwise empty string SMALLINT Translation number type 0 Random 1 Fixed 2 Fixed with 3 digit code SMALLINT Traditional shared call flow 0 Unavailable 1 Availab...

Page 127: ...ess 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 Parameters Specify all parameters The constraints column shows specific value...

Page 128: ...traints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 Existing access phone number Must be in database LocalNewAccNum CHAR 60 New access phone number Must be in database or an empty string Data Type Description INT Return code 0 OK otherwise error code ...

Page 129: ...ints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber to update Must be in database vLanguage CHAR 4 Language or empty string vCity CHAR 20 City or empty string vState CHAR 20 State or empty string vZip CHAR 15...

Page 130: ... INT 0 ID of subscriber to update vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number Set to 0 if not updating billing information vBillingPhone CHAR 30 Phone number to bill or empty string if not updating billing information vBillingAddress CHAR 255 Billing address or empty string if not updating billing information vBillingId INT 0 0 Existing billing ID from database if updati...

Page 131: ...deLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vAccountStatus SMALLINT 0 2 Account status 0 Inactive 1 Active 2 Deleted vMaxParticipants SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 ...

Page 132: ...30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Confer...

Page 133: ...o dial after dialing out numeric characters only Set to empty string if not used vLOEntry SMALLINT 0 1 Listen Only Entry option conferences start with all but subscriber in Listen Only mode 0 Off 1 On vLOEntryEnable SMALLINT 0 1 Listen Only Entry option changeable by subscriber for future conferences 0 No 1 Yes Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Con...

Page 134: ...ReadiVoice PSPI Reference 126 Proprietary Confidential ...

Page 135: ...our code to use the functions described in Chapter 2 Do not however mix and match current and legacy functions or two different levels of legacy functions such as v 2 10 0 and v 1 30 0 For instance don t use AddSub_v2130 to add subscribers and then try to update them with the legacy UpdateSubscriber function ReadiVoice IP functionality was merged into the standard release of ReadiVoice v 2 30 0 so...

Page 136: ...rameters 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group must be in groupdetail table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Descript...

Page 137: ...eters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return ...

Page 138: ...nd access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate table...

Page 139: ...aining this table vAccessNum CHAR 60 Access phone number numeric characters only vHiddenNum CHAR 60 Hidden number for access phone number numeric characters only Can t be empty string vSharedFlag SMALLINT 0 1 Access number type 0 Private 1 Shared vNumberType SMALLINT 0 Access class for access phone number must be in numberclasses table vNumberGroup SMALLINT 0 Number group for access phone number m...

Page 140: ...meters 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber must be in subscriberinfo table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Description INT...

Page 141: ...r specifies a number to be dialed before the telephone number when dialing out The vDialoutPostFix 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 Using this procedure or its siblings AddSubAndAN_v2110 and AddSubAndA...

Page 142: ...f CHAR 30 For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Caution The CacsEventUpdate table must be purged periodically using the cleanCacsEvtUpdate pl script as described in the ReadiVoice Administration Maintenance Guide Parameter Data Type Constraints Description AccessNumVerify SMALLINT 0 1 Validate access number integrity 0 No 1 Yes Notify...

Page 143: ...mpt set vFirstName CHAR 30 Subscriber s first name or empty string vLastName CHAR 30 Subscriber s last name or empty string vMiddleName CHAR 30 Subscriber s middle name or empty string vCompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscriber password Can t be empty string Must be at least AccessCodeLength characters set in SysConfig Numeric characters only M...

Page 144: ...0 No 1 Yes vAutoContinuation SMALLINT 0 1 Conference starts with continuation enabled 0 No 1 Yes vQuickStartOption SMALLINT 0 1 Quick start enabled 0 No 1 Yes vQuickStartEnable SMALLINT 0 1 Quick start changeable by subscriber 0 No 1 Yes vExternalId CHAR 30 External ID numeric characters only or 1 if not using For systems using fixed translation numbers see the additional requirements specified in...

Page 145: ...ing out numeric characters only Set to empty string if not used vDialOutPostFix CHAR 30 Number to dial after dialing out numeric characters only Set to empty string if not used vAccessCode CHAR 20 Desired access code numeric characters only For shared access numbers this is required and must be at least AccessCodeLength characters set in SysConfig table For private access numbers set to empty stri...

Page 146: ...ess number vAccessNumber3 CHAR 30 Third access number numeric characters only Set to empty string if not using vHiddenNum3 CHAR 30 Hidden number for third access number numeric characters only If not using hidden numbers duplicate the third access number Set to empty string if not specifying third access number vSharedFlag3 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not spec...

Page 147: ... message telling them the number of people including themselves in conference The vDialoutPrefix parameter specifies a number to be dialed before the telephone number when dialing out The vDialoutPostFix 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 ReadiVoi...

Page 148: ... card number numeric characters only Set to 999999 if not using vCreditCardExpire DATETIME YEAR TO MONTH Credit card expiration date Set to 1999 12 if not using vClientBillA CHAR 255 User defined billing field 1 Set to empty string if not using vClientBillB CHAR 255 User defined billing field 2 Set to empty string if not using vGroupId INT 1 0 ID number of subscriber group to which this subscriber...

Page 149: ... 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disabled 1 Enabled vNameRecordEnable SMALLI...

Page 150: ...ccess numbers this is required and must be at least AccessCodeLength characters set in SysConfig table For private access numbers set to empty string vAccessNumber CHAR 30 Desired access number numeric characters only Can t be empty string Must be in phonenumbers table vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option...

Page 151: ...numeric characters only Set to empty string if not used vDialOutPostFix CHAR 30 Number to dial after dialing out numeric characters only Set to empty string if not used Parameter Data Type Constraints Description Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID of new subscriber if no error CHAR 30 Access number allocated phone number CHAR 20 Access code same as Ac...

Page 152: ...mber and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate...

Page 153: ... compatibility Regardless of setting the SPC puts new data into the CacsEventUpdate table See caution above about maintaining this table SubscriberId INT 0 ID of subscriber Must be in database AccessNum CHAR 60 New access phone number to assign to subscriber Must be in database SharedFlag INT 0 1 Access number type 0 Used shared 1 Used private NumberType SMALLINT 0 Not used HiddenNum CHAR 60 Hidde...

Page 154: ...er access class 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not valid ...

Page 155: ...subscriber is marked inactive 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalDelAccNum CHAR 60 Access phone number to delete Must...

Page 156: ...ta into the CacsEventUpdate table in the database the CACS then updates the call router with the data from the temporary table every ten seconds 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 on page 4 Caution The CacsEventUpdate table must be purged perio...

Page 157: ...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 on page 4 Return Values Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database vAcmId INT 0 ID of ACM option ...

Page 158: ...tion 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 For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must ...

Page 159: ...returns each account options change record that hasn t been flagged as read and then flags it as read A return code of 100 flags the end of the list of account options change records Compatible with v 2 02 0 or later of the software if the Account Options Updates feature is enabled Parameters None Return Values Data Type Description INT Return code 0 OK otherwise error code Data Type Description I...

Page 160: ...ater of the software if ACM is installed and configured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database Data Type Description INT R...

Page 161: ...message telling them the number of people including themselves in conference The Dial Out Prefix parameter specifies a number to be dialed before the telephone number when dialing out 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 ReadiVo...

Page 162: ... Operator available 0 No 1 Yes SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Quick start changeable by subscriber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conferenc...

Page 163: ...tratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60 Country Metratech billing field if the corre...

Page 164: ...ules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values 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 Para...

Page 165: ...ues set to 0 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set Parameter Data Type Constraints Descri...

Page 166: ...00 0 or later of the software if ACM is installed and configured Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber group Must be in database Data Type Description INT Return code 0 OK ...

Page 167: ...rameter 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 Parameters Note The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedur...

Page 168: ...e 2 Deleted SMALLINT Maximum number of participants SMALLINT Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither SMALLINT Dialout capability 0 Disabled 1 Enabled SMALLINT Roll call entry exit announcement option 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeab...

Page 169: ...LLINT Account options menu 0 Unavailable 1 Available SMALLINT Prompt to identify subscriber 0 No 1 Yes SMALLINT Terminate minimum participant conference set in SysConfig table after auto termination time 0 No 1 Send to operator queue first 2 Terminate SMALLINT Auto termination time in minutes Set to 480 if not using SMALLINT Conference entry with participant count PlayPartCount 0 No 1 Yes CHAR 4 L...

Page 170: ...e corresponding table is defined on the CACS CHAR 30 Fax number Metratech billing field if the corresponding table is defined on the CACS INT Metratech billing account flag 0 Not processed 1 Being processed but not completed yet 2 Completed SMALLINT Password changeable by subscriber 0 No 1 Yes CHAR 30 Dial Out Prefix a number to dial before the dial out number when dialing out CHAR 30 Dial Out Pos...

Page 171: ...of 1 indicates that an access code is required two password call flow is disabled Parameters None Return Values Caution If two password call flow is enabled then you can t use any pre v 2 10 0 stored procedures except those included in chapters 2 5 Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Minimum c...

Page 172: ...res on page 4 Return Values 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 CHAR 20 System type RVIP ReadiVoice IP RV_PSTN ReadiVoice PSTN CHAR 128 SIP domain name if ReadiVoice IP system Otherwise empty string SMALLINT Access code required AccessCode4Shared flag 0 No 1 Yes Data T...

Page 173: ...y all parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 Existing access phone number Must be in database LocalNewAccNum CHAR 60 New acces...

Page 174: ...ts column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber to update Must be in database vLanguage CHAR 4 Language or empty string vCity CHAR 20 City or empty string vState CHAR 20 State or empty string vZip CHAR 15 Z...

Page 175: ...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 on page 4 Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber to update vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number Set to...

Page 176: ...t least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vParticipantPin CHAR 20 Participant password dual password call flow or empty string If used must be at least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vAccountStatus SMALLINT 0 2 Account status...

Page 177: ...numbers see the additional requirements specified in If vExternalId is used for translation numbers on page 18 vConfRecAvailable SMALLINT 0 1 Conference recording available 0 No 1 Yes vAddress CHAR 255 Subscriber s address or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 S...

Page 178: ...Auto termination time in minutes Set to 480 if not using vPartPlayCount SMALLINT 0 1 Conference entry with participant count 0 Off 1 On vDialOutPreFix CHAR 30 Number to dial before dialing out numeric characters only Set to empty string if not used vDialOutPostFix CHAR 30 Number to dial after dialing out numeric characters only Set to empty string if not used Data Type Description INT Return code ...

Page 179: ... functions with newer versions of the software to avoid rewriting your code However you can t access the new options and features To access all the features added since v 2 11 x rewrite your code to use the functions described in Chapter 2 Do not however mix and match current and legacy functions or two different levels of legacy functions such as v 2 10 0 and v 1 30 0 For instance don t use AddSu...

Page 180: ...rameters 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group must be in groupdetail table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Descript...

Page 181: ...rs The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return cod...

Page 182: ...nd access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpdate table...

Page 183: ...ing this table vAccessNum CHAR 60 Access phone number numeric characters only vHiddenNum CHAR 60 Hidden number for access phone number numeric characters only Can t be empty string vSharedFlag SMALLINT 0 1 Access number type 0 Private 1 Shared vNumberType SMALLINT 0 Access class for access phone number must be in numberclasses table vNumberGroup SMALLINT 0 Number group for access phone number must...

Page 184: ...e access numbers for a new subscriber even if those access numbers don t currently exist in the database First the procedure attempts to add the first access number to the database If this access number already exists the procedure simply skips the add process and continues Next the procedure adds the subscriber to the database and assigns the first access number to the new subscriber If you speci...

Page 185: ...king that the combination of hidden number and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRoute...

Page 186: ... YEAR TO MINUTE Time of activation vBillingId INT 1 0 Existing billing ID from database or 1 to let system generate a new billing ID vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number vBillingPhone CHAR 30 Phone number to bill or empty string vBillingAddress CHAR 255 Billing address or empty string vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover S...

Page 187: ...alid password list BadPins table vAccountStatus SMALLINT 0 1 Account status 0 Inactive 1 Active account status 2 deleted isn t valid for a new subscription vMaxParticipants SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2...

Page 188: ...e number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off...

Page 189: ...only If not using hidden numbers duplicate the second access number Set to empty string if not specifying second access number vSharedFlag2 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not specifying second access number Otherwise must be same type as first access number vNumberType2 SMALLINT Number class of second access number Must be in numberclasses table Set to 0 if not s...

Page 190: ... For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID of new subscriber if no error Parameter Data Type Constraints Description AccessNumVerify SMALLINT 0 1 Validate access number integrity 0 No 1 Yes NotifyCallRouter SMALLINT 0 1 Parameter remains only to maintain bac...

Page 191: ... subscriber group vPromptSet INT 1 0 Prompt set to assign to this subscriber must be in database or 1 to assign default prompt set vFirstName CHAR 30 Subscriber s first name or empty string vLastName CHAR 30 Subscriber s last name or empty string vMiddleName CHAR 30 Subscriber s middle name or empty string vCompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscr...

Page 192: ...es vContinueEnable SMALLINT 0 1 Autocontinuation option changeable by subscriber 0 No 1 Yes vPasswordEnable SMALLINT 0 1 Password changeable by subscriber 0 No 1 Yes vAutoContinuation SMALLINT 0 1 Conference starts with continuation enabled 0 No 1 Yes vQuickStartOption SMALLINT 0 1 Quick start enabled 0 No 1 Yes vQuickStartEnable SMALLINT 0 1 Quick start changeable by subscriber 0 No 1 Yes vExtern...

Page 193: ...LINT 5 480 Auto termination time in minutes Set to 480 if not using vPartPlayCount SMALLINT 0 1 Conference entry with participant count 0 Off 1 On vAccessCode CHAR 20 Desired access code numeric characters only For shared access numbers this is required and must be at least AccessCodeLength characters set in SysConfig table For private access numbers set to empty string vAccessNumber1 CHAR 30 Firs...

Page 194: ...ess number vAccessNumber3 CHAR 30 Third access number numeric characters only Set to empty string if not using vHiddenNum3 CHAR 30 Hidden number for third access number numeric characters only If not using hidden numbers duplicate the third access number Set to empty string if not specifying third access number vSharedFlag3 SMALLINT 0 1 Type of access number 0 Private 1 Shared Set to 0 if not spec...

Page 195: ...tone to keep the conference going If there is no response the system alerts an operator if the setting is 1 or automatically terminates the conference if the setting is 2 The ConfTermTime parameter specifies the period of time in minutes that triggers the ConfTermOption process Valid values are from 5 to 480 inclusive Parameters Specify all parameters The constraints column shows specific value or...

Page 196: ...t vFirstName CHAR 30 Subscriber s first name or empty string vLastName CHAR 30 Subscriber s last name or empty string vMiddleName CHAR 30 Subscriber s middle name or empty string vCompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscriber password Can t be empty string Must be at least AccessCodeLength characters set in SysConfig Numeric characters only Must no...

Page 197: ...MALLINT 0 1 Password changeable by subscriber 0 No 1 Yes vAutoContinuation SMALLINT 0 1 Conference starts with continuation enabled 0 No 1 Yes vQuickStartOption SMALLINT 0 1 Quick start enabled 0 No 1 Yes vQuickStartEnable SMALLINT 0 1 Quick start changeable by subscriber 0 No 1 Yes vExternalId CHAR 30 External ID or 1 if not using Numeric characters only For systems using fixed translation number...

Page 198: ...d ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unavailable 1 Available vPromptSubscriber SMALLINT 0 1 Prompt to identify subscriber 0 No 1 Yes vConfTermOption SMALLINT 0 2 Terminate minimum participant conference set in SysConfig table after auto termination time 0 No 1 Send to operator qu...

Page 199: ... rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Parameter Data Type Constraints Description vEntryDate DATETIME YEAR TO MINUTE Time of creation vActivationDate DATETIME YEAR TO MINUTE Time of activation vBillingId INT 1 0 Existing billing ID from database or 1 to let system generate a new billing ID vBillingType SMALLINT 0 1 Type of billing 0 Credit card...

Page 200: ...adPins table vParticipantPin CHAR 20 Participant password dual password call flow or empty string If used must be at least AccessCodeLength characters set in SysConfig Numeric characters only Must not be in invalid password list BadPins table vAccountStatus SMALLINT 0 1 Account status 0 Inactive 1 Active account status 2 deleted isn t valid for a new subscription vMaxParticipants SMALLINT 1 Maximu...

Page 201: ...n page 18 vConfRecAvailable SMALLINT 0 1 Conference recording available 0 No 1 Yes vAddress CHAR 255 Subscriber s address or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty str...

Page 202: ...minimum participant conference set in SysConfig table after auto termination time 0 No 1 Send to operator queue first 2 Terminate vConfTermTime SMALLINT 5 480 Auto termination time in minutes Set to 480 if not using vPartPlayCount SMALLINT 0 1 Conference entry with participant count 0 Off 1 On Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID of new subscriber if no...

Page 203: ... number and access code is unique For a private access number making sure all access numbers that share the specified hidden number are marked unavailable for assignment to other subscribers In earlier versions of ReadiVoice prior to v 2 50 0 the NotifyCallRouter parameter let you choose whether to load new data into call router memory immediately NotifyCallRouter 1 or write it to the CacsEventUpd...

Page 204: ...tibility Regardless of setting the SPC puts new data into the CacsEventUpdate table See caution above about maintaining this table SubscriberId INT 0 ID of subscriber Must be in database AccessNum CHAR 60 New access phone number to assign to subscriber Must be in database SharedFlag INT 0 1 Access number type 0 Used shared 1 Used private NumberType SMALLINT 0 Not used HiddenNum CHAR 60 Hidden numb...

Page 205: ... per access class 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not vali...

Page 206: ...iber is marked inactive 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalDelAccNum CHAR 60 Access phone number to delete Must be in...

Page 207: ... data into the CacsEventUpdate table in the database the CACS then updates the call router with the data from the temporary table every ten seconds 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 on page 4 Caution The CacsEventUpdate table must be purged pe...

Page 208: ...y all parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database vAcmId INT 0 ID of ACM option Must b...

Page 209: ...parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must be in database LocalNumClassId INT 0 ID of access class Must be in database Data Type Description INT Return code 0 O...

Page 210: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT Return ...

Page 211: ...eature This procedure returns each account options change record that hasn t been flagged as read and then flags it as read A return code of 100 flags the end of the list of account options change records Compatible with v 2 02 0 or later of the software if the Account Options Updates feature is enabled Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Su...

Page 212: ...ater of the software if ACM is installed and configured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database Data Type Description INT R...

Page 213: ... Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group type CHAR 50 Group name CHAR 50 Company name CHAR 30 Company phone number CHAR 30 Company fax number CHAR 50 Contact name CHAR 30 Contact phone INT Billing ID INT Prompt set INT Carrier ID CHAR 255 Group notes A CHAR 255 Group notes B CHAR 512 Operator notes SMALLINT Roll call entry exit announcem...

Page 214: ...Yes SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference recording available 0 No 1 Yes INT Application provider ID SMALLINT VIP conference option guaranteed ports 0 Off 1 On SMALLINT Conference security code 0 Unavailable 1 Optional 2 Required SMALLINT Account options menu 0 Unavailable 1 Available SMALLINT Prompt to identify subscriber 0 No 1 Yes SMALLINT Terminate minimu...

Page 215: ...rresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60 Country Metratech billing field if the corresponding table is defined on th...

Page 216: ...d 1 Enabled SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Account status 0 Inactive 1 Active 2 Deleted SMALLINT Quick start enabled 0 No 1 Yes SMALLINT Operator available 0 No 1 Yes SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Quick start changeable by subscriber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber ...

Page 217: ...PlayCount 0 No 1 Yes CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech...

Page 218: ...ules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values 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 Para...

Page 219: ...set to 0 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set Parameter Data Type Constraints Descriptio...

Page 220: ...00 0 or later of the software if ACM is installed and configured Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber group Must be in database Data Type Description INT Return code 0 OK ...

Page 221: ...Description vSubscriberId INT 0 ID of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa 1 MC 2 Amex 3 Discover CHAR 20 Credit card number DATETIME YEAR TO MONTH Credit card expiration ...

Page 222: ...INT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Quick start enabl...

Page 223: ...table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email ad...

Page 224: ...lling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa 1 MC 2 Amex 3 Di...

Page 225: ...t option 0 Tone 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled...

Page 226: ...tion time in minutes Set to 480 if not using SMALLINT Conference entry with participant count PartPlayCount 0 No 1 Yes CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metratech billing field if the corresponding table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code...

Page 227: ...essed but not completed yet 2 Completed SMALLINT Password changeable by subscriber 0 No 1 Yes Data Type Description Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Minimum code length for access code and for subscriber and participant passwords SMALLINT Maximum number of participants SMALLINT Confidence f...

Page 228: ...urn Values Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Minimum code length for access code and for subscriber and participant passwords SMALLINT Maximum number of participants SMALLINT Confidence factor SMALLINT Port utilization factor SMALLINT Routed system 0 Non routed shared 1 Routed 2 Non routed p...

Page 229: ... minimum 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalNewAccCode CHAR 20 New access code Can t be empty string Must be at least...

Page 230: ...ber a subscriber must have at least one access phone number 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 Exis...

Page 231: ...ints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber to update Must be in database vLanguage CHAR 4 Language or empty string vCity CHAR 20 City or empty string vState CHAR 20 State or empty string vZip CHAR 15...

Page 232: ...dating billing information vBillingId INT 0 0 Existing billing ID from database if updating billing information Negative number if not updating billing information vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not if not updating billing information vCreditCardNumber CHAR 20 Credit card number numeric characters only or empty string if not updating bill...

Page 233: ...ble vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disabled 1...

Page 234: ...CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unavailable 1 Available vPromptSu...

Page 235: ...it card 1 Phone number Set to 0 if not updating billing information vBillingPhone CHAR 30 Phone number to bill or empty string if not updating billing information vBillingAddress CHAR 255 Billing address or empty string if not updating billing information vBillingId INT 0 0 Existing billing ID from database if updating billing information Negative number if not updating billing information vCredit...

Page 236: ...list BadPins table vAccountStatus SMALLINT 0 2 Account status 0 Inactive 1 Active 2 Deleted vMaxParticipants SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 E...

Page 237: ...ng vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 ...

Page 238: ...ReadiVoice PSPI Reference 230 Proprietary Confidential Return Values Data Type Description INT Return code 0 OK otherwise error code ...

Page 239: ...ent levels of legacy functions such as v 2 00 0 and v 1 30 0 For instance don t use AddSubAndAN_v2320 to add subscribers and then try to update them with the legacy UpdateSub_v2000 function 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 Caution If two password call flow is enabled then you can t use any pre v 2 10 0 stor...

Page 240: ...rameters 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group must be in groupdetail table vAcmId INT 0 ID of ACM option must be in acmoptions table Data Type Descript...

Page 241: ...rs The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return cod...

Page 242: ...couldn t specify an access number for a new subscriber the system chose one In this function you specify the access number desired with the AccessNumber parameter required Consequently the AccessNumType and NumberClassId parameters used in AddSub_v1300 are no longer necessary and have been removed Parameters Note Specify all parameters The constraints column shows specific value or range constrain...

Page 243: ...o 999999 if not using vCreditCardExpire DATETIME YEAR TO MONTH Credit card expiration date Set to 1999 12 if not using vClientBillA CHAR 255 User defined billing field 1 Set to empty string if not using vClientBillB CHAR 255 User defined billing field 2 Set to empty string if not using vGroupId INT 1 0 ID number of subscriber group to which this subscriber should be assigned must be in database or...

Page 244: ...ord changeable by subscriber 0 No 1 Yes vContinuation SMALLINT 0 1 Conference continuation option changeable for current conference 0 No 1 Yes vContinueEnable SMALLINT 0 1 Autocontinuation option changeable by subscriber 0 No 1 Yes vAutoContinuation SMALLINT 0 1 Conference starts with continuation enabled 0 No 1 Yes vQuickStartOption SMALLINT 0 1 Quick start enabled 0 No 1 Yes vQuickStartEnable SM...

Page 245: ...access numbers vAccessNumber CHAR 30 Desired access number numeric characters only Can t be empty string Must be in phonenumbers table vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMAL...

Page 246: ...traints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not valid for private vShared INT 0 1 Access number type 0 Private 1 Shared vClassName CHAR 30 Desired access class o...

Page 247: ...criber is marked inactive 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalDelAccNum CHAR 60 Access phone number to delete Must be ...

Page 248: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT...

Page 249: ...parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must be in database LocalNumClassId INT 0 ID of access class Must be in database Data Type Description INT Return code 0 O...

Page 250: ...figured 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAcmId INT 0 ID of ACM option Must be in database Data Type Description INT Return ...

Page 251: ...eature This procedure returns each account options change record that hasn t been flagged as read and then flags it as read A return code of 100 flags the end of the list of account options change records Compatible with v 2 02 0 or later of the software if the Account Options Updates feature is enabled Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Su...

Page 252: ...ater of the software if ACM is installed and configured 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 on page 4 Return Values Parameter Data Type Constraints Description vGroupId INT 0 ID of subscriber group Must be in database Data Type Description INT R...

Page 253: ... Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group type CHAR 50 Group name CHAR 50 Company name CHAR 30 Company phone number CHAR 30 Company fax number CHAR 50 Contact name CHAR 30 Contact phone INT Billing ID INT Prompt set INT Carrier ID CHAR 255 Group notes A CHAR 255 Group notes B CHAR 512 Operator notes SMALLINT Roll call entry exit announcem...

Page 254: ...ble by subscriber 0 No 1 Yes SMALLINT Conference recording available 0 No 1 Yes INT Application provider ID SMALLINT VIP conference option guaranteed ports 0 Off 1 On SMALLINT Conference security code 0 Unavailable 1 Optional 2 Required SMALLINT Account options menu 0 Unavailable 1 Available CHAR 4 Language Metratech billing field if the corresponding table is defined on the CACS CHAR 20 City Metr...

Page 255: ...s and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60 Country Metratech billing field if the corresponding table is defined on the CACS CHAR 30 Fax number Metratech billing field if the corresponding table is defined on the CACS Data Type Descripti...

Page 256: ...scriber 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 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable t...

Page 257: ...ured Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Data Type Description INT Return code 0 OK otherwise error code CHAR 60 Access phone number INT Access class ID CHAR 30 Access class name Parameter Data Type Constraints Description vSubId INT 0 ID of su...

Page 258: ...pe Constraints Description vSubscriberId INT 0 ID of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa 1 MC 2 Amex 3 Discover CHAR 20 Credit card number DATETIME YEAR TO MONTH Credit c...

Page 259: ...e 1 Name 2 Silence SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled 0 No 1 Yes SM...

Page 260: ...table is defined on the CACS CHAR 20 State Metratech billing field if the corresponding table is defined on the CACS CHAR 15 ZIP code Metratech billing field if the corresponding table is defined on the CACS INT Time zone Metratech billing field if the corresponding table is defined on the CACS CHAR 120 Email address Metratech billing field if the corresponding table is defined on the CACS CHAR 60...

Page 261: ...database Compatible with v 1 10 0 or later of the software Parameters None Return Values Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Access code length SMALLINT Maximum number of participants SMALLINT Confidence factor SMALLINT Port utilization factor ...

Page 262: ...inimum 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalNewAccCode CHAR 20 New access code Can t be empty string Must be at least A...

Page 263: ...number a subscriber must have at least one access phone number 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 E...

Page 264: ...ts column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber to update Must be in database vLanguage CHAR 4 Language or empty string vCity CHAR 20 City or empty string vState CHAR 20 State or empty string vZip CHAR 15 Z...

Page 265: ... address or empty string if not updating billing information vBillingId INT 0 0 Existing billing ID from database if updating billing information Negative number if not updating billing information vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not if not updating billing information vCreditCardNumber CHAR 20 Credit card number numeric characters only or...

Page 266: ...on 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disabled 1 Enabled vNameRecordEnable SMALLINT 0 1 Name record changeable by subscriber 0 No 1 Yes vContinuation SMALLINT 0 1 Conference continuation option changeable for current conference 0 No 1 Yes vContinueEnable SMALLINT 0 1 Autocontinuation optio...

Page 267: ...er defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using vVipConf SMALLINT 0 1 VIP conference option guaranteed ports 0 Off 1 On vPromptSecurity SMALLINT 0 2 Conference security code 0 Unavailable 1 Optional 2 Required vPromptMenu SMALLINT 0 1 Account options menu 0 Unavailable 1 Available Data Type Descri...

Page 268: ...ReadiVoice PSPI Reference 260 Proprietary Confidential ...

Page 269: ...wo different levels of legacy functions such as v 2 00 0 and v 1 30 0 For instance don t use AddSubAndAN_v2320 to add subscribers and then try to update them with the legacy UpdateSub_v1300 function 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 Caution If two password call flow is enabled then you can t use any pre v 2 ...

Page 270: ...The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description GroupId INT 0 ID of subscriber group must be in groupdetail table NumberClassId INT 0 ID of access class must be in numberclasses table Data Type Description INT Return code 0...

Page 271: ...em generate a new billing ID vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number vBillingPhone CHAR 30 Phone number to bill or empty string vBillingAddress CHAR 255 Billing address or empty string vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not using vCreditCardNumber CHAR 20 Credit card number numeric characters only Set to 999999 ...

Page 272: ... table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disable...

Page 273: ...if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vAccessNumType INT 0 1 Type of access number desired 0 Shared 1 Private vAccessCode CHAR 20 Desired access code numeric characters only Required for shared access numbers Set to empty string for private access numbers vNumberClassId INT 0 Desired access number class Must be in database vProviderId IN...

Page 274: ...er access class 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 on page 4 Return Values Parameter Data Type Constraints Description vSubId INT 0 ID of subscriber Must be in database vAccCode CHAR 20 New access code optional for shared access type not valid ...

Page 275: ...criber is marked inactive 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalDelAccNum CHAR 60 Access phone number to delete Must be ...

Page 276: ...rameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalGroupId INT 0 ID of subscriber group Must be in database LocalNumClassId INT 0 ID of access class Must be in database Data Type Description INT Return code 0 OK ...

Page 277: ... Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group type CHAR 50 Group name CHAR 50 Company name CHAR 30 Company phone number CHAR 30 Company fax number CHAR 50 Contact name CHAR 30 Contact phone INT Billing ID INT Prompt set INT Carrier ID CHAR 255 Group notes A CHAR 255 Group notes B CHAR 512 Operator notes SMALLINT Roll call entry exit announcem...

Page 278: ...ontinuation option changeable for current conference 0 No 1 Yes SMALLINT Account status 0 Inactive 1 Active 2 Deleted SMALLINT Quick start enabled 0 No 1 Yes SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Quick start changeable by subscriber 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Con...

Page 279: ...oth 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 Return Values Data Type Description INT Return code 0 OK 100 end of list otherwise error code INT ID of access class Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set ...

Page 280: ...ues set to empty strings and the INT values set to 0 Compatible with v 1 30 0 or later of the software Parameters The constraints column shows specific value or range constraints For syntax rules and constraints applicable to all parameters see Calling Stored Procedures on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database Data Ty...

Page 281: ...Description vSubscriberId INT 0 ID of subscriber Must be in database Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMALLINT Credit card type 0 Visa 1 MC 2 Amex 3 Discover CHAR 20 Credit card number DATETIME YEAR TO MONTH Credit card expiration ...

Page 282: ... SMALLINT Roll call changeable by subscriber 0 No 1 Yes SMALLINT Name record option 0 Disabled 1 Enabled SMALLINT Name record changeable by subscriber 0 No 1 Yes SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes SMALLINT Autocontinuation option changeable by subscriber 0 No 1 Yes SMALLINT Conference starts with continuation enabled 0 No 1 Yes SMALLINT Quick start...

Page 283: ...ers None Return Values CHAR 255 User defined subscriber field 1 CHAR 255 User defined subscriber field 2 INT Application provider ID Data Type Description Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Access code length SMALLINT Maximum number of participants SMALLINT Confidence factor SMALLINT Port uti...

Page 284: ...inimum 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalNewAccCode CHAR 20 New access code Can t be empty string Must be at least A...

Page 285: ...number a subscriber must have at least one access phone number 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 on page 4 Return Values Parameter Data Type Constraints Description LocalSubId INT 0 ID of subscriber Must be in database LocalOldAccNum CHAR 60 E...

Page 286: ...dating billing information vBillingId INT 0 0 Existing billing ID from database if updating billing information Negative number if not updating billing information vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not if not updating billing information vCreditCardNumber CHAR 20 Credit card number numeric characters only or empty string if not updating bill...

Page 287: ... subscriber 0 No 1 Yes vNameRecord SMALLINT 0 1 Name record option 0 Disabled 1 Enabled vNameRecordEnable SMALLINT 0 1 Name record changeable by subscriber 0 No 1 Yes vContinuation SMALLINT 0 1 Conference continuation option changeable for current conference 0 No 1 Yes vContinueEnable SMALLINT 0 1 Autocontinuation option changeable by subscriber 0 No 1 Yes vAutoContinuation SMALLINT 0 1 Conference...

Page 288: ...ld 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vProviderId INT 0 Application provider ID must be in providers table or 1 if not using Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Constraints Description ...

Page 289: ...or two different levels of legacy functions such as v 2 00 0 and v 1 20 0 For instance don t use AddSub_v2130 to add subscribers and then try to update them with the legacy UpdateSub_v1200 function 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 Caution If two password call flow is enabled then you can t use any pre v 2 1...

Page 290: ...ationDate DATETIME YEAR TO MINUTE Time of activation vBillingId INT 1 0 Existing billing ID from database or 1 to let system generate a new billing ID vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number vBillingPhone CHAR 30 Phone number to bill or empty string vBillingAddress CHAR 255 Billing address or empty string vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2...

Page 291: ...s SMALLINT 1 Maximum number of participants in a conference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call entry exit announcement option 0 Tone 1 Name 2 Silence vRollCallEna...

Page 292: ...HAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using vAccessNumType INT 0 1 Type of access number desired 0 Shared 1 Private vAccessCode CHAR 20 Desired access code numeric characters only Required for shared access numbers Set to empty st...

Page 293: ...the list of subscriber groups Compatible with v 1 10 0 or later of the software Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group type CHAR 50 Group name CHAR 50 Company name CHAR 30 Company phone number CHAR 30 Company fax number CHAR 50 Contact name CHAR 30 Contact phone INT Billing ID INT Prompt set INT Carrier ID CHAR 255 Group...

Page 294: ... GetSubscriber Stored procedure for retrieving a subscriber s record from the database Compatible with v 1 10 0 or later of the software This procedure returns the v 1 10 0 compatible values for the Roll Call feature 0 3 It maps the current values as follows Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set If settings in database are SP ret...

Page 295: ...e subscriber ID must be greater than 0 and in database vSubscriberPin CHAR 20 Subscriber password numeric characters only or empty string vAccessCode CHAR 20 Access code numeric characters only or empty string Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Bill...

Page 296: ...out capability 0 Disabled 1 Enabled SMALLINT Roll call option 0 Unavailable 1 Tone 2 Name 3 Silence These are the v 1 10 0 roll call values See explanation in description of procedure SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes CHAR 255 Subscriber s address CHAR 30 Subscriber s phone number CHAR 30 Subscriber s title CHAR 255 User defined subscriber field 1...

Page 297: ...database Compatible with v 1 10 0 or later of the software Parameters None Return Values Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Access code length SMALLINT Maximum number of participants SMALLINT Confidence factor SMALLINT Port utilization factor ...

Page 298: ... string if not updating billing information vBillingAddress CHAR 255 Billing address or empty string if not updating billing information vBillingId INT 0 0 Existing billing ID from database if updating billing information Negative number if not updating billing information vCreditCardType SMALLINT 0 3 Type of credit card 0 Visa 1 MC 2 Amex 3 Discover Set to 0 if not if not updating billing informa...

Page 299: ...ference Can t be greater than maxparticipants value in sysconfig table vOperatorAvailable SMALLINT 0 2 Who may request operator 0 Subscriber only 1 Subscriber and participants 2 Neither vDialOut SMALLINT 0 1 Dialout capability 0 Disabled 1 Enabled vRollCall SMALLINT 0 2 Roll call option 0 Tone 1 Name 2 Silence vRollCallEnable SMALLINT 0 1 Roll call changeable by subscriber 0 No 1 Yes vNameRecord S...

Page 300: ...available 0 No 1 Yes vAddress CHAR 255 Subscriber s address or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using Data Type Description INT Return code 0 OK ot...

Page 301: ... functions or two different levels of legacy functions such as v 2 00 0 and v 1 20 0 For instance don t use AddSubAndAN_v2320 to add subscribers and then try to update them with the legacy UpdateSubscriber function Caution If two password call flow is enabled then you can t use any pre v 2 10 0 stored procedures except those included in chapters 2 through 5 If your system uses fixed translation nu...

Page 302: ...these values in database 0 Unavailable RollCallEnable 0 1 Tone RollCallEnable 1 RollCall 0 2 Name RollCallEnable 1 RollCall 1 NameRecord 1 NameRecordEnable 1 3 Silence RollCallEnable 1 RollCall 2 Parameter Data Type Constraints Description vEntryDate DATETIME YEAR TO MINUTE Time of creation vActivationDate DATETIME YEAR TO MINUTE Time of activation vBillingId INT 1 0 Existing billing ID from datab...

Page 303: ...ame or empty string vMiddleName CHAR 30 Subscriber s middle name or empty string vCompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscriber password numeric characters only Can t be empty string vAccountStatus SMALLINT 0 1 Account status 0 Inactive 1 Active account status 2 deleted isn t valid for a new subscription vMaxParticipants SMALLINT 1 Maximum number o...

Page 304: ...255 User defined subscriber field 2 Set to empty string if not using vAccessNumType INT 0 1 Type of access number desired 0 Shared 1 Private vAccessCode CHAR 20 Desired access code numeric characters only Required for shared access numbers Set to empty string for private access numbers Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID of new subscriber if no error C...

Page 305: ...the list of subscriber groups Compatible with v 1 10 0 or later of the software Parameters None Return Values Data Type Description INT Return code 0 OK 100 end of list INT Group ID SMALLINT Group type CHAR 50 Group name CHAR 50 Company name CHAR 30 Company phone number CHAR 30 Company fax number CHAR 50 Contact name CHAR 30 Contact phone INT Billing ID INT Prompt set INT Carrier ID CHAR 255 Group...

Page 306: ... GetSubscriber Stored procedure for retrieving a subscriber s record from the database Compatible with v 1 10 0 or later of the software This procedure returns the v 1 10 0 compatible values for the Roll Call feature 0 3 It maps the current values as follows Data Type Description INT Return code 0 OK 100 end of list INT ID of prompt set CHAR 30 Name of prompt set If settings in database are SP ret...

Page 307: ...must be greater than 0 and in database vSubscriberPin CHAR 20 Subscriber password numeric characters only or empty string vAccessCode CHAR 20 Access code numeric characters only or empty string Data Type Description INT Return code 0 OK otherwise error code INT Subscriber ID INT Billing ID SMALLINT Billing type 0 Credit card 1 Phone number CHAR 30 Billing phone number CHAR 255 Billing address SMAL...

Page 308: ... Disabled 1 Enabled SMALLINT Roll call option 0 Unavailable 1 Tone 2 Name 3 Silence These are the v 1 10 0 roll call values See explanation in description of procedure SMALLINT Conference continuation option changeable for current conference 0 No 1 Yes CHAR 255 Subscriber s address CHAR 30 Subscriber s phone number CHAR 30 Subscriber s title CHAR 255 User defined subscriber field 1 CHAR 255 User d...

Page 309: ...database Compatible with v 1 10 0 or later of the software Parameters None Return Values Data Type Description INT Return code 0 OK otherwise error code SMALLINT Subscriber entry time out SMALLINT Subscriber exit time out SMALLINT Access code length SMALLINT Maximum number of participants SMALLINT Confidence factor SMALLINT Port utilization factor ...

Page 310: ...able 0 1 Tone RollCallEnable 1 RollCall 0 2 Name RollCallEnable 1 RollCall 1 NameRecord 1 NameRecordEnable 1 3 Silence RollCallEnable 1 RollCall 2 Parameter Data Type Constraints Description vSubscriberId INT 0 ID of subscriber to update vBillingType SMALLINT 0 1 Type of billing 0 Credit card 1 Phone number Set to 0 if not updating billing information vBillingPhone CHAR 30 Phone number to bill or ...

Page 311: ...CompanyName CHAR 50 Subscriber s company name or empty string vSubscriberPin CHAR 20 Subscriber password numeric characters only Can t be empty string vAccessCode CHAR 20 Desired access code numeric characters only Required for shared access numbers Set to empty string for private access numbers vAccessNum CHAR 30 Desired access number numeric characters only Can t be empty string Must be in phone...

Page 312: ...ress or empty string vPhone CHAR 30 Subscriber s phone number or empty string vTitle CHAR 30 Subscriber s title or empty string vClientSubA CHAR 255 User defined subscriber field 1 Set to empty string if not using vClientSubB CHAR 255 User defined subscriber field 2 Set to empty string if not using Data Type Description INT Return code 0 OK otherwise error code Parameter Data Type Constraints Desc...

Page 313: ... here SPCs may return SQL error codes which are negative numbers Consult your Informix documentation for descriptions of these Return Code Description 0 OK no error 100 End of list reached or record not found 101 The default subscriber group isn t in the database 102 The specified subscriber group isn t in the database 110 No prompt sets exist in the database 111 The specified prompt set isn t in ...

Page 314: ... Continuation off 1 Continuation on 141 Invalid ContinueEnable Must be one of the following 0 ContinueEnable off 1 ContinueEnable on 142 Invalid AutoContinuation Must be one of the following 0 AutoContinuation off 1 AutoContinuation on 150 Invalid QuickStart Must be one of the following 0 QuickStart off 1 QuickStart on 151 Invalid QuickStartEnable Must be one of the following 0 QuickStartEnable no...

Page 315: ...g 0 Subscriber only 1 Subscriber and participants 2 None 210 Invalid BillingType Must be one of the following 0 Credit card 1 Telephone number 211 Invalid CreditCardType Must be one of the following 0 Visa 1 MasterCard 2 American Express 3 Discover 220 Invalid AccessNumType Must be one of the following 0 Shared access number 1 Private access number 221 First name last name address company name or ...

Page 316: ...6 For AssignPhoneNum procedure only No access number available for the specified criteria 247 The subscriber s access number type is private but an access code is specified 248 For AssignPhoneNum procedure only Invalid LocalShared Must be one of the following 0 Private access number 1 Shared access number 250 For AssignNumToSub procedure only Subscriber already has this access number 251 This acce...

Page 317: ... class is already associated with this subscriber group 280 For GetGrpAccessClass procedure only The specified subscriber group isn t in the table of access class associations 290 For DelAssignedPN and ReAssignPhoneNum procedures The specified access phone number isn t assigned to this subscriber 291 For ReAssignPhoneNum procedure only The new access phone number isn t in the database 292 For ReAs...

Page 318: ...igned to group 412 For AddSubACM procedure only ACM option has already been assigned to subscriber 413 For DelSubACM procedure only ACM option isn t assigned to subscriber 414 For DelGroupACM procedure only ACM option isn t assigned to group 415 For AddSubAndAccNum procedure only Access number is blank 416 For AddPhoneNum and AddSubAndAccNum procedures This access number is associated with a diffe...

Page 319: ...riber s access code use the ReAssignAccCode procedure 427 For AddSubAndAccNum procedure only Either the specified subscriber group isn t in the database or it doesn t have a number group associated with it 428 Invalid access code length less than AccessCodeLength setting or greater than 20 429 SubscriberPin is in BadPins table 430 ParticipantPin is in BadPins table 431 Invalid SubscriberPin length...

Page 320: ...m uses hidden numbers The requested SubscriberPin or ParticipantPin is unavailable because 2 password call flow is enabled and another subscriber with the same HiddenNum is already using it as AccessCode If the system doesn t use hidden numbers The requested SubscriberPin or ParticipantPin is unavailable because 2 password call flow is enabled and another subscriber with the same AccessNum is alre...

Page 321: ...d 706 For AddSubAndAccNum and AddSub_v2100 procedure Insert into SubscriberInfo table failed 707 For AddSubAndAccNum and AddSub_v2100 procedure Insert into SubscriberDetail table failed 708 Access code must be unique system wide 709 Invalid PartPlayCount parameter Must be 0 or 1 710 Bridge does not exist 711 Access number already belongs to this bridge 712 Some subscriptions contain an access numb...

Page 322: ...g_v2500 procedure only ValidateOnAccCode can t be turned on because duplicate access codes exist 741 For UpdateSysConfig_v2500 procedure only Can t disable shared call flows because system has shared access phone numbers 742 For UpdateSysConfig_v2500 procedure only Can t disable private call flows because system has private access phone numbers 743 For UpdateSysConfig_v2500 procedure only Can t di...

Page 323: ... Metratech billing fields are empty strings 758 The system uses the Fixed with 3 Digit Code translation numbers TransNumberType is 2 in SysConfig and the ExternalId length isn t three shorter than the DNIS length set in the Bridges table 790 For AddModSubGrp_v2500 procedure only Invalid Group Type Must be 0 or 1 791 For AddModSubGrp_v2500 procedure only Group name must be unique and can t be empty...

Page 324: ... and BillingType is 0 credit card 804 For AddModSubGrp_v2500 procedure only Billing phone can t be empty string if GroupType is 1 corporate and BillingType is 0 phone number 805 For AddModSubGrp_v2500 procedure only AccountStatus can t be 2 deleted To delete an existing subscriber group use DeleteGroup 806 For DeleteGroup procedure only Subscriber group doesn t exist 808 For DeleteGroup procedure ...

Page 325: ...e below cross references the names of the defines with their defined values Define Value DB_ACC_NUMS_STR_LEN 720 DB_ACCESS_LEN 20 DB_ADDRESS_LEN 255 DB_CARRIER_LEN 30 DB_CCNUMBER_LEN 20 DB_CITY_LEN 20 DB_COMPANY_LEN 50 DB_CONTACT_LEN 50 DB_COUNTRY_LEN 60 DB_DOMAIN_LEN 128 DB_EMAIL_LEN 120 DB_ERROR_MSG_LEN 256 DB_EVENT_NAME_LEN 60 DB_EXTENSION_LEN 8 DB_EXTID_LEN 30 DB_FAX_LEN 30 DB_FIELD_NAME_LEN 3...

Page 326: ...idential DB_OPERNOTE_LEN 512 DB_PASSWORD_LEN 30 DB_PHONE_LEN 30 DB_PIN_LEN 20 DB_PROMPT_LEN 30 DB_SHORT_ADDR_LEN 50 DB_STATE_LEN 20 DB_SYSTYPE_LEN 20 DB_TITLE_LEN 30 DB_UNAME_LEN 30 DB_USERFIELD_LEN 255 DB_VERSION_LEN 20 DB_ZIP_LEN 15 Define Value ...

Reviews:

No comments

Related manuals for ReadiVoice

altiris eXpress Altris eXpress Helpdesk Solution 5.6 SP1 User Manual preview
eXpress Altris eXpress Helpdesk Solution 5.6 SP1
Brand: altiris Pages: 143
Sigma PHOTO PRO 4.2 Manual preview
PHOTO PRO 4.2
Brand: Sigma Pages: 55
Extreme Networks EPICenter 4.1 Software Installation Manual preview
EPICenter 4.1
Brand: Extreme Networks Pages: 546
Extreme Networks ExtremeWare 7.5 Command Reference Manual preview
ExtremeWare 7.5
Brand: Extreme Networks Pages: 2546
F-SECURE MOBILE SECURITY 80 Series User Manual preview
MOBILE SECURITY 80 Series
Brand: F-SECURE Pages: 39
Avaya IP Agent Installation And User Manual preview
IP Agent
Brand: Avaya Pages: 286
Cabletron Systems SmartCell ZX Administrator Installation Manual preview
SmartCell ZX Administrator
Brand: Cabletron Systems Pages: 34
NEC V850 ZigBee Pro User Manual preview
V850 ZigBee Pro
Brand: NEC Pages: 59
NEC Storage Manager Configuration Setting Tool User'S Manual preview
Storage Manager Configuration Setting
Brand: NEC Pages: 68
NEC SpectraView User Manual preview
SpectraView
Brand: NEC Pages: 68
NEC Storage ReplicationControl SQL Option User Manual preview
Storage ReplicationControl SQL Option
Brand: NEC Pages: 104
NEC Storage Performance Monitor/Optimizer User Manual preview
Storage Performance Monitor/Optimizer
Brand: NEC Pages: 184
NEC Storage Manager IS015-9E User Manual preview
Storage Manager IS015-9E
Brand: NEC Pages: 200
NEC Storage Manager Messages Handbook preview
Storage Manager Messages
Brand: NEC Pages: 499
NEC Storage Manager Messages Handbook preview
Storage Manager
Brand: NEC Pages: 710
DeLorme Street Atlas USA 2011 User Manual preview
Street Atlas USA 2011
Brand: DeLorme Pages: 265
Polycom ConferenceSuite Brochure preview
ConferenceSuite
Brand: Polycom Pages: 2
Red Hat APPLICATION STACK 2.1 RELEASE Release Note preview
APPLICATION STACK 2.1 RELEASE
Brand: Red Hat Pages: 26

Brands by name

Popular brands

Load more brands