1 <?xml version="1.0" encoding="UTF-8"?>
\r
3 <!-- ********************************************************************** -->
\r
4 <!-- Copyright (c) 2000-2012 BroadSoft, Inc. All rights reserved. -->
\r
5 <!-- ********************************************************************** -->
\r
6 <!-- O C I X M L S C H E M A : S E R V I C E P A R T -->
\r
8 <!-- E N H A N C E D C A L L L O G S S E R V I C E -->
\r
10 <!-- This file defines the XML Schema for the BroadSoft Application Server -->
\r
11 <!-- Open Client Interface (OCI). -->
\r
12 <!-- ********************************************************************** -->
\r
14 <xs:schema xmlns:xs = "http://www.w3.org/2001/XMLSchema"
\r
17 attributeFormDefault = "qualified"
\r
18 elementFormDefault = "qualified">
\r
20 <xs:import namespace = "C"
\r
21 schemaLocation = "../OCISchemaBASE.xsd"/>
\r
23 <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>
\r
24 <xs:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>
\r
26 <!-- ********************************************************************************** -->
\r
27 <!-- E N H A N C E D C A L L L O G S R E Q U E S T S A N D R E S P O N S E S -->
\r
28 <!-- ********************************************************************************** -->
\r
30 Requests and responses are listed here in alphabetical order.
\r
31 The non-primitive attributes inside the commands are defined in another
\r
32 section of the schema.
\r
34 Requests in this schema file:
\r
35 EnterpriseEnhancedCallLogsGetListRequest21
\r
36 GroupEnhancedCallLogsGetListRequest21
\r
37 ServiceProviderEnhancedCallLogsGetRequest17sp4
\r
38 ServiceProviderEnhancedCallLogsModifyRequest
\r
39 SystemEnhancedCallLogsGetRequest20sp1
\r
40 SystemEnhancedCallLogsModifyRequest
\r
41 UserEnhancedCallLogsGetListRequest21
\r
45 <xs:complexType name="EnterpriseEnhancedCallLogsGetListRequest21">
\r
48 Request users' call logs within an enterprise
\r
49 If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned.
\r
50 It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl
\r
51 is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control
\r
52 the maximum number of call logs can be returned.
\r
53 The response is either an EnterpriseEnhancedCallLogsGetListResponse21 or an ErrorResponse.
\r
54 The following elements are only used in AS data mode and ignored in HSS data mode:
\r
55 callAuthorizationCodeFilter
\r
59 <xs:extension base="core:OCIRequest">
\r
61 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
62 <xs:element name="callLogType" type="EnhancedCallLogsCallLogsRequestType" minOccurs="0"/>
\r
64 <xs:element name="groupId" type="GroupId" minOccurs="0" maxOccurs="unbounded"/>
\r
65 <xs:element name="userDnRange" type="DNRange" minOccurs="0" maxOccurs="unbounded"/>
\r
66 <xs:element name="userExtensionRange" type="ExtensionRange17" minOccurs="0" maxOccurs="unbounded"/>
\r
68 <xs:element name="dateTimeRange" type="EnhancedCallLogsTimeRange"/>
\r
69 <xs:element name="numberFilter" type="EnhancedCallLogsNumberFilter" minOccurs="0"/>
\r
70 <xs:element name="redirectedNumberFilter" type="EnhancedCallLogsRedirectedNumberFilter21" minOccurs="0"/>
\r
71 <xs:element name="accountAuthorizationCodeFilter" type="EnhancedCallLogsAccountAuthorizationCodeFilter" minOccurs="0"/>
\r
72 <xs:element name="callAuthorizationCodeFilter" type="EnhancedCallLogsCallAuthorizationCodeFilter" minOccurs="0"/>
\r
73 <xs:element name="subscriberType" type="EnhancedCallLogsSubscriberType20" minOccurs="0"/>
\r
74 <xs:element name="responsePagingControl" type="EnhancedCallLogsResponsePagingControl" minOccurs="0"/>
\r
77 </xs:complexContent>
\r
80 <xs:complexType name="EnterpriseEnhancedCallLogsGetListResponse21">
\r
83 Response to EnterpriseEnhancedCallLogsGetListRequest21.
\r
84 Total numbers of rows is:
\r
85 - the total number of retrievable logs of the call log type that was specified in the EnterpriseEnhancedCallLogsGetListRequest21,
\r
86 if a call log type was specified in the request.
\r
87 - the total number of retrievable logs, if no call log type was specified in the request.
\r
88 A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned.
\r
89 The result is sorted by date/time of the call.
\r
93 <xs:extension base="core:OCIDataResponse">
\r
95 <xs:element name="totalNumberOfRows" type="xs:int"/>
\r
96 <xs:element name="extendedCallLog" type="ExtendedMixedCallLogsEntry21" minOccurs="0" maxOccurs="unbounded"/>
\r
99 </xs:complexContent>
\r
102 <xs:complexType name="GroupEnhancedCallLogsGetListRequest21">
\r
105 Request users' call logs within a group
\r
106 If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned.
\r
107 It is possible to restrict the number of rows returned using responsePagingControl.If responsePagingControl
\r
108 is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control
\r
109 the maximum number of call logs can be returned.
\r
110 The response is either a GroupEnhancedCallLogsGetListResponse21 or an ErrorResponse.
\r
111 The following elements are only used in AS data mode and ignored in HSS data mode:
\r
112 callAuthorizationCodeFilter
\r
113 </xs:documentation>
\r
115 <xs:complexContent>
\r
116 <xs:extension base="core:OCIRequest">
\r
118 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
119 <xs:element name="groupId" type="GroupId"/>
\r
120 <xs:element name="callLogType" type="EnhancedCallLogsCallLogsRequestType" minOccurs="0"/>
\r
122 <xs:element name="userDnRange" type="DNRange" minOccurs="0" maxOccurs="unbounded"/>
\r
123 <xs:element name="userExtensionRange" type="ExtensionRange17" minOccurs="0" maxOccurs="unbounded"/>
\r
125 <xs:element name="dateTimeRange" type="EnhancedCallLogsTimeRange"/>
\r
126 <xs:element name="numberFilter" type="EnhancedCallLogsNumberFilter" minOccurs="0"/>
\r
127 <xs:element name="redirectedNumberFilter" type="EnhancedCallLogsRedirectedNumberFilter21" minOccurs="0"/>
\r
128 <xs:element name="accountAuthorizationCodeFilter" type="EnhancedCallLogsAccountAuthorizationCodeFilter" minOccurs="0"/>
\r
129 <xs:element name="callAuthorizationCodeFilter" type="EnhancedCallLogsCallAuthorizationCodeFilter" minOccurs="0"/>
\r
130 <xs:element name="subscriberType" type="EnhancedCallLogsSubscriberType20" minOccurs="0"/>
\r
131 <xs:element name="responsePagingControl" type="EnhancedCallLogsResponsePagingControl" minOccurs="0"/>
\r
134 </xs:complexContent>
\r
137 <xs:complexType name="GroupEnhancedCallLogsGetListResponse21">
\r
140 Response to GroupEnhancedCallLogsGetListRequest21.
\r
141 Total numbers of rows is:
\r
142 - the total number of retrievable logs of the call log type that was specified in the GroupEnhancedCallLogsGetListRequest21,
\r
143 if a call log type was specified in the request.
\r
144 - the total number of retrievable logs, if no call log type was specified in the request.
\r
145 A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS. Otherwise, an error response will be returned.
\r
146 The logs are sorted by date/time of the call.
\r
147 </xs:documentation>
\r
149 <xs:complexContent>
\r
150 <xs:extension base="core:OCIDataResponse">
\r
152 <xs:element name="totalNumberOfRows" type="xs:int"/>
\r
153 <xs:element name="extendedCallLog" type="ExtendedMixedCallLogsEntry21" minOccurs="0" maxOccurs="unbounded"/>
\r
156 </xs:complexContent>
\r
159 <xs:complexType name="ServiceProviderEnhancedCallLogsGetRequest17sp4">
\r
162 Get the service provider's enhanced call log settings.
\r
163 The response is either a ServiceProviderEnhancedCallLogsGetResponse17sp4 or an ErrorResponse.
\r
164 This command will return an ErrorResponse if DBS is used as the call log server.
\r
165 </xs:documentation>
\r
167 <xs:complexContent>
\r
168 <xs:extension base="core:OCIRequest">
\r
170 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
173 </xs:complexContent>
\r
176 <xs:complexType name="ServiceProviderEnhancedCallLogsGetResponse17sp4">
\r
179 Response to ServiceProviderEnhancedCallLogsGetRequest17sp4.
\r
180 </xs:documentation>
\r
182 <xs:complexContent>
\r
183 <xs:extension base="core:OCIDataResponse">
\r
185 <xs:element name="maxLoggedCalls" type="EnhancedCallLogsMaxLoggedCalls17sp4"/>
\r
186 <xs:element name="callExpirationDays" type="EnhancedCallLogsCallExpirationDays"/>
\r
189 </xs:complexContent>
\r
192 <xs:complexType name="ServiceProviderEnhancedCallLogsModifyRequest">
\r
195 Modify the Service Provider level data associated with Enhanced Call Logs.
\r
196 Configures the maximum number of logged calls and maximum age of your user's call logs.
\r
197 Log entries are deleted when either of the two limits is reached.
\r
198 The response is either a SuccessResponse or an ErrorResponse.
\r
199 </xs:documentation>
\r
201 <xs:complexContent>
\r
202 <xs:extension base="core:OCIRequest">
\r
204 <xs:element name="serviceProviderId" type="ServiceProviderId"/>
\r
205 <xs:element name="maxLoggedCalls" type="EnhancedCallLogsMaxLoggedCalls17sp4" minOccurs="0"/>
\r
206 <xs:element name="callExpirationDays" type="EnhancedCallLogsCallExpirationDays" minOccurs="0"/>
\r
209 </xs:complexContent>
\r
212 <xs:complexType name="SystemEnhancedCallLogsGetRequest20sp1">
\r
215 Request the system level data associated with Enhanced Call Logs. The response is either a
\r
216 SystemEnhancedCallLogsGetResponse20sp1 or an ErrorResponse.
\r
217 </xs:documentation>
\r
219 <xs:complexContent>
\r
220 <xs:extension base="core:OCIRequest">
\r
223 </xs:complexContent>
\r
226 <xs:complexType name="SystemEnhancedCallLogsGetResponse20sp1">
\r
229 Response to SystemEnhancedCallLogsGetRequest20sp1.
\r
230 The following elements are only used in AS data mode:
\r
234 server1RetrievePort
\r
237 server2RetrievePort
\r
239 retransmissionDelayMilliSeconds
\r
243 eclQueryApplicationURL
\r
244 eclQueryDataRepositoryURL
\r
245 </xs:documentation>
\r
247 <xs:complexContent>
\r
248 <xs:extension base="core:OCIDataResponse">
\r
250 <xs:element name="isSendEnabled" type="xs:boolean"/>
\r
251 <xs:element name="server1NetAddress" type="NetAddress" minOccurs="0"/>
\r
252 <xs:element name="server1SendPort" type="Port1025"/>
\r
253 <xs:element name="server1RetrievePort" type="Port"/>
\r
254 <xs:element name="server2NetAddress" type="NetAddress" minOccurs="0"/>
\r
255 <xs:element name="server2SendPort" type="Port1025"/>
\r
256 <xs:element name="server2RetrievePort" type="Port"/>
\r
257 <xs:element name="sharedSecret" type="EnhancedCallLogsSharedSecret" minOccurs="0"/>
\r
258 <xs:element name="retransmissionDelayMilliSeconds" type="EnhancedCallLogsRetransmissionDelayMilliSeconds"/>
\r
259 <xs:element name="maxTransmissions" type="EnhancedCallLogsMaxTransmissions"/>
\r
260 <xs:element name="soapTimeoutSeconds" type="EnhancedCallLogsSoapTimeoutSeconds"/>
\r
261 <xs:element name="useDBS" type="xs:boolean"/>
\r
262 <xs:element name="maxNonPagedResponseSize" type="EnhancedCallLogsNonPagedResponseSize"/>
\r
263 <xs:element name="eclQueryApplicationURL" type="URL" minOccurs="0"/>
\r
264 <xs:element name="eclQueryDataRepositoryURL" type="URL" minOccurs="0"/>
\r
267 </xs:complexContent>
\r
270 <xs:complexType name="SystemEnhancedCallLogsModifyRequest">
\r
273 Modify the system level data associated with Enhanced Call Logs.
\r
274 The response is either a SuccessResponse or an ErrorResponse.
\r
275 The following elements are only used in AS data mode:
\r
279 server1RetrievePort
\r
282 server2RetrievePort
\r
284 retransmissionDelayMilliSeconds
\r
288 eclQueryApplicationURL
\r
289 eclQueryDataRepositoryURL
\r
290 </xs:documentation>
\r
292 <xs:complexContent>
\r
293 <xs:extension base="core:OCIRequest">
\r
295 <xs:element name="isSendEnabled" type="xs:boolean" minOccurs="0"/>
\r
296 <xs:element name="server1NetAddress" type="NetAddress" nillable="true" minOccurs="0"/>
\r
297 <xs:element name="server1SendPort" type="Port1025" minOccurs="0"/>
\r
298 <xs:element name="server1RetrievePort" type="Port" minOccurs="0"/>
\r
299 <xs:element name="server2NetAddress" type="NetAddress" nillable="true" minOccurs="0"/>
\r
300 <xs:element name="server2SendPort" type="Port1025" minOccurs="0"/>
\r
301 <xs:element name="server2RetrievePort" type="Port" minOccurs="0"/>
\r
302 <xs:element name="sharedSecret" type="EnhancedCallLogsSharedSecret" nillable="true" minOccurs="0"/>
\r
303 <xs:element name="retransmissionDelayMilliSeconds" type="EnhancedCallLogsRetransmissionDelayMilliSeconds" minOccurs="0"/>
\r
304 <xs:element name="maxTransmissions" type="EnhancedCallLogsMaxTransmissions" minOccurs="0"/>
\r
305 <xs:element name="soapTimeoutSeconds" type="EnhancedCallLogsSoapTimeoutSeconds" minOccurs="0"/>
\r
306 <xs:element name="useDBS" type="xs:boolean" minOccurs="0"/>
\r
307 <xs:element name="maxNonPagedResponseSize" type="EnhancedCallLogsNonPagedResponseSize" minOccurs="0"/>
\r
308 <xs:element name="eclQueryApplicationURL" type="URL" nillable="true" minOccurs="0"/>
\r
309 <xs:element name="eclQueryDataRepositoryURL" type="URL" nillable="true" minOccurs="0"/>
\r
312 </xs:complexContent>
\r
315 <xs:complexType name="SystemEnhancedCallLogsSchemaInstanceGetListResponse">
\r
318 Response to SystemEnhancedCallLogsSchemaInstanceGetListRequest.
\r
319 Contains a table with column headings: "Instance Name", "Actual Users", "Potential Users".
\r
320 </xs:documentation>
\r
322 <xs:complexContent>
\r
323 <xs:extension base="core:OCIDataResponse">
\r
325 <xs:element name="schemaInstanceUsageTable" type="core:OCITable"/>
\r
328 </xs:complexContent>
\r
331 <xs:complexType name="UserEnhancedCallLogsGetListRequest21">
\r
334 Request user's call logs.
\r
335 If the callLogType is not specified, all types of calls logs (placed, received, missed) are returned.
\r
336 The filters "dateTimeRange", "numberFilter", "redirectedNumberFilter", "accountAuthorizationCodeFilter"
\r
337 "callAuthorizationCodeFilter" and "subscriberType" are ignored if call logs are stored in CDS. When
\r
338 "ReceivedOrMissed" is specified as "callLogType" and call logs are stored in CDS, all call logs including
\r
339 placed will be returned.
\r
340 It is possible to restrict the number of rows returned using responsePagingControl. If responsePagingControl
\r
341 is not specified, the value of Enhanced Call Logs system parameter maxNonPagedResponseSize will control
\r
342 the maximum number of call logs can be returned.
\r
343 The response is either a UserEnhancedCallLogsGetListResponse21 or an ErrorResponse.
\r
344 The following elements are only used in AS data mode and ignored in HSS data mode:
\r
345 callAuthorizationCodeFilter
\r
346 </xs:documentation>
\r
348 <xs:complexContent>
\r
349 <xs:extension base="core:OCIRequest">
\r
351 <xs:element name="userId" type="UserId"/>
\r
352 <xs:element name="callLogType" type="EnhancedCallLogsCallLogsRequestType" minOccurs="0"/>
\r
353 <xs:element name="dateTimeRange" type="EnhancedCallLogsTimeRange"/>
\r
354 <xs:element name="numberFilter" type="EnhancedCallLogsNumberFilter" minOccurs="0"/>
\r
355 <xs:element name="redirectedNumberFilter" type="EnhancedCallLogsRedirectedNumberFilter21" minOccurs="0"/>
\r
356 <xs:element name="accountAuthorizationCodeFilter" type="EnhancedCallLogsAccountAuthorizationCodeFilter" minOccurs="0"/>
\r
357 <xs:element name="callAuthorizationCodeFilter" type="EnhancedCallLogsCallAuthorizationCodeFilter" minOccurs="0"/>
\r
358 <xs:element name="subscriberType" type="EnhancedCallLogsSubscriberType20" minOccurs="0"/>
\r
359 <xs:element name="responsePagingControl" type="ResponsePagingControl" minOccurs="0"/>
\r
362 </xs:complexContent>
\r
365 <xs:complexType name="UserEnhancedCallLogsGetListResponse21">
\r
368 Response to UserEnhancedCallLogsGetListRequest21.
\r
369 Total numbers of rows is:
\r
370 - the total number of retrievable logs of the call log type that was specified in the UserEnhancedCallLogsGetListRequest21,
\r
371 if a call log type was specified in the request.
\r
372 - the total number of retrievable logs, if no call log type was specified in the request.
\r
373 A list of MixedCallLogsEntry will be returned if the call logs are stored on CDS
\r
374 A list of ExtendedMixedCallLogsEntry21 will be returned if the call logs are stored on DBS
\r
375 The logs are sorted by date/time of the call.
\r
376 </xs:documentation>
\r
378 <xs:complexContent>
\r
379 <xs:extension base="core:OCIDataResponse">
\r
381 <xs:element name="totalNumberOfRows" type="xs:int"/>
\r
383 <xs:element name="legacyEntry">
\r
387 <xs:element name="callLog" type="MixedCallLogsEntry" minOccurs="0" maxOccurs="unbounded"/>
\r
391 <xs:element name="extendedEntry">
\r
395 <xs:element name="extendedCallLog" type="ExtendedMixedCallLogsEntry21" minOccurs="0" maxOccurs="unbounded"/>
\r
402 </xs:complexContent>
\r
405 <xs:simpleType name="EnhancedCallLogsCallExpirationDays">
\r
408 The maximum length of time the system will store logged calls.
\r
409 </xs:documentation>
\r
411 <xs:restriction base="xs:int">
\r
412 <xs:minInclusive value="1"/>
\r
413 <xs:maxInclusive value="1000"/>
\r
417 <xs:simpleType name="EnhancedCallLogsMaxLoggedCalls17sp4">
\r
420 Sets the maximum number of logged calls that can be stored.
\r
421 </xs:documentation>
\r
423 <xs:restriction base="xs:int">
\r
424 <xs:minInclusive value="1"/>
\r
425 <xs:maxInclusive value="99000"/>
\r
429 <xs:simpleType name="EnhancedCallLogsMaxTransmissions">
\r
432 Maximum transmissions.
\r
433 </xs:documentation>
\r
435 <xs:restriction base="xs:int">
\r
436 <xs:minInclusive value="1"/>
\r
437 <xs:maxInclusive value="5"/>
\r
441 <xs:simpleType name="EnhancedCallLogsNonPagedResponseSize">
\r
444 The maximum number of call log entries to return when paging information is
\r
445 not specified in the request.
\r
446 </xs:documentation>
\r
448 <xs:restriction base="xs:int">
\r
449 <xs:minInclusive value="100"/>
\r
450 <xs:maxInclusive value="1000"/>
\r
454 <xs:complexType name="EnhancedCallLogsNumberFilter">
\r
457 Filter criteria based on the called number or number called.
\r
458 </xs:documentation>
\r
462 <xs:element name="includeBasicCallType" type="BasicCallType" maxOccurs="unbounded"/>
\r
463 <xs:element name="includeCallCategory" type="CallCategory" maxOccurs="unbounded"/>
\r
464 <xs:element name="includeConfigurableCallType" type="CommunicationBarringCallType" maxOccurs="unbounded"/>
\r
465 <xs:element name="searchCriteriaDialedNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
466 <xs:element name="searchCriteriaCalledNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
467 <xs:element name="searchCriteriaNetworkTranslatedNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
468 <xs:element name="searchCriteriaCallingPresentationNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
473 <xs:simpleType name="EnhancedCallLogsOutgoingDnis">
\r
476 Outgoing call center dnis name. In the format of call center id + ":" + DNIS name.
\r
477 </xs:documentation>
\r
479 <xs:restriction base="xs:token">
\r
480 <xs:minLength value="1"/>
\r
481 <xs:maxLength value="202"/>
\r
485 <xs:complexType name="EnhancedCallLogsRedirectedNumberFilter21">
\r
488 Filter criteria based on the transferred/forwarded number.
\r
489 </xs:documentation>
\r
493 <xs:element name="redirectedCall" type="EnhancedCallLogsRedirectedCallSelection21"/>
\r
494 <xs:element name="includeServiceInvocationBasicCallType" type="BasicCallType" maxOccurs="unbounded"/>
\r
495 <xs:element name="includeServiceInvocationCallCategory" type="CallCategory" maxOccurs="unbounded"/>
\r
496 <xs:element name="includeServiceInvocationConfigurableCallType" type="CommunicationBarringCallType" maxOccurs="unbounded"/>
\r
497 <xs:element name="searchCriteriaServiceInvocationDialedNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
498 <xs:element name="searchCriteriaServiceInvocationCalledNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
499 <xs:element name="searchCriteriaServiceInvocationNetworkTranslatedNumber" type="SearchCriteriaOutgoingDNorSIPURI" maxOccurs="unbounded"/>
\r
504 <xs:complexType name="EnhancedCallLogsRedirectedCallSelection21">
\r
507 Redirected call selection.
\r
508 When " redirectedCall " is set to true, all call logs with redirected call are returned. When it
\r
509 set to false, all call logs without redirected call are returned.
\r
510 The redirected call can be defined by including a subset of Service Invocation Disposition here.
\r
511 If none included, any call has a ServiceInvocationDisposition value defined in ServiceInvocationDisposition
\r
512 is considered as a redirected call.
\r
513 </xs:documentation>
\r
516 <xs:element name="redirectedCall" type="xs:boolean"/>
\r
517 <xs:element name="redirectType" type="ServiceInvocationDisposition21" minOccurs="0" maxOccurs="unbounded"/>
\r
521 <xs:complexType name="EnhancedCallLogsAccountAuthorizationCodeFilter">
\r
524 Filter criteria based on the account code.
\r
525 When "callsWithCodes" is set to true, all call logs with account/authorization codes are returned.
\r
526 When it set to false, all call logs without account/authorization codes are returned.
\r
527 </xs:documentation>
\r
531 <xs:element name="callsWithCodes" type="xs:boolean"/>
\r
532 <xs:element name="accountAuthorizationCode" type="OutgoingCallingPlanAuthorizationCode"/>
\r
537 <xs:complexType name="EnhancedCallLogsCallAuthorizationCodeFilter">
\r
540 Filter criteria based on call authorization code. Note that this code
\r
541 filter is different than EnhancedCallLogsAccountAuthorizationCodeFilter,
\r
542 which applies strictly to codes entered using the account/authorization
\r
544 When "callsWithCodes" is set to true, all call logs with authorization
\r
545 codes are returned.
\r
546 When it set to false, all call logs without authorization codes are
\r
548 If "authorizationCode" is set, all call logs matching that specific
\r
549 authorization code are returned.
\r
550 </xs:documentation>
\r
554 <xs:element name="callsWithCodes" type="xs:boolean"/>
\r
555 <xs:element name="authorizationCode" type="OutgoingCallingPlanAuthorizationCode"/>
\r
560 <xs:simpleType name="EnhancedCallLogsRetransmissionDelayMilliSeconds">
\r
563 Retransmission delay in milli-seconds.
\r
564 </xs:documentation>
\r
566 <xs:restriction base="xs:int">
\r
567 <xs:minInclusive value="200"/>
\r
568 <xs:maxInclusive value="5000"/>
\r
572 <xs:simpleType name="EnhancedCallLogsSharedSecret">
\r
574 <xs:documentation>Shared Secret.</xs:documentation>
\r
576 <xs:restriction base="xs:token">
\r
577 <xs:minLength value="1"/>
\r
578 <xs:maxLength value="80"/>
\r
582 <xs:simpleType name="EnhancedCallLogsSoapTimeoutSeconds">
\r
585 Timeout when retrieving enhanced call logs through the SOAP interface.
\r
586 </xs:documentation>
\r
588 <xs:restriction base="xs:int">
\r
589 <xs:minInclusive value="1"/>
\r
590 <xs:maxInclusive value="120"/>
\r
594 <xs:complexType name="EnhancedCallLogsTimeRange">
\r
597 Time range used to filter call logs.
\r
598 </xs:documentation>
\r
601 <xs:element name="startDateTime" type="xs:dateTime"/>
\r
602 <xs:element name="endDateTime" type="xs:dateTime"/>
\r
606 <xs:complexType name="ExtendedMixedCallLogsEntry21">
\r
609 Extended Call Log entry describing a placed, received, or missed call.
\r
610 "countryCode" is the user's country code
\r
611 The following time elements are represented as timestamp, i.e., the number of milliseconds
\r
612 since January 1, 1970, 00:00:00 GMT.
\r
613 "startTime" represents the time when the system sends out a call invitation message (e.g. for
\r
614 placed calls) or receives a call invitation message (e.g. for missed/received calls).
\r
615 "answerTime" represents the time when the call is answered by the terminating party.
\r
616 "detachedTime" represents the time when the call is successfully redirected by the system.
\r
617 "releaseTime" represents the time when the call is released. This time corresponds to the
\r
618 moment the call is released by the system, and not necessarily when one party hangs up, since this
\r
619 does not always mean the call is released (e.g. Emergency/911 calls).
\r
620 The elements "userGroupId", "userId","userPrimaryDn" and "userPrimaryExtension"
\r
621 are only returned when the enterprise or group level requests are used.
\r
622 The following elements are only used in AS data mode:
\r
623 callAuthorizationCode
\r
624 securityClassification
\r
625 </xs:documentation>
\r
628 <xs:element name="callLogType" type="CallLogsType"/>
\r
629 <xs:element name="countryCode" type="CountryCode"/>
\r
630 <xs:element name="callLogId" type="CallLogId17sp4"/>
\r
631 <xs:element name="callId" type="CallId"/>
\r
632 <xs:element name="subscriberType" type="EnhancedCallLogsSubscriberType20"/>
\r
633 <xs:element name="dialedNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
634 <xs:element name="calledNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
635 <xs:element name="networkTranslatedAddress" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
636 <xs:element name="callingAssertedNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
637 <xs:element name="callingPresentationNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
638 <xs:element name="callingPresentationNumberSource" type="CallingPresentationNumberSource" minOccurs="0"/>
\r
639 <xs:element name="callingPresentationName" type="CallLogsEntryName17sp4" minOccurs="0"/>
\r
640 <xs:element name="callingPresentationIndicator" type="PresentationIndicator"/>
\r
641 <xs:element name="callingGroupId" type="GroupId" minOccurs="0"/>
\r
642 <xs:element name="calledDirectoryName" type="CallLogsEntryName" minOccurs="0"/>
\r
643 <xs:element name="calledGroupId" type="GroupId" minOccurs="0"/>
\r
644 <xs:element name="connectedNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
645 <xs:element name="connectedNumberSource" type="ConnectedNumberSource" minOccurs="0"/>
\r
646 <xs:element name="connectedName" type="CallLogsEntryName17sp4" minOccurs="0"/>
\r
647 <xs:element name="connectedPresentationIndicator" type="PresentationIndicator" minOccurs="0"/>
\r
648 <xs:element name="typeOfNetwork" type="NetworkType" minOccurs="0"/>
\r
649 <xs:element name="callCategory" type="CallCategory" minOccurs="0"/>
\r
650 <xs:element name="basicCallType" type="BasicCallType"/>
\r
651 <xs:element name="configurableCallType" type="CommunicationBarringCallType" minOccurs="0"/>
\r
652 <xs:element name="alternateCallIndicator" type="CommunicationBarringAlternateCallIndicator" minOccurs="0"/>
\r
653 <xs:element name="virtualOnNetCallType" type="VirtualOnNetCallTypeName" minOccurs="0"/>
\r
654 <xs:element name="time" type="xs:dateTime"/>
\r
655 <xs:element name="startTime" type="xs:long"/>
\r
656 <xs:element name="answerTime" type="xs:long" minOccurs="0"/>
\r
657 <xs:element name="releaseTime" type="xs:long" minOccurs="0"/>
\r
658 <xs:element name="detachedTime" type="xs:long" minOccurs="0"/>
\r
659 <xs:element name="detachedAnswerTime" type="xs:long" minOccurs="0"/>
\r
660 <xs:element name="outgoingDnis" type="EnhancedCallLogsOutgoingDnis" minOccurs="0"/>
\r
661 <xs:element name="serviceInvocationDisposition" type="ServiceInvocationDisposition21" minOccurs="0"/>
\r
662 <xs:element name="serviceInvocationDialedNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
663 <xs:element name="serviceInvocationCalledNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
664 <xs:element name="serviceInvocationNetworkTranslatedAddress" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
665 <xs:element name="serviceInvocationTypeOfNetwork" type="NetworkType" minOccurs="0"/>
\r
666 <xs:element name="serviceInvocationCallCategory" type="CallCategory" minOccurs="0"/>
\r
667 <xs:element name="serviceInvocationBasicCallType" type="BasicCallType" minOccurs="0"/>
\r
668 <xs:element name="serviceInvocationConfigurableCallType" type="CommunicationBarringCallType" minOccurs="0"/>
\r
669 <xs:element name="serviceInvocationAlternateCallIndicator" type="CommunicationBarringAlternateCallIndicator" minOccurs="0"/>
\r
670 <xs:element name="serviceInvocationVirtualOnNetCallType" type="VirtualOnNetCallTypeName" minOccurs="0"/>
\r
671 <xs:element name="serviceInvocationCalledDirectoryName" type="CallLogsEntryName" minOccurs="0"/>
\r
672 <xs:element name="serviceInvocationCalledGroupId" type="GroupId" minOccurs="0"/>
\r
673 <xs:element name="redirectingNumber" type="OutgoingDNorSIPURI" minOccurs="0"/>
\r
674 <xs:element name="redirectingName" type="CallLogsEntryName17sp4" minOccurs="0"/>
\r
675 <xs:element name="redirectingPresentationIndicator" type="RedirectingPresentationIndicator" minOccurs="0"/>
\r
676 <xs:element name="RedirectingReason" type="RedirectingReason" minOccurs="0"/>
\r
677 <xs:element name="accountAuthorizationCode" type="OutgoingCallingPlanAuthorizationCode" minOccurs="0"/>
\r
678 <xs:element name="callAuthorizationCode" type="OutgoingCallingPlanAuthorizationCode" minOccurs="0"/>
\r
679 <xs:element name="userGroupId" type="GroupId" minOccurs="0"/>
\r
680 <xs:element name="userId" type="UserId" minOccurs="0"/>
\r
681 <xs:element name="userPrimaryDn" type="DN" minOccurs="0"/>
\r
682 <xs:element name="userPrimaryExtension" type="Extension17" minOccurs="0"/>
\r
683 <xs:element name="securityClassification" type="SecurityClassificationName" minOccurs="0"/>
\r
687 <xs:simpleType name="CallId">
\r
690 The call Id of a call associated a this call log entry
\r
691 </xs:documentation>
\r
693 <xs:restriction base="xs:token">
\r
694 <xs:minLength value="1"/>
\r
695 <xs:maxLength value="40"/>
\r
699 <xs:simpleType name="CallingPresentationNumberSource">
\r
702 Identifies the source of the number used in the Calling Presentation Number field
\r
703 </xs:documentation>
\r
705 <xs:restriction base="xs:token">
\r
706 <xs:enumeration value="Configurable CLID"/>
\r
707 <xs:enumeration value="DNIS"/>
\r
708 <xs:enumeration value="Emergency"/>
\r
709 <xs:enumeration value="Group"/>
\r
710 <xs:enumeration value="Trunk Group"/>
\r
711 <xs:enumeration value="User"/>
\r
712 <xs:enumeration value="Department"/>
\r
716 <xs:simpleType name="PresentationIndicator">
\r
719 Presentation Indicator
\r
720 </xs:documentation>
\r
722 <xs:restriction base="xs:token">
\r
723 <xs:enumeration value="Anonymous"/>
\r
724 <xs:enumeration value="Anonymous Name"/>
\r
725 <xs:enumeration value="Anonymous URI"/>
\r
726 <xs:enumeration value="Anonymous Unavailable"/>
\r
727 <xs:enumeration value="Public"/>
\r
728 <xs:enumeration value="Unavailable"/>
\r
732 <xs:simpleType name="ConnectedNumberSource">
\r
735 Connected Number Type
\r
736 </xs:documentation>
\r
738 <xs:restriction base="xs:token">
\r
739 <xs:enumeration value="Configurable CLID"/>
\r
740 <xs:enumeration value="Group"/>
\r
741 <xs:enumeration value="User"/>
\r
742 <xs:enumeration value="Department"/>
\r
746 <xs:simpleType name="NetworkType">
\r
749 The Type of Network for the call provided in the most significant contact from the NS
\r
750 </xs:documentation>
\r
752 <xs:restriction base="xs:token">
\r
753 <xs:enumeration value="Private"/>
\r
754 <xs:enumeration value="Public"/>
\r
758 <xs:simpleType name="CallCategory">
\r
761 The Call Category for the call provided in the most significant contact from the NS
\r
762 </xs:documentation>
\r
764 <xs:restriction base="xs:token">
\r
765 <xs:enumeration value="Local"/>
\r
766 <xs:enumeration value="National"/>
\r
767 <xs:enumeration value="Interlata"/>
\r
768 <xs:enumeration value="Intralata"/>
\r
769 <xs:enumeration value="International"/>
\r
770 <xs:enumeration value="Private"/>
\r
771 <xs:enumeration value="Emergency"/>
\r
772 <xs:enumeration value="Other"/>
\r
776 <xs:simpleType name="BasicCallType">
\r
779 The basic call type for the origination
\r
780 </xs:documentation>
\r
782 <xs:restriction base="xs:token">
\r
783 <xs:enumeration value="Group"/>
\r
784 <xs:enumeration value="Enterprise"/>
\r
785 <xs:enumeration value="Network"/>
\r
786 <xs:enumeration value="Network URL"/>
\r
787 <xs:enumeration value="Repair"/>
\r
788 <xs:enumeration value="Emergency"/>
\r
792 <xs:simpleType name="ServiceInvocationDisposition21">
\r
795 Indicates the type of service invocation that caused the call to be detached.
\r
796 </xs:documentation>
\r
798 <xs:restriction base="xs:token">
\r
799 <xs:enumeration value="Automatic Hold/Retrieve"/>
\r
800 <xs:enumeration value="Call Forward Always"/>
\r
801 <xs:enumeration value="Call Forward Busy"/>
\r
802 <xs:enumeration value="Call Forward No Answer"/>
\r
803 <xs:enumeration value="Call Forward Not Reachable"/>
\r
804 <xs:enumeration value="Call Forward Selective"/>
\r
805 <xs:enumeration value="Call Park"/>
\r
806 <xs:enumeration value="Call Pickup"/>
\r
807 <xs:enumeration value="Deflection"/>
\r
808 <xs:enumeration value="Directed Call Pickup"/>
\r
809 <xs:enumeration value="Distribution from Call Center"/>
\r
810 <xs:enumeration value="Distribution from Hunt Group"/>
\r
811 <xs:enumeration value="Distribution from Route Point"/>
\r
812 <xs:enumeration value="Do Not Disturb"/>
\r
813 <xs:enumeration value="Fax Deposit"/>
\r
814 <xs:enumeration value="Group Night Forwarding"/>
\r
815 <xs:enumeration value="Sequential Ring"/>
\r
816 <xs:enumeration value="Series Completion"/>
\r
817 <xs:enumeration value="Simultaneous Ring"/>
\r
818 <xs:enumeration value="Third Party Deflection"/>
\r
819 <xs:enumeration value="Third Party Voice Mail Support"/>
\r
820 <xs:enumeration value="Transfer Consult"/>
\r
821 <xs:enumeration value="Trunk Group Forward Capacity Exceeded"/>
\r
822 <xs:enumeration value="Trunk Group Forward Unreachable"/>
\r
823 <xs:enumeration value="Trunk Group Forward Unconditional"/>
\r
824 <xs:enumeration value="Voice Mail Transfer"/>
\r
825 <xs:enumeration value="Voice Messaging"/>
\r
826 <xs:enumeration value="Find-me/Follow-me"/>
\r
827 <xs:enumeration value="Personal Assistant"/>
\r
831 <xs:simpleType name="RedirectingPresentationIndicator">
\r
834 The presentation indicator for the last redirecting party
\r
835 </xs:documentation>
\r
837 <xs:restriction base="xs:token">
\r
838 <xs:enumeration value="Anonymous"/>
\r
839 <xs:enumeration value="Anonymous Name"/>
\r
840 <xs:enumeration value="Anonymous URI"/>
\r
841 <xs:enumeration value="Public"/>
\r
845 <xs:simpleType name="RedirectingReason">
\r
848 The reason for the redirection by the last redirecting party
\r
849 </xs:documentation>
\r
851 <xs:restriction base="xs:token">
\r
852 <xs:minLength value="1"/>
\r
853 <xs:maxLength value="20"/>
\r
857 <xs:simpleType name="EnhancedCallLogsResponsePageSize">
\r
860 Maximum number of rows to return in response to a paging request for enhanced call logs
\r
861 </xs:documentation>
\r
863 <xs:restriction base="xs:int">
\r
864 <xs:minInclusive value="1"/>
\r
865 <xs:maxInclusive value="1000"/>
\r
869 <xs:complexType name="EnhancedCallLogsResponsePagingControl">
\r
872 Used in enhanced call logs group and enterprise queries to restrict the set of result
\r
873 rows when making a request that can result in a large dataset. The client specifies the
\r
874 starting row and the number of rows requested.
\r
875 The server only provides those rows in results, if available.
\r
876 </xs:documentation>
\r
879 <xs:element name="responseStartIndex" type="ResponseStartIndex"/>
\r
880 <xs:element name="responsePageSize" type="EnhancedCallLogsResponsePageSize"/>
\r
884 <xs:simpleType name="EnhancedCallLogsSubscriberType20">
\r
888 </xs:documentation>
\r
890 <xs:restriction base="xs:token">
\r
891 <xs:enumeration value="Auto Attendant"/>
\r
892 <xs:enumeration value="BroadWorks Anywhere Portal"/>
\r
893 <xs:enumeration value="Call Center"/>
\r
894 <xs:enumeration value="Find-me/Follow-me"/>
\r
895 <xs:enumeration value="Flexible Seating Host"/>
\r
896 <xs:enumeration value="Hunt Group"/>
\r
897 <xs:enumeration value="Route Point"/>
\r
898 <xs:enumeration value="User"/>
\r
899 <xs:enumeration value="VoiceXML"/>
\r
903 <xs:simpleType name="EnhancedCallLogsCallLogsRequestType">
\r
906 Call Log type used by enhanced call logs requests
\r
907 </xs:documentation>
\r
909 <xs:restriction base="xs:token">
\r
910 <xs:enumeration value="Placed"/>
\r
911 <xs:enumeration value="Received"/>
\r
912 <xs:enumeration value="Missed"/>
\r
913 <xs:enumeration value="ReceivedOrMissed"/>
\r
917 <xs:simpleType name="CallLogsEntryName17sp4">
\r
921 </xs:documentation>
\r
923 <xs:restriction base="xs:token">
\r
924 <xs:minLength value="1"/>
\r
925 <xs:maxLength value="80"/>
\r
929 <xs:complexType name="SearchCriteriaOutgoingDNorSIPURI">
\r
932 Criteria for searching for a phone number or SIPURI.
\r
933 </xs:documentation>
\r
935 <xs:complexContent>
\r
936 <xs:extension base="SearchCriteria">
\r
938 <xs:element name="mode" type="SearchMode"/>
\r
939 <xs:element name="value" type="OutgoingDNorSIPURI"/>
\r
940 <xs:element name="isCaseInsensitive" type="xs:boolean" fixed="false"/>
\r
943 </xs:complexContent>
\r