Sign In
Upload
Manuals
Brands
Polycom Manuals
Software
ReadiVoice CAPI
Polycom ReadiVoice CAPI Manuals
Manuals and User Guides for Polycom ReadiVoice CAPI. We have
1
Polycom ReadiVoice CAPI manual available for free PDF download: Developer's Manual
Polycom ReadiVoice CAPI Developer's Manual (295 pages)
Polycom ReadiVoice Network: Opers Guide
Brand:
Polycom
| Category:
Software
| Size: 1 MB
Table of Contents
Table of Contents
3
Purpose
11
Document Conventions
12
Customer Support
13
Introducing CAPI
15
CAPI Functional Overview
15
CAPI Technical Overview
16
Readivoice and CAPI Application Architecture
16
CAPI SDK Components
17
Code Files
17
Documentation
17
Overview of CAPI Enhancements in this Release
18
Getting Started
18
Developing CAPI Applications
19
Writing Your CAPI Application
19
Installing CAPI Code and Documentation
20
System Requirements
20
Software
20
Readivoice
21
CAPI Installation
21
Setup
21
Accessing the Documentation and Code
21
Documentation
21
Code
22
Understanding CAPI Architecture
22
Understanding CAPI Communication: Synchronous and Asynchronous
23
Understanding How Ports Are Used
24
Pull Mode and Ports
24
Sending Port on the Client
24
Receiving Port on the Server
24
Push Mode and Ports
24
Sending Port on the Client
25
Receiving Port on the Server
25
Sending Port on the Server
25
Receiving Port on the Client
25
Ports and Firewalls
25
Understanding Connections, Sessions, and Logins
26
Overview of Connections, Sessions, and Logins
26
Application, Moderator, and Participant Logins
27
High-Level Overview of the Conferencing Process
28
Relationships Among Connections, Sessions, and Logins
28
Basic Relationships
29
Login and Session Combinations
29
Login, Session, and Connection Combinations
29
Illustrations of Connection, Session, Conference, and Login
30
Configurations
30
Benefits and Drawbacks
32
Considerations for Number of Connections to Use
32
Considerations for Logins
33
CAPI SDK Components
34
Understanding the CAPI Events
34
Push and Pull Mode
34
Events Can be Run by Certain Login Types
34
Responses Versus Notifications
34
Using the Event Reference Section
35
Understanding the CAPI Java Files
35
CAPI Java Files
36
CAPI Java File Quick Reference
38
Connecting the CAPI Events and the Java Utility Files
40
Programming Guidelines
42
How the ODPROC and the CSC Work Together
42
Application Design and Configuration
42
Choosing a Programming Language
42
Object Model Layer
43
Storing Configuration Information
43
Programming Fundamentals
43
Using ACM
44
Using Push and Pull Mode
45
Using the Login Types
46
Creating a Connection
47
Maintaining Open Sessions and Connections
47
Programming Tips
47
Notes on Conference, Participant, and Subscriber Ids
48
Database Conference Information Updates
48
Prerequisites: Connection and Conference, and Session and Conference Ids
48
Verifying Events Have Occurred
49
Multiple Requests of same Event and the Passback Parameter
49
Implementing the Conference Security Code
50
Response to Malformed XML and HTTP
50
Dial String Requirements
50
Commonly Used Conferencing Procedures
51
Additional Sources of Information
51
Procedure Sequence
51
Procedure Notes
53
Content of Procedures in this Section
53
Push Mode Versus Pull Mode
53
Application Login Prerequisites
53
Initial Procedures
54
Setting up Logging
54
Connecting to the CACS
55
Maintaining an Open Session
57
Logging into the CACS
58
Conference Procedures
60
Starting a Conference
60
Saving Conference and Subscriber ID
61
Registering the Application Login for Conference Start and Stop
61
Notification
61
Setting Conference Security
62
Dialing Participants
62
Joining a Conference
66
Using the Waiting Room
66
Setting the Port for Asynchronous Responses on the Client
67
Sending Events
70
Reading Events
71
Identifying Talkers
72
Using ACM to Interface with External Applications
73
Conference-End Procedures
74
Ending a Conference
74
Logging out
75
Sample Moderator Application
77
Simplepushmoderator.java
77
Simplepushmoderatorhandler.java
97
Migrating Applications to CAPI
103
Migration Overview
103
Compatibility Notes
104
MAPI-To-CAPI Sample Application Comparison
105
CAPI Events
138
Enumerated Types
138
ACM_MODE Enum Values
139
ACM_REASON_CODE Enum Values
139
ACM_TYPE Enum Values
140
ANNOUNCEMENT_OPTION Enum Values
140
CALLFLOW Enum Values
140
CALL_MODE Enum Values
141
CANCELATION_REASON Enum Values
141
CI_REASON Enum Values
141
CONF_RUN_STATE Enum Values
142
LOCK_STATE Enum Values
142
LOCK_TYPE Enum Values
142
NACK_REASON Enum Values
143
OP_REQ_PRIV Enum Values
143
OP_REQ_TYPE Enum Values
144
PART_STATUS Enum Values
144
PART_TYPE Enum Values
145
PI_REASON Enum Values
145
SI_REASON Enum Values
145
WAV_TYPE Enum Values
146
WR_OPTION Enum Values
146
SIMPLE_CANCELATION_REASON Enum Values
146
CAPI Request Events
148
Acm_Call_Enter (Capi)
148
Acm_Cdr (Capi)
149
Acm_Get_Dtmf (Capi)
150
Acm_Get_Options (Capi)
151
Acm_Heartbeat (Capi)
152
Acm_Play_Wav (Capi)
153
Acm_Query (Capi)
154
Acm_Register (Capi)
155
Acm_Unregister (Capi)
156
Add_Contact_Entry_To_Group (Capi)
157
App_Register_Confs_Activity (Capi)
158
App_Register_Subscr (Capi)
159
App_Unregister_Confs_Activity (Capi)
160
App_Unregister_Subscr (Capi)
161
Conf_Play_Wav (Capi)
162
Conf_Rollcall (Capi)
163
Create_Contact (Capi)
164
Create_Contact_Group (Capi)
165
Dial_Call (Capi)
166
Dial_Group (Capi)
168
Disconnect_Call (Capi)
169
End_Conf (Capi)
170
Join_Part_To_Conf (Capi)
171
Lock_Conf (Capi)
172
Login_Application (Capi)
173
Login_Moderator (Capi)
174
Login_Part (Capi)
175
Login_Push_Moderator (Capi)
176
Logout (Capi)
177
Mute_All (Capi)
178
Mute_Call (Capi)
179
One_To_One (Capi)
180
Operator_Knocking (Capi)
181
Play_Name (Capi)
182
Register_Talker_Update (Capi)
183
Remove_Contact (Capi)
184
Remove_Contact_Entry_From_Group (Capi)
185
Remove_Contact_Group (Capi)
186
Remove_Part (Capi)
187
Req_Conf_Info (Capi)
188
Req_Contact_Group_Info (Capi)
189
Req_Contact_Group_List (Capi)
190
Req_Contact_Info (Capi)
191
Req_Contact_Info_Search (Capi)
192
Req_Contact_List (Capi)
193
Req_Part_Info (Capi)
194
Req_Part_List (Capi)
195
Req_Session_Info (Capi)
196
Req_Subscr_Id_By_Access_Data (Capi)
197
Req_Subscr_Info (Capi)
198
Req_System_Info (Capi)
199
Session_Heartbeat (Capi)
200
Set_Announcement (Capi)
201
Set_Auto_Cont (Capi)
202
Set_Conf_Cont (Capi)
203
Set_Conf_Mode (Capi)
204
Set_Conf_Security_Code (Capi)
205
Set_Contact_Group_Info (Capi)
206
Set_Contact_Info (Capi)
207
Set_Listen_Only_Entry (Capi)
209
Set_Lock_Type (Capi)
210
Set_Name_Record (Capi)
211
Set_Op_Req (Capi)
212
Set_Part_Name (Capi)
213
Set_Quick_Start(Capi)
214
Set_Subscr_Announcement (Capi)
215
Set_Subscr_Name_Record (Capi)
216
Set_Waiting_Room_Option (Capi)
217
Start_Conf (Capi)
218
Unlock_Conf (Capi)
219
Unmute_All (Capi)
220
Unmute_Call (Capi)
221
Unregister_Talker_Update (Capi)
222
CAPI Response Events
223
Ack (Capi)
223
Acm_Call_Enter_Ack (Capi)
224
Acm_Call_Entered (Capi)
225
Acm_Call_Leave (Capi)
226
Acm_Call_Left (Capi)
227
Acm_Dtmf (Capi)
228
Acm_Heartbeat_Ack (Capi)
229
Acm_Heartbeat_Failure (Capi)
230
Acm_Options (Capi)
231
Acm_Query_Resp (Capi)
232
Acm_Registered (Capi)
233
Announcement_Changed (Capi)
234
Application_Session_Info (Capi)
235
Bridge_Logout (Capi)
236
Bridge_Status_Changed (Capi)
237
Bridge_Up (Capi)
238
Call_Connected_To_Changed (Capi)
239
Call_Disconnected (Capi)
240
Call_Left_Conf (Capi)
241
Call_Mode_Changed (Capi)
242
Call_Status_Changed (Capi)
243
Conf_Cont_Changed (Capi)
244
Conf_Ended (Capi)
245
Conf_Info (Capi)
246
Conf_Info_Changed (Capi)
248
Conf_Lock_Changed (Capi)
249
Conf_Mode_Changed (Capi)
250
Conf_Security_Code_Changed (Capi)
251
Conf_Started (Capi)
252
Contact_Created (Capi)
253
Contact_Group_Created (Capi)
254
Contact_Group_Info (Capi)
255
Contact_Group_Info_Changed (Capi)
256
Contact_Group_List (Capi)
257
Contact_Group_Removed (Capi)
258
Contact_Info (Capi)
259
Contact_Info_Changed (Capi)
261
Contact_List (Capi)
262
Contact_Removed (Capi)
263
Dialout_Connected (Capi)
264
Dialout_Started (Capi)
265
Group_Contact_Entry_Added (Capi)
266
Group_Contact_Entry_Removed (Capi)
267
Lock_Type_Changed (Capi)
268
Moderator_Session_Info (Capi)
269
Nack (Capi)
270
Op_Req_Answered (Capi)
271
Op_Req_Canceled (Capi)
272
Op_Requested (Capi)
273
Part_Info (Capi)
274
Part_Info_Changed (Capi)
276
Part_List (Capi)
277
Part_Name_Changed (Capi)
278
Part_Session_Info (Capi)
279
Part_Type_Changed (Capi)
280
Session_Heartbeat_Ack (Capi)
281
Subscr_Info (Capi)
282
Subscr_Info_Changed (Capi)
285
System_Info (Capi)
286
Talker_Update (Capi)
287
Advertisement
Advertisement
Related Products
Polycom ReadiVoice
Polycom ReadiManagerSE200
Polycom ReadiConvene
Polycom ReadiManagerLX100
Polycom RealPresence Group Series
Polycom RealPresence 2000
Polycom RealPresence RMX 2000
Polycom RealPresence Immersive Studio Flex
Polycom RealPresence Medialign 255 Slimline Base
Polycom RealPresence Experience RPX HD
Polycom Categories
IP Phone
Telephone
Conference System
Conference Phone
Server
More Polycom Manuals
Login
Sign In
OR
Sign in with Facebook
Sign in with Google
Upload manual
Upload from disk
Upload from URL