Polycom ReadiVoice User manual

ReadiVoice®
PSPI Reference

ReadiVoice PSPI Reference
ii Proprietary & Confidential
Trademark Information
Polycom®, the Polycom logo design, ReadiVoice®, InnoVox®, and the Voyant logo are registered
trademarks of Polycom, Inc. Voyant TechnologiesTM is a trademark of Polycom, Inc. All other trademarks
are the property of their respective owners.
Patent Information
The accompanying product is protected by one or more U.S. and foreign patents and/or pending patent
applications held by Polycom, Inc.
Catalog No. 3725-70006-009C
v. 2.56.x
© 2005 Polycom, Inc. All rights reserved.
Polycom Inc.
1765 West 121st Avenue
Westminster, CO 80234-2301 U.S.A.
No part of 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. The software is protected by United States copyright laws
and international treaty provision. Therefore, you must treat the software like any other copyrighted
material (e.g. a book or sound recording).
Every effort has been made to ensure that the information in this manual is accurate. Polycom, Inc. is not
responsible for printing or clerical errors. Information in this document is subject to change without notice.

Proprietary & Confidential iii
Contents
1 Introduction to PSPI
Overview of PSPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Legacy vs. Current PSPI Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Setting Up to Use PSPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Calling Stored Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Current PSPI Functions
AddGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
AddGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
GetSubByEId_v2500() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

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

Contents
Proprietary & Confidential v
4 Legacy v. 2.13.0/2.30.0 PSPI Functions
AddGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
AddGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
AddPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
AddSubAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
AddSubAndAN_v2130() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133
AddSub_v2130() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139
AssignNumToSub() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
AssignPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
DelAssignedPN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
DeleteSubscriber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
DelGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
DelGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
AddSubAndAN_v2110() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
AddSub_v2100() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
AddSub_v2110() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191
AssignNumToSub() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195
AssignPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

ReadiVoice PSPI Reference
vi Proprietary & Confidential
DelAssignedPN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
DeleteSubscriber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
DelGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
DelGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
DelSubAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
GetAccOptChanges() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203
GetGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204
GetGroupInfo_v2100() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
GetGroupInfo_v2110() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
GetGrpAccessClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
GetPromptInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
GetSubAccNums() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
GetSubAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
GetSub_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
GetGroupAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
GetGroupInfo_v2000() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245
GetGrpAccessClass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
GetPromptInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
GetSubAccNums() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
GetSubAcm() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249

Contents
Proprietary & Confidential vii
GetSub_v2000() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
GetSysConfig() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253
ReAssignAccCode() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
ReAssignPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
UpdateMTBilling() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
UpdateSub_v2000() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257
7 Legacy v. 1.30.0 PSPI Functions
AddGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
AddSub_v1300() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
AssignPhoneNum() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
DelAssignedPN() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
DelGrpAccessClass() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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
GetPromptInfo() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
GetSubscriber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
GetSysConfig() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
UpdateSubscriber() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302

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

Proprietary & Confidential 1
1
Introduction to PSPI
This chapter describes the Provisioning Stored Procedure Interface (PSPI),
discusses the various current and legacy versions of PSPI, and provides basic
information you need in order to use stored procedures.
Overview of PSPI
PSPI is a bundled set of SQL functions for adding provisioning data to and
retrieving it from the ReadiVoice Informix database. Provisioning is the
process of defining the system profile of ReadiVoice users, such as creating a
new subscriber account or changing the parameters of an existing account (for
instance, the number of lines available to the subscriber).
The PSPI stored procedures are defined during the ReadiVoice installation
process in conjunction with the database tables. A stored procedure is an
object in the database and therefore 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 or data input.
This manual is for the developer using Polycom’s CleverVoice™ Web
Conferencing Software Development Kit (SDK) to create custom applications
for provisioning and controlling a ReadiVoice Intelligent Voice Conferencing
System. To use PSPI, you should be familiar with SQL databases in general,
Informix, and the ReadiVoice system.
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.

ReadiVoice PSPI Reference
2Proprietary & Confidential
Legacy vs. Current PSPI Functions
Some PSPI functions can be used with all versions of
ReadiVoice/ConferenceNow! and some can’t. Over time, product
enhancements have introduced new options and features that necessitated
various database changes.
New PSPI functions enable you to work with new options and features and to
access the new data. However, new PSPI functions can’t be used with earlier
versions of the software. For example, the new PSPI functions introduced with
ReadiVoice v. 2.50.0 can’t be used with versions prior to v. 2.50.0.
To ensure backward compatibility, however, the legacy PSPI functions are still
supported (to the extent possible) in newer versions of the software. If you
developed an interface for an earlier version of ReadiVoice/ConferenceNow!,
you can continue using it with ReadiVoice v. 2.50.0 or later, with little or no
code modifications.
The legacy v. 1.10.0 functions work with any version of the software; the
legacy v. 1.20.0 functions work with v. 1.20.0 or later; the legacy v. 1.30.0
functions work with v. 1.30.0 or later; and so forth. However, these legacy
functions can’t set or retrieve the new variables available in the current version
of the ReadiVoice software. For instance:
•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 settings.
Do not “mix and match” current and legacy 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_v2500() to add subscribers and then try to update them with
the legacy
UpdateSubscriber() function.
ReadiVoice was known as ConferenceNow! prior to v. 2.00.0. ReadiVoice-IP
v. 1.00.0 through v. 1.1x used the same stored procedures as ReadiVoice v. 2.10.0.
ReadiVoice-IP functionality was merged into the standard release of ReadiVoice
v. 2.30.0.
Caution! If two-passcode call flow is enabled, then you can’t use any pre-v.2.10.0 stored
procedures except those included in chapters 2through 5. If your system uses fixed
translation numbers, be aware that pre-v.2.10.0 stored procedures don’t perform
the required external ID validations (see “If vExternalId is used for translation
numbers…” on page 18) and that you can’t use the v.1.10.0 stored procedures
because they don’t provide the required external ID. Note also that the vExternalId
parameter must now be a CHAR, even for legacy stored procedures.

Introduction to PSPI
Proprietary & Confidential 3
If you want to provision the new options and features available in ReadiVoice
v. 2.5x.x., rewrite your legacy code to use only the current PSPI functions.
Each of the subsequent chapters is a PSPI reference for a specific version of the
ReadiVoice stored procedures. For your convenience, each chapter also
includes all the functions that are unchanged from earlier releases.
Once you determine which chapter meets your compatibility requirements,
you don’t have to jump from chapter to chapter to find the reference
information 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-IP version) Chapter 3
ReadiVoice v. 2.13.0 and later or v. 2.30.0 and later
(including the ReadiVoice-IP version) Chapter 4
ReadiVoice v. 2.10.0 and later or
ReadiVoice-IP v. 1.00.0 and later Chapter 5
ReadiVoice v. 2.00.0 and later Chapter 6
ConferenceNow! v. 1.30.0 and later Chapter 7
ConferenceNow! v. 1.20.0 and later Chapter 8
ConferenceNow! v. 1.10.0 and later Chapter 9

ReadiVoice PSPI Reference
4Proprietary & Confidential
Setting Up to Use PSPI
To use PSPI in an application that you’re developing, you must:
1Install an ODBC (open database connectivity) or JDBC (Java database
connectivity) driver on the client computer.
2Properly set up the environment on the client computer.
3Configure the ODBC/JDBC driver to access your ReadiVoice database on
the server.
4Set up your application to talk to the ODBC/JDBC driver.
The details depend on your client computer operating system, ODBC/JDBC
driver, and application development environment.
Most of the information you need should be in the documentation for the
ODBC/JDBC driver. For instance, if you’re using Informix’s I-Connect driver,
the driver documentation tells you how to set up the driver in Windows and
Unix environments and how to access and interact with an Informix 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 can’t do something like this:
DeleteSub_v2320 (2143,,0,0) //WRONG
The value you specify for each parameter must be valid (correct data type and
length). In many cases, the value you specify must be found in the database.
The parameter descriptions for each procedure indicate when this is true.
The parameter descriptions also show when you can use a placeholder, or
“default” value, if you don’t need a parameter, and what the correct
placeholder is. For instance, look at the
DeleteSub_v2320() procedure on
Caution! Polycom strongly advises against server-side access in a production environment.
For this kind of testing and debugging, the system should be off line.

Introduction to PSPI
Proprietary & Confidential 5
page 39. Notice that the second parameter, vAccessNum , can be set to a blank
string if not selecting the subscriber by access number. Therefore, the correct
version of the above SPC is:
DeleteSubscriber (2143,“”,0,0) //RIGHT
Typically, the correct placeholder is 0 or -1 for an INT or SMALLINT , and an
empty string (
“” ) for a CHAR . But, always check the reference information for
a procedure to see what the requirements for its parameters are.
How you connect to the database and call stored procedures from your code
depends on your application development environment and your
ODBC/JDBC driver. Consult the driver documentation for instructions on
how to connect to the database and execute queries.
Within Informix, the command syntax for running a stored procedure (after
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-alone
entity with INFORMIX-SQL.
You can use INFORMIX-SQL in two ways:
•Start INFORMIX-SQL, create the SPC query, and then run it.
•Create and save the SPC query in a command file, and then run
INFORMIX-SQL at the command line, specifying the file as an argument.
To create and execute an SPC from within INFORMIX-SQL:
1In a terminal window, start INFORMIX-SQL and select the database by
entering:
isql databaseName
2Select Query-language, and then select:
Caution! Polycom strongly advises against server-side access in a production environment.
For this kind of testing and debugging, the system should be off line.

ReadiVoice PSPI Reference
6Proprietary & Confidential
—Newto create your query in the SQL editor.
—Useeditorto select the default system editor or a different editor.
3In the editor you chose, type the query and save it. In the SQL editor,
press ESCAPE.
The SQL menu reappears.
4Select Run to execute the query.
If there are no errors, Informix processes the query and displays the results
on the screen.
For information about additional options, including saving your SPC as a
command file or sending the output to a printer or file, see the
INFORMIX-SQL User Guide.
To execute an SPC query from the command line using a command file:
1In the editor of your choice, write the SPC query and save it with a
.sql
extension.
2At 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. For information about using
isql
from the command line, see the INFORMIX-SQL Reference Manual.
You can run the command file from within INFORMIX-SQL by selecting Choose
from the Query menu and then selecting the file name from the list. (This list shows
all
.sql files in the current directory. If your file is in another directory, enter the full
path name.)

Proprietary & Confidential 7
2
Current PSPI Functions
This chapter documents the current PSPI functions that require v. 2.5x.x of the
ReadiVoice software. For your convenience, it also includes functions that
remain unchanged from previous versions. If you’re developing code for
v. 2.5x.x, all the PSPI functions you need are in this one chapter.
In v. 2.55.0, one new field (External ID B) was added to the database, so this
chapter contains two versions each of the add, get and update subscriber
functions:
•
AddSubAndAN_v2500() and AddSubAndAN_v2550()
•
GetSub_v2500() and GetSub_v2550()
•
UpdateSub_v2500() and UpdateSub_v2550()
In addition, there is a new procedure,
GetSubByEIdB() , for retrieving
subscriber data using the new field.
If you intend to use 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 described in Chapters 3–9, whichever is appropriate for your
existing code.
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_v2500() 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 the same stored procedures are used for both the ReadiVoice-PSTN
and ReadiVoice-IP configurations.

ReadiVoice PSPI Reference
8Proprietary & Confidential
AddGroupAcm()
Stored procedure for adding an Application Control Mode (ACM) option to a
subscriber group. Compatible with v. 2.00.0 or later of the software if ACM is
installed and configured.
Parameters
Specify all parameters. The constraints column shows specific value or range
constraints. For syntax rules and constraints applicable 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
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 Description
INT
Return code (0: OK; otherwise, error code).

Current PSPI Functions
Proprietary & Confidential 9
AddGrpAccessClass()
Stored procedure for adding an access class to a subscriber group. Compatible
with v. 1.30.0 or later of the software.
Parameters
Specify all parameters. The constraints column shows specific value or range
constraints. For syntax rules and constraints applicable to all parameters, see
“Calling Stored Procedures” 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: OK; otherwise, error code).

ReadiVoice PSPI Reference
10 Proprietary & Confidential
AddModSubGroup_v2500()
Stored procedure for adding a subscriber group to the database or modifying
an existing group.
If you set
vCheckParms to 1 , the SPC verifies that:
•The
vLanguage and vTimezone values, if any, are valid.
•The
vAccountStatus value isn’t 2 (deleted).
•If
vRollCall is 1 , vNameRecord is also 1 .
•If
vGroupType is 1 , all the required company and billing fields are
populated. If you elect to do error checking on a corporate group, the
company and billing fields can’t be empty strings.
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
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 blank for personal and corporate
groups.
vPassword CHAR (50)
Leave blank for personal and corporate
groups.
vCompanyName CHAR (50)
Company name or empty string.
vCompanyPhone CHAR (30)
Company phone number or empty string.
vCompanyFax CHAR (30)
Company fax number or empty string.
vContactName CHAR (50)
Company contact name or empty string.
vContactPhone CHAR (30)
Company contact’s phone number or empty
string.
vBillingId INT -1, >0
Existing billing ID (must be in database) or -1
to auto-generate billing ID.

Current PSPI Functions
Proprietary & Confidential 11
vBillingType SMALLINT 0, 1
Type of billing. 0: credit card, 1: phone number.
vBillingPhone CHAR (30)
Billing phone number 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 notif not updating billing
information.
vCreditCardNumber CHAR (20)
Credit card number (numeric characters only)
or empty string if not updating billing
information.
vCreditCardExpire DATETIME
YEAR TO
MONTH
Credit card expiration date. Set to 1999-12 if
not updating billing information.
vClientBillA CHAR (255)
User-defined billing field 1. Set to empty string
if not updating billing information.
vClientBillB CHAR (255)
User-defined billing field 2. Set to empty string
if not updating billing 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 call (entry/exit announcement) option.
0: Tone; 1: Name; 2: Silence.
vDialOut SMALLINT 0, 1
Dialout capability. 0: Disabled; 1: Enabled.
vContinuation SMALLINT 0, 1
Conference continuation option changeablefor
current conference. 0: No; 1: Yes.
vAccountStatus SMALLINT 0–1
Account status. 0: Inactive; 1: Active. Account
status 2, deleted, isn’t valid for a new
subscriber group; to delete a subscriber group,
use
DeleteGroup() .
vQuickStart SMALLINT 0, 1
Quick start enabled. 0: No; 1: Yes.
vOperatorAvailable SMALLINT 0–2
Who may request operator. 0: Subscriber only;
1: Subscriber and participants; 2: Neither.
Parameter Data Type Constraints Description

ReadiVoice PSPI Reference
12 Proprietary & Confidential
vRollCallEnable SMALLINT 0, 1
Roll call changeable by subscriber.
0: No; 1: Yes.
vQuickStartEnable SMALLINT 0, 1
Quick start changeable by subscriber.
0: No; 1: Yes.
vPasswordEnable SMALLINT 0, 1
Password changeable by subscriber.
0: No; 1: Yes.
vContinueEnable SMALLINT 0, 1
Autocontinuation option changeable by
subscriber. 0: No; 1: Yes.
vNameRecord SMALLINT 0, 1
Name record option. 0: Disabled; 1: Enabled.
vAutoContinuation SMALLINT 0, 1
Conference starts with continuation enabled.
0: No; 1: Yes.
vNameRecordEnable SMALLINT 0, 1
Name record changeable by subscriber.
0: No; 1: Yes.
vLOEntryEnable SMALLINT 0, 1
Listen Only Entry option changeable by
subscriber (for future conferences).
0: No; 1: Yes.
vWROptionEnable SMALLINT 0, 1
WR Enable flag (conference lock type
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: 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 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.
vDialOutPreFix CHAR (30)
Number to dial before dialing out (numeric
chars only). Set to empty string if not used.
Parameter Data Type Constraints Description