Polycom ReadiVoice Manuel utilisateur

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

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

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.

Autres manuels pour ReadiVoice

Table des matières

Autres manuels Polycom Logiciel

Polycom

Polycom 8 Manuel utilisateur

Polycom

Polycom GlobalManagementSystem Mode d’emploi

Polycom

Polycom ReadiVoice Mode d’emploi

Polycom

Polycom ConferenceSuite Mode d’emploi

Polycom

Polycom GlobalManagementSystem Manuel utilisateur

Polycom

Polycom Network Adware Scheduler Manuel utilisateur

Polycom

Polycom Vortex EF2201 Mode d’emploi

Polycom

Polycom MGC Manager Manuel utilisateur

Polycom

Polycom PVX Mode d’emploi

Polycom

Polycom ReadiVoice Manuel utilisateur

Polycom

Polycom V4.0 INTEGRATION RMX 1000 V1.1.1 Manuel utilisateur

Polycom

Polycom ReadiManagerLX100 Manuel de service

Polycom

Polycom GlobalManagementSystem Mode d’emploi

Polycom

Polycom ReadiManagerSE200 Guide de démarrage rapide

Polycom

Polycom Conference Composer Manuel utilisateur

Polycom

Polycom PictureTel 140 Mode d’emploi

Polycom

Polycom ReadiConvene Manuel utilisateur

Polycom

Polycom 8 Manuel utilisateur

Polycom

Polycom ReadiVoice Manuel

Polycom

Polycom ConferenceSuite Manuel utilisateur

Polycom

Polycom iPower 600 Manuel utilisateur

Polycom

Polycom V2IU4300T Mode d’emploi

Polycom

Polycom Vortex EF2201 Instructions d'installation et d'utilisation

Polycom

Polycom ReadiManagerSE200 Mode d’emploi

Manuels Logiciel populaires d'autres marques

COMPRO

COMPRO COMPROFM Manuel utilisateur

Muratec

Muratec OFFICEBRIDGE ONLINE Manuel utilisateur

Oracle

Oracle Contact Center Anywhere 8.1 Manuel utilisateur

Adobe

Adobe 65007312 - Photoshop Lightroom Manuel

Avaya

Avaya NULL One-X for RIM Blackberry Manuel utilisateur

HP ProLiant BL420c Manuel utilisateur

PS Audio

PS Audio PowerPlay Manuel du propriétaire

Brady

Brady LOCKOUT PRO 3.0 Manuel de service

Avaya

Avaya Interaction Center Manuel utilisateur

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manuel

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manuel utilisateur

Oracle

Oracle Application 9i Manuel utilisateur

Acer

Acer RDM Manuel utilisateur

Canon

Canon Vixia HF21 Manuel utilisateur

Canon

Canon ZR950 Manuel utilisateur

Samsung

Samsung Auto Backup Manuel utilisateur

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manuel utilisateur

Novell

Novell SP2 - S Mode d’emploi