Cisco BroadWorks

Xtended Services Interface

Interface Specification

Document Version 4
 Copyright Notice

Copyright© 2021 Cisco Systems, Inc. All rights reserved.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its
affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this
URL: https://www.cisco.com/c/en/us/about/legal/trademarks.html. Third-party trademarks
mentioned are the property of their respective owners. The use of the word partner does
not imply a partnership relationship between Cisco and any other company. (1721R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not
intended to be actual addresses and phone numbers. Any examples, command display
output, network topology diagrams, and other figures included in the document are shown
for illustrative purposes only. Any use of actual IP addresses or phone numbers in
illustrative content is unintentional and coincidental.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 2 OF 521
 Document Revision History

Release Version Reason for Change Date Author

17.0 1 Created initial draft. December 31, 2010 Stephan Goulet

17.0 2 Updated section 4.2.1.2 Event August 31, 2011 Martin Perron
Channel.

18.0 1 Updated document for Release 18.0. November 11, 2011 Martin Perron

18.0 1 Edited document. November 22, 2011 Patricia Renaud

18.0 1 Edited and published document. January 11, 2012 Patricia Renaud

18.0 2 Updated section 4.2.1.2 Event March 7, 2012 Goska Auerbach

Channel for EV 161294. Changed
“Hartbeat” to “HeartBeat”.

18.0 2 Updated sections 3.3 Message May 4, 2012 Martin Perron

Encoding and 4.3 Message Encoding
for EV 156257.

18.0 2 Edited changes and published May 31, 2012 Andrea Fitzwilliam
document.

18.0 3 Updated section 4.2.1.2 Event July 25, 2012 Martin Perron
Channel for EV 161294. Changed
“Hartbeat” to “HeartBeat” in Figure 7.

18.0 3 Updated section 3.5.3.13 July 25, 2012 Martin Perron

services/CallCenter (AS Only) for
EV 149186. Added details regarding
the usage of the PUT method to
modify service attributes.

18.0 3 Updated section 4.6.2 Subscription July 25, 2012 Martin Perron
Commands for EV 167033. Modified
examples to ensure that the expires
element is provided before the
httpContact element.

18.0 3 Updated sections 3.3.2 HTTP July 25, 2012 Martin Perron
Headers and 4.3.2 HTTP Headers for
EV 156257.

18.0 3 Edited changes and published August 20, 2012 Andrea Fitzwilliam
document.

19.0 1 Updated section 4.6.2 Subscription August 27, 2012 Stephan Goulet
Commands for
EV 159748 and section 3.5.4 User
Call Commands: /user/<userid>/calls
for EV 159741.

19.0 1 Updated section 3.5.3.48 August 30, 2012 Stephan Goulet

services/HotelingGuest for
EV 167024.

19.0 1 Updated section 4.2.1.2 Event September 4, 2012 Stephan Goulet

Channel for EV 163255

19.0 1 Introduced changes for Release 19.0. October 11, 2012 Stephan Goulet

19.0 1 Clarified behavior of 3.5.3.4 October 17, 2012 Noel McNulty

services/AlternateNumbers for EV
114934.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 3 OF 521
 Release Version Reason for Change Date Author

19.0 1 Updated following internal review. November 12, 2012 Stephan Goulet

19.0 1 Edited changes. November 22, 2012 Jessica Boyle

19.0 1 Reviewed editing changes. November 26, 2012 Patricia Renaud

19.0 1 Edited changes and published November 26, 2012 Jessica Boyle
document.

19.0 2 Clarified URL in sections 4.2.1.2 May 16, 2013 Paul Humphries
Event Channel and 4.3 Message
Encoding for EV 191309.

19.0 2 Edited changes and published May 29, 2013 Jessica Boyle
document.

19.0 3 Removed an internal section. July 24, 2013 Stephan Goulet

19.0 3 Edited changes and published July 25, 2013 Jessica Boyle
document.

20.0 1 Added criteriaActivationList in PUT August 30, 2013 Juliette D’Almeida

request and GET response examples
for Simultaneous Ringing Personal.

20.0 1 Introduced changes for Release 20.0. October 11, 2013 Stephan Goulet

20.0 1 Updated section 3.4 Backward October 11, 2013 Stephan Goulet
Compatibility for EV 185622.

20.0 1 Updated sections 4.4.17 Call Park

and 3.5.1.2 User Services October 11, 2013 Stephan Goulet
Commands for EV 193880.

20.0 1 Updated section 4.6.3 Channel October 11, 2013 Stephan Goulet
Commands for EV 196801.

20.0 1 Updated section 3.5.13.2 October 11, 2013 Stephan Goulet

conference/<conferenceid>/outgoing
dial for EV 197892

20.0 1 Updated sections 4.6.2 Subscription October 11, 2013 Stephan Goulet
Commands and 4.7.19 Meet-Me
Conference Events for EV 200958.

20.0 1 Edited changes and published December 6, 2013 Joan Renaud

document.

20.0 2 Added sections 3.5.16 Version February 18, 2014 Stephan Goulet
Command and 4.6.4 Version
Command for EV 216215.

20.0 2 Edited changes and published April 21, 2014 Joan Renaud
document.

21.0 1 Introduced changes for Release 21.0. October 28, 2014 Sébastien Martineau

21.0 1 Updated section 3.3.3.1 JSON for EV November 30, 2014 Martin Perron
219189.

21.0 1 Updated the legal notice. December 8, 2014 Joan Renaud

Edited, rebranded, and published
document.

22.0 1 Introduced changes for Release 22.0. December 22, 2014 Sébastien Martineau

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 4 OF 521
 Release Version Reason for Change Date Author

22.0 1 Removed maxChannelsReached April 9, 2015 Alexandre Beaudry

reason from
channelTerminatedEvent.

22.0 1 Added section 3.2.2.4 Authentication August 4, 2015 François Rajotte

with SIP.

22.0 1 Modified section 3.5.4.30 June 14, 2016 Sébastien Martineau

calls/CallRetrieve for PR-51178.
Modified section for PR-49817.

22.0 1 Updated document for Release 22.0. September 12, 2016 Sébastien Martineau

22.0 1 Updated document for PR-45683. September 19, 2016 Supriya Herwadkar

22.0 1 Edited changes and published November 30, 2016 Joan Renaud
document.

22.0 2 Added section 4.7.34 December 9, 2016 Sébastien Martineau

CallParkedAgainstEvent to add the
missing CallParkedAgainstEvent for
PR-53879.

22.0 2 Modified section 4.2.1.2 Event January 30, 2017 Sébastien Martineau
Channel to add mention about the
CTI Interface.

22.0 2 Edited changes and published March 3, 2017 Jessica Boyle

document.

22.0 3 Added sections 3.3.4.1 Slash September 18, 2017 Goska Auerbach
Character in Cisco BroadWorks
Identifiers and 4.3.4.1 Slash
Character in Cisco BroadWorks
Identifiers for PR-56474.

22.0 3 Modified section 3.5.4.41 September 26, 2017 Sébastien Martineau

calls/ParkRetrieve for PR-56342.

22.0 3 Edited changes and published December 18, 2017 Jessica Boyle
document.

22.0 4 Modified section 3.5.4 User Call February 9, 2018 Sébastien Martineau
Commands: /user/<userid>/calls for
PR-57671. Added “FlexibleSeating
Guest” to location parameters.

22.0 4 Updated section 3.5.3.4 April 17, 2018 Kinh Do

services/AlternateNumbers for PR-
54485.

22.0 4 Updated section 3.5.9.2 May 15, 2018 Sébastien Martineau

profile/DispositionCodes for
PR-58580.

22.0 4 Edited changes and published May 23, 2018 Joan Renaud
document.

23.0 1 Updated section 3.5.7.13 May 28, 2018 Sébastien Martineau

directories/Personal for PR-58470.
Updated section 3.5.3.10
services/BroadworksMobility for
PR-51154.

23.0 1 Updated document for Release 23.0. June 18, 2018 Sébastien Martineau

23.0 1 Edited section 4.7.1.1.3 October 25, 2018 Sébastien Martineau

CallReceivedEvent for PR-59835.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 5 OF 521
 Release Version Reason for Change Date Author

23.0 1 Rebranded document for Cisco. November 3, 2018 Joan Renaud

Edited changes and published
document.

23.0 2 Edited section 3.5.3.11.1 January 28, 2018 Sébastien Martineau

services/BusyLampField/MonitoredU
serList for PR-60493.

23.0 2 Rebranded product name for Cisco. March 20, 2019 Joan Renaud
Edited changes and published
document.

23.0 3 Edited sections 3.5.7.7 April 4, 2019 Sébastien Martineau

directories/Enterprise and 3.5.7.10
directories/Group for PR-60685.
Edited section 1.2 Interface Changes
for Release 23.0 to remove list of
feature documents.

23.0 3 Edited section 3.5.2.4 May 16, 2019 Sébastien Martineau

profile/DeviceToken for PR-61234.

23.0 3 Edited changes and published July 23, 2019 Jessica Boyle
document.

23.0 4 Edited section 4.6.2.5 Subscription August 26, 2019 Sébastien Martineau
for PR-62148. Corrected
subscription command name and
address.

23.0 4 Added indicators for AS-TAS and XS- October 16, 2019 Sébastien Martineau
TAS specific requests for PR-62182.

23.0 4 Added section 4.2.4.7 Expiration with December 17, 2019 Sébastien Martineau
information on un-expiring
subscriptions and expiration values
for PR-62786.

23.0 4 Added section 5 Xsi-MMTel for PR- January 30, 2020 Sébastien Martineau
63133.

23.0 4 Reviewed changes. February 5, 2020 Goska Auerbach

23.0 4 Modified section 3.5.8.1.3 February 11, 2020 Sébastien Martineau

VoiceMessagingMessages/<messag
eId> (AS Only) for PR-60902.
Modified sections 3.5.4.38 calls/Imrn
and 3.5.4.28 calls/CallMeNow (AS
Only) for PR-63185.

23.0 4 Edited changes and published March 27, 2020 Jessica Boyle
document.

2020.07 1 Updated document for Release June 15, 2020 Sébastien Martineau
2020.07.

2020.07 1 Added keywords to document July 3, 2020 Patricia Renaud

Properties, edited changes, and
published document.

2020.07 2 Updated section 3.5.7.13 July 10, 2020 Sébastien Martineau

directories/Personal for PR-64356.

2020.07 2 Edited changes and published October 2, 2020 Joan Renaud

document.

2020.07 3 Edited section 4.2.3 Channel for October 8, 2020 Sébastien Martineau
PR-64161.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 6 OF 521
 Release Version Reason for Change Date Author

2020.07 3 Edited changes and republished November 19, 2020 Andrea Fitzwilliam
document.

2020.07 4 Edited section 3.5.7 User Directories January 8, 2021 Sébastien Martineau
Commands:
/user/<userid>/directories for PR-
65071.

2020.07 4 Updated section 4.2.1.2 Event January 20, 2021 Sébastien Martineau
Channel for PR-65201.

2020.07 4 Updated copyright information. January 26, 2021 Goska Auerbach

2020.07 4 Edited changes and republished April 6, 2021 Jessica Boyle

document.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 7 OF 521
 Table of Contents

1 Summary of Interface Changes ............................................................................................... 13

1.1 Interface Changes for Release 2020.07 .................................................................................. 13
1.2 Interface Changes for Release 23.0......................................................................................... 14
1.3 Interface Changes for Release 22.0......................................................................................... 15
1.4 Interface Changes for Release 21.0......................................................................................... 16
1.5 Interface Changes for Release 20.0......................................................................................... 17
1.6 Interface Changes for Release 19.0......................................................................................... 18
1.7 Interface Changes for Release 18.0......................................................................................... 21
1.8 Interface Changes for Release 17.sp4..................................................................................... 21
1.9 Interface Changes for Release 17.sp3..................................................................................... 22
1.10 Interface Changes for Release 17.sp2..................................................................................... 23
2 Overview....................................................................................................................................... 25
2.1 Purpose ...................................................................................................................................... 25
2.2 About This Document................................................................................................................ 25
2.3 Scope of This Document........................................................................................................... 25
2.3.1 Cisco BroadWorks Deployment Mode ............................................................................ 25
3 Xsi-Actions................................................................................................................................... 27
3.1 Overview .................................................................................................................................... 27
3.2 Functional Description ............................................................................................................... 27
3.2.1 Architecture and Messaging ............................................................................................ 27
3.2.2 Authorization ..................................................................................................................... 28
3.2.3 Security ............................................................................................................................. 29
3.3 Message Encoding .................................................................................................................... 29
3.3.1 Versioning ......................................................................................................................... 30
3.3.2 HTTP Headers .................................................................................................................. 30
3.3.3 HTTP Body ....................................................................................................................... 31
3.3.4 Character Sets .................................................................................................................. 32
3.3.5 File Uploading ................................................................................................................... 32
3.4 Backward Compatibility ............................................................................................................. 33
3.4.1 Requests ........................................................................................................................... 33
3.4.2 Version Value.................................................................................................................... 33
3.4.3 XML Schema .................................................................................................................... 34
3.5 Command Description............................................................................................................... 34
3.5.1 Command Listing.............................................................................................................. 34
3.5.2 User Profile Commands: /user/<userid>/profile ............................................................. 43
3.5.3 User Services Commands: /user/<userid>/services ..................................................... 68
3.5.4 User Call Commands: /user/<userid>/calls.................................................................. 208
3.5.5 User Collaborate Commands: /user/<userid>/Collaborate ......................................... 257
3.5.6 User Fax Commands: /user/<userid>/fax .................................................................... 261

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 8 OF 521
 3.5.7 User Directories Commands: /user/<userid>/directories ............................................ 264
3.5.8 User Voice Messaging Commands: /user/<userid>/VoiceMessagingMessages ...... 302
3.5.9 Call Center Profile Commands: /callcenter/<callcenterid>/profile ............................... 306
3.5.10 Call Center Call Commands: /callcenter/<callcenterid>/calls...................................... 313
3.5.11 Route Point Profile Commands: /routepoint/<routepointid>/profile............................. 316
3.5.12 Route Point Call Commands: /routepoint/<routepointid>/calls ................................... 316
3.5.13 Meet-Me Conference: /meetmeconference/<bridgeid>/conference........................... 325
3.5.14 Group Services Commands: /group/<groupid>/services ............................................ 333
3.5.15 System Commands: /system/services ......................................................................... 335
3.5.16 Version Command.......................................................................................................... 335
3.5.17 Wild Card and Flag Usage in Search Criterion ............................................................. 336
3.5.18 Paging Responses ......................................................................................................... 337
4 Xsi-Events .................................................................................................................................. 338
4.1 Overview .................................................................................................................................. 338
4.2 Functional Description ............................................................................................................. 338
4.2.1 Architecture and Messaging .......................................................................................... 338
4.2.2 Authorization and Security ............................................................................................. 345
4.2.3 Channel ........................................................................................................................... 346
4.2.4 Subscription .................................................................................................................... 347
4.3 Message Encoding .................................................................................................................. 350
4.3.1 Versioning ....................................................................................................................... 350
4.3.2 HTTP Headers ................................................................................................................ 350
4.3.3 HTTP Body ..................................................................................................................... 351
4.3.4 Character Sets ................................................................................................................ 351
4.4 Event Packages....................................................................................................................... 352
4.4.1 Basic Call ........................................................................................................................ 352
4.4.2 Standard Call .................................................................................................................. 352
4.4.3 Advanced Call ................................................................................................................. 353
4.4.4 Call Center Queue (AS Only)......................................................................................... 354
4.4.5 Route Point Queue (AS Only)........................................................................................ 355
4.4.6 Voice Mail Message Summary ...................................................................................... 356
4.4.7 Three-Way Calling .......................................................................................................... 357
4.4.8 BroadWorks Anywhere .................................................................................................. 357
4.4.9 Call Center Agent (AS Only) .......................................................................................... 357
4.4.10 Call Center Agent Monitoring (AS Only) ....................................................................... 357
4.4.11 Call Center Configuration (AS Only).............................................................................. 357
4.4.12 Call Center Monitoring (AS Only) .................................................................................. 358
4.4.13 Call Forwarding Always .................................................................................................. 358
4.4.14 Call Forwarding Always Secondary............................................................................... 358
4.4.15 Call Forwarding Busy ..................................................................................................... 358
4.4.16 Call Forwarding No Answer ........................................................................................... 358
4.4.17 Call Park .......................................................................................................................... 358

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 9 OF 521
 4.4.18 Call Transfer.................................................................................................................... 358
4.4.19 Call Waiting ..................................................................................................................... 358
4.4.20 Do Not Disturb ................................................................................................................ 359
4.4.21 Hoteling Guest ................................................................................................................ 359
4.4.22 Last Number Redial ........................................................................................................ 359
4.4.23 Meet Me Conference (AS Only) .................................................................................... 359
4.4.24 Music On Hold ................................................................................................................ 360
4.4.25 N-Way Calling ................................................................................................................. 360
4.4.26 Remote Office (AS Only)................................................................................................ 360
4.4.27 Sequential Ringing ......................................................................................................... 360
4.4.28 Simultaneous Ringing Personal..................................................................................... 360
4.4.29 Third-Party Voice Mail Support ...................................................................................... 360
4.4.30 Voice Messaging ............................................................................................................ 360
4.4.31 Security Classification (AS Only) ................................................................................... 361
4.4.32 Flexible Seating Guest (AS Only) .................................................................................. 361
4.4.33 Personal Assistant (AS Only)......................................................................................... 361
4.4.34 Collaborate Room (AS Only) ......................................................................................... 361
4.4.35 Silent Alerting (AS Only)................................................................................................. 361
4.4.36 Push Notification Registration (AS Only)....................................................................... 362
4.5 Backward Compatibility ........................................................................................................... 362
4.5.1 Events ............................................................................................................................. 362
4.6 Command Description............................................................................................................. 363
4.6.1 Command Listing............................................................................................................ 363
4.6.2 Subscription Commands ................................................................................................ 363
4.6.3 Channel Commands ...................................................................................................... 374
4.6.4 Version Command.......................................................................................................... 379
4.7 Events ...................................................................................................................................... 380
4.7.1 Call and Conference Events .......................................................................................... 380
4.7.2 Route Point Events ......................................................................................................... 414
4.7.3 Automatic Call Distribution Events................................................................................. 438
4.7.4 Agent Events................................................................................................................... 454
4.7.5 Automatic Call Distribution Configuration Events ......................................................... 457
4.7.6 CallCenterAgentMonitoringEvent .................................................................................. 459
4.7.7 CallCenterMonitoringEvent ............................................................................................ 461
4.7.8 CallForwardingAlwaysEvent .......................................................................................... 462
4.7.9 CallForwardingAlwaysSecondaryEvent ........................................................................ 463
4.7.10 CallForwardingNoAnswerEvent..................................................................................... 464
4.7.11 CallForwardingBusyEvent.............................................................................................. 464
4.7.12 HotelingGuestEvent ....................................................................................................... 465
4.7.13 DoNotDisturbEvent ......................................................................................................... 465
4.7.14 VoiceMailMessageSummaryEvent ............................................................................... 466
4.7.15 BroadWorksAnywhereEvent.......................................................................................... 466

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 10 OF 521
 4.7.16 CallTransferEvent ........................................................................................................... 467
4.7.17 CallWaitingEvent ............................................................................................................ 468
4.7.18 LastNumberRedialEvent ................................................................................................ 468
4.7.19 Meet-Me Conference Events ......................................................................................... 469
4.7.20 MusicOnHold .................................................................................................................. 487
4.7.21 N-WayCallEvent ............................................................................................................. 487
4.7.22 RemoteOfficeEvent ........................................................................................................ 488
4.7.23 ThirdPartyVoiceMailSupportEvent................................................................................. 488
4.7.24 ThreeWayCallEvent ....................................................................................................... 489
4.7.25 VoiceMessagingEvent.................................................................................................... 489
4.7.26 CommPilotExpressEvent ............................................................................................... 490
4.7.27 SequentialRingEvent ...................................................................................................... 491
4.7.28 SimultaneousRingPersonalEvent .................................................................................. 492
4.7.29 SecurityClassificationEvent ............................................................................................ 493
4.7.30 FlexibleSeatingGuestEvent............................................................................................ 493
4.7.31 PersonalAssistantEvent ................................................................................................. 494
4.7.32 SilentAlertingEvent ......................................................................................................... 495
4.7.33 PushNotificationRegistrationEvent ................................................................................ 495
4.7.34 CallParkedAgainstEvent ................................................................................................ 496
4.7.35 Collaborate Room Events .............................................................................................. 497
4.7.36 Subscription Event .......................................................................................................... 505
4.7.37 Channel Event ................................................................................................................ 505
4.7.38 PlayMusicOnHoldFailureEvent ...................................................................................... 506
5 Xsi-MMTel................................................................................................................................... 507
5.1 Overview .................................................................................................................................. 507
5.2 Functionality ............................................................................................................................. 507
5.2.1 MMTel Services Document............................................................................................ 507
5.2.2 Originating Identity Restriction Document ..................................................................... 509
5.2.3 Terminating Identity Restriction Document ................................................................... 510
5.2.4 Communication Diversion .............................................................................................. 511
5.2.5 Communication Waiting ................................................................................................. 515
5.3 Management ............................................................................................................................ 516
5.3.1 Authentication ................................................................................................................. 516
5.3.2 Error Codes ..................................................................................................................... 516
5.3.3 Test Web Page Toolkit ................................................................................................... 516
6 XML Schema.............................................................................................................................. 517
6.1 Schema Updates ..................................................................................................................... 518
Acronyms and Abbreviations........................................................................................................ 519
References ........................................................................................................................................ 521

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 11 OF 521
 Table of Figures

Figure 1 Xsi-Actions Request-response.................................................................................................. 27

Figure 2 High-level Structure ................................................................................................................... 35
Figure 3 Subscription Creation Using HTTP Contact ........................................................................... 339
Figure 4 Channel Creation ..................................................................................................................... 342
Figure 5 Event Subscription ................................................................................................................... 343
Figure 6 Event Notification ..................................................................................................................... 344
Figure 7 Channel HeartBeat .................................................................................................................. 345

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 12 OF 521
 1 Summary of Interface Changes

This section describes the changes to the Xtended Service Interface (Xsi) interface
specification.

1.1 Interface Changes for Release 2020.07

The following new Xsi-Actions commands were introduced in Release 2020.07.
/v2.0/user/<userId>/calls/<callId>/PlayMusicOnHold
/v2.0/routepoint/<routepointid>/calls/<callid>/ConnectToVoiceXML
/v2.0/user/<userid>/calls/coachagent
/v2.0/user/<userid>/calls/conference/silentmonitor
/v2.0/user/<userid>/calls/conference/supervisorcoach
/v2.0/user/<userid>/calls/conference/bargein
/v2.0/routepoint/<routepointId>/calls/<callId>/admit
/v2.0/routepoint/<routepointId>/calls/<callId>/reject
/v2.0/user/<userid>/services/CallNotify/Criteria
/v2.0/user/<userid>/services/CallNotify/Criteria/<criteriaName>
/v2.0/user/<userid>/profile/schedule/time/<scheduleName>/event
/v2.0/user/<userid>/profile/schedule/holiday/<scheduleName>/event
/v2.0/user/<userid>/profile/schedule/time/<scheduleName>/event/<eventName>
/v2.0/user/<userid>/profile/schedule/holiday/<scheduleName>/event/<eventNa
me>

The following Xsi-Actions commands were modified in Release 2020.07.

/v2.0/user/<userid>/directories/group
/v2.0/user/<userid>/directories/enterprise
/v2.0/user/<userid>/directories/agents
/v2.0/user/<userid>/directories/supervisors
/v2.0/user/<userid>/services/pushnotification
/v2.0/user/<userid>/profile/PushNotificationRegistrations
/v2.0/user/<userid>/profile/PushNotificationRegistrations/new
/v2.0/user/<userid>/profile
/v2.0/user/<userid>/directories/enhancedcalllogs
/v2.0/user/<userid>/directories/enhancedcalllogs/received
/v2.0/user/<userid>/fax
/v2.0/user/<userid>/fax/<faxid>
/v2.0/user/<userid>/profile
/v2.0/user/<userid>/profile/schedule/time
/v2.0/user/<userid>/profile/schedule/holiday
/v2.0/user/<userid>/profile/schedule/time/<scheduleName>
/v2.0/user/<userid>/profile/schedule/holiday/<scheduleName>

The following new Xsi-Events commands were introduced in Release 2020.07.

/v2.0/systemChannel
/v2.0/systemChannel/channelId>
/v2.0/systemChannelSet/<channelSetId>
/v2.0/systemSubscription
/v2.0/systemSubscription/<subscriptionId>

The following existing event packages were modified in Release 2020.07.

Standard Call
Advanced Call
Route Point Queue

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 13 OF 521
 1.2 Interface Changes for Release 23.0
The following new Xsi-Actions commands were introduced in Release 23.0.
/v2.0/user/<userid>/fax
/v2.0/user/<userid>/fax/<faxid>
/v2.0/user/<userid>/services/GETSCallingLineIDDeliveryBlocking
/v2.0/user/<userid>/services/PushNotification

The following Xsi-Actions commands were modified in Release 23.0.

/v2.0/user/<userid/profile/Registrations
/v2.0/user/<userid/profile/Device
/v2.0/user/<userid/profile/Device/<lineport>
/v2.0/user/<userid>/calls/imrn
/v2.0/user/<userid>/services/personalassistant
/v2.0/user/<userid>/services/broadworksmobility/MobileIdentity/<mobileNumb
er>
/v2.0/user/<userid>/directories/Enterprise
/v2.0/user/<userid>/directories/enterprisecommon
/v2.0/user/<userid>/directories/Group
/v2.0/user/<userid>/directories/groupcommon
/v2.0/user/<userid>/directories/Personal

The following new Xsi-Events commands were introduced in Release 23.0.

/v2.0/systemChannel
/v2.0/systemChannel/channelId>
/v2.0/systemChannelSet/<channelSetId>
/v2.0/systemSubscription
/v2.0/systemSubscription/<subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 14 OF 521
 1.3 Interface Changes for Release 22.0
The following new Xsi-Actions commands were introduced in Release 22.0.
/v2.0/user/<userid>/calls/conference/mute
/v2.0/user/<userid>/services/CallForwardingAlwaysSecondary
/v2.0/user/<userid>/services/SilentAlerting
/v2.0/user/<userid>/profile/PushNotificationRegistrations
/v2.0/user/<userid>/profile/PushNotificationRegistrations/new
/v2.0/user/<userid>/profile/device/<linePort>

The following Xsi-Actions commands were modified in Release 22.0.

/v2.0/user/<userid>/services/interceptuser
/v2.0/user/<userid>/services/collaborate
/v2.0/user/<userid>/services/collaborate/room
/v2.0/user/<userid>/services/collaborate/room/<roomid>
/v2.0/user/<userid>/directories/EnhancedCallLogs
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received
/v2.0/user/<userid>/services
/v2.0/user/<userid>/profile
/v2.0/user/<userid>/directories/Enterprise
/v2.0/user/<userid>/directories/Group
/v2.0/user/<userid>/profile/device
/v2.0/user/<userid>/calls/<callid>
/v2.0/user/<userid>/services/alternatenumbers

The following Xsi-Actions commands were deprecated in Release 22.0.

/v2.0/user/<userid>/services/attendantconsole
/v2.0/user/<userid>/services/attendantconsole/availableusers
/v2.0/user/<userid>/services/attendantconsole/displayfields
/v2.0/user/<userid>/services/attendantconsole/monitoredusers
/v1.0/user/<userid>/services/attendantconsole
/v1.0/user/<userid>/services/attendantconsole/availableusers
/v1.0/user/<userid>/services/attendantconsole/displayfields
/v1.0/user/<userid>/services/attendantconsole/monitoredusers
/v1.0/user/<userid>/services/broadworksassistantenterprise
/v2.0/user/<userid>/services/commpilotcallmanager
/v1.0/user/<userid>/services/commpilotcallmanager
/v2.0/user/<userid>/services/outlookintegration

The following new event packages were introduced in Release 22.0.

Call Forwarding Always Secondary
Silent Alerting
Push Notification Registration

The following existing event package was modified in Release 22.0.

Standard Call
Advanced Call

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 15 OF 521
 1.4 Interface Changes for Release 21.0
The following new Xsi-Actions commands were introduced in Release 21.0.
/v2.0/user/<userid>/collaborate/room/<roomid>
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>
/v2.0/user/<userid>/collaborate/room/<roomid>/outgoingdial
/v2.0/user/<userid>/collaborate/room/<roomid>/lock
/v2.0/user/<userid>/collaborate/room/<roomid>/unlock
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>/mute
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>/unmute
/v2.0/user/<userid>/collaborate/room/<roomid>/ClientSessionInfo
/v2.0/user/<userid>/profile/devicetoken
/v2.0/user/<userid>/services/broadworksmobility/MobileIdentity/<mobileNumb
er>
/v2.0/user/<userid>/services/collaborate
/v2.0/user/<userid>/services/collaborate/room
/v2.0/user/<userid>/services/NumberPortabilityAnnouncement
/v2.0/user/<userid>/services/personalassistant
/v2.0/user/<userid>/services/personalassistant/assignedcalltonumbers
/v2.0/user/<userid>/services/personalassistant/availablecalltonumbers
/v2.0/user/<userid>/services/personalassistant/exclusionnumber
/v2.0/user/<userid>/services/personalassistant/exclusionnumber/<number>
/v2.0/user/<userid>/services/personalassistant/exclusionumberlist

The following Xsi-Actions commands were modified in Release 21.0.

/v2.0/user/<userid>/services/broadworksanywhere/location/<number>/criteria
/v2.0/user/<userid>/services/BroadWorksAnywhere/Location/<number>/Criteria
/<criteriaName>
/v2.0/user/<userid>/services/broadworksmobility
/v2.0/user/<userid>/services/CallForwardingSelective/criteria
/v2.0/user/<userid>/services/CallForwardingSelective/criteria/<criterianam
e>
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria/<criteriaName>
/v2.0/user/<userid>/services/executive/filtering/criteria
/v2.0/user/<userid>/services/Executive/Filtering/Criteria/<criterianame>
/v2.0/user/<userid>/services/PriorityAlert/Criteria
/v2.0/user/<userid>/services/PriorityAlert/Criteria/<criteriaName>
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria/<criterianam
e>
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria/<criterianame
>
/v2.0/user/<userid>/calls/new
/v2.0/user/<userid>/calls/Escalate
/v2.0/user/<userid>/calls/CallPickup
/v2.0/user/<userid>/calls/CallRetrieve
/v2.0/user/<userid>/calls/CallReturn
/v2.0/user/<userid>/calls/DirectedCallPickup
/v2.0/user/<userid>/calls/DirectedCallPickupBargeIn
/v2.0/user/<userid>/calls/LastNumberRedial
/v2.0/user/<userid>/calls/ParkRetrieve
/v2.0/user/<userid>/calls/PushToTalk
/v2.0/user/<userid>/calls/SilentMonitor
/v2.0/user/<userid>/calls/SilentMonitorNext
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 16 OF 521
 The following new event packages were introduced in Release 21.0.
Personal Assistant
Collaborate Room

The following existing event package was modified in Release 21.0.

Advanced Call

1.5 Interface Changes for Release 20.0

The following new Xsi-Actions commands were introduced in Release 20.0.
/v2.0/meetmeconference/<bridgeId>/conference/<conferenceid>/ClientSessionI
nfo
/v2.0/meetmeconference/<bridgeId>/conference/<conferenceid>/PlaysSecurityC
lassification
/v2.0/user/<userid>/calls/<callid>/ClientSessionInfo
/v2.0/user/<userid>/calls/<callid>/ExecutiveAssistantCallPush
/v2.0/user/<userid>/calls/<callid>/PauseRecording
/v2.0/user/<userid>/calls/<callid>/StopRecording
/v2.0/user/<userid>/calls/ExecutiveAssistantInitiateCall
/v2.0/user/<userid>/calls/HookStatus
/v2.0/user/<userid>/directories/FlexibleSeatingHosts
/v2.0/user/<userid>/profile/LoginToken
/v2.0/user/<userid>/services/Executive
/v2.0/user/<userid>/services/Executive/Assistants/Availableusers
/v2.0/user/<userid>/services/Executive/Assistants
/v2.0/user/<userid>/services/Executive/Assistants/AssignedUsers
/v2.0/user/<userid>/services/Executive/Filtering
/v2.0/user/<userid>/services/Executive/Filtering/Criteria
/v2.0/user/<userid>/services/Executive/Filtering/Criteria/<criterianame>
/v2.0/user/<userid>/services/Executive/Screening
/v2.0/user/<userid>/services/Executive/Alerting
/v2.0/user/<userid>/services/ExecutiveAssistant
/v2.0/user/<userid>/services/FlexibleSeatingGuest
/v2.0/user/<userid>/services/SecurityClassification
/v2.0/user/<userid>/voicemessagingmessages
/v2.0/user/<userid>/voicemessagingmessages/markAllAsUnread
/v2.0/user/<userid>/voicemessagingmessages/markAllAsRead
/v2.0/user/<userid>/voicemessagingmessages/<messageId>
/v2.0/user/<userid>/voicemessagingmessages/<messageId>/markAsUnread
/v2.0/user/<userid>/voicemessagingmessages/<messageId>/markAsRead
/v2.0/versions

The following existing Xsi-Actions commands were modified in Release 20.0.

/v2.0/callcenter/<callcenterid>/profile
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>
/v2.0/meetmeconference/<bridgeid >/conference/<conferenceid>/outgoingdial
/v2.0/services/BroadworksAnywhere/Location/<location>/Criteria/<criteriana
me>
/v2.0/user/<userid>/calls/<callid>
/v2.0/user/<userid>/calls/<callid>/blindtransfer

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 17 OF 521
 /v2.0/user/<userid>/calls/<callid>/record
/v2.0/user/<userid>/calls/imrn
/v2.0/user/<userid>/calls/new
/v2.0/user/<userid>/directories/CustomContact/<directoryname>
/v2.0/user/[userId]/directories/Enterprise
/v2.0/user/<userid>/directories/EnterpriseCommon
/v2.0/user/<userid>/directories/EnhancedCallLogs
/v2.0/user/<userid>/directories/ EnhancedCallLogs/Missed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received
/v2.0/user/[userId]/directories/Group
/v2.0/user/<userid>/directories/GroupCommon
/v2.0/user/<userid>/directories/Personal
/v2.0/user/<userid>/profile
/v2.0/user/<userid>/profile/Registrations
/v2.0/user/<userid>/profile/Schedule/
/v2.0/user/<userid>/profile/Schedule/Time
/v2.0/user/<userid>/profile/Schedule/Holiday
/v2.0/user/<userid>/profile/Schedule/Time/<scheduleName>
/v2.0/user/<userid>/profile/Schedule/Holiday/<scheduleName>
/v2.0/user/<userid>/services/broadworksmobility
/v2.0/user/<userid>/services/callrecording

The following new Xsi-Events command was introduced in Release 20.0.

/v2.0/versions

The following new event packages were introduced in Release 20.0.

Flexible Seating Guest
Security Classification

The following existing event packages were modified in Release 20.0.

Advanced Call
Basic Call
Call Center Queue
Meet Me Conference
Route Point Queue
Standard Call

The following existing event package was deprecated in Release 20.0.

Call Recording

1.6 Interface Changes for Release 19.0

The following new Xsi-Actions commands were introduced in Release 19.0.
/v2.0/user/<userid>/services/BroadworksMobility
/v2.0/user/<userid>/services/CallForwardingSelective/criteria
/v2.0/user/<userid>/services/CallForwardingSelective/criteria/<criteriaNam
e
/v2.0/user/<userid>/services/CallingNameDelivery
/v2.0/user/<userid>/services/CallingNumberDelivery

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 18 OF 521
 /v2.0/user/<userid>/services/CallMeNow
/v2.0/user/<userid>/services/CallMeNow/Criteria
/v2.0/user/<userid>/services/CallMeNow/Criteria/<criteriaName>
/v2.0/user/<userid>/services/GroupNightForwarding
/v2.0/user/<userid>/services/InCallServiceActivation
/v2.0/user/<userid>/services/LegacyAutomaticCallback
/v2.0/user/<userid>/services/MwiDeliveryToMobileEndpoint
/v2.0/user/<userid>/services/OutgoingMwi
/v2.0/user/<userid>/services/OutlookIntegration
/v2.0/user/<userid>/services/PriorityAlert
/v2.0/user/<userid>/services/PriorityAlert/Criteria
/v2.0/user/<userid>/services/PriorityAlert/Criteria /<criteriaName>
/v2.0/user/<userid>/services/Privacy
/v2.0/user/<userid>/services/privacy/AllowedUsers
/v2.0/user/<userid>/services/privacy/AvailableUsers
/v2.0/user/<userid>/services/PushTotalk
/v2.0/user/<userid>/services/PushTotalk/AllowedUsers
/v2.0/user/<userid>/services/PushTotalk/AvailableUsers
/v2.0/user/<userid>/services/SelectiveCallAcceptance
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria/<criterianam
e>
/v2.0/user/<userid>/services/SelectiveCallRejection
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria/<criterianame
>
/v2.0/user/<userid>/services/SequentialRing/Criteria
/v2.0/user/<userid>/services/SequentialRing/Criteria/<criterianame>
/v2.0/user/<userid>/services/SimultaneousRingPersonal/Criteria
/v2.0/user/<userid>/services/SimultaneousRingPersonal/Criteria/<criteriana
me>
/v2.0/user/<userid>/services/ThirdPartyVoicemailSupport
/v2.0/user/<userid>/services/VoiceMessaging
/v2.0/user/<userid>/services/VoiceMessaging/Aliases
/v2.0/user/<userid>/services/VoiceMessaging/Aliases/<phoneNumber>
/v2.0/user/<userid>/services/VoiceMessaging/DistributionLists/<listid>
/v2.0/user/<userid>/services/VoiceMessaging/Greetings
/v2.0/user/<userid>/services/VoiceMessaging/MailServer
/v2.0/user/<userid>/services/VoicePortal
/v2.0/user/<userid>/calls/<callid>/FindMeFollowMeCallPush/<callId>
/v2.0/user/<userid>/calls/imrn

The following existing Xsi-Actions commands were modified in Release 19.0.

/v2.0/callcenter/<callcenterid>/profile
/v2.0/group/<groupid>/services/CallCenter/ExternalReporting
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/outgoingdial
/v2.0/user/<userid>/calls/<callid>
/v2.0/user/<userid>/directories/EnhancedCallLogs
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed
/v2.0/user/<userid>/directories/Eenhancedcalllogs/Missed
/v2.0/user/<userid>/directories/Enhancedcalllogs/Received

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 19 OF 521
 /v2.0/user/<userid>/directories/Enterprise
/v2.0/user/<userid>/directories/Group
/v2.0/user/<userid>/IMPProfile/
/v2.0/user/<userid>/profile/Device
/v2.0/user/<userid>/profile/Registrations
/v2.0/user/<userid>/services/BroadWorksAnywhere
/v2.0/user/<userid>/services/BroadworksMobility
/v2.0/user/<userid>/services/CallCenter
/v2.0/user/<userid>/services/CallForwardingSelective
/v2.0/user/<userid>/services/CommPilotExpress
/v2.0/user/<userid>/services/CustomRingbackUser
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria/<criteriaName>
/v2.0/user/<userid>/services/CommPilotExpress/Profile
/v2.0/user/<userid>/services/Meetmeconference/<bridgeid>/conference
/v2.0/user/<userid>/services/MeetMeConference/<bridgeid>/conference/<meetm
econferenceId>

The following existing Xsi-Actions commands were deprecated in Release 19.0.

/v2.0/user/<userid>/services/customringbackuser/criteriaactivation
/v2.0/user/<userid>/services/directories/reportingServer

The following new Xsi-Events command was introduced in Release 19.0.

/v2.0/user/<userid>/subId/<subid>

The following existing Xsi-Events commands were modified in Release 19.0.

/v2.0/channel
/v2.0/channelset/<channelsetid>
/v2.0/enterprise/<enterpriseId>
/v2.0/enterprise/<enterpriseId>/group/<groupId>
/v2.0/serviceprovider/<serviceProviderId>
/v2.0/serviceprovider/<serviceProviderId>/group/
<groupId>
/v2.0/subscription
/v2.0/subscription/<subscriptionId>
/v2.0/system
/v2.0/user/<userId>

The following new event packages were introduced in Release 19.0.

Meet Me Conference

The following existing event packages were modified in Release 19.0.

Advanced Call
Basic Call
Call Center Agent
Call Center Agent Monitoring
Call Center Monitoring
Call Center Queue
Meet Me Conference
Standard Call

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 20 OF 521
 1.7 Interface Changes for Release 18.0
The following new Xsi-Actions commands were introduced in Release 18.0.
/v2.0/user/<userid>/services/integratedimp
/v2.0/user/<userid>/profile/device
/v2.0/user/<userid>/profile/impprofile

The following existing Xsi-Actions commands were modified in Release 18.0.

/v2.0/user/<userid>/profile
/v2.0/user/<userid>/services/attendantconsole/availableusers
/v2.0/user/<userid>/services/busylampfield/availableusers
/v2.0/user/<userid>/services/bwreceptionist
/v2.0/user/<userid>/services/bwreceptionist/monitoredusers
/v2.0/user/<userid>/services/bwreceptionist/availableusers
/v2.0/user/<userid>/directories/customcontact/<directoryname>
/v2.0/user/<userid>/directories/enterprise
/v2.0/user/<userid>/directories/group
/v2.0/user/<userid>/directories/supervisors
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/setlecturemode

No new Xsi-Events commands were introduced in Release 18.0. No existing Xsi-Events

commands were modified in Release 18.0.
No event packages were introduced or modified in Release 18.0.

1.8 Interface Changes for Release 17.sp4

The following new Xsi-Actions commands were introduced in Release 17.sp4.
/v2.0/user/<userid>/services/callrecording
/v2.0/user/<userid>/calls/<callid>/record
/v2.0/user/<userid>/calls/<callid>/callretrieve

The following existing Xsi-Actions commands were modified in Release 17.sp4.

/v2.0/user/<userid>/profile
/v2.0/user/<userid>/calls/new
/v2.0/user/<userid>/calls/<callid>
/v2.0/user/<userid>/calls/escalate
/v2.0/user/<userid>/calls/callpickup
/v2.0/user/<userid>/calls/callreturn
/v2.0/user/<userid>/calls/directedcallpickup
/v2.0/user/<userid>/calls/directedcallpickupbargein
/v2.0/user/<userid>/calls/lastnumberredial
/v2.0/user/<userid>/calls/parkretrieve
/v2.0/user/<userid>/calls/pushtotalk
/v2.0/user/<userid>/calls/silentmonitor
/v2.0/user/<userid>/calls/silentmonitornext
/v2.0/user/<userid>/directories/enhancedcalllogs
/v2.0/user/<userid>/directories/enhancedcalllogs/missed
/v2.0/user/<userid>/directories/enhancedcalllogs/placed
/v2.0/user/<userid>/directories/enhancedcalllogs/received

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 21 OF 521
 No new Xsi-Events commands were introduced in Release 17.sp4. No existing Xsi-
Events commands were modified in Release 17.sp4.
The following new event package was introduced in Release 17.sp4.
Call Recording

The following existing event packages were modified in Release 17.sp4.

Basic Call
Standard Call
Advanced Call

1.9 Interface Changes for Release 17.sp3

The following new Xsi-Actions commands were introduced in Release 17.sp3.
/v2.0/user/<userid>/services/meetmeconference
/v2.0/user/<userid>/services/meetmeconference/<bridgeid>
/v2.0/user/<userid>/services/meetmeconference/<bridgeid>/conference
/v2.0/user/<userid>/services/meetmeconference/<bridgeid>/conference/<confe
renceid>
/v2.0/user/<userid>/calls/callmenow
/v2.0/user/<userid>/calls/conference/unmute
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/outgoingdial
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/mute
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/unmute
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/hold
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/retrieve
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>lock
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>unlock
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/startrecording
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/pauserecording
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/resumerecordin
g
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/stoprecording
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/setlecturemode
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/unsetlecturemo
de

The following existing Xsi-Actions commands were modified in Release 17.sp3.

/v2.0/user/<userid>/services/callcenter
/v2.0/user/<userid>/directories/agents
/v2.0/user/<userid>/directories/callcenters
/v2.0/callcenter/<callcenterid>/profile

No new Xsi-Events commands were introduced in Release 17.sp3. No existing Xsi-

Events commands were modified in Release 17.sp3.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 22 OF 521
 The following new event package was introduced in Release 17.sp3.
Call Park

The following existing event packages were modified in Release 17.sp3.

Call Center Agent
Call Center Configuration
Call Center Queue
Route Point Queue

1.10 Interface Changes for Release 17.sp2

The following new Xsi-Actions commands were introduced in Release 17.sp2.
/v2.0/user/<userid>/directories/enterprisecommon
/v2.0/user/<userid>/directories/groupcommon
/v2.0/user/<userid>/directories/CallLogs/Missed/<callLogId>
/v2.0/user/<userid>/directories/CallLogs/Placed/<callLogId>
/v2.0/user/<userid>/directories/CallLogs/Received/<callLogId>
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed/<callLogId>
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed/<callLogId>
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received/<callLogId>
/v2.0/user/<userid>/directories/ReportingServers
/v2.0/user/<userid>/services/AgentCallCenterAssignedStatus
/v2.0/user/<userid>/services/CallCenterMonitoring
/v2.0/group/<groupid>/services/CallCenter/ExternalReporting

The following existing Xsi-Actions commands were modified in Release 17.sp2.

/v2.0/user/<userid>/directories/Agents
/v2.0/user/<userid>/directories/CallLogs
/v2.0/user/<userid>/directories/CallLogs/Missed
/v2.0/user/<userid>/directories/CallLogs/Received
/v2.0/user/<userid>/directories/CallLogs/Placed
/v2.0/user/<userid>/directories/CustomContact/<directoryName>
/v2.0/user/<userid>/directories/EnhancedCallLogs
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received
/v2.0/user/<userid>/directories/Enterprise
/v2.0/user/<userid>/directories/Group
/v2.0/user/<userid>/directories/Personal
/v2.0/user/<userid>/services/AttendantConsole/AvailableUsers
/v2.0/user/<userid>/services/BwReceptionist
/v2.0/user/<userid>/services/BwReceptionist/AvailableUsers
/v2.0/user/<userid>/services/BwReceptionist/MonitoredUsers
/v2.0/user/<userid>/services/BusyLampField/AvailableUsers
/v2.0/user/<userid>/services/CallCenter

No new Xsi-Events commands were introduced in Release 17.sp2. No existing Xsi-

Events commands were modified in Release 17.sp2.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 23 OF 521
 The following new event packages were introduced in Release 17.sp2.
Call Center Agent Monitoring
Call Center Monitoring

The following existing event package was modified in Release 17.sp2.

Call Center Agent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 24 OF 521
 2 Overview

2.1 Purpose
This document is the specification of the Xtended Service Interface. The Xtended Service
Interface (hereafter referred to as the Xsi interface) allows remote applications to integrate
with Cisco BroadWorks to perform telephony-related actions and to be notified about
telephony events against subscribers hosted in a Cisco BroadWorks-powered network.
The Cisco BroadWorks Xsi interface allows applications to control a subscriber’s
telephony experience by supporting various kinds of call control requests and notifications.
The interface defines a rich set of requests for call control, as well as services, and
publishes or generates events that are used to inform applications about both call and
service-related activity that occurs for subscribers.
For the remainder of this document, the “Xsi interface” and “interface” are used
interchangeably, as are the terms “remote application” and “external application”.

2.2 About This Document

Each section in this specification document serves a distinct purpose as follows:
 Section 3 Xsi-Actions describes the Xsi-Actions application programming interfaces
(APIs). These APIs allow a remote application to control and query Cisco
BroadWorks. The section contains a functional description along with information on
message encoding and backward compatibility. It also provides a detailed description
of each command offered.
 Section 4 Xsi-Events describes the Xsi-Events APIs and event notification
mechanism. This API is used by a remote application to be notified when activity
occurs for Cisco BroadWorks-based subscriber. The section contains a functional
description along with information on message encoding and backward compatibility.
It also provides a detailed description of events and available event packages.
 Section 5 Xsi-MMTel describes the XSI-MMTel APIs. MMTel is a specification for
simulation services that are standard in the existing public switched telephone
network (PSTN)/Integrated Services Digital Network (ISDN) network.
 Section 6 XML Schema describes the structure of the XML schema.

2.3 Scope of This Document

This document describes the functionality provided by Xsi-Actions, Xsi-Events and Xsi-
MMTel.
It assumes understanding of the call and service management concepts used by Cisco
BroadWorks. For more information on these concepts, see the Cisco BroadWorks
Computer Telephony Integration Interface Specification [2].

2.3.1 Cisco BroadWorks Deployment Mode

Depending on the deployment configuration, Cisco BroadWorks subscribers can be
hosted on two types of Telephony Application Servers (TASs): An Execution Server or an
Application server. The two server types can co-exist within the same network, however
not all functionality is supported by the Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 25 OF 521
 Cisco BroadWorks returns an error when an attempt is made to use a command not
available on an Execution Server. For instance, the command to query the hoteling
service configuration for a user hosted on an Execution Server returns an error because
the hoteling service is not supported on an Execution Server.
This document describes the Xsi interface functionality available for both the Application
Server and Execution Server. When applicable, it indicates which functionality returns an
error when invoked for a user hosted on an Execution Server.
When supported only on a specific TAS, the section header of a command or event
package is identified with either “AS Only” (Application Server) Only or “XS Only”
(Execution Server) Only, where applicable.
For more information on the functionality supported service by an Execution Server, see
the Cisco BroadWorks Feature Overview [7] and the Cisco BroadWorks XS Mode
Configuration Guide [8].

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 26 OF 521
 3 Xsi-Actions

3.1 Overview
Xsi-Actions are a set of RESTful APIs that allow access to resources on Cisco
BroadWorks. For more information on REST, see the RESTful Web Services [1] . Each
action is initiated by a client on a resource and a response is returned from a server. The
action can be a modification or retrieval of data. Xsi-Actions expose a broad spectrum of
functionality to support a variety of web applications. The areas exposed are:
 Call Management – Exposes real-time call control primitives, such as, Click To Dial,
Answer, Hold, Transfer, and so on.
 Call Status – Exposes the real-time abilities to retrieve the list of active calls and
determine the call state of those calls.
 Call Lists – Exposes the commonly accessed lists, such as placed, received, and
missed call logs, as well as enterprise, group, and personal directories.
 Service Management – Exposes the ability to retrieve and configure services
managed by the Cisco BroadWorks Application Server.
Xsi-Actions allow applications to operate on Cisco BroadWorks resources (for example,
services or calls) using only the Hypertext Transfer Protocol (HTTP) and eXtensible
Markup Language (XML).

3.2 Functional Description

3.2.1 Architecture and Messaging

The Xsi-Actions is a Web Application that runs in a container like the Cisco BroadWorks
Xtended Services Platform (Xsp). Xsi-Actions is responsible for authenticating the
requests received from the remote application. It is also responsible for providing request
and response mapping and for routing events received from the Cisco BroadWorks core.
When an HTTP request is received from the remote application and successfully
authenticated, then the request is processed by the Cisco BroadWorks core and an
appropriate response is generated.

Figure 1 Xsi-Actions Request-response

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 27 OF 521
 3.2.2 Authorization
The Xsi-Actions is responsible for the authentication of the requesting user before
performing the transaction being requested.
The Xsi-Actions performs authorization using HTTP Basic Authentication. It should be
noted that this authorization is not secure unless it is used over Hypertext Transfer
Protocol Secure Sockets (HTTPS), which is the recommended configuration.
The Xsi-Actions supports two models for authentication:
 Internal Authentication – The Xsi performs a transaction against the Cisco
BroadWorks core system to determine if the user is valid. This assumes that Cisco
BroadWorks is the repository used for user and password data.
 External Authentication – The Xsi performs a transaction to a customer-provided
authentication server, such as Site Minder, or some other Lightweight Directory
Access Protocol (LDAP) database.
Lastly, it should be noted that the Xsi-Actions returns a cookie that is pre-authorized, which
can be used for a period of time so that subsequent requests do not need to be
authorized. It is recommended that this cookie be used to reduce the load on the system
for applications that perform multiple requests. It should be noted, however, that an
authorization header is still required even when using the cookie. (It is only for
performance optimization). The user’s session can be invalidated by sending a request to
a URL that ends with “/j_logout”.

3.2.2.1 Internal Authentication

Internal Authentication is provided by default by Cisco BroadWorks. This requires all
passwords to be stored on Cisco BroadWorks and to be maintained there. After the user
is authorized, the request is sent to the appropriate place to be completed. It should be
noted that authorization requests place a load on the core system when using Internal
Authentication.

3.2.2.2 External Authentication

External Authentication is performed by a carrier-provided authentication server. All
authorizations are performed on this server before the request is processed by the Cisco
BroadWorks server. For more information, see the Cisco BroadWorks External Portal
Integration Guide Developer’s Guide [4].

3.2.2.3 Authorization with DN

In addition to authentication with a user ID and password, the Xsi-Actions web application
allows authorization using a directory number (DN) and voice portal code. This allows
applications, which cannot accept anything other than digits entered with a keypad, to
authorize and use Xsi-Actions.
All end-user authorizations can perform this type of authentication. However, you cannot
use a mix, such as, user ID and voice portal code or DN and password.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 28 OF 521
 3.2.2.4 Authentication with SIP
In addition to authentication with a user ID and password, the Xsi-Actions web application
allows authentication using a user ID, SIP username, and password. This allows devices,
which already have the SIP credentials, to be authenticated and use Xsi-Actions.
Rather than using HTTP Basic Authentication, this method uses a custom HTTP
Authorization header that is similar to Basic Authentication and is formed as follows:
Authorization: BroadWorksSIP
basic=”base64(userId:sipPassword)”,sipUser=”base64(sipUsername)”

3.2.3 Security
The Xsi-Actions has been designed for deployment in a Web 2.0 environment whereby
end users can create applications to access their data on the Cisco BroadWorks platform.
This openness, by definition, provides a greater opportunity for applications to cause
problems in the network by accident, for example, either by a poorly written application or
on purpose, by a denial of service attack.
The following security capabilities are part of the Xsi:
 Authentication – All requests to be processed must be authenticated before being
processed. The authentication is performed by the Xsi before reaching the core
network so that unauthenticated requests have no impact on the core network.
Requests without authentication are challenged with a 401 Unauthorized.
 Encryption – The Xsi supports the HTTPS Secure Sockets Layer (SSL) so that
usernames, passwords, and contents are protected from snooping. It is
recommended that all applications use HTTPS. HTTP is permitted but can be turned
off so that the Xsi only accepts HTTPS requests.
 Overload Controls – The Xsi has controls to restrict the transaction rate that it
processes, as well as the transaction rate per any user, to protect the core network
from a denial of service attack or from an unreasonable number of requests.
 Scope Control – The Xsi can be configured to only allow certain resources to be
accessed. This would allow a configuration to not allow directories or certain services,
if desired. In addition, the real-time components of call control and call states can be
restricted on a per user basis, if desired.
In addition, the core network has the standard Cisco BroadWorks security policies, such
as Overload Controls.

3.3 Message Encoding

Each Xsi-Actions command is encoded in an HTTP request and is identified using the
following attributes:
 Uniform Resource Locator (URL) in the form: http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/…
 Method: GET, POST, DELETE or PUT
Some commands have mandatory or optional parameters that are included in the query
string of the request. For example:
http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/<command>?parm1=val1&parm2=val2

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 29 OF 521
 For each command listed in this document, the mandatory and optional parameters are
described along with their allowed values and other information. It should be noted that
the order of inclusion of parameters is not relevant and unrecognized parameters included
in the query string are simply ignored by Cisco BroadWorks. A parameter can appear
more than once in a query string. This is typically used to specify different values for a
parameter that is used as a search criterion.
Example:
…&multiValueParm=Value1& multiValueParm=Value2& multiValueParm=Value3
Note that if multiple values are present for a parameter, then the decision as to whether to
apply a logical OR operation or a logical AND operation among these values depends on
the parameter specification.
Whether a query parameter can contain multiple values depends only on the parameter
specification. In cases where the URL query strings erroneously contain multiple values
for a parameter, then only the first value is taken into consideration.
In the following example, only Value1 is considered and Value2 is ignored.
…&singleValueParm=Value1&singleValueParm=Value2

3.3.1 Versioning
Xsi-Actions commands are versioned in two ways:
 Using the URL version information specified in the URL itself (“/v2.0/” in the URL).
The URL version allows Cisco to introduce significant changes to command structures
and schemas without breaking backward compatibility to prior Xsi-Actions versions.
This document covers only Xsi command URL version v2.0.
 Using the protocol version information specified in the HTTP header. This version
header is used to identify the exact protocol version of a “v2.0” URL. The protocol
version allows Cisco to introduce smaller changes or improvements to existing
commands, while also maintaining backward compatibility. For more information, see
section 3.4.1.1 Specify Request Version.

3.3.2 HTTP Headers

HTTP request headers of interest to Xsi from the remote application include the following:
 Authorization: Contains the user credentials.
 Content-type: Should be set to “application/xml; charset=UTF-8” (recommendation,
that is not enforced by Xsi). It can also contain “application/json”. For more
information, see section 3.3.3 HTTP Body.
 X-BroadWorks-Protocol-Version: This header is optional. When set, it specifies the
Xsi-Actions protocol version to use. For more information, see section 3.4.1.1 Specify
Request Version.
 Accept: This header is optional and can be set to “application/json”. For more
information, see section 3.3.3 HTTP Body.
HTTP response headers of interest to the remote application and sent by Xsi-Action
include the following:
 Status header with status code 200, 201, and so on
 Content-type: “application/xml” or “application/json”. The character set (charset)
depends on the type of response. For more information, see section 3.3.4 Character
Sets.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 30 OF 521
 3.3.3 HTTP Body
The body of an Xsi-Action request or response can optionally carry a whole eXtensible
Markup Language (XML) document. The body can be sent by the client on a PUT or
POST or returned to the client on a GET. The XML document must conform to the Xsi
schema provided.

3.3.3.1 JSON
JSON is a lightweight text-based format for representing simple data structures. JSON is
provided as an alternative to XML. The Xsi-Actions web application effectively translates
from JSON-to-XML when it receives request with JSON-formatted contents and translates
from XML-to-JSON when it sends responses to client applications that are expecting
JSON-formatted contents. The BadgerFish convention (see What is BadgerFish? [9]) is
used for the translation and is described as follows for convenience.
A remote application can indicate that it is sending JSON-formatted data in a
PUT/POST/DELETE in two ways:
 By setting the content-type HTTP header to “application/json”.
 By adding a request parameter format with value “json” in the URL. Note that the
URL should appear as usual with the “format=json” appended to it. For example:
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/DoNotDisturb?format=json

Similarly, a remote application can indicate that it is expecting JSON-formatted data in a

GET in two ways:
 By setting the accept HTTP header to “application/json”.
 By adding a request parameter format with value “json” in the URL. The URL should
look like as usual with a “format=json” appended to it.

3.3.3.1.1 Translation Conventions

The BadgerFish convention is used for translating to/from XML. Client applications are
expected to adhere to these conventions when using the Xsi-Actions web application in
the JSON format.
 Element names become object properties.
 Text content of elements go in the $ property of an object.
 Nested elements become nested properties.
 Multiple elements at the same level become array elements.
 Attributes go in properties where the names begin with “@”.
 Active namespaces for an element go in the element’s @xmlns property.
 The default namespace URI goes in @xmlns.$.
 Other namespaces go in other properties of @xmlns.
 Elements with namespace prefixes become object properties, too.
The BadgerFish convention is followed completely, barring one aspect, that is, that
BadgerFish populates @xmlns in all elements where a namespace is active and not just in
the elements where the namespace is declared. This is not followed during the translation
to/from XML.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 31 OF 521
 The following is an example of JSON-formatted Xsi response data.
{
"DoNotDisturb":{
"@xmlns":{"$":"http://schema.broadsoft.com/xsi"},
"isActive":{"$":"true"},
"ringSplash":{"$":"true"}
}
}

3.3.4 Character Sets

The following describes how Xsi-Actions determines the character set to use for the
encoding of message bodies included in responses:
 Profile, service, and directory command responses – The authorized user’s locale
determines the character set used.
 Call command responses – UTF-8 is always used.
 Platform-level error responses – The Xtended Services Platform’s default character
set is used.

3.3.4.1 Slash Character in Cisco BroadWorks Identifiers

The slash character (“/”) is not allowed in identifiers. Although some identifiers such as
user ID can be provisioned with a slash character, they cannot be referenced from Xsi
applications (Xsi-Actions and Xsi-Events).

3.3.5 File Uploading

A few commands allow clients to upload or specify files through the XML elements
<content> or <sourceFileName>.
The source file name can be either a URI indicating where to download the file (the web
server hosting the file must support WebDAV and must be on the External Authentication
Network Access List) or a local path where the file is stored on the Application Server or
Profile Server. The path can be absolute or relative to
/var/broadworks/userfiles/customFiles/.
The content element is the base64 encoded content of the file to upload.
The following example shows how to use the <content> XML element to upload a custom
ringback WAV file while using the
/v2.0/user/<userid>/services/customringbackuser/criteria/<criterianame> command PUT
method.
<?xml version="1.0" encoding="UTF-8"?>
<CustomRingbackUserCriteria xmlns="http://schema.broadsoft.com/xsi">
<criteria>
<criteriaName>Always</criteriaName>
</criteria>
<audioFileDetails>
<fileDescriptor>
<fileTypeSelected>File</fileTypeSelected>
<mediaType>WAV</mediaType>
<file>
<content>UklGRvwyAgBXQVZFZm10IBIAAAA...</content>
</file>
<fileDescription>Custom Ring</fileDescription>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 32 OF 521
 </fileDescriptor>
</audioFileDetails>
</CustomRingbackUserCriteria>

3.4 Backward Compatibility

Beginning with Release 17.0, Xsi-Actions is backward compatible for up to two major
releases of Cisco BroadWorks. This allows Cisco BroadWorks to be upgraded without
requiring code changes to the remote application that interworks with Cisco BroadWorks.

3.4.1 Requests
Each Xsi-Actions request is versioned. The remote application sending a request
specifies the request version by specifying the version with the request. Examples of
request versions are “19.0”, “20.0”, and so on.
Each version maps to a specific request functionality. If any change occurs in a request
parameter or in the parameters included in the response returned by Cisco BroadWorks,
then a new version of the request is created and the existing version remains unchanged.
A remote application issuing a request that provides a specific version always receives the
same response format, for as long as that version of the request is supported by Cisco
BroadWorks. A versioned request is supported for two major Cisco BroadWorks releases,
after which, issuing that version of the request results in a “method not supported” error
response.

3.4.1.1 Specify Request Version

The HTTP header X-BroadWorks-Protocol-Version is used to specify the request version.
The version header needs to accompany a request for Cisco BroadWorks to execute the
command at the version of the request that is present in the version header. If the version
header is not specified, the version used corresponds to the release number of the active
Xtended Service Platform Server.

3.4.1.2 Example
Assuming an existing request in BroadWorks Release 20.0 is modified in Release 21.0
(for example, an additional parameter is returned in the response), a remote application
could issue a request with X-BroadWorks-Protocol-Version set to “20.0” or “21.0”. In this
case, specifying “20.0” against a BroadWorks 21.0 deployment returns a response
identical to the one issued for a 20.0 deployment. Specifying “21.0” returns a response
with the changes as documented for the command’s new version.

3.4.2 Version Value

Xsi-Actions request versions are defined using a character string. In general, this string
corresponds to the major Cisco BroadWorks release number (for example "20.0") the
request was introduced. In some cases, however, requests are made available earlier
through the use of intermediate version value (for example "18.sp3", "19.sp5", and so on).
As a result, the request versions can differ from the Cisco BroadWorks software release
number.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 33 OF 521
 To illustrate this, look at the following example. A new
/v2.0/user/<userid>/services/DoNotDisturb GET request is introduced in BroadWorks
Release 20.0 and is made available in Release 19.0 through a software patch. This
software patch provides access to this new functionality by introducing version “19.sp5” of
the /v2.0/user/<userid>/services/DoNotDisturb GET request. As a result, a remote
application can make use of the new functionality by setting the version to “19.sp5” in the
request or could access the former functionality by leaving the version set to “19.0”.

3.4.3 XML Schema

The XML schema defines types used by the Xsi and is published with every release of
Cisco BroadWorks. A schema is associated to an Xsi-Actions version (that is, the schema
associated with Xsi version “21.0” is made available with BroadWorks Release 21.0).
The XML schema can also be published if software patches introduces an Xsi-Actions
change within a release (that is, the schema for Xsi-Actions version “19.sp5” is published
along with its associated software patch).
The changes to the schema are documented with the schema files. For example,
assuming the DoNotDisturb type has been modified; schema files in the Cisco
BroadWorks release in which the modification occurred would document this change.
For more information on the XML schema, see section 4.5.1.4 XML Schema.

3.5 Command Description

3.5.1 Command Listing

Each Xsi-Actions command URL is located in the high-level structure illustrated in
Figure 2.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 34 OF 521
 /com.broadsoft.xsi-actions/v2.0

/user/<userid>

/profile /directories /collaborate

/services /voicemessagingmessages /fax

/calls /directories

/callcenter/<callcenterid>

/profile /calls

/routepoint/<routepointid>

/profile /calls

/meetmeconference/<bridgeid>

/conference

/group/<groupid>

/system

/versions

Figure 2 High-level Structure

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 35 OF 521
 The remainder of this section lists each Xsi-Actions command. These listings represent
the complete API for Xsi-Actions. Since http(s)://<host:port>/com.broadsoft.xsi-actions is
common to all command URLs, the following listings begin with /v2.0.

3.5.1.1 User Profile Commands

/v2.0/user/<userid>/profile
/v2.0/user/<userid>/profile/Device
/v2.0/user/<userid>/profile/DeviceToken
/v2.0/user/<userid>/profile/Fac
/v2.0/user/<userid>/profile/IMPProfile
/v2.0/user/<userid>/profile/LoginToken
/v2.0/user/<userid>/profile/Password/Portal
/v2.0/user/<userid>/profile/Schedule
/v2.0/user/<userid>/profile/Schedule/Holiday
/v2.0/user/<userid>/profile/Schedule/Holiday/<scheduleName>
/v2.0/user/<userid>/profile/Schedule/Time
/v2.0/user/<userid>/profile/Schedule/Time/<scheduleName>
/v2.0/user/<userid>/profile/Registrations

3.5.1.2 User Services Commands

/v2.0/user/<userid>/services
/v2.0/user/<userid>/services/AccountCodes
/v2.0/user/<userid>/services/agentCallCenterAssignedStatus
/v2.0/user/<userid>/services/AlternateNumbers
/v2.0/user/<userid>/services/AnonymousCallRejection
/v2.0/user/<userid>/services/AttendantConsole
/v2.0/user/<userid>/services/AttendantConsole/AvailableUsers
/v2.0/user/<userid>/services/AttendantConsole/DisplayFields
/v2.0/user/<userid>/services/AttendantConsole/MonitoredUsers
/v2.0/user/<userid>/services/AutomaticCallback
/v2.0/user/<userid>/services/AutomaticHoldRetrieve
/v2.0/user/<userid>/services/BargeInExempt
/v2.0/user/<userid>/services/BroadWorksAnywhere
/v2.0/user/<userid>/services/BroadWorksAnywhere/Location
/v2.0/user/<userid>/services/BroadWorksAnywhere/Location/<number>
/v2.0/user/<userid>/services/BroadWorksAnywhere/Location/<number>/Criteria
/v2.0/user/<userid>/services/BroadWorksAnywhere/Location/<number>/Criteria
/<criteriaName>
/v2.0/user/<userid>/services/BroadworksMobility
/v2.0/user/<userid>/services/BroadworksMobility/MobileIdentity/<mobileNumb
er>
/v2.0/user/<userid>/services/BusyLampField
/v2.0/user/<userid>/services/BusyLampField/MonitoredUsers
/v2.0/user/<userid>/services/BusyLampField/AvailableUsers
/v2.0/user/<userid>/services/BwReceptionist
/v2.0/user/<userid>/services/BwReceptionist/MonitoredUsers
/v2.0/user/<userid>/services/BwReceptionist/AvailableUsers
/v2.0/user/<userid>/services/CallCenter
/v2.0/user/<userid>/services/CallCenterMonitoring
/v2.0/user/<userid>/services/CallForwardingAlways
/v2.0/user/<userid>/services/CallForwardingBusy

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 36 OF 521
 /v2.0/user/<userid>/services/CallForwardingNoAnswer
/v2.0/user/<userid>/services/CallForwardingNotReachable
/v2.0/user/<userid>/services/CallForwardingSelective
/v2.0/user/<userid>/services/CallForwardingSelective/criteria
/v2.0/user/<userid>/services/CallForwardingSelective/criteria/<criteriaNam
e>
/v2.0/user/<userid>/services/CallingLineIDBlockingOverride
/v2.0/user/<userid>/services/CallingLineIDDeliveryBlocking
/v2.0/user/<userid>/services/CallingNameDelivery
/v2.0/user/<userid>/services/CallingNameRetrieval
/v2.0/user/<userid>/services/CallingNumberDelivery
/v2.0/user/<userid>/services/CallingPartyCategory
/v2.0/user/<userid>/services/CallMeNow
/v2.0/user/<userid>/services/CallMeNow/Criteria
/v2.0/user/<userid>/services/CallMeNow/Criteria/<criteriaName>
/v2.0/user/<userid>/services/CallNotify
/v2.0/user/<userid>/services/CallPark
/v2.0/user/<userid>/services/CallRecording
/v2.0/user/<userid>/services/CallTransfer
/v2.0/user/<userid>/services/CallWaiting
/v2.0/user/<userid>/services/ChargeNumber
/v2.0/user/<userid>/services/Collaborate
/v2.0/user/<userid>/services/Collaborate/Room
/v2.0/user/<userid>/services/CommPilotCallManager
/v2.0/user/<userid>/services/CommPilotExpress
/v2.0/user/<userid>/services/CommPilotExpress/Profile
/v2.0/user/<userid>/services/CommPilotExpress/AvailableInOffice
/v2.0/user/<userid>/services/CommPilotExpress/AvailableOutOfOffice
/v2.0/user/<userid>/services/CommPilotExpress/Busy
/v2.0/user/<userid>/services/CommPilotExpress/Unavailable
/v2.0/user/<userid>/services/ConnectedLineIdentificationPresentation
/v2.0/user/<userid>/services/ConnectedLineIdentificationRestriction
/v2.0/user/<userid>/services/CustomRingbackUser
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria
/v2.0/user/<userid>/services/CustomRingbackUser/Criteria/<criteriaName>
/v2.0/user/<userid>/services/DirectedCallPickup
/v2.0/user/<userid>/services/DirectedCallPickupWithBargeIn
/v2.0/user/<userid>/services/DoNotDisturb
/v2.0/user/<userid>/services/Executive
/v2.0/user/<userid>/services/Executive/assistants/AvailableUsers
/v2.0/user/<userid>/services/Executive/Assistants
/v2.0/user/<userid>/services/Executive/assistants/AssignedUsers
/v2.0/user/<userid>/services/Executive/filtering
/v2.0/user/<userid>/services/Executive/filtering/criteria
/v2.0/user/<userid>/services/executive/filtering/criteria/<criterianame>
/v2.0/user/<userid>/services/executive/Screening
/v2.0/user/<userid>/services/executive/Alerting
/v2.0/user/<userid>/services/ExecutiveaAsistant
/v2.0/user/<userid>/services/ExternalCallingLineIDDelivery
/v2.0/user/<userid>/services/FaxMessaging
/v2.0/user/<userid>/services/FlexibleSeatingGuest
/v2.0/user/<userid>/services/GETSCallingLineIDDeliveryBlocking

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 37 OF 521
 /v2.0/user/<userid>/services/GroupNightForwarding
/v2.0/user/<userid>/services/HotelingHost
/v2.0/user/<userid>/services/HotelingGuest
/v2.0/user/<userid>/services/InCallServiceActivation/v2.0/user/<userid>/se
rvices/IntegratedIMP
/v2.0/user/<userid>/services/InterceptUser
/v2.0/user/<userid>/services/InternalCallingLineIDDelivery
/v2.0/user/<userid>/services/LegacyAutomaticCallback
/v2.0/user/<userid>/services/MeetMeConference
/v2.0/user/<userid>/services/MeetMeConference/<bridgeid>
/v2.0/user/<userid>/services/MeetMeConference/<bridgeid>/conference
/v2.0/user/<userid>/services/MeetMeConference/<bridgeid>/conference/<confe
renceid>
/v2.0/user/<userid>/services/MusicOnHold
/v2.0/user/<userid>/services/MwiDeliveryToMobileEndpoint
/v2.0/user/<userid>/services/NumberPortabilityAnnouncement
/v2.0/user/<userid>/services/services/OutgoingMwi
/v2.0/user/<userid>/services/services/OutlookIntegration
/v2.0/user/<userid>/services/services/PriorityAlert
/v2.0/user/<userid>/services/services/PriorityAlert/Criteria
/v2.0/user/<userid>/services/services/PriorityAlert/Criteria
/<criteriaName>
/v2.0/user/<userid>/services/services/Privacy
/v2.0/user/<userid>/services/privacy/AllowedUsers
/v2.0/user/<userid>/services/privacy/AvailableUsers
/v2.0/user/<userid>/services/pushnotification
/v2.0/user/<userid>/services/services/PushTotalk
/v2.0/user/<userid>/services/services/PersonalAssistant
/v2.0/user/<userid>/services/services/PersonalAssistant/AssignedCallToNumb
ers/v2.0/user/<userid>/services/services/PersonalAssistant/AvailableCallTo
Numbers
/v2.0/user/<userid>/services/services/PersonalAssistant/ExclusionNumber
/v2.0/user/<userid>/services/services/PersonalAssistant/ExclusionNumber/<n
umber>
/v2.0/user/<userid>/services/services/PersonalAssistant/ExclusionNumberLis
t
/v2.0/user/<userid>/services/services/PersonalAssistant
/v2.0/user/<userid>/services/PushTotalk/AllowedUsers
/v2.0/user/<userid>/services/PushTotalk/AvailableUsers
/v2.0/user/<userid>/services/RemoteOffice
/v2.0/user/<userid>/services/SecurityClassification

/v2.0/user/<userid>/services/SelectiveCallAcceptance
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria
/v2.0/user/<userid>/services/SelectiveCallAcceptance/Criteria/<criterianam
e>
/v2.0/user/<userid>/services/SelectiveCallRejection
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria
/v2.0/user/<userid>/services/SelectiveCallRejection/Criteria/<criterianame
>
/v2.0/user/<userid>/services/SequentialRing
/v2.0/user/<userid>/services/SequentialRing/Criteria
/v2.0/user/<userid>/services/SequentialRing/Criteria/<criterianame>
/v2.0/user/<userid>/services/SimultaneousRingPersonal

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 38 OF 521
 /v2.0/user/<userid>/services/SimultaneousRingPersonal/Criteria
/v2.0/user/<userid>/services/SimultaneousRingPersonal/Criteria/<criteriana
me>
/v2.0/user/<userid>/services/SpeedDial100
/v2.0/user/<userid>/services/SpeedDial100/<code>
/v2.0/user/<userid>/services/SpeedDial8
/v2.0/user/<userid>/services/ThirdPartyVoicemailSupport
/v2.0/user/<userid>/services/VoiceMessaging
/v2.0/user/<userid>/services/VoiceMessaging/Aliases
/v2.0/user/<userid>/services/VoiceMessaging/Aliases/<phoneNumber>
/v2.0/user/<userid>/services/VoiceMessaging/DistributionLists/<listid>
/v2.0/user/<userid>/services/VoiceMessaging/Greetings
/v2.0/user/<userid>/services/VoiceMessaging/MailServer
/v2.0/user/<userid>/services/VoicePortal

3.5.1.3 User Call Control Commands

/v2.0/user/<userid>/calls
/v2.0/user/<userid>/calls/New
/v2.0/user/<userid>/calls/<callid>
/v2.0/user/<userid>/calls/DispositionCode/<code>
/v2.0/user/<userid>/calls/<callid>/DispositionCode/<code>
/v2.0/user/<userid>/calls/<callid>/BlindTransfer
/v2.0/user/<userid>/calls/<callid>/ClientSessionInfo
/v2.0/user/<userid>/calls/<callid1>/ConsultTransfer/<callid2>
/v2.0/user/<userid>/calls/<callid>/EmergencyEscalate
/v2.0/user/<userid>/calls/Escalate
/v2.0/user/<userid>/calls/<callid>/FindMeFollowMeCallPush/<callId>
/v2.0/user/<userid>/calls/<callid>/GroupCallPark
/v2.0/user/<userid>/calls/<callid>/Hold
/v2.0/user/<userid>/calls/<callid>/MuteTransfer
/v2.0/user/<userid>/calls/<callid>/Park
/v2.0/user/<userid>/calls/<callid>/PauseRecording
/v2.0/user/<userId>/calls/<callId>/PlayMusicOnHold
/v2.0/user/<userid>/calls/<callid>/Reconnect
/v2.0/user/<userid>/calls/<callid>/Record
/v2.0/user/<userid>/calls/<callid>/ResumeRecording
/v2.0/user/<userid>/calls/<callid>/StopRecording
/v2.0/user/<userid>/calls/<callid>/Talk
/v2.0/user/<userid>/calls/<callid>/TransmitDTMF
/v2.0/user/<userid>/calls/<callid>/VmTransfer
/v2.0/user/<userid>/calls/AutomaticCallback
/v2.0/user/<userid>/calls/CallMeNow
/v2.0/user/<userid>/calls/CallPickup
/v2.0/user/<userid>/calls/CallRetrieve
/v2.0/user/<userid>/calls/CallReturn
/v2.0/user/<userid>/calls/Conference
/v2.0/user/<userid>/calls/Conference/<callid>
/v2.0/user/<userid>/calls/Conference/<callid>/Deaf
/v2.0/user/<userid>/calls/Conference/<callid>/Mute
/v2.0/user/<userid>/calls/Conference/<callid>/UnDeaf
/v2.0/user/<userid>/calls/Conference/<callid>/UnMute

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 39 OF 521
 /v2.0/user/<userid>/calls/Conference/Hold
/v2.0/user/<userid>/calls/Conference/Talk
/v2.0/user/<userid>/calls/Conference/Unmute
/v2.0/user/<userid>/calls/<callId>/CustomerOriginatedTrace
/v2.0/user/<userid>/calls/CustomerOriginatedTrace
/v2.0/user/<userid>/calls/DirectedCallPickup
/v2.0/user/<userid>/calls/DirectedCallPickupBargeIn
/v2.0/user/<userid>/calls/<callid>/ExecutiveAssistantCallPush
/v2.0/user/<userid>/calls/ExecutiveAssistantInitiateCall
/v2.0/user/<userid>/calls/HookStatus
/v2.0/user/<userid>/calls/Imrn
/v2.0/user/<userid>/calls/LastNumberRedial
/v2.0/user/<userid>/calls/ParkRetrieve
/v2.0/user/<userid>/calls/PushToTalk
/v2.0/user/<userid>/calls/SilentMonitor
/v2.0/user/<userid>/calls/SilentMonitorNext
/v2.0/user/<userid>/calls/MessageSummary

3.5.1.4 User Collaborate Commands

/v2.0/user/<userid>/collaborate/room/<roomid>
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>
/v2.0/user/<userid>/collaborate/room/<roomid>/outgoingdial
/v2.0/user/<userid>/collaborate/room/<roomid>/lock
/v2.0/user/<userid>/collaborate/room/<roomid>/unlock
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>/mute
/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<callid>/unmute
/v2.0/user/<userid>/collaborate/room/<roomid>/ClientSessionInfo

3.5.1.5 User Directory Commands

/v2.0/user/<userid>/directories/Agents
/v2.0/user/<userid>/directories/BroadWorksAnywherePortal
/v2.0/user/<userid>/directories/CallCenters?user=Agent
/v2.0/user/<userid>/directories/CallCenters?user=Supervisor
/v2.0/user/<userid>/directories/CallLogs
/v2.0/user/<userid>/directories/CallLogs/Missed
/v2.0/user/<userid>/directories/CallLogs/Missed/<callLogId>
/v2.0/user/<userid>/directories/CallLogs/Placed
/v2.0/user/<userid>/directories/CallLogs/Placed/<callLogId>
/v2.0/user/<userid>/directories/CallLogs/Received
/v2.0/user/<userid>/directories/CallLogs/Received/<callLogId>
/v2.0/user/<userid>/directories/CustomContact
/v2.0/user/<userid>/directories/CustomContact/<directoryName>
/v2.0/user/<userid>/directories/EnhancedCallLogs
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Missed/<callLogId>
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed
/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed/<callLogId>
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received
/v2.0/user/<userid>/directories/EnhancedCallLogs/Received/<callLogId>
/v2.0/user/<userid>/directories/Enterprise

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 40 OF 521
 /v2.0/user/<userid>/directories/EnterpriseCommon
/v2.0/user/<userid>/directories/FlexibleSeatingHosts
/v2.0/user/<userid>/directories/Group
/v2.0/user/<userid>/directories/GroupCommon
/v2.0/user/<userid>/directories/HotelingHosts
/v2.0/user/<userid>/directories/Personal
/v2.0/user/<userid>/directories/Supervisors

3.5.1.6 User Fax Commands

/v2.0/user/<userid>/fax
/v2.0/user/<userid>/fax/<faxid>

3.5.1.7 Voice Messaging Messages Commands

/v2.0/user/<userid>/VoiceMessagingMessages
/v2.0/user/<userid>/VoiceMessagingMessages/MarkAllAsUnread
/v2.0/user/<userid>/VoiceMessagingMessages/MarkAllAsRead
/v2.0/user/<userid>/VoiceMessagingMessages/<messageId>
/v2.0/user/<userid>/VoiceMessagingMessages/<messageId>/MarkAsUnread
/v2.0/user/<userid>/VoiceMessagingMessages/<messageId>/MarkAsRead

3.5.1.8 Call Center Profile Commands

/v2.0/callcenter/<callcenterid>/profile
/v2.0/callcenter/<callcenterid>/profile/DispositionCodes
/v2.0/callcenter/<callcenterid>/profile/Dnis
/v2.0/callcenter/<callcenterid>/profile/Dnis/<dnisName>
/v2.0/callcenter/<callcenterid>/profile/policies/ForcedForwarding
/v2.0/callcenter/<callcenterid>/profile/policies/NightService

3.5.1.9 Call Center Call Control Commands

/v2.0/callcenter/<callcenterid>/calls
/v2.0/callcenter/<callcenterid>/calls/<callid>
/v2.0/callcenter/<callcenterid>/calls/<callid>/BlindTransfer
/v2.0/callcenter/<callcenterid>/calls/<callid>/Promote
/v2.0/callcenter/<callcenterid>/calls/<callid>/Reorder

3.5.1.10 RoutePoint Profile Commands

/v2.0/routepoint/<routepointid>/profile
/v2.0/routepoint/<routepointid>/profile/State

3.5.1.11 RoutePoint Call Control Commands

/v2.0/routepoint/<routepointid>/calls
/v2.0/routepoint/<routepointid>/calls/<callid>
/v2.0/routepoint/<routepointid>/calls/<callid>/Bounce
/v2.0/routepoint/<routepointid>/calls/<callid>/BlindTransfer

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 41 OF 521
 /v2.0/routepoint/<routepointid>/calls/<callid>/Distribute
/v2.0/routepoint/<routepointid>/calls/<callid>/Fail
/v2.0/routepoint/<routepointid>/calls/<callid>/PlayBusy
/v2.0/routepoint/<routepointid>/calls/<callid>/PlayMusicOnHold
/v2.0/routepoint/<routepointid>/calls/<callid>/PlayRingback
/v2.0/routepoint/<routepointid>/calls/<callid>/PlaySilence
/v2.0/routepoint/<routepointid>/calls/<callid>/PlayTreatment
/v2.0/routepoint/<routepointid>/calls/New

3.5.1.12 MeetMeConference Conference Control Commands

/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>
/v2.0/meetmeconference/<userid>/conference/<conferenceid>/ClientSessionInf
o
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/outgoingdial
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/mute
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/unmute
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/hold
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/calls/<callid>
/retrieve
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>lock
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>unlock
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/startrecording
/v2.0/meetmeconference/<bridgeId>/conference/<conferenceid>/PlaysSecurityC
lassification
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/pauserecording
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/resumerecordin
g
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/stoprecording
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/setlecturemode
/v2.0/meetmeconference/<bridgeid>/conference/<conferenceid>/unsetlecturemo
de

3.5.1.13 Group Services Commands

/v2.0/group/<groupid>/services/CallCenter/UnavailableCodes
/v2.0/group/<groupid>/services/CallCenter/ExternalReporting

3.5.1.14 System Services Commands

/v2.0/system/services/RoutePoint/ApplicationController/<applicationContro
llerId>

3.5.1.15 Version Command

/v2.0/versions

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 42 OF 521
 3.5.2 User Profile Commands: /user/<userid>/profile

3.5.2.1 profile
This command is used to retrieve the profile information for a particular user. It returns
information about a user as stored in Cisco BroadWorks. It also allows for retrieval of
users’ feature access codes (FACs) and device registrations, as well as schedules, for the
Holiday and Time Schedule services.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <Profile xmlns="http://schema.broadsoft.com/xsi"
Content
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<details>
<userId>[email protected]</userId>
<externalId>39b8a245-644a-4a60-8f1d-
8ec206c3a689</externalId>
<firstName>Subhash</firstName>
<lastName>Negi</lastName>
<hiranganaLastName>Negi</hiranganaLastName>
<hiranganaFirstName>Subhash</hiranganaFirstName>
<groupId>gp1</groupId>
<serviceProvider isEnterprise="false">
sp1</serviceProvider>
<number>5006007004</number>
<extension>7004</extension>
</details>
<additionalDetails>
<mobile xsi:nil="true" />
<yahooId xsi:nil="true" />
<pager xsi:nil="true" />
<emailAddress>[email protected]
</emailAddress>
<title xsi:nil="true" />
<location xsi:nil="true" />
<department xsi:nil="true" />
<impId>[email protected]</impId>
</additionalDetails>
<timeZone>US/Central</timeZone>
<timeZoneDisplayName>(GMT-05:00) US/Central
</timeZoneDisplayName>
<passwordExpiresDays>21</passwordExpiresDays>
<fac>/v2.0/user/[email protected]/profile/Fac

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 43 OF 521
 </fac>
<registrations>/v2.0/user/[email protected]/profile/Reg
istrations
</registrations>
<scheduleList>/v2.0/user/[email protected]/profile/Sche
dule
</scheduleList>
<portalPasswordChange>/v2.0/user/[email protected]/prof
ile/Password/Portal
</portalPasswordChange>
<countryCode>1</countryCode></Profile>

3.5.2.2 profile/Device
This command is used to retrieve information for a list of devices corresponding to the
primary and shared call appearance devices for the user.
BroadWorks Anywhere and Mobility locations are not returned in this devices list.
The deviceUserNameAndPassword element is only included in Xtended Services
Interface responses when Cisco BroadWorks is configured to allow retrieval of device
credentials.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/device
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AccessDevices xmlns="http://schema.broadsoft.com/xsi">
Content
<accessDevice>
<deviceName>[email protected]</deviceName>
<deviceLevel>System</deviceLevel>
<deviceType>Polycom</deviceType>
<deviceLinePort>10.2.202.18:5060</deviceLinePort>
<deviceTypeUrl>http://10.2.202.18/dev</deviceTypeUrl>
<deviceUserNamePassword>
<userName>[email protected]</userName>
<password>gfhjjkl</password>
</deviceUserNamePassword>
<macAddress>AAAAAAAAAAAA</macAddress>
<version>Grandstream BT100 1.0.5.23</version>
<endpointType>Primary</endpointType>
</accessDevice>
</AccessDevices>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 44 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

deviceType String O Search criteria for a user’s device types.

Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

onlySoftClient True, False O When this option is set to “true”, all devices
having their “Autoconfiguration Soft Client”
option set are returned.
The default value is “false”.

macAddress String O Specifies the MAC address of the access

device for which to return details.

3.5.2.3 profile/Device/<linePort>
This command allows the remote application to retrieve (GET method) the following
information associated with the linePort:
 deviceName
 deviceLevel
 deviceType
 version
 endpointType (primary, Shared Call Appearance or mobility)
 allowTermination

A PUT request is used to modify the following property:

 allowTermination

A primary or Shared Call Appearance location is identified by the linePort part of the
Request-URI. The client can get the list of primary and Shared Call Appearance linePorts
assigned to a user using the existing profile/device Xtended Services Interface GET
request.
By setting allowTermination to “false”, a client that supports push notification can prevent
receiving both a push notification and an INVITE for an incoming call. With
allowTermination set to “false” only, the push notification is sent to the client.
If a Video Add-On or Flexible Seating Guest endpoint is specified in the PUT, it does not
change the ability to terminate to the endpoint, and a success response is returned.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.Xsi-
actions/v2.0/user/<userid>/profile/device/<linePort>
Command Profile
Category
Methods GET, PUT
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 45 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AccessDevice xmlns="http://schema.broadsoft.com/xsi">
Content <deviceName>user1-mobile</deviceName>
<deviceLevel>Group</deviceLevel>
<deviceType>Business Communicator - Mobile</deviceType>
<deviceLinePort>[email protected]</deviceLinePort>
<deviceTypeUrl>http://10.16.120.119:80/dms/bc/mobile/
</deviceTypeUrl>
<deviceUserNamePassword>
<userName>[email protected]</userName>
<password>password</password>
</deviceUserNamePassword>
<version>bc-uc - Communicator (21.5.1.5415 Android
Mobile)</version>
<endpointType>Shared Call Appearance</endpointType>
<allowTermination>true</allowTermination>
</AccessDevice>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
<AccessDevice xmlns="http://schema.broadsoft.com/xsi">
Request
<allowTermination>false</allowTermination>
Content </AccessDevice>
PUT
Response No Content
Content

3.5.2.4 profile/DeviceToken (AS Only)

This command is used by a client application to create a token that is associated with a
Cisco BroadWorks user’s access device. The token is subsequently used by another
client application to authenticate and get access to the given Device Management files
associated with the given access device, thus implementing a Single Sign-On mechanism.
 The /user/<userid>/profile/deviceToken command is effective only if the device
supports Device Management when creating a token for one’s own device or for a
managed Cisco BroadWorks user’s device.
 A generated token has an expiry period of 60 seconds.
Upon success, an HTTP 201 (created) response is returned.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/deviceToken?deviceName=.
..&deviceLevel=...
Command
Category
Profile

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <DeviceToken xmlns="http://schema.broadsoft.com/xsi">
Content
<token>c3NvMV85ZTVmOTJiZS0yYzJmLTRmM2MtOTJmYi1jZGJkYjN
lNjVmODZfMTI3LjAuMC4xX25vcnRoMDBAbXRsYXNkZXY4My5uZXQ=
</token>
</DeviceToken>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 46 OF 521
 Parameter Description
Parameter Name Allowed Value Optional/ Description
Mandatory

deviceName String M The name of the access device

deviceLevel Group M Subscriber level of the access device

Service Provider
System

3.5.2.5 profile/Fac
This command is used to retrieve all feature access codes configured for services, which
are assigned for a particular user. For each feature access code, the name and code are
returned. If an alternate code has been defined for a feature access code in Cisco
BroadWorks, then that alternate code is also returned.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Fac
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <FAC xmlns="http://schema.broadsoft.com/xsi">
Content
<featureAccessCode>
<codeName>Night Service Activation Manual
Override</codeName>
<code>#70</code>
<alternateCode>#60</alternateCode>
</featureAccessCode>
<featureAccessCode>
<codeName>Call Forwarding Not Reachable
Deactivation</codeName>
<code>*95</code>
</featureAccessCode>
</FAC>

3.5.2.6 profile/impprofile (AS Only)

The service is used to retrieve the Instant Messaging and Presence (IM&P) profile for the
user.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/impprofile
Command
Category
Service Management

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 47 OF 521
 Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <IMPProfile xmlns="http://schema.broadsoft.com/xsi">
Content
<serviceNetAddress>imptest.com</serviceNetAddress>
<servicePort>8888</servicePort>
<impUserId>[email protected]></impUserId>
<boshURL>
https://company.server.com:7070/boshBinding/</boshURL>
</IMPProfile>

3.5.2.7 profile/LoginToken (AS Only)

This command is used by a client application to create a login token that is subsequently
used to authenticate another client application, thus implementing a Single Sign-On
mechanism. It is effective only when creating a token for yourself or for a managed user.
The generated token has an expiry period of 60 seconds.
Upon success, an HTTP 201 (created) response is returned.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/LoginToken
Command
Category
Profile

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <LoginToken xmlns="http://schema.broadsoft.com/xsi">
Content <token>c3NvMV85ZTVmOTJiZS0yYzJmLTRmM2MtOTJmYi1jZGJkYjN
lNjVmODZfMTI3LjAuMC4xX25vcnRoMDBAbXRsYXNkZXY4My5uZXQ=
</token>
</LoginToken>

3.5.2.8 profile/Password/Portal
This command is used to reset the Cisco BroadWorks web portal password. This
password is used to log in to the Cisco BroadWorks web portal as well as any Cisco
BroadWorks client applications; it is also the password used to authenticate a subscriber
over the Cisco BroadWorks OCI-P, CAP, and Xsi Interfaces.

NOTE: This service sends password information as clear text to Cisco BroadWorks. It is
recommended to use Hypertext Transfer Protocol Secure Sockets (HTTPS) to perform this
command.

Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Password/Portal

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 48 OF 521
 Command
Category
Service Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <Portal xmlns="http://schema.broadsoft.com/xsi">
Content
<oldPassword>ladmin</oldPassword>
<newPassword>admin</newPassword>
</Portal>
PUT
Response No Content
Content

3.5.2.9 profile/PushNotificationRegistrations
This command allows the remote application to issue a command to the Application
Server to deregister (DELETE) and to retrieve (GET) push notification registrations for a
target user.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/PushNotificationRegistrat
ions
Command
Profile
Category
Methods DELETE, GET
DELETE
Request No Content
Content
DELETE
Response 201
Content
GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <PushNotificationRegistrations
Content xmlns="http://schema.broadsoft.com/xsi">
<pushNotificationRegistration>
<applicationId>com.broadsoft.androidclient.application
</applicationId>
<applicationVersion>1.1.8</applicationVersion>
<registrationId>F22E109F-21A8-4881-A45B-3DF56D791111
</registrationId>
<deviceOSType>Android</deviceOSType>
<deviceOSVersion>8.2</deviceOSVersion>
<deviceTokenList>
<deviceToken>
<token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C1111</to
ken>
<type>VoIP</type>
<pushNotificationEvents>
<eventDetail>
<name>NEW_CALL</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 49 OF 521
 <eventDetail>
<name>CALL_UPD</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>
<eventDetail>
<name>RNG_SPLSH</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>
</pushNotificationEvents>
</deviceToken>
</deviceTokenList>
</pushNotificationRegistration>
<pushNotificationRegistration>
<applicationId>com.broadsoft.iosclient.application</applicat
ionId>
<applicationVersion>1.1.1.0</applicationVersion>
<registrationId>F22E109F-21A8-4881-A45B-3DF56D792222
</registrationId>
<deviceOSType>iOS</deviceOSType>
<deviceOSVersion>8.4.0</deviceOSVersion>
<deviceTokenList>
<deviceToken>
<token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C2222</to
ken>
<type>Normal</type>
<pushNotificationEvents>
<eventDetail>
<name>MWI</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>
<eventDetail>
<name>CALL_UPD</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>
<eventDetail>
<name>RNG_SPLSH</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
</eventDetail>
</pushNotificationEvents>
</deviceToken>
<deviceToken>
<token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C3333</to
ken>
<type>VoIP</type>
<pushNotificationEvents>
<eventDetail>
<name>NEW_CALL</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
<parameters>
<iOSParam>
<param>
<name>iOSKey1</name>
<value>iOSValue1</value>
</param>
<param>
<name>iOSKey2</name>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 50 OF 521
 <value>iOSValue2</value>
</param>
</iOSParam>
<appDataParam>
<param>
<name>appKey1</name>
<value>appValue1</value>
</param>
<param>
<name>appKey2</name>
<value>appValue2</value>
</param>
</appDataParam>
</parameters>
</eventDetail>
</pushNotificationEvents>
</deviceToken>
</deviceTokenList>
</pushNotificationRegistration>
</PushNotificationRegistrations>

Parameter Description
Parameter Allowed Optional / Description
Name Values Mandatory

registrationId String Optional The unique ID associated with the application

(DELETE, GET) instance when it registered for push
notifications.
This parameter is optional for DELETE and
GET. For additional behavior, see section
3.5.2.9 profile/PushNotificationRegistrations.

token String Optional The unique token when the application

(DELETE) registered for push notifications.
This parameter is optional for DELETE. For
additional behavior, see section 3.5.2.9
profile/PushNotificationRegistrations.

3.5.2.10 profile/PushNotificationRegistrations/new
This command allows the remote application to issue a command to the Application
Server to register (POST) for push notifications for a target user.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/PushNotificationRegistrat
ions/new
Command Profile
Category
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <PushNotificationRegistration
Content xmlns="http://schema.broadsoft.com/xsi">
<applicationId>com.broadsoft.ucone2015</applicationId>
<applicationVersion>1.1.1.0</applicationVersion>
<registrationId>apple-res1-johnsmith-
dev1</registrationId>
<deviceOSType>iOS</deviceOSType>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 51 OF 521
 <deviceOSVersion>8.4.0</deviceOSVersion>
<deviceTokenList>
<deviceToken>
<token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C2222</to
ken>
<type>Normal</type>
<pushNotificationEvents>
<eventDetail>
<name>MWI</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
<parameters></parameters>
</eventDetail>
<eventDetail>
<name>CALL_UPD</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
<parameters></parameters>
</eventDetail>
<eventDetail>
<name>RNG_SPLSH</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
<parameters></parameters>
</eventDetail>
</pushNotificationEvents>
</deviceToken>
<deviceToken>
<token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C3333</to
ken>
<type>VoIP</type>
<pushNotificationEvents>
<eventDetail>
<name>NEW_CALL</name>
<silent>true</silent>
<mutableContent>true</mutableContent>
<parameters>
<iOSParam>
<param>
<name>iOSKey1</name>
<value>iOSValue1</value>
</param>
<param>
<name>iOSKey2</name>
<value>iOSValue2</value>
</param>
</iOSParam>
<appDataParam>
<param>
<name>appKey1</name>
<value>appValue1</value>
</param>
<param>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 52 OF 521
 <name>appKey2</name>
<value>appValue2</value>
</param>
</appDataParam>
</parameters>
</eventDetail>
</pushNotificationEvents>
</deviceToken>
</deviceTokenList>
</PushNotificationRegistration>
POST
Response 201
Content

3.5.2.11 profile/Schedule
This command is used to retrieve the schedules assigned to a user. Holiday and Time
schedules form the list of schedules a user can have. This command returns the name
and type of each user schedule.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Schedule
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ScheduleList xmlns="http://schema.broadsoft.com/xsi">
Content
<timeSchedules>
<timeSchedule>
<level>User</level>
<name>SomeUserSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/SomeU
serSchedule?scheduleLevel=User</uri>
</timeSchedule>
<timeSchedule>
<level>Group</level>
<name>SomeGroupSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/SomeG
roupSchedule?scheduleLevel=Group</uri>
</timeSchedule>
<timeSchedule>
<level>Enterprise</level>
<name>SomeEnterpriseSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/SomeU
serSchedule?scheduleLevel=Enterprise</uri>
</timeSchedule>
</timeSchedules>
<holidaySchedules>
<holidaySchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 53 OF 521
 <level>User</level>
<name>SomeUserSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/ holiday
/SomeUserSchedule?scheduleLevel=User</uri>
</holidaySchedule>
<holidaySchedule>
<level>Group</level>
<name>SomeGroupSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/ holiday
/SomeGroupSchedule?scheduleLevel=Group</uri>
</holidaySchedule>
<holidaySchedule>
<level>Enterprise</level>
<name>SomeEnterpriseSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/ holiday
/SomeUserSchedule?scheduleLevel=Enterprise</uri>
</holidaySchedule>
</holidaySchedules>
</SchedulesList>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String Optional Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.2.11.1 profile/Schedule/Holiday
This command is used to retrieve only the list of Holiday schedules assigned to a user or
add a new holiday schedule for a user. Only user-level schedules can be added using the
POST command. The response here is a subset of the profile/Schedule command,
returning only schedules of type=“Holiday”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/schedule/holiday
Command
Category
Service Management

Methods GET, POST

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <holidaySchedules>
Content
<holidaySchedule>
<level>User</level>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 54 OF 521
 <name>SomeUserSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/
holiday/SomeUserSchedule?scheduleLevel=User</uri>
</holidaySchedule>
<holidaySchedule>
<level>Group</level>
<name>SomeGroupSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/
holiday/SomeGroupSchedule?scheduleLevel=Group</uri>
</holidaySchedule>
<holidaySchedule>
<level>Enterprise</level>
<name>SomeEnterpriseSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/
holiday/SomeUserSchedule?scheduleLevel=Enterprise</uri>
</holidaySchedule>
</holidaySchedules>
POST <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Holiday">
<name>HolidaySchedule</name>
<level>User</level>
</scheduleDetail>
</Schedule>
POST
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String Optional Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.2.11.2 profile/Schedule/Holiday/<scheduleName>
This command is used to retrieve detailed information about the specified Holiday
schedule, modify a Holiday schedule, or delete a Holiday Schedule. Only user-level
schedules can be modified using the PUT command. The response lists information
about the Holiday schedule, as well as all events that are defined within this schedule.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Schedule/Holiday/<schedu
leName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 55 OF 521
 Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Time">
<name>HolidayOne</name>
<level>User</level>
<events>
<eventDetail>
<eventName>HolidayEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>2</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
<uri>
/v2.0/user/[email protected]/profile/schedule/holiday/Holiday
One/event/HolidayEventOne?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>HolidayEventTwo</eventName>
<startDate>2010-03-23+05:30</startDate>
<startTime>
<hour>8</hour>
<minute>0</minute>
</startTime>
<endTime>
<hour>22</hour>
<minute>0</minute>
</endTime>
<endDate>2010-03-24+05:30</endDate>
<recurrence>
<recurWeekly>
<recurInterval>1</recurInterval>
<sunday>false</sunday>
<monday>false</monday>
<tuesday>true</tuesday>
<wednesday>false</wednesday>
<thursday>true</thursday>
<friday>false</friday>
<saturday>true</saturday>
</recurWeekly>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 56 OF 521
 <recurEndDate>2010-03-24+05:30
</recurEndDate>
</recurrence>
<uri>
/v2.0/user/[email protected]/profile/schedule/holiday/Holiday
One/event/HolidayEventTwo?scheduleLevel=User
</uri>
</eventDetail>
</events>
</scheduleDetail>
</Schedule>
PUT <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Time">
<name>HolidayOne</name>
<level>User</level>
</scheduleDetail>
</Schedule>
PUT
Response No Content
Content
DELETE
Request No content.
Content
DELETE
Response No content.
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String Optional Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.2.11.3 profile/schedule/holiday/<scheduleName>/event

This command is used to add an event to a holiday schedule of a user as well as retrieve
events under the particular schedule name.
The GET command accepts a scheduleLevel parameter to allow the retrieval of
group/enterprise-level schedule events as well as user-level events.
The POST command is only allowed for user-level schedules.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 57 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/schedule/holiday/<schedu
leName>/event
Command
Category
Service Management

Methods POST, GET

POST <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <EventDetail xmlns="http://schema.broadsoft.com/xsi">
Content
<eventDetail>
<eventName>HolidayEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>2</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</eventDetail>
</EventDetail>
POST
Response No Content
Content
GET Request
Content
No Content

GET <?xml version="1.0" encoding="ISO-8859-1"?>

Response <Events xmlns="http://schema.broadsoft.com/xsi">
Content
<eventDetail>
<eventName>HolidayEventOne</eventName>
<uri>
v2.0/user/[email protected]/profile/schedule/holiday/HolidayO
ne/event/HolidayEventOne?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>HolidayEventTwo</eventName>
<uri>
/v2.0/user/[email protected]/profile/schedule/holiday/Holiday
One/event/HolidayEventTwo?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>GroupEventTwo</eventName>
<uri>
/v2.0/user/[email protected]/profile/schedule/holiday/Holiday
One/event/GroupEventTwo?scheduleLevel=Group
</uri>
</eventDetail>
</Events>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 58 OF 521
 Parameter Description
Parameter Name Allowed Value Optional/ Description
Mandatory

scheduleLevel String O Specifies the level to

query for the schedule.
The default value is
“User” and is applied
when no
scheduleLevel is
supplied.
The following values
are valid:
 Group
 Enterprise
 User

3.5.2.11.4 profile/schedule/holiday/<scheduleName>/event/<eventName>

This command is added to modify (PUT), retrieve (GET), and delete (DELETE) an event
in a holiday schedule assigned to a user.
The GET command accepts a scheduleLevel parameter to allow the retrieval of
group/enterprise-level schedule events as well as user-level events. The PUT and the
DELETE are only allowed for user-level schedules.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/schedule/holiday/<schedu
leName>/event/<eventName>
Command
Category
Service Management

Methods GET, PUT, DELETE

PUT Request <?xml version="1.0" encoding="ISO-8859-1" ?>
Content <EventDetail xmlns="http://schema.broadsoft.com/xsi">
<eventDetail>
<eventName>HolidayEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>5</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</eventDetail>
</EventDetail>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 59 OF 521
 DELETE
Request No content.
Content
DELETE
Response No content.
Content
GET Request
Content
No content.

GET <?xml version="1.0" encoding="ISO-8859-1" ?>

Response <EventDetail xmlns="http://schema.broadsoft.com/xsi">
Content
<eventName>HolidayEventTwo</eventName>
<startDate>2010-03-26+05:30</startDate>
<startTime>
<hour>7</hour>
<minute>30</minute>
</startTime>
<endTime>
<hour>23</hour>
<minute>30</minute>
</endTime>
<endDate>2010-03-28+05:30</endDate>
<recurrence>
<recurYearlyByWeek>
<recurInterval>1</recurInterval>
<dayOfWeek>Tuesday</dayOfWeek>
<dayOfWeekInMonth>Fourth
</dayOfWeekInMonth>
<month>June</month>
</recurYearlyByWeek>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</EventDetail>

Parameter Description
Parameter Name Allowed Value Optional/ Description
Mandatory

scheduleLevel String O Specifies the level to

query for the schedule.
The default value is
“User” and is applied
when no
scheduleLevel is
supplied.
The following values
are valid:
 Group
 Enterprise
 User

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 60 OF 521
 3.5.2.11.5 profile/Schedule/Time
This command is used to retrieve on the list of Time schedules assigned to a user or add
a time schedule for a user. Only user-level schedules can be added using the POST
command. The response here is a subset of the profile/Schedule command, returning
only schedules of type=“Time”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Schedule/Time
Command
Category
Service Management

Methods GET, POST

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <timeSchedules>
Content
<timeSchedule>
<level>User</level>
<name>SomeUserSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/Som
eUserSchedule?scheduleLevel=User</uri>
</timeSchedule>
<timeSchedule>
<level>Group</level>
<name>SomeGroupSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/Som
eGroupSchedule?scheduleLevel=Group</uri>
</timeSchedule>
<timeSchedule>
<level>Enterprise</level>
<name>SomeEnterpriseSchedule</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/Som
eUserSchedule?scheduleLevel=Enterprise</uri>
</timeSchedule>
</timeSchedules>
POST <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Time">
<name>TimeSchedule</name>
<level>User</level>
</scheduleDetail>
</Schedule>
POST
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 61 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String Optional Specifies the level to query for the

schedule.
Default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid.
Example:
 Group
 Enterprise
 User

3.5.2.11.6 profile/Schedule/Time/<scheduleName>
This command is used to retrieve detailed information about the specified Time schedule,
modify the specified Time schedule, or delete the specified Time schedule, identified by
the name in the command’s URL. Only user-level schedules can be modified using the
PUT command. The response lists information about the time schedule, as well as all
events that are defined within this schedule.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Schedule/Time/<scheduleN
ame>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request - No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Time">
<name>TimeSchedule</name>
<level>User</level>
<events>
<eventDetail>
<eventName>TimeEventOne</eventName>
<startDate>2010-03-26+05:30</startDate>
<startTime>
<hour>7</hour>
<minute>30</minute>
</startTime>
<endTime>
<hour>23</hour>
<minute>30</minute>
</endTime>
<endDate>2010-03-28+05:30</endDate>
<recurrence>
<recurYearlyByWeek>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 62 OF 521
 <recurInterval>1</recurInterval>
<dayOfWeek>Tuesday</dayOfWeek>
<dayOfWeekInMonth>Fourth
</dayOfWeekInMonth>
<month>June</month>
</recurYearlyByWeek>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
<uri>
/v2.0/user/[email protected]/profile/schedule/time/TimeSche
dule/event/TimeEventOne?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>TimeEventTwo</eventName>
<startDate>2010-04-01+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-04-02+05:30</endDate>
<recurrence>
<recurMonthlyByWeek>
<recurInterval>1</recurInterval>
<dayOfWeekInMonth>Third
</dayOfWeekInMonth>
<dayOfWeek>Saturday</dayOfWeek>
</recurMonthlyByWeek>
<recurEndDate>2010-04-02+05:30
</recurEndDate>
</recurrence>
<uri>
/v2.0/user/[email protected]/profile/schedule/time/TimeSche
dule/event/TimeEventTwo?scheduleLevel=User
</uri>
</eventDetail>
</events>
</scheduleDetail>
</Schedule>
PUT <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <Schedule xmlns="http://schema.broadsoft.com/xsi">
Content
<scheduleDetail type="Time">
<name>NewTimeSchedule</name>
<level>User</level>
</scheduleDetail>
</Schedule>
PUT
Response No content.
Content
DELETE
Request No content.
Content
DELETE
Response No content.
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 63 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String Optional Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.2.11.7 profile/schedule/time/<scheduleName>/event

This command is used to add an event to a time schedule of a user as well as retrieve
events under the particular schedule name.
The GET command accepts a scheduleLevel parameter to allow the retrieval of
group/enterprise-level schedule events as well as user-level events.
The POST command is only allowed for user-level schedules.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/schedule/time/<scheduleN
ame>/event
Command
Category
Service Management

Methods POST, GET

POST <?xml version="1.0" encoding="ISO-8859-1" ?>
Request <EventDetail xmlns="http://schema.broadsoft.com/xsi">
Content
<eventDetail>
<eventName>TimeEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>2</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</eventDetail>
</EventDetail>
POST
Response No Content
Content
GET Request
Content
No Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 64 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Events xmlns="http://schema.broadsoft.com/xsi">
Content
<eventDetail>
<eventName>TimeEventOne</eventName>
<uri>
v2.0/user/[email protected]/profile/schedule/time/TimeSchedul
e/event/TimeEventOne?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>TimeEventTwo</eventName>
<uri>
/v2.0/user/[email protected]/profile/schedule/time/TimeSchedu
le/event/TimeEventTwo?scheduleLevel=User
</uri>
</eventDetail>
<eventDetail>
<eventName>GroupEventOne</eventName>
<uri>
/v2.0/user/[email protected]/profile/schedule/time/GroupSched
ule/event/GroupEventOne?scheduleLevel=Group
</uri>
</eventDetail>
</Events>

Parameter Description
Parameter Name Allowed Value Optional/ Description
Mandatory

scheduleLevel String O Specifies the level to

query for the
schedule.
The default value is
“User” and is applied
when no
scheduleLevel is
supplied.
The following values
are valid:
 Group
 Enterprise
 User

3.5.2.11.8 profile/schedule/time/<scheduleName>/event/<eventName>

This command is added to modify, retrieve, and delete an event in a time schedule
assigned to a user.
The GET command accepts a scheduleLevel parameter to allow the retrieval of
group/enterprise-level schedule events as well as user-level events. The PUT and the
DELETE are only allowed for user-level schedules.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 65 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/schedule/time/<scheduleN
ame>/event/<eventName>
Command
Category
Service Management

Methods GET, PUT, DELETE

PUT Request <?xml version="1.0" encoding="ISO-8859-1" ?>
Content <EventDetail xmlns="http://schema.broadsoft.com/xsi">
<eventDetail>
<eventName>TimeEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>5</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</eventDetail>
</EventDetail>
PUT
Response No content.
Content
DELETE
Request No content.
Content
DELETE
Response No content.
Content
GET Request
Content
No content.

GET <?xml version="1.0" encoding="ISO-8859-1" ?>

Response <EventDetail xmlns="http://schema.broadsoft.com/xsi">
Content
<eventName>TimeEventOne</eventName>
<startDate>2010-03-22+05:30</startDate>
<allDayEvent>true</allDayEvent>
<endDate>2010-03-23+05:30</endDate>
<recurrence>
<recurDaily>
<recurInterval>5</recurInterval>
</recurDaily>
<recurEndOccurrence>2
</recurEndOccurrence>
</recurrence>
</EventDetail>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 66 OF 521
 Parameter Description
Parameter Name Allowed Value Optional/ Description
Mandatory

scheduleLevel String O Specifies the level to

query for the
schedule.
The default value is
“User” and is applied
when no
scheduleLevel is
supplied.
The following values
are valid:
 Group
 Enterprise
 User

3.5.2.12 profile/Registrations
This command is used to retrieve the list of Session Initiation Protocol (SIP) registrations
that belong to devices or device endpoints that belong to a user.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/profile/Registrations
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <Registrations xmlns="http://schema.broadsoft.com/xsi">
Content
<registration>
<endpointType>Primary</endpointType>
<uri>sip:[email protected]:41106</uri>
<expiration>Wed Apr 07 06:24:51 EDT 2010
</expiration>
<linePort>[email protected]
</linePort>
<publicIP>10.16.150.100</publicIP>
<publicPort>5060</publicPort>
<privateIP>192.168.1.51</privateIP>
<privatePort>5060</privatePort>
<userAgent>Grandstream BT100 1.0.5.23</userAgent>
</registration>
</Registrations>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 67 OF 521
 3.5.3 User Services Commands: /user/<userid>/services

NOTE: For the commands listed in this section, the PUT method is used to modify the attributes
of a service. The elements included in the XML document are used to update the corresponding
service attributes. Optional elements (that is, minOccurs=”0”) can be omitted, in which case the
corresponding service attribute is left unchanged. Setting an element to “nil” when supported by
the schema, is typically used to clear a service attribute or service list. In addition, some
elements cannot be modified through the Xtended Services Interface. In these cases, the
elements are ignored when included in the XML document.

3.5.3.1 Services
This command is used to retrieve all assigned services for the identified subscriber. The
response contains the service names and the corresponding Xtended Services Interface
resource URL for the service, if the Xtended Services Interface has support for that
service. If a particular service is not available via Xsi-Actions, the corresponding resource
tag for that service is not present in the response.
This command would allow, for example, a client/application to query all services assigned
to a user, and then simply access the URL provided in the <uri> tag to present information
for each specific service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Services xmlns="http://schema.broadsoft.com/xsi">
Content
<service>
<name>Anonymous Call Rejection</name>
<uri>/v2.0/user/[email protected]/services/anonymou
scallrejection
</uri>
</service>
<service>
<name>Do Not Disturb</name>
<uri>/v2.0/user/[email protected]/services/donotdis
turb
</uri>
</service>
<service>
<name>Hoteling Guest</name>
<uri>/v2.0/user/[email protected]/services/hoteling
guest
</uri>
</service>
</Services>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 68 OF 521
 3.5.3.2 services/AccountCodes
This command is used to retrieve the list of account/authorization codes associated with
the given user. These codes are defined at the group level but are accessible by users.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/AccountCodes
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <AccountCodes xmlns="http://schema.broadsoft.com/xsi">
Content
<codeEntry>
<code>000000</code>
<description>AccountCodeOne</description>
</codeEntry>
</AccountCodes>

3.5.3.3 services/agentCallCenterAssignedStatus
This command is used to retrieve detailed information regarding call center licenses
assigned to a user.
This command can be executed by an administrator, an agent, or a supervisor for the
agent.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/agentCallCenterAssigned
Status
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <AgentCallCenterAssignedStatus
Content xmlns="http://schema.broadsoft.com/xsi">
<isCallCenterBasicAssigned>true
</isCallCenterBasicAssigned>
<isCallCenterStandardAssigned>true
</isCallCenterStandardAssigned>
<isCallCenterPremiumAssigned>true
</isCallCenterPremiumAssigned>
</AgentCallCenterAssignedStatus>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 69 OF 521
 3.5.3.4 services/AlternateNumbers
This command is used to retrieve the user’s alternate numbers or to modify the profile of
an alternate number that has already been configured by the administrator.
 Retrieving the list of alternate numbers: An HTTP GET retrieves the list of alternate
numbers.
 Modifying the profile of an alternate number: An HTTP PUT modifies the alternate
number profile. Specifically, a distinctive ring pattern can be set for each alternate
number, provided that the user’s device supports it. The phoneNumber and
extension elements are ignored for PUT requests if they are present. Any attempt to
modify the ring pattern of an alternate number that has not already been configured by
the administrator will also be ignored.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/AlternateNumbers
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1" ?>
Response <AlternateNumbers
Content
xmlns="http://schema.broadsoft.com/xsi">
<distinctiveRing>true</distinctiveRing>
<numbers>
<numberEntry>
<alternateNumberId>1</alternateNumberId>
<phoneNumber>5006007014</phoneNumber>
<extension>7014</extension>
<ringPattern>Short-Short-Long</ringPattern>
</numberEntry>
<numberEntry>
<alternateNumberId>2</alternateNumberId>
<phoneNumber>5006007015</phoneNumber>
<extension>7015</extension>
<ringPattern>Long-Long</ringPattern>
</numberEntry>
</numbers>
</AlternateNumbers>
PUT <?xml version="1.0" encoding="UTF-8" ?>
Request <AlternateNumbers
Content
xmlns="http://schema.broadsoft.com/xsi">
<distinctiveRing>true</distinctiveRing>
<numbers>
<numberEntry>
<alternateNumberId>1</alternateNumberId>
<ringPattern>Short-Short-Long</ringPattern>
</numberEntry>
</numbers>
</AlternateNumbers>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 70 OF 521
 PUT
Response No Content
Content

3.5.3.5 services/AnonymousCallRejection
This command is used to retrieve (GET method) or modify (PUT method) the settings of
Anonymous Call Rejection.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/AnonymousCallRejection
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AnonymousCallRejection
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</AnonymousCallRejection>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <AnonymousCallRejection
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</AnonymousCallRejection>
PUT
Response No Content
Content

3.5.3.6 services/AutomaticCallback
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Automatic Callback service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/AutomaticCallback
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AutomaticCallback
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</AutomaticCallback>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 71 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <AutomaticCallback
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</AutomaticCallback>
PUT
Response No Content
Content

3.5.3.7 services/AutomaticHoldRetrieve
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Automatic Hold Retrieve service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/AutomaticHoldRetrieve
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AutomaticHoldRetrieve
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
<recallTimerSeconds>120</recallTimerSeconds>
</AutomaticHoldRetrieve>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <AutomaticHoldRetrieve
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<recallTimerSeconds>60</recallTimerSeconds>
</AutomaticHoldRetrieve>
PUT
Response No Content
Content

3.5.3.8 services/BargeInExempt
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Barge-In Exempt service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BargeInExempt
Command
Category
Service Management

Methods GET, PUT

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 72 OF 521
 GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BargeInExempt xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
</BargeInExempt>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <BargeInExempt xmlns="http://schema.broadsoft.com/xsi">
Content
<active>false</active>
</BargeInExempt>
PUT
Response No Content
Content

3.5.3.9 services/BroadWorksAnywhere
This command is used to retrieve (GET method) and modify (PUT method) the settings of
the BroadWorks Anywhere service.
An HTTP GET also retrieves a list of BroadWorks Anywhere locations, which includes the
URL that can be used to obtain details on each location.
An HTTP PUT can be used to modify the general settings of the service, or the settings of
each individual location. This command cannot be used to modify a location’s
phoneNumber element, to add selective criteria, or to add a location. For this command,
the phoneNumber is used to reference the existing location. It should be noted that the
phoneNumber element must include the country code element.
The services/BroadWorksAnywhere/Location/<number> command can be used to modify
the phoneNumber element of a BroadWorks Anywhere location.
The services/BroadWorksAnywhere/Location/<number>/criteria command can be used to
add a criterion to an existing BroadWorks Anywhere location.
The services/BroadWorksAnywhere/Location command can be used to create a new
BroadWorks Anywhere location.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BroadWorksAnywhere
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 73 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BroadWorksAnywhere
Content
xmlns="http://schema.broadsoft.com/xsi">
<alertAllLocationsForClickToDialCalls>false
</alertAllLocationsForClickToDialCalls>
<alertAllLocationsForGroupPagingCalls>false
</alertAllLocationsForGroupPagingCalls>
<locations>
<location>
<locationUri>
/v2.0/user/[email protected]/services/broadworksanywher
e/location/34234234
</locationUri>
<phoneNumber>34234234</phoneNumber>
<active>true</active>
<description>Testing</description>
</location>
</locations>
</BroadWorksAnywhere>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <BroadWorksAnywhere
Content xmlns="http://schema.broadsoft.com/xsi">
<alertAllLocationsForClickToDialCalls>true
</alertAllLocationsForClickToDialCalls>
<alertAllLocationsForGroupPagingCalls>false
</alertAllLocationsForGroupPagingCalls>
<locations>
<location>
<phoneNumber countryCode="1">111111
</phoneNumber>
<active>true</active>
<description>HomeLocation</description>
<criteriaActivations>
<criteriaActivation>
<criteriaName>Home</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</location>
</locations>
</BroadWorksAnywhere>
PUT
Response No Content
Content

3.5.3.9.1 services/BroadWorksAnywhere/Location
This command is used to create a BroadWorks Anywhere location.
A successful HTTP POST request returns a Location header with the URL of the
BroadWorks Anywhere location created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BroadWorksAnywhere/Loca
tion

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 74 OF 521
 Command
Category
Service Management

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <BroadWorksAnywhereLocation
Content
xmlns="http://schema.broadsoft.com/xsi">
<phoneNumber>34234234</phoneNumber>
<description>Testing</description>
<active>true</active>
<outboundAlternateNumber> 4534345345
</outboundAlternateNumber>
<broadworksCallControl>True</broadworksCallControl>
<useDiversionInhibitor>True</useDiversionInhibitor>
<answerConfirmationRequired>false
</answerConfirmationRequired>
<criteriaActivation>
<criteriaName>Busy</criteriaName>
<active>true</active>
</criteriaActivation>
</BroadWorksAnywhereLocation>
POST
Response No Content
Content

3.5.3.9.2 services/BroadWorksAnywhere/Location/<number>
This command is used to retrieve (GET method), update (PUT method), and delete
(DELETE method) a BroadWorks Anywhere location.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BroadWorksAnywhere/Loca
tion/<number>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 75 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BroadWorksAnywhereLocation
Content xmlns="http://schema.broadsoft.com/xsi">
<phoneNumber>34234234</phoneNumber>
<description>Testing</description>
<active>true</active>
<outboundAlternateNumber>
4534345345
</outboundAlternateNumber>
<broadworksCallControl>true</broadworksCallControl>
<useDiversionInhibitor>true</useDiversionInhibitor>
<answerConfirmationRequired>
false
</answerConfirmationRequired>
<criteriaActivation>
<criteriaName>Busy</criteriaName>
<active>true</active>
<uri>
/v2.0/user/[email protected]/services/broadworksanywher
e/location/34234234/Criteria/Busy
</uri>
</criteriaActivation>
</BroadWorksAnywhereLocation>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <BroadWorksAnywhereLocation
Content xmlns="http://schema.broadsoft.com/xsi">
<phoneNumber>34234234</phoneNumber>
<description>Testing</description>
<active>true</active>
<outboundAlternateNumber>
4534345345
</outboundAlternateNumber>
<broadworksCallControl>true</broadworksCallControl>
<useDiversionInhibitor>true</useDiversionInhibitor>
<answerConfirmationRequired>false</answerConfirmationRequir
ed>
</BroadWorksAnywhereLocation>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 76 OF 521
 3.5.3.9.3 services/BroadWorksAnywhere/Location/<number>/Criteria
This command is used to create criteria for a BroadWorks Anywhere location.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BroadWorksAnywhere/Loca
tion/<number>/Criteria
Command
Category
Service Management

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <BroadWorksAnywhereLocationCriteria
Content
xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>Busy</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSchdule1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySchedule</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>Any
</fromDnCriteriaSelection>
<includeAnonymousCallers>true
</includeAnonymousCallers>
<includeUnavailableCallers>true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>4534564556</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 77 OF 521
 </BroadWorksAnywhereLocationCriteria>
POST
Response No Content
Content

3.5.3.9.4 services/BroadWorksAnywhere/Location/<number>/Criteria/<criteriaName>
This command is used to retrieve (GET method), update (PUT method), and delete
(DELETE method) criteria for a BroadWorks Anywhere location.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BroadWorksAnywhere/Loca
tion/<number>/Criteria/<criteriaName>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content Sent
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BroadWorksAnywhereLocationCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>MyCriteria</criteriaName>
<timeSchedule>
<level>Group</level>
<name>MyCriteria</name>
<uri>/v2.0/user/[email protected]/profile/schedule/time/SomeG
roupSchedule?scheduleLevel=Group</uri>
</timeSchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>Any</fromDnCriteriaSelection>
<includeAnonymousCallers>false</includeAnonymousCallers>
<includeUnavailableCallers>false
</includeUnavailableCallers>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 78 OF 521
 </criteriaCallToNumber>
</criteria>
</BroadWorksAnywhereLocationCriteria>
PUT
Request No Content Sent
Content
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <BroadWorksAnywhereLocationCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>
NewTestCriteria
</criteriaName>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</BroadWorksAnywhereLocationCriteria>
DELETE
Request No Content Sent
Content
DELETE
Response No Content Sent
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
Default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 79 OF 521
 3.5.3.10 services/BroadworksMobility (AS Only)
This command allows the retrieval (GET method) and modification (PUT method) of
BroadWorks Mobility user’s Mobility service configuration.
The GET request also retrieves a list of mobile identities, which includes the URL that can
be used to obtain details on each identity.
The PUT request can be used to modify the profile identity alerting policy.
The mobile numbers provided in the mobileNumbersAlertList element are used as a
replacement for the numbers already configured. The list of mobile numbers can be
cleared by setting the element to “nil”.
If the devicesToRing element in profileAlertingPolicy is set to ring “Mobile”, then
mobileNumbersAlertList should contain at least one mobile number. If it does not, an error
is returned.
The PUT request cannot be used to modify the following read-only elements. If these
elements are included, then they are simply ignored.
 active
 allowCallAnchoringControl
 preventCallsToOwnMobiles
 mobileIdentity
− mobileNumber
− enableAlerting
− identityUri
− primary
− description
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/broadworksmobility
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BroadWorksMobility
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<allowCallAnchoringControl>true</allowCallAnchoringControl>
<preventCallsToOwnMobiles>false</preventCallsToOwnMobiles>
<profileIdentity>
<profileAlertingPolicy>
<devicesToRing>Fixed</devicesToRing>
<includeSharedCallAppearance>true</includeSharedCallAppeara
nce>
<includeBroadWorksAnywhere>true</includeBroadWorksAnywhere>
<includeExecutiveAssistant>true</includeExecutiveAssistant>
</profileAlertingPolicy>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 80 OF 521
 </profileIdentity>
<mobileIdentity>
<mobileNumber>5146977803</mobileNumber>
<enableAlerting>true</enableAlerting>
<primary>true</primary>
<identityUri>/v2.0/user/[email protected]/services/bro
adworksmobility/mobileIdentity/5146977803</identityUri>
</mobileIdentity>
</BroadWorksMobility>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <BroadWorksMobility
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<allowCallAnchoringControl>false</allowCallAnchoringControl
>
<preventCallsToOwnMobiles>false</preventCallsToOwnMobiles>
<mobileIdentity>
<mobileNumber>5146977803</mobileNumber>
<enableAlerting>true</enableAlerting>
<primary>true</primary>
</mobileIdentity>
</BroadWorksMobility>
PUT
Response No Content
Content

3.5.3.10.1 services/BroadWorksMobility/MobileIdentity/<number> (AS Only)

This command allows the retrieval (GET method) and modification (PUT method) of
BroadWorks Mobility user’s mobile identity configuration.
The GET request also provides a URL to access the time of day or holiday schedules
used in call anchoring configuration.
A PUT request allows the user to modify the general, alerting, and call anchoring
attributes.
The mobile numbers provided in the mobileNumbersAlertList element are used as a
replacement for the numbers already configured. The list of mobile numbers can be
cleared by setting the element to “nil”.
If the devicesToRing element is set to “Mobile”, then mobileNumbersAlertList should
contain at least one mobile number. If it does not, an error is returned.
This command cannot be used to modify the following read-only elements. If the following
elements are included in the PUT request, they are simply ignored:
 mobileNumber
 primary
 uri sub-element in timeSchedule and holidaySchedule in call anchoring
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/broadworksmobility/Mobi
leIdentity/<mobileNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 81 OF 521
 Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="IS0-8859-1"?>
Response <BroadWorksMobilityMobileIdentity
Content xmlns="http://schema.broadsoft.com/xsi">
<mobileNumber>9725551111</mobileNumber>
<description>Business Galaxy-S4</description>
<enableAlerting>true</enableAlerting>
<primary>true</primary>
<alertAgentCalls>true</alertAgentCalls>
<alertClickToDialCalls>true</alertClickToDialCalls>
<alertGroupPagingCalls>true</alertGroupPagingCalls>

<useMobilityCallingLineID>false</useMobilityCallingLineID
>
<useDiversionInhibitor>true</useDiversionInhibitor>

<answerConfirmationRequired>true</answerConfirmationRequi
red>
<broadworksCallControl>true</broadworksCallControl>
<mobileAlertingPolicy>
<devicesToRing>Both</devicesToRing>
<includeSharedCallAppearance>
true
</includeSharedCallAppearance>
<includeBroadWorksAnywhere>
true
</includeBroadWorksAnywhere>
<includeExecutiveAssistant>
true
</includeExecutiveAssistant>
<mobileNumbersAlertList>
<mobileNumber>9725551111</mobileNumber>
<mobileNumber>9726661111</mobileNumber>
</mobileNumbersAlertList>
</mobileAlertingPolicy>
<mobileCallAnchoringPolicy>
<enableCallAnchoring>true</enableCallAnchoring>
<timeSchedule>
<level>User</level>
<name>Spring-Schedule</name>
<uri>

/v2.0/user/[email protected]/profile/schedule/time/Spring
-Schedule?ScheduleLevel=User
</uri>
</timeSchedule>
</mobileCallAnchoringPolicy>
<useMobilityConnectedIdentity>false</useMobilityConnected
Identity>
</BroadWorksMobilityMobileIdentity>
PUT <?xml version="1.0" encoding="IS0-8859-1"?>
Request <BroadWorksMobilityMobileIdentity
Content xmlns="http://schema.broadsoft.com/xsi"

<alertVirtualUserServices>false</alertVirtualUserServices>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 82 OF 521
 <alertClickToDialCalls>true</alertClickToDialCalls>
<alertGroupPagingCalls>true</alertGroupPagingCalls>
<broadworksCallControl>false</broadworksCallControl>
<mobileAlertingPolicy>
<devicesToRing>Mobile</devicesToRing>
<mobileNumbersAlertList>
<mobileNumber>9725551111</mobileNumber>
<mobileNumber>9726661111</mobileNumber>
</mobileNumbersAlertList>
</mobileAlertingPolicy>
<mobileCallAnchoringPolicy>
<enableCallAnchoring>true</enableCallAnchoring>
<timeSchedule>
<level>User</level>
<name>Summer-Schedule</name>
</timeSchedule>
</mobileCallAnchoringPolicy>
<useMobilityConnectedIdentity>false</useMobilityConnected
Identity>
</BroadWorksMobilityMobileIdentity>
PUT
Response No Content
Content

3.5.3.11 services/BusyLampField
This command is used to retrieve (GET method) and modify (PUT method) the settings of
the Busy Lamp Field service.
In an HTTP PUT, the existing Busy Lamp Field details are replaced with the details in the
request. To modify the monitoredUserList, only the user IDs of monitored users are
required; other elements are ignored. If the monitoredUserList is set to “nil”, then the
configured monitored users list is simply cleared.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BusyLampField
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <BusyLampField xmlns="http://schema.broadsoft.com/xsi">
Content
<listURI>[email protected]</listURI>
<monitoredUserList>
<userDetails>
<userId>[email protected]</userId>
<firstName>nav001</firstName>
<lastName>nav001</lastName>
<hiranganaLastName>nav001</hiranganaLastName>
<hiranganaFirstName>nav001</hiranganaFirstName>
</userDetails>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 83 OF 521
 <userDetails>
<userId>[email protected]</userId>
<firstName>nav001</firstName>
<lastName>nav001</lastName>
<hiranganaLastName>nav001</hiranganaLastName>
<hiranganaFirstName>nav001</hiranganaFirstName>
</userDetails>
</monitoredUserList>
</BusyLampField>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <BusyLampField xmlns="http://schema.broadsoft.com/xsi">
Content
<listURI>[email protected]</listURI>
<monitoredUserList>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
</monitoredUserList>
</BusyLampField>
PUT
Response No Content
Content

3.5.3.11.1 services/BusyLampField/MonitoredUserList
This URI retrieves and updates only the monitored user details of the Busy Lamp Field.
In a PUT request on monitored user’s URI, the existing Busy Lamp Field
monitoredUserList details are replaced with monitoredUserList details from the request.

NOTE: To modify the monitoredUserList, the request requires only the user IDs of monitored
users, the remaining elements are ignored (if present). If the monitoredUserList is set to “nil”,
then the execution of the request clears the configured monitored users list.

Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BusyLampField
/MonitoredUserList
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <monitoredUserList>
Content <userDetails>
<userId>[email protected]</userId>
<firstName>animesh</firstName>
<lastName>animesh</lastName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 84 OF 521
 <hiranganaLastName>animesh</hiranganaLastName>
<hiranganaFirstName>animesh
</hiranganaFirstName>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<firstName>kanchan</firstName>
<lastName>kanchan</lastName>
<hiranganaLastName>kanchan</hiranganaLastName>
<hiranganaFirstName>kanchan
</hiranganaFirstName>
</userDetails>
</monitoredUserList>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <monitoredUserList>
Content <userDetails>
<userId>[email protected]</userId>
</userDetails>
</monitoredUserList>
PUT
Response No Content
Content

3.5.3.11.2 services/BusyLampField/AvailableUsers
This URI retrieves a list of available users who can be monitored for the Busy Lamp Field.
The number of entries included in the response message body is limited and is subject to
a maximum value configured on the system. The default configuration value is “1000”.
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BusyLampField/Available
Users
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AvailableUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>[email protected]</userId>
<firstName>nav003</firstName>
<lastName>nav003</lastName>
<hiranganaLastName>nav003</hiranganaLastName>
<hiranganaFirstName>nav003</hiranganaFirstName>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<firstName>negi004</firstName>
<lastName>negi004</lastName>
<hiranganaLastName/><hiranganaFirstName/>
</userDetails>
</AvailableUsers>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 85 OF 521
 Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this
search criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this
search criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

3.5.3.12 services/BwReceptionist (AS Only)

The BroadWorks Receptionist URL allows for the retrieval and update of this service’s
details for a user.
In an HTTP PUT, the existing BroadWorks Receptionist details are replaced with those
sent in the request. To modify the monitoredUserList, only the user IDs of monitored
users are required; other elements are ignored. If the MonitoredUserList is set to “nil”,
then the configured monitored users list is simply cleared.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BwReceptionist
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <BroadWorksReceptionist
Content xmlns="http://schema.broadsoft.com/xsi">
<monitoredUsers>
<userDetails>
<userId>[email protected]</userId>
<firstName>john8</firstName>
<lastName>south</lastName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 86 OF 521
 <hiranganaLastName>john8</hiranganaLastName>
<hiranganaFirstName>south</hiranganaFirstName>
<groupId>South_as87</groupId>
<number>+15146987608</number>
<extension>608</extension>
<additionalDetails>
<mobile>123-456-7890</mobile>
<emailAddress>[email protected]</emailAddress>
</additionalDetails>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<firstName>john0</firstName>
<lastName>north</lastName>
<groupId>North_as87</groupId>
<number>+15146987500</number>
<extension>500</extension>
</userDetails>
</monitoredUsers>
</BroadWorksReceptionist>
PUT <?xml version="1.0" encoding="iso-8859-1"?>
Request <BroadWorksReceptionist
Content xmlns="http://schema.broadsoft.com/xsi">
<monitoredUsers>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
</monitoredUsers>
</BroadWorksReceptionist>
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

receptionistType enterprise, M Determines the type of the Receptionist as

office, any one of “Enterprise”, “Office”, or
smallbusiness “SmallBusiness”, for which the details are
retrieved or modified.

3.5.3.12.1 services/BwReceptionist/MonitoredUsers (AS Only)

This URI retrieves and updates the monitored users for a BroadWorks Receptionist
application.
 In a GET/PUT request, the parameter, receptionistType, determines the type of the
Receptionist as any one of “Enterprise”, “Office”, or “SmallBusiness”, for which the
details are retrieved or modified.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 87 OF 521
  In a PUT request on the monitored user’s URI, the existing BroadWorks Receptionist
monitoredUserList details are replaced with the monitoredUserList details from the
request.

NOTE: To modify the monitoredUserList, the request requires only the user IDs of monitored
users, the remaining elements are ignored (if present). If the monitoredUserList is set to “nil”,
then the execution of the request clears the configured monitored users list.

Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BwReceptionist/Monitore
dUsers
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <monitoredUsers>
Content
<userDetails>
<userId>[email protected]</userId>
<firstName>john8</firstName>
<lastName>south</lastName>
<hiranganaLastName>john8</hiranganaLastName>
<hiranganaFirstName>south</hiranganaFirstName>
<groupId>South_as87</groupId>
<number>+15146987608</number>
<extension>608</extension>
<additionalDetails>
<mobile>123-456-7890</mobile>
<emailAddress>[email protected]</emailAddress>
</additionalDetails>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<firstName>john0</firstName>
<lastName>north</lastName>
<groupId>North_as87</groupId>
<number>+15146987500</number>
<extension>500</extension>
</userDetails>
</monitoredUsers>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 88 OF 521
 PUT <?xml version="1.0" encoding="iso-8859-1"?>
Request <monitoredUsers>
Content
<userDetails>
<userId>[email protected]</userId>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
</monitoredUsers>
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

receptionistType enterprise, M Determines the type of the Receptionist as

office, any one of “Enterprise”, “Office”, or
smallbusiness “SmallBusiness”, for which the details are
retrieved or modified.

3.5.3.12.2 services/BwReceptionist/AvailableUsers (AS Only)

This URI retrieves a list of available users who can be monitored by the BroadWorks
Receptionist.
The number of entries included in the response message body is limited and is subject to
a maximum value configured on the system. The default configuration value is “1000”.
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/BwReceptionist/Availabl
eUsers
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <AvailableUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>[email protected]</userId>
<firstName>john0</firstName>
<lastName>north</lastName>
<groupId>North_as87</groupId>
<number>+15146987500</number>
<extension>875-500</extension>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<firstName>john8</firstName>
<lastName>south</lastName>
<hiranganaLastName>john8</hiranganaLastName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 89 OF 521
 <hiranganaFirstName>south</hiranganaFirstName>
<groupId>South_as87</groupId>
<number>+15146987608</number>
<extension>608</extension>
<additionalDetails>
<mobile>123-456-7890</mobile>
<emailAddress>[email protected]</emailAddress>
</additionalDetails>
</userDetails>
</AvailableUsers>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

receptionistType enterprise, M Determines the type of the Receptionist as

office, any one of “Enterprise”, “Office”, or
smallbusiness “SmallBusiness”, for which the details are
retrieved or modified.

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

groupId String O Search criteria for a user’s group ID.

Wild cards are not supported for this search
criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this search
criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

3.5.3.13 services/CallCenter (AS Only)

This command is used to retrieve (GET method) and modify (PUT method) the settings of
the Call Center (Basic, Standard, or Premium) service.
The response to the GET method also contains the list of assigned call centers, along with
the current join status for each call center. The PUT method can be used to modify the
join status of the agent for any of the assigned call centers. The phoneNumber,
extension, and isLogOffAllowed elements cannot be modified, and are ignored when
included.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
This command can be executed by an administrator, an agent, or a supervisor for the
agent.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 90 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallCenter
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallCenter xmlns="http://schema.broadsoft.com/xsi">
Content
<agentACDState>Sign-In</agentACDState>
<useDefaultGuardTimer>true</useDefaultGuardTimer>
<enableGuardTimer>false</enableGuardTimer>
<guardTimerSeconds>5</guardTimerSeconds>
<useSystemDefaultUnavailableSettings>true
</useSystemDefaultUnavailableSettings>
<forceAgentUnavailableOnDNDActivation>false
/forceAgentUnavailableOnDNDActivation>
<forceUnavailableOnPersonalCalls>false
</forceUnavailableOnPersonalCalls>
<forceAgentUnavailableOnBouncedCallLimit>false
</forceAgentUnavailableOnBouncedCallLimit>
<numberConsecutiveBouncedCallsToForceAgentUnavailable>3
</numberConsecutiveBouncedCallsToForceAgentUnavailable>
<makeOutgoingCallsAsCallCenter>false
</makeOutgoingCallsAsCallCenter>
<callCenterList>
<callCenterDetails>
<serviceUserId>g1PremiumCallCenter</serviceUserId>
<available>true</available>
<phoneNumber>9728880010</phoneNumber>
<extension>0010</extension>
<isLogOffAllowed>true</isLogOffAllowed>
<skillLevel>9</skillLevel>
</callCenterDetails>
</callCenterList>
</CallCenter>

PUT <?xml version="1.0" encoding="iso-8859-1"?>

Request <CallCenter xmlns="http://schema.broadsoft.com/xsi">
Content
<agentACDState>Available</agentACDState>
<useDefaultGuardTimer>true</useDefaultGuardTimer>
<enableGuardTimer>false</enableGuardTimer>
<guardTimerSeconds>5</guardTimerSeconds>
<useSystemDefaultUnavailableSettings>
true</useSystemDefaultUnavailableSettings>
<forceAgentUnavailableOnDNDActivation>
false</forceAgentUnavailableOnDNDActivation>
<forceUnavailableOnPersonalCalls>
false</forceUnavailableOnPersonalCalls>
<forceAgentUnavailableOnBouncedCallLimit>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 91 OF 521
 false</forceAgentUnavailableOnBouncedCallLimit>
<numberConsecutiveBouncedCallsToForceAgentUnavailable>
3</numberConsecutiveBouncedCallsToForceAgentUnavailable>
<makeOutgoingCallsAsCallCenter>
false</makeOutgoingCallsAsCallCenter>
<callCenterList>
<callCenterDetails>
<serviceUserId>[email protected]
</serviceUserId>
<available>true</available>
</callCenterDetails>
</callCenterList>
</CallCenter>
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

validateSignOut True/False O When this option is set to “true”, Cisco

BroadWorks validates whether the agent
can sign out without leaving stranded calls
in the call centers that the agent is staffing.
If the value of the validateSignOut
parameter is set to “true”, and if any other
elements other than the agentACDState are
present in the put request, then the request
is rejected. In addition, if the value of the
validateSignOut parameter is set to “true”,
and if the agentACDState is any value other
than “Sign-Out”, then the request is
rejected.
If the put request meets the validateSignOut
and agentACDState conditions, then the put
request returns a successful response only
if the user is not the last staffing agent of
any call center in which the agent is
assigned. In the case of a success
response, the agent state is changed to
“Sign-Out”. In the case of an error
response, the state remains unchanged.
The client can invoke the
“directories/CallCenters” command to obtain
additional information about the call centers
for which the agent is last staffing and how
many calls are remaining in those queues.
The default value is “false”.

3.5.3.14 services/CallCenterMonitoring (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Center Monitoring service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 92 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallCenterMonitoring
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <CallCenterMonitoring
Content xmlns="http://schema.broadsoft.com/xsi">
<playToneToAgentForSilentMonitoring>
false</playToneToAgentForSilentMonitoring>
</CallCenterMonitoring>
PUT <?xml version="1.0" encoding="utf-8"?>
Request <CallCenterMonitoring
Content xmlns="http://schema.broadsoft.com/xsi">
<playToneToAgentForSilentMonitoring>false
</playToneToAgentForSilentMonitoring>
</CallCenterMonitoring>
PUT
Response No Content
Content

3.5.3.15 services/CallForwardingAlways
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding Always service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingAlways
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingAlways
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+91-
2223334455</forwardToPhoneNumber>
<ringSplash>true</ringSplash>
</CallForwardingAlways>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 93 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallForwardingAlways
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+91-2223334455
</forwardToPhoneNumber>
<ringSplash>false</ringSplash>
</CallForwardingAlways>
PUT
Response No Content
Content

3.5.3.16 services/CallForwardingAlwaysSecondary
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding Always Secondary service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingAlwaysSec
ondary
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingAlwaysSecondary
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+91-
2223334455</forwardToPhoneNumber>
<ringSplash>true</ringSplash>
</CallForwardingAlwaysSecondary>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallForwardingAlwaysSecondary
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+91-2223334455
</forwardToPhoneNumber>
<ringSplash>false</ringSplash>
</CallForwardingAlwaysSecondary>
PUT
Response No Content
Content

3.5.3.17 services/CallForwardingBusy
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding Busy service.
Method Description

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 94 OF 521
 URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingBusy
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingBusy
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>23234434223
</forwardToPhoneNumber>
</CallForwardingBusy>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallForwardingBusy
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>23234434223</forwardToPhoneNumber>
</CallForwardingBusy>
PUT
Response No Content
Content

3.5.3.18 services/CallForwardingNoAnswer
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding No Answer service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingNoAnswer
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingNoAnswer
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+1-221131313
</forwardToPhoneNumber>
<numberOfRings>5</numberOfRings>
</CallForwardingNoAnswer>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 95 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallForwardingNoAnswer
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+1-221131313
</forwardToPhoneNumber>
<numberOfRings>7</numberOfRings>
</CallForwardingNoAnswer>
PUT
Response No Content
Content

3.5.3.19 services/CallForwardingNotReachable
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding Not Reachable service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingNotReacha
ble
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingNotReachable
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>+1-221131313
</forwardToPhoneNumber>
</CallForwardingNotReachable>
PUT <?xml version="1.0" encoding=“ISO-8859-1"?>
Request <CallForwardingNotReachable
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
<forwardToPhoneNumber>+1-221131313</forwardToPhoneNumber>
</CallForwardingNotReachable>
PUT
Response No Content
Content

3.5.3.20 services/CallForwardingSelective
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Forwarding Selective service.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 96 OF 521
 The PUT method is used to modify the general attributes of the service and can also be
used to activate or deactivate a specific criterion. To modify the attributes of a specific
criterion, the application should be using the PUT method on the
/services/callforwardingselective/criteria/<criteriaName>. The criterion attributes included
in the XML document (other than the “active” element) are ignored. The criteria not
included in the XML document are unchanged.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallForwardingSelective
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 97 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingSelective
Content xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
<defaultForwardToPhoneNumber>
0002
</defaultForwardToPhoneNumber>
<playRingReminder>false</playRingReminder>
<criteriaActivations>
<criteriaActivation>
<criteriaName>criteria2</criteriaName>
<active>true</active>
<uri>/v2.0/user/userSP1A@broadworks/services/
callforwardingselective/criteria/criteria2</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>criteria3</criteriaName>
<active>true</active>
<uri>/v2.0/user/userSP1A@broadworks/services/
callforwardingselective/criteria/criteria3</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>criteriaTEST</criteriaName>
<active>true</active>
<uri>/v2.0/user/userSP1A@broadworks/services/
callforwardingselective/criteria/criteriaTEST</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria10</criteriaName>
<active>true</active>
<uri>/v2.0/user/userSP1A@broadworks/services/
callforwardingselective/criteria/criteria10</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>criteria1</criteriaName>
<active>true</active>
<uri>/v2.0/user/userSP1A@broadworks/services/
callforwardingselective/criteria/criteria1</uri>
</criteriaActivation>
</criteriaActivations>
</CallForwardingSelective>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallForwardingSelective
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<defaultForwardToPhoneNumber>
0002
</defaultForwardToPhoneNumber>
<playRingReminder>true</playRingReminder>
</CallForwardingSelective>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 98 OF 521
3.5.3.20.1 services/CallForwardingSelective/criteria
This command is used to add a Call Forwarding Selective criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
CallForwardingSelective/criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <CallForwardingSelectiveCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<forwardToNumberSelection>
Forward To Specified Number
</forwardToNumberSelection>
<forwardToPhoneNumber>0001</forwardToPhoneNumber>
<criteria>
<criteriaName>Criteria10</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0006</phoneNumber>
</phoneNumberList>
</criteriaFromDn>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 99 OF 521
 <criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CallForwardingSelectiveCriteria>
POST
Response No Content
Content

3.5.3.20.2 services/CallForwardingSelective/criteria/<criteriaName>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Call Forwarding Selective service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attributes of a selected criterion. To activate or
deactivate a specific criterion, the application should use the PUT method on the
/services/callforwardingselective command. The “uri” schedule element is ignored when
included in the XML document.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
CallForwardingSelective/criteria/<criterianame>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallForwardingSelectiveCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<forwardToNumberSelection>Forward To Specified
Number</forwardToNumberSelection>
<forwardToPhoneNumber>0001</forwardToPhoneNumber>
<criteria>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 100 OF 521
 <criteriaName>Criteria10</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0006</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CallForwardingSelectiveCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallForwardingSelectiveCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<criteria>
<criteriaName>Criteria10</criteriaName>
<timeSchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 101 OF 521
 <level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0006</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CallForwardingSelectiveCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 102 OF 521
 3.5.3.21 services/CallingLineIDBlockingOverride
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Line ID Blocking Override service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingLineIDBlockingOv
erride
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallingLineIDBlockingOverride
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</CallingLineIDBlockingOverride>
PUT <?xml version="1.0” encoding="ISO-8859-1”?>
Request <CallingLineIDBlockingOverride
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</CallingLineIDBlockingOverride>
PUT
Response No Content
Content

3.5.3.22 services/CallingLineIDDeliveryBlocking
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Line ID Delivery Blocking service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingLineIDDeliveryBl
ocking
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallingLineIDDeliveryBlocking
Content
xmlns="http://schema.broadsoft.com/xsi ">
<active>true</active>
</CallingLineIDDeliveryBlocking>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 103 OF 521
 PUT <?xml version="1.0” encoding="ISO-8859-1”?>
Request <CallingLineIDDeliveryBlocking
Content
xmlns="http://schema.broadsoft.com/xsi ">
<active>false</active>
</CallingLineIDDeliveryBlocking>
PUT
Response No Content
Content

3.5.3.23 services/CallingNameDelivery
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Name Delivery service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingNameDelivery
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallingNameDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<isActiveForExternalCalls>true</isActiveForExternalCalls>
<isActiveForInternalCalls>true</isActiveForInternalCalls>
</CallingNameDelivery>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallingNameDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<isActiveForExternalCalls>
true
</isActiveForExternalCalls>
<isActiveForInternalCalls>
true
</isActiveForInternalCalls>
</CallingNameDelivery>
PUT
Response No Content
Content

3.5.3.24 services/CallingNameRetrieval
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Name Retrieval service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 104 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingNameRetrieval
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallingNameRetrieval
Content
xmlns="http://schema.broadsoft.com/xsi”>
<active>true</active>
</CallingNameRetrieval>
PUT <?xml version="1.0” encoding="ISO-8859-1”?>
Request <CallingNameRetrieval
Content
xmlns="http://schema.broadsoft.com/xsi”>
<active>false</active>
</CallingNameRetrieval>
PUT
Response No Content
Content

3.5.3.25 services/CallingNumberDelivery
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Number Delivery service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingNumberDelivery
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallingNumberDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<isActiveForExternalCalls>true</isActiveForExternalCalls>
<isActiveForInternalCalls>true</isActiveForInternalCalls>
</CallingNumberDelivery>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 105 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallingNumberDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<isActiveForExternalCalls>
true
</isActiveForExternalCalls>
<isActiveForInternalCalls>
true
</isActiveForInternalCalls>
</CallingNumberDelivery>
PUT
Response No Content
Content

3.5.3.26 services/CallingPartyCategory
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Calling Party Category service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallingPartyCategory
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallingPartyCategory
Content
xmlns="http://schema.broadsoft.com/xsi”>
<category>Ordinary</category>
</CallingPartyCategory>

3.5.3.27 services/CallMeNow
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Me Now service.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.
The PUT method is used to modify the general attributes of the service and can also be
used to activate or deactivate a specific criterion. To modify the attributes of a specific
criterion, the application should use the PUT method on the
/services/callmenow/criteria/<criteriaName>. The criterion attributes included in the XML
document (other than the “active” element) are ignored. The criteria not included in the
XML document are unchanged.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 106 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallMeNow
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallMeNow xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
<answerConfirmation>Passcode</answerConfirmation>
<criteriaActivations>
<criteriaActivation>
<criteriaName>criteria1</criteriaName>
<active>true</active>
<uri>
/v2.0/user/userSP1A@broadworks/services/callmenow/criteria/
criteria1
</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>criteria6</criteriaName>
<active>true</active>
<uri>
/v2.0/user/userSP1A@broadworks/services/callmenow/criteria/
criteria6
</uri>
</criteriaActivation>
</criteriaActivations>
</CallMeNow>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallMeNow xmlns="http://schema.broadsoft.com/xsi">
Content
<active>false</active>
<answerConfirmation>Passcode</answerConfirmation>
<criteriaActivations>
<criteriaActivation>
<criteriaName>criteria1</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</CallMeNow>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 107 OF 521
3.5.3.27.1 services/CallMeNow/Criteria
This command is used to add a Call Me Now service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallMeNow/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <CallMeNowCriteria xmlns="http://schema.broadsoft.com/xsi">
Content
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaToDn>
<toDnCriteriaSelection>
Specified Only
</toDnCriteriaSelection>
<phoneNumberList>
<phoneNumber>00001</phoneNumber>
</phoneNumberList>
</criteriaToDn>
</criteria>
</CallMeNowCriteria>
POST
Response No Content
Content

3.5.3.27.2 services/CallMeNow/Criteria/<criteriaName>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Call Me Now service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attribute of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/callmenow command. The “uri” schedule element is ignored when included in
the XML document.
Method Description

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 108 OF 521
 URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallMeNow/Criteria
/<criteriaName>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallMeNowCriteria xmlns="http://schema.broadsoft.com/xsi">
Content <blackListed>true</blackListed>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaToDn>
<toDnCriteriaSelection>
Specified Only
</toDnCriteriaSelection>
<phoneNumberList>
<phoneNumber>00001</phoneNumber>
</phoneNumberList>
</criteriaToDn>
</criteria>
</CallMeNowCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallMeNowCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaToDn>
<toDnCriteriaSelection>
Specified Only

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 109 OF 521
 </toDnCriteriaSelection>
<phoneNumberList>
<phoneNumber>00001</phoneNumber>
</phoneNumberList>
</criteriaToDn>
</criteria></CallMeNowCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.28 services/CallNotify
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Notify service.
In an HTTP PUT, existing criteria can be enabled or disabled, but additional criteria cannot
be added.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallNotify
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 110 OF 521
 GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallNotify xmlns="http://schema.broadsoft.com/xsi ">
Content
<callNotifyEmailAddress>[email protected]
</callNotifyEmailAddress>
<criteriaActivation>
<criteriaName>time</criteriaName>
<active>false</active>
</criteriaActivation>
</CallNotify>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallNotify xmlns="http://schema.broadsoft.com/xsi">
Content
<callNotifyEmailAddress>[email protected]
</callNotifyEmailAddress>
<criteriaActivation>
<criteriaName>time</criteriaName>
<active>false</active>
</criteriaActivation>
</CallNotify>
PUT
Response No Content
Content

3.5.3.28.1 services/CallNotify/Criteria

This command is used to add a Call Notify criterion.

A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallNotify/Criteria
Command
Category
Services

Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 111 OF 521
 POST <?xml version="1.0" encoding="UTF-8"?>
Request <CallNotifyCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<notify>true</notify>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>Any
</fromDnCriteriaSelection>
<includeAnonymousCallers>true
</includeAnonymousCallers>
<includeUnavailableCallers>true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>4534564556</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber> </criteria>
</CallNotifyCriteria>
POST
Response No Content
Content

3.5.3.28.2 services/CallNotify/Criteria/<criteriaName>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Call Notify service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 112 OF 521
 The PUT method is used to modify the attribute of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/callnotify command. The “uri” schedule element is ignored when included in the
XML document.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallNotify/Criteria
/<criteriaName>
Command
Category
Services

Methods GET, PUT, DELETE

GET Request
Content
No Content

GET <?xml version="1.0" encoding="ISO-8859-1"?>

Response <CallNotifyCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<notify>true</notify>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name> <uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name> <uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>Any</fromDnCriteriaSelection>
<includeAnonymousCallers>false</includeAnonymousCallers>
<includeUnavailableCallers>false
</includeUnavailableCallers>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CallNotifyCriteria>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 113 OF 521
 PUT Request <?xml version="1.0" encoding="UTF-8"?>
Content <CallNotifyCriteria
xmlns="http://schema.broadsoft.com/xsi">
<notify>true</notify>
<criteria>
<criteriaName>criteria7</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CallNotifyCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.29 services/CallPark
This command is used to find the list of Call Park groups to which the user belongs, if any,
and the list of users in the group.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallPark
Command
Category
Service Management

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 114 OF 521
 Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallPark xmlns="http://schema.broadsoft.com/xsi">
Content
<callParkGroup>Grp1</callParkGroup>
<userDetailsList>
<userDetails>
<userId>[email protected]</userId>
<lastName>eventssp1user1</lastName>
<firstName>eventssp1user1</firstName>
<hiraganaLastName>eventssp1user1</hiraganaLastName>
<hiraganafirstName>eventssp1user1</hiraganafirstName>
</userDetails>
<userDetails>
<userId>[email protected]</userId>
<lastName>eventssp1user2</lastName>
<firstName>eventssp1user2</firstName>
<hiraganaLastName>eventssp1user2</hiraganaLastName>
<hiraganafirstName>eventssp1user2</hiraganafirstName>
</userDetails>
</userDetailsList>
</CallPark>

3.5.3.30 services/CallRecording (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Recording service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallRecording
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <CallRecording xmlns="http://schema.broadsoft.com/xsi">
Content <recordingMode>always-pause-resume</recordingMode>
<pauseResumeNotifyMethod>none</pauseResumeNotifyMode>
<playCallRecordingStartStopAnnouncement>false</
playCallRecordingStartStopAnnouncement>
<playCallRecordingWarningTone>false</
playCallRecordingWarningTone>
<playCallRecordingWarningToneSeconds>15</
playCallRecordingWarningToneSeconds>
</CallRecording>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 115 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CallRecording xmlns="http://schema.broadsoft.com/xsi">
Content
<playCallRecordingStartStopAnnouncement>false</
playCallRecordingStartStopAnnouncement>
<playCallRecordingWarningTone>false</
playCallRecordingWarningTone>
<playCallRecordingWarningToneSeconds>15</
playCallRecordingWarningToneSeconds>
</CallRecording>
PUT
Response No Content
Content

3.5.3.31 services/CallTransfer
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Transfer service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallTransfer
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <CallTransfer xmlns="http://schema.broadsoft.com/xsi ">
Content
<isRecallActive>true</isRecallActive>
<recallNumberOfRings>5</recallNumberOfRings>
<enableBusyCampOn>true</enableBusyCampOn>
<busyCampOnSeconds>130</busyCampOnSeconds>
<useDiversionInhibitorForBlindTransfer>true
</useDiversionInhibitorForBlindTransfer>
<useDiversionInhibitorForConsultativeCalls>true
</useDiversionInhibitorForConsultativeCalls>
</CallTransfer>
PUT <?xml version="1.0" encoding=ISO-8859-1"?>
Request <CallTransfer xmlns=http://schema.broadsoft.com/xsi>
Content
<isRecallActive>true</isRecallActive>
<recallNumberOfRings>5</recallNumberOfRings>
<enableBusyCampOn>true</enableBusyCampOn>
<busyCampOnSeconds>130</busyCampOnSeconds>
<useDiversionInhibitorForBlindTransfer>true
</useDiversionInhibitorForBlindTransfer>
<useDiversionInhibitorForConsultativeCalls>true
</useDiversionInhibitorForConsultativeCalls>
</CallTransfer>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 116 OF 521
 3.5.3.32 services/CallWaiting
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Call Waiting service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CallWaiting
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallWaiting xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
</CallWaiting>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CallWaiting xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
</CallWaiting>
PUT
Response No Content
Content

3.5.3.33 services/ChargeNumber
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Charge Number service.
Method Description
URI https://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ChargeNumber
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ChargeNumber xmlns="http://schema.broadsoft.com/xsi">
Content
<useChargeNumberForEnhancedTranslations>true</useChargeNu
mberForEnhancedTranslations>

<sendChargeNumberToNetwork>true</sendChargeNumberToNetwor
k>
</ChargeNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 117 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <ChargeNumber xmlns="http://schema.broadsoft.com/xsi">
Content
<useChargeNumberForEnhancedTranslations>true</useChargeNu
mberForEnhancedTranslations>

<sendChargeNumberToNetwork>true</sendChargeNumberToNetwor
k>
</ChargeNumber>
PUT
Response No Content
Content

3.5.3.34 services/Collaborate (AS Only)

The services/collaborate URL allows a remote application to get information on all of the
rooms for the specified user using the GET method and to modify the settings for all
instant rooms using the PUT method.
The GET request returns a successful or an error response. The successful response
contains information on all of the rooms that the user owns as well as the common
settings for all instant rooms.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/collaborate
Command
Services
Category
Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Collaborate xmlns="http://schema.broadsoft.com/xsi"
Content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<bridgeInfo>
<bridgeID>[email protected]</bridgeID>
<phonenumber>+19726992650</phonenumber>
<maxParticipants>15</maxParticipants>
<alternateNumbers>
<numberEntry>
<alternateNumberId>1</alternateNumberId>
<phoneNumber>9726992667</phoneNumber>
<extension>667</extension>
<ringPattern>Short-Long-Short</ringPattern>
<description>North Alternate Number1</description>
</ numberEntry >
< numberEntry >
<alternateNumberId>2</alternateNumberId>
<phoneNumber>9726992668</phoneNumber>
<extension>668</extension>
<ringPattern>Long-Long</ringPattern>
<description>North Alternate Number2</description>
</ numberEntry >
< numberEntry >
<alternateNumberId>3</alternateNumberId>
<phoneNumber>9726992669</phoneNumber>
<extension>669</extension>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 118 OF 521
 <ringPattern>Short-Short-Long</ringPattern>
<description>North Alternate Number3</description>
</ numberEntry >
</alternateNumbers>
</bridgeInfo>
<rooms>
<room>
<name>My room</name>
<roomType>MyRoom</roomType>
<roomId>703962</roomId>
</room>
<room>
<name>Code Inspection</name>
<roomType>ProjectRoom</roomType>
<roomId>757062</roomId>
</room>
<room>
<name>FS Review</name>
<roomType>ProjectRoom</roomType>
<roomId>622326</roomId>
</room>
<room>
<name>Department Meeting</name>
<roomType>ProjectRoom</roomType>
<roomId>778386</roomId>
</room>
<room>
<name>776828</name>
<roomType>InstantRoom</roomType>
<roomId>776828</roomId>
</room>
</rooms>
<commonInstantRoomSettings>
<endSessionOnOwnerExit>true</endSessionOnOwnerExit>
<ownerRequired>false</ownerRequired>
<attendeeNotification>No Notification
</attendeeNotification>
</commonInstantRoomSettings>
</Collaborate>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <Collaborate xmlns="http://schema.broadsoft.com/xsi">
Content <commonInstantRoomSettings>
<endSessionOnOwnerExit>false
</endSessionOnOwnerExit>
<ownerRequired>true</ownerRequired>
<attendeeNotification>No Notification
</attendeeNotification>
</commonInstantRoomSettings>
</Collaborate>
PUT
Response No Content
Content

3.5.3.34.1 services/Collaborate/Room (AS Only)

The services/collaborate/room URL allows the remote application to create a new project
or instant room using the POST method.
The endSessionOnOwnerExit, ownerRequired, attendeeNotification, and roomSchedule
are required in the request to create a project room. If they are not specified, the request
will be failed.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 119 OF 521
 The endSessionOnOwnerExit, ownerRequired, attendeeNotification, and roomSchedule
are not required in the request to create an instant room. If they are specified, the request
will be failed.
The request to create my room is not supported and the request will be failed.
The roomName must be specified for the request to create a project room; otherwise, the
request will be failed. If the roomName is not specified in the request to create an instant
room, the roomId is used for the roomName.
The instantRoomDuration element is applicable for an instant room. The
instantRoomDuration is automatically generated. If the instantRoomDuration is specified,
the element is ignored.
The roomId element is automatically generated. If the roomId is specified, it is ignored. A
successful POST request returns a Location header with the URL of the room created in
the request. For example:
/v2.0/user/[email protected]/services/collaborate/room/6354894.
The URL contains the room ID for the new room.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/collaborate/room
Command
Services
Category
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <CollaborateRoomInfo xmlns="http://schema.broadsoft.com/xsi">
Content <name>Project Alpha</name>
<type>ProjectRoom</type>
<endSessionOnOwnerExit>false
</endSessionOnOwnerExit>
<ownerRequired>true</ownerRequired>
<attendeeNotification>Play Tone</attendeeNotification>
<roomSchedule>
<scheduleReservationless>
<startTime>2014-12-24T00:00:00</startTime>
<endTime>2000-01-01T00:00:00</endTime>
</scheduleReservationless>
</roomSchedule>
</CollaborateRoomInfo>
POST
Response No Content
Content

3.5.3.34.2 services/Collaborate/Room/<roomid> (AS Only)

The services/collaborate/room/roomid URL allows a remote application to get the settings
of a specific collaborate room using the GET method, to modify the settings of a specific
project room or my room using the PUT method and to delete a room using the DELETE
method. The specific collaborate room is specified by the roomid URL parameter.
The roomType element is ignored if is specified in the PUT request content. The PUT
request is returned with an error response if the specified room is an instant room.
The roomSchedule element is not applicable for my room. If it is specified, the request to
modify my room will be failed.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 120 OF 521
 The roomSchedule parameter is applicable for project room. This parameter cannot be
cleared.
The GET/DELETE request does not have the request content. The GET response
contains the room settings applicable for the specified room. The roomSchedule is only
present in the response for the retrieval of a project room while the instantRoomDuration is
only present in the response for the retrieval of an instant room.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/collaborate/room/<roomi
d>
Command Services
Category
Methods GET, PUT, DELETE
GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <CollaborateRoomInfo
Content xmlns="http://schema.broadsoft.com/xsi">
<name>Code Inspection</name>
<roomType>ProjectRoom</roomType>
<roomId>757062</roomId>
<endSessionOnOwnerExit>false
</endSessionOnOwnerExit>
<ownerRequired>true</ownerRequired>
<attendeeNotification>Play Tone</attendeeNotification>
<roomSchedule>
<scheduleReservationless>
<startTime>2014-12-24T00:00:00</startTime>
<endTime>2000-01-01T00:00:00</endTime>
</scheduleReservationless>
</roomSchedule>
</CollaborateRoomInfo>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CollaborateRoomInfo
Content xmlns="http://schema.broadsoft.com/xsi">
<name>Project Alpha</name>
<endSessionOnOwnerExit>false
</endSessionOnOwnerExit>
<ownerRequired>true</ownerRequired>
<attendeeNotification>No Notification
</attendeeNotification>
<roomSchedule>
<scheduleReservationless>
<startTime>2014-12-24T00:00:00</startTime>
<endTime>2000-01-01T00:00:00</endTime>
</scheduleReservationless>
</roomSchedule>
</CollaborateRoomInfo>
PUT
Response No Content
Content
DELETE
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 121 OF 521
 DELETE
Response 200 if the room was successfully removed.
Content

3.5.3.34.3 services/Collaborate/Room/<roomid>/Reset (AS Only)

The services/collaborate/room/<roomid>/reset URL allows a remote application to
generate a new roomid for an existing room. A successful HTTP POST request returns a
Location header with a URL that reflects the creation of the new roomId (for example,
/v2.0/user/user@domain/services/collaborate/room/6354894).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/collaborate/room/<roomid>/r
eset
Command
Services
Category
Methods POST
POST
Request No Content
Content
POST
Response No Content
Content

3.5.3.35 services/ConnectedLineIdentificationPresentation
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Connected Line Identification Presentation service.
Method Description
URI https://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ConnectedLineIdentifica
tionPresentation
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ConnectedLineIdentificationPresentation
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</ConnectedLineIdentificationPresentation>

3.5.3.36 services/ConnectedLineIdentificationRestriction
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Connected Line Identification Restriction service.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 122 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ConnectedLineIdentifica
tionRestriction
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ConnectedLineIdentificationRestriction
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</ConnectedLineIdentificationRestriction>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <ConnectedLineIdentificationRestriction
Content xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</ConnectedLineIdentificationRestriction>
PUT
Response No Content
Content

3.5.3.37 services/CustomRingbackUser
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Custom Ringback User service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/CustomRingbackUser
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CustomRingbackUser
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>
<uri>
/v2.0/user/userSP1A@broadworks/services/
customringbackuser/criteria/Criteria1
</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>false</active>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 123 OF 521
 <uri>
/v2.0/user/userSP1A@broadworks/services/
customringbackuser/criteria/Criteria2
</uri>
</criteriaActivation>
</criteriaActivations>
</CustomRingbackUser>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <CustomRingbackUser
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</CustomRingbackUser>
PUT
Response No Content
Content

3.5.3.37.1 services/CustomRingbackUser/Criteria
This command is used to add a Custom Ringback User service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
CustomRingbackUser/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <CustomRingbackUserCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 124 OF 521
 true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</CustomRingbackUserCriteria>
POST
Response No Content
Content

3.5.3.37.2 services/CustomRingbackUser/Criteria/<criteriaName>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Custom Ringback User service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attributes of a selective criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/customringbackuser command. The “uri” schedule element is ignored when
included in the XML document.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
CustomRingbackUser/Criteria/<criteriaName>
Command
Category
Services

Methods GET, PUT, DELETE

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 125 OF 521
 GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CustomRingbackUserCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 126 OF 521
 </CustomRingbackUserCriteria>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <CustomRingbackUserCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/Time
Sched1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/H
olidaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
</criteriaCallToNumber>
</criteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 127 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.38 services/DirectedCallPickupWithBargeIn
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Directed Call Pickup with Barge-In service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/DirectedCallPickupWithB
argeIn
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <DirectedCallPickupWithBargeIn
Content xmlns="http://schema.broadsoft.com/xsi">
<enableBargeInWarningTone>true</enableBargeInWarningTone>

<enableAutomaticTargetSelection>false</enableAutomaticTarge
tSelection>
</DirectedCallPickupWithBargeIn>
PUT <?xml version="1.0" encoding="UTF-
Request 8"?><DirectedCallPickupWithBargeIn
Content xmlns="http://schema.broadsoft.com/xsi">
<enableBargeInWarningTone>true</enableBargeInWarningTone>

<enableAutomaticTargetSelection>true</enableAutomaticTarget
Selection>
</DirectedCallPickupWithBargeIn>
PUT
Response No Content
Content

3.5.3.39 services/DoNotDisturb
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Do Not Disturb service.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 128 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/DoNotDisturb
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <DoNotDisturb xmlns="http://schema.broadsoft.com/xsi">
Content
<active>false</active>
<ringSplash>false</ringSplash>
</DoNotDisturb>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <DoNotDisturb xmlns="http://schema.broadsoft.com/xsi">
Content
<active>false</active>
<ringSplash>true</ringSplash>
</DoNotDisturb>
PUT
Response No Content
Content

3.5.3.40 services/Executive (AS Only)

This is the root URI for the Executive service that contains four elements:
 user/<userid>services/executive/assistants
 user/<userid>services/executive/filtering
 user/<userid>services/executive/screening
 user/<userid>services/executive/alerting

Only the GET command is supported by this URI. Both the Executive and the Executive
Assistant are authorized to perform this request.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/ user/<userid>/services/Executive
Command
Category
Services

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 129 OF 521
 GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <Executive xmlns=“http://schema.broadsoft.com/xsi”
Content xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<assistants>/v2.0/user/[email protected]/services/exe
cutive/assistants</assistants>
<filtering/v2.0/user/[email protected]/services/execu
tive/filtering</filtering>
<screening>/v2.0/user/[email protected]/services/exec
utive/screening </screening>
<alerting>/v2.0/user/[email protected]/services/execu
tive/screening </alerting>
</Executive>

3.5.3.40.1 services/Executive/Alerting (AS Only)

This command gets the alerting configuration for an executive. This includes the alerting
mode in which the assistant pool should be alerted, the number of rings before the call is
recalled, the calling line ID name and number configuration, and so on.
Both the Executive and Executive Assistant users have the authorization to perform this
request.
In an HTTP PUT, the alerting configuration is replaced with the details in the request.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/executive/alerting
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveAlerting
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<alertingMode>Simultaneous</alertingMode>
<alertingCallingLineIdNameMode>Executive</alertingCalling
LineIdNameMode>
<alertingCustomCallingLineIdName>Alice</alertingCallingLi
neIdName>
<alertingCallingLineIdPhoneNumberMode>Executive</alerting
CallingLineIdPhoneNumberMode>
<alertingCustomCallingLineIdPhoneNumber>2131001001</alert
ingCallingLineIdPhoneNumber>
<callPushRecallNumberOfRings>2</callPushRecallNumberOfRin
gs>
<nextAssistantNumberOfRings>2</nextAssistantNumberOfRings
>
<enableRollover>true</enableRollover>
<rolloverWaitTimeSeconds>10</rolloverWaitTimeSeconds>
<rolloverAction>Forward</rolloverAction>
<rolloverForwardToPhoneNumber>2131001045</rolloverForward
ToPhoneNumber>
</ExecutiveAlerting>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 130 OF 521
 PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveAlerting
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<alertingMode>Sequential</alertingMode>
<alertingCallingLineIdNameMode>Executive</alertingCalling
LineIdNameMode>
<alertingCustomCallingLineIdName>Alice-
Marketing</alertingCallingLineIdName>
<alertingCallingLineIdPhoneNumberMode>Custom</alertingCal
lingLineIdPhoneNumberMode>
<alertingCustomCallingLineIdPhoneNumber>2131001001</alert
ingCallingLineIdPhoneNumber>
<callPushRecallNumberOfRings>2</callPushRecallNumberOfRin
gs>
<nextAssistantNumberOfRings>2</nextAssistantNumberOfRings
>
<enableRollover>true</enableRollover>
<rolloverWaitTimeSeconds>10</rolloverWaitTimeSeconds>
<rolloverAction>Forward</rolloverAction>
<rolloverForwardToPhoneNumber>2131001045</rolloverForward
ToPhoneNumber>
</ExecutiveAlerting>
PUT
Response 200
Content

3.5.3.40.2 services/Executive/Assistants (AS Only)

This command allows a remote application to retrieve the list of Assistants that are
assigned to an Executive along with the opt-in/opt-out configuration. Only an Executive
user has the authorization to perform this request.
The list of Assistants assigned to the Executive can be fetched using the GET command
and modified using the PUT command.
An HTTP PUT can be used to assign a list of assistants. It can also be used to replace
the list with the list in the request.

NOTE: To modify the assignedUsers, the request requires only the user IDs of assigned users.
The remaining elements are ignored (if present). If the assignedUsers is set to “nil”, then the
execution of the request clears the configured assigned users list.

The optIn element in userDetails can be modified by the /user/<userid>/services/

executiveassistant command.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Assistants
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 131 OF 521
 GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveAssistants
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<allowOptInOut>true</allowOptInOut>
<assignedUsers>
<userDetails> <userId>[email protected]</userId>
<optIn>true</optIn
</userDetails>
</assignedUsers>
</ExecutiveAssistants>
PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveAssistants
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<allowOptInOut>true</allowOptInOut>
<assignedUsers>
<userDetails>
<userId>[email protected]</userId>

</userDetails>
</assignedUsers>
</ExecutiveAssistants>
PUT
Response 200
Content

3.5.3.40.2.1 services/Executive/Assistants/AvailableUsers (AS Only)

This command allows a remote application to retrieve the list of available Assistants that
can be assigned to an Executive. Only an Executive user has the authorization to perform
this request.
The number of entries included in the response message body is limited and is subject to
a maximum value configured on the system. The default configuration value is “1000”.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Assistants/Av
ailableUsers
Command
Category
Services

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 132 OF 521
 GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <AvailableUsers xmlns=“http://schema.broadsoft.com/xsi”
Content xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<userDetails>
<userId>asmith</userId>
<firstName>Arthur</firstName>
<lastName>Smith</lastName>
<hiranganaLastName>Smith</hiranganaLastName>
<hiranganaFirstName>Arthur</hiranganaFirstName>
<extension>0002</extension>
</userDetails>
<userDetails>
<userId>djones</userId>
<firstName>David</firstName>
<lastName>Jones</lastName>
<hiranganaLastName>Jones</hiranganaLastName>
<hiranganaFirstName>David</hiranganaFirstName>
<extension>0003</extension>
</userDetails>
</AvailableUsers>

The results of this command are searchable based on the following criteria.
Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this
search criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this
search criterion.

userId String O Search criteria for a user’s ID.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

dn String O Search criteria for a user’s DN.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

extension String O Search criteria for a user’s extension.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 133 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

impId String O Search criteria for a user’s impId.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

3.5.3.40.2.2 services/Executive/Assistants/AssignedUsers (AS Only)

This command is a subset of the executive/assistants command. This allows a remote
application to retrieve the list of Assistants that are assigned to an Executive. Only an
Executive user has the authorization to perform this request.
The list of Assistants assigned to the executive can be fetched using the GET command.
An HTTP PUT can be used to assign a list of Assistants. It can also be used to replace
the list with the list in the request. The optIn element in userDetails can be modified by the
/user/<userid>/services/executiveassistant command.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Assistants/As
signedUsers
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <assignedUsers xmlns=“http://schema.broadsoft.com/xsi”
Content xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<userDetails>
<userId>[email protected]</userId>
<optIn>true</optIn
</userDetails>
</assignedUsers>
PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <assignedUsers xmlns=“http://schema.broadsoft.com/xsi”
Content xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<userDetails>
<userId>[email protected]</userId>
</userDetails>
</assignedUsers>
PUT
Response 200
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 134 OF 521
 3.5.3.40.3 services/Executive/Filtering (AS Only)
This command is used to retrieve (GET method) or modify (PUT method) the call filtering
configuration assigned to the Executive.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.
The PUT method is used to activate or deactivate a specific criterion. To modify the
attributes of a specific criterion, the application should be using the PUT method on the
/services/executive/filtering/criteria/<criteriaName>. The criterion attributes included in the
XML document (other than the “active” element) are ignored. The criteria not included in
the XML document are unchanged.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Filtering
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveCallFiltering
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableFiltering>true</enableFiltering>
<filteringMode>Simple</filteringMode>
<simpleFilterType>All Calls</simpleFilterType>
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>

<uri>/v2.0/user/userSP1A@broadworks/services/executive/fi
ltering/criteria/Criteria1</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>false</active>

<uri>/v2.0/user/userSP1A@broadworks/services/executive/fi
ltering/criteria/Criteria2</uri>
</criteriaActivation>
</criteriaActivations>
</ExecutiveCallFiltering>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 135 OF 521
 PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveCallFiltering
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableFiltering>true</enableFiltering>
<filteringMode>Simple</filteringMode>
<simpleFilterType>All Calls</simpleFilterType>
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations> </ExecutiveCallFiltering>
PUT
Response No Content
Content

3.5.3.40.3.1 services/Executive/Filtering/Criteria (AS Only)

This command adds selective criteria to an Executive user for screening calls. Both the
Executive and Executive Assistant users have the authorization to perform this request.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/executive/filtering/cri
teria
Command
Category
Services

Methods POST
POST <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveFilteringCriteria
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 136 OF 521
 <criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</ExecutiveFilteringCriteria>
POST
Response No Content
Content

3.5.3.40.3.2 services/Executive/Filtering/Criteria/<criterianame> (AS Only)

This command retrieves, modifies, or deletes filtering selective criteria for an Executive for
screening calls. Both the Executive and Executive Assistant users have the authorization
to perform this request.
This command is used to retrieve (GET method), modify (PUT method), or remove
(DELETE method) the specified Executive Call Filtering service criterion.
The PUT method is used to modify the attribute of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/executive/filtering command. The active and uri criteria elements are ignored
when included in the XML document.
The uri in the criterion will not work if the command is requested by an Executive Assistant
when either:
a. The schedule is a group level schedule and the Executive and the Executive Assistant
are in two different groups, or
b. The schedule is a personal schedule for the Executive.
If the command is requested by an admin or the Executive themselves, the uri in the
criterion will work irrespective of the type of schedule.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Filtering/Cri
teria/<criterianame>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 137 OF 521
 GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveFilteringCriteria
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<filter>true</filter>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/services/executive/filteri
ng/criteria/criteria1
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/services/executive/filteri
ng/criteria/criteria1
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteria></ExecutiveFilteringCriteria>
PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveFilteringCriteria
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-
instance”><filter>true</filter>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 138 OF 521
 <level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</ExecutiveFilteringCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.40.4 services/Executive/Screening (AS Only)

This command gets the screening configuration for an Executive. Both the Executive and
Executive Assistant users have the authorization to perform this request.
This command is used to retrieve or configure the alerting type, whether screening has
been enabled or not and whether BroadWorks Anywhere (BA), Shared Call Appearance,
and Mobility locations should be alerted or not.
In an HTTP PUT, the screening configuration is replaced with the details in the request.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Executive/Screening
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 139 OF 521
 GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveScreening
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableScreening>true</enableScreening>
<screeningAlertType>Silent</screeningAlertType>
<alertBroadWorksMobilityLocation>true</alertBroadWorksMob
ilityLocation>
<alertBroadWorksAnywhereLocations>true</alertBroadWorksAn
ywhereLocations>
<alertSharedCallAppearanceLocations>true</alertSharedCall
AppearanceLocations>
</ExecutiveScreening>
PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveScreening
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableScreening>false</enableScreening>
<screeningAlertType>Silent</screeningAlertType>
<alertBroadWorksMobilityLocation>true</alertBroadWorksMob
ilityLocation>
</ExecutiveScreening>
PUT
Response 200
Content

3.5.3.41 services/ExecutiveAssistant (AS Only)

The services/executiveassistant URL allows the remote application to issue a command to
the Application Server on behalf of the Executive Assistant. The response to the GET
request contains the Executive Assistant’s setting and a table of Executives to which this
Assistant has been assigned.
The PUT request is used to modify the attributes for the Executive Assistant. When an
HTTP PUT is performed, existing assistant details are replaced with the details in the
request. For the modification of the executiveDetailsList, only the user ID of the Executive
is required; other elements are ignored.
The opt-in configuration for the Executive can also be modified by the PUT request. The
Executive userId is needed to identify the Executive for whom the value is being changed.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ExecutiveAssistant
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <ExecutiveAssistant
Content xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableDivert>true</enableDivert>
<divertToPhoneNumber>2131001045</divertToPhoneNumber>
<executives>
<executiveDetails>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 140 OF 521
 <executiveUserId>[email protected]</executiveUserId
>
<executiveLastName>Smith</executiveLastName>
<executiveFirstName>Charlie</executiveFirstName>
<optIn>true</optIn>
<executiveUri>/v2.0/user/[email protected]/services
/executive</executiveUri>
</executiveDetails>
<executiveDetails>

<executiveUserId>[email protected]</executiveUserId>
<executiveLastName>Jones</executiveLastName>
<executiveFirstName>Grace</executiveFirstName>
<optIn>false</optIn>
<executiveUri>/v2.0/user/[email protected]/services/e
xecutive</executiveUri>
</executiveDetails>
</executives>
</ExecutiveAssistant>
PUT <?xml version=“1.0” encoding=“UTF-8”?>
Request <ExecutiveAssistant
Content
xmlns=“http://schema.broadsoft.com/xsi”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<enableDivert>true</enableDivert>
<divertToPhoneNumber>2131001046</divertToPhoneNumber>
<executives>
<executiveDetails>

<executiveUserId>[email protected]</executiveUserId>
<optIn>true</optIn>
</executiveDetails>
</executives>
</ExecutiveAssistant>
PUT
Response 200
Content

3.5.3.42 services/ExternalCallingLineIDDelivery
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the External Calling Line ID Delivery service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ExternalCallingLineIDDe
livery
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 141 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ExternalCallingLineIDDelivery
Content xmlns="http://schema.broadsoft.com/xsi”>
<active>true</active>
</ExternalCallingLineIDDelivery>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <ExternalCallingLineIDDelivery
Content xmlns="http://schema.broadsoft.com/xsi”>
<active>true</active>
</ExternalCallingLineIDDelivery>
PUT
Response No Content
Content

3.5.3.43 services/FaxMessaging (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Fax Messaging service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/FaxMessaging
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <FaxMessaging xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<phoneNumber>5006007019</phoneNumber>
<extension>7019</extension>
</FaxMessaging>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <FaxMessaging xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<phoneNumber>5006007018</phoneNumber>
<extension>7018</extension>
</FaxMessaging>
PUT
Response No Content
Content

3.5.3.44 services/FlexibleSeatingGuest (AS Only)

Flexible Seating Guest allows a user to associate their service profile with a Flexible
Seating Host user. This allows the guest user to use the host’s device with the guest
user’s service profile.
The following elements are read-only and cannot be modified:
 hostLastName
 hostFirstname
 hostAssociationDateTime

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 142 OF 521
  hostEnforcesAssociationLimit
 hostAssociationLimitHours
 deviceName
 deviceLevel
 deviceType
 deviceLinePort
The PUT request example in the following table shows associating a guest to a host. To
remove host-guest association, hostUserId element should be set to “nil”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/FlexibleSeatingGuest
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <FlexibleSeatingGuest
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<enableAssociationLimit>true</enableAssociationLimit>
<associationLimitHours>12</associationLimitHours>
<unlockPhonePINCode>24222</unlockPhonePINCode>
<accessDevice>
<deviceName>testDevice</deviceName>
<deviceLevel>System</deviceLevel>
<deviceLinePort>23@testport</deviceLinePort>
</accessDevice>
<hostUserId>[email protected]</hostUserId>
<hostLastName>negi002</hostLastName>
<hostFirstName>Subhash</hostFirstName>
<hostAssociationDateTime>2010-04-
06T14:11:10.918+05:30</hostAssociationDateTime>
<hostEnforcesAssociationLimit>true</hostEnforcesAssociati
onLimit>
<hostAssociationLimitHours>24</hostAssociationLimitHours>
</FlexibleSeatingGuest>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <FlexibleSeatingGuest
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<enableAssociationLimit>true</enableAssociationLimit>
<associationLimitHours>13</associationLimitHours>
<unlockPhonePINCode>55555</unlockPhonePINCode>
<hostUserId>[email protected]</hostUserId>
</FlexibleSeatingGuest>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 143 OF 521
 3.5.3.45 services/GETSCallingLineIDDeliveryBlocking
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the GETS Calling Line ID Delivery Blocking service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/GETSCallingLineIDDeli
veryBlocking
Command Service Management
Category
Methods GET,PUT
GET
Request No Content
Content
GET <?xml version="1.0” encoding="ISO-8859-1”?>
Response <GETSCallingLineIDDeliveryBlocking
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</GETSCallingLineIDDeliveryBlocking>
PUT <?xml version="1.0” encoding="ISO-8859-1”?>
Request <GETSCallingLineIDDeliveryBlocking
Content xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</GETSCallingLineIDDeliveryBlocking>
PUT
Response No Content
Content

3.5.3.46 services/GroupNightForwarding
This command is used to return the Group Night Forwarding-related configuration for the
user. The GET response provides information regarding if and when the Night service
applies to the user. This information is deduced from the user-level configuration and the
group-level configuration for the Group Night Forwarding service.
Example:
 If the user-level setting is “Use Group” and the group-level setting is “Automatic On”
with a set holiday schedule, the GET response returns that the Night service applies
to the user and it also returns the holiday schedule that would apply.
 If the user-level setting is “Off” and the group-level setting is “Automatic On” with a set
holiday schedule, the GET response returns that the Night service does not apply to
the user.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/GroupNightForwarding
Command
Category
Services

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 144 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <GroupNightForwarding
Content xmlns="http://schema.broadsoft.com/xsi">
<userNightForwardingMode>Automatic
On</userNightForwardingMode>
<holidaySchedule>
<level>Group</level>
<name>GroupLevel</name>
<uri>
/v2.0/user/[email protected]/profile/schedule/time/Gro
upLevel</uri>
</holidaySchedule>
</GroupNightForwarding>

3.5.3.47 services/HotelingHost (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Hoteling Host service.
Note that the following elements are read-only and cannot be modified. Including them in
an HTTP PUT is without effect and Cisco BroadWorks simply ignores the elements.
 guestLastName
 guestFirstname
 guestPhoneNumber
 guestExtension
 guestLocationDialingCode
 guestAssociationDateTime
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/HotelingHost
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <HotelingHost xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<enforceAssociationLimit>true</enforceAssociationLimit>
<associationLimitHours>24</associationLimitHours>
<accessLevel>Group</accessLevel>
<guestLastName>negi003</guestLastName>
<guestFirstName>Subhash</guestFirstName>
<guestPhoneNumber>5006007003</guestPhoneNumber>
<guestExtension>7003</guestExtension>
<guestAssociationDateTime>2010-04-
06T14:26:51.335+05:30</guestAssociationDateTime>
</HotelingHost>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 145 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <HotelingHost xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<enforceAssociationLimit>true</enforceAssociationLimit>
<associationLimitHours>14</associationLimitHours>
<accessLevel>Group</accessLevel>
<removeGuestAssociation>true</removeGuestAssociation>
</HotelingHost>
PUT
Response No Content
Content

3.5.3.48 services/HotelingGuest (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Hoteling Guest service.
A remote application can clear the association between the host and the guest by setting
the hostUserId element to nil.
Note that the following elements are read-only and cannot be modified. Including them in
an HTTP PUT is without effect and Cisco BroadWorks simply ignores them.
 hostLastName
 hostFirstname
 hostAssociationDateTime
 hostEnforcesAssociationLimit
 hostAssociationLimitHours
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/HotelingGuest
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 146 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <HotelingGuest xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<enableAssociationLimit>true</enableAssociationLimit>
<associationLimitHours>12</associationLimitHours>
<hostUserId>[email protected]</hostUserId>
<hostLastName>negi002</hostLastName>
<hostFirstName>Subhash</hostFirstName>
<hostAssociationDateTime>2010-04-
06T14:11:10.918+05:30</hostAssociationDateTime>

<hostEnforcesAssociationLimit>true</hostEnforcesAssociati
onLimit>

<hostAssociationLimitHours>24</hostAssociationLimitHours>
</HotelingGuest>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <HotelingGuest xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<enableAssociationLimit>true</enableAssociationLimit>
<associationLimitHours>13</associationLimitHours>
<hostUserId>[email protected]</hostUserId>
</HotelingGuest>
PUT
Response No Content
Content

3.5.3.49 services/InCallServiceActivation (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the In-Call Service Activation service.
The following elements are present only while retrieving the information and cannot be
updated as part of a PUT request: flashActivationDigits, callTransferActivationDigits.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/InCallServiceActivation
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <InCallServiceActivation
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<flashActivationDigits>##</flashActivationDigits>

<callTransferActivationDigits>*1</callTransferActivationDig
its>
</InCallServiceActivation>>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 147 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <InCallServiceActivation
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</InCallServiceActivation>
PUT
Response No Content
Content

3.5.3.50 services/IntegratedIMP (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Integrated IM&P service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/integratedimp
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <IntegratedIMPService
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</IntegratedIMPService>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <IntegratedIMPService
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</IntegratedIMPService>
PUT
Response 200
Content

3.5.3.51 services/InterceptUser
This command is used to retrieve the settings of the Intercept User service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/InterceptUser
Command
Category
Service Management

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 148 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?> <InterceptUser
Response xmlns="http://schema.broadsoft.com/xsi">
Content <active>false</active>
<announcementSelection>Default</announcementSelection>
<playNewPhoneNumber>false</playNewPhoneNumber>
<transferOnZeroToPhoneNumber>false</transferOnZeroToPhone
Number>
<rerouteOutboundCalls>false</rerouteOutboundCalls>
<allowOutboundLocalCalls>false</allowOutboundLocalCalls>
<inboundCallMode>Intercept All</inboundCallMode>
<alternateBlockingAnnouncement>false</alternateBlockingAn
nouncement>
<routeToVoiceMail>false</routeToVoiceMail>
<exemptInboundMobilityCalls>false</exemptInboundMobilityC
alls>
<exemptOutboundMobilityCalls>false</exemptOutboundMobilit
yCalls>
<disableParallelRingingToNetworkLocations>false</
disableParallelRingingToNetworkLocations>
<outboundCallMode>blockAll</outboundCallMode>
</InterceptUser>

3.5.3.52 services/InternalCallingLineIDDelivery
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Internal Calling Line ID Delivery service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/InternalCallingLineIDDe
livery
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <InternalCallingLineIDDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</InternalCallingLineIDDelivery>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <InternalCallingLineIDDelivery
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</InternalCallingLineIDDelivery>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 149 OF 521
 3.5.3.53 services/LegacyAutomaticCallback (AS Only)
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Legacy Automatic Callback service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/LegacyAutomaticCallback
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <LegacyAutomaticCallback
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</LegacyAutomaticCallback>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <LegacyAutomaticCallback
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</LegacyAutomaticCallback>
PUT
Response No Content
Content

3.5.3.54 services/MeetMeConference (AS Only)

This command is used to get the list of Meet-Me Conferencing bridges for which the user
is a host.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userId>/services/meetmeconference
Command
Category
Service Management

Methods Get
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MeetMeConferencingUserBridges
Content xmlns="http://schema.broadsoft.com/xsi">
<userBridge>
<bridgeId>abcd1234</bridgeId>
<name>xyz1234</name>
<phoneNumber>+44-7981897555</phoneNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 150 OF 521
 <extension>7555</extension>
<ports>unlimited</ports>
<isActive>true</isActive>
<allowIndividualOutDial>true</allowIndividualOutDial>
<bridgeUri>/v2.0/user/<userId>/services/meetmeconference
/abcd1234</bridgeUri>
</userBridge>
<userBridge>
<bridgeId>pqrs1234</conferenceId>
<name>lmno1234</name>
<phoneNumber>+1-2409874321</phoneNumber>
<extension>4321</extension>
<ports>unlimited</ports>
<isActive>true</isActive>
<allowIndividualOutDial>false</allowIndividualOutDial>
<bridgeUri>/v2.0/user/<userId>/services/meetmeconference
/pqrs1234</bridgeUri>
</userBridge>
</MeetMeConferencingUserBridges>

3.5.3.54.1 services/MeetMeConference/<bridgeId> (AS Only)

This command is used to get the list of all conferences owned by the user on a specified
bridge.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userId>/services/meetmeconference
/<bridgeid>
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
POST <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MeetMeConferencingUserConferences
Content xmlns="http://schema.broadsoft.com/xsi">
<userConference>
<bridgeId>abcd1234</bridgeId>
<conferenceId>123456</conferenceId>
<conferenceTitle>Team Meeting</conferenceTitle>
<bridgeName>Engineering Bridge</bridgeName>
<status>Active</status>
<type>Reservationless</type>
<startTime>2010-10-01T09:30:00:000-0400</startTime>
<isActive>true</isActive>
<conferenceUri>/v2.0/user/<userid>/services/meetmeconferenc
e/abcd1234/conference/123456</conferenceUri>
</userConference>
<userConference>
<bridgeId>abcd1234</bridgeId>
<conferenceId>654321</conferenceId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 151 OF 521
 <conferenceTitle>New Team Meeting</conferenceTitle>
<bridgeName>Engineering Bridge</bridgeName>
<status>Active</status>
<type>Reservationless</type>
<startTime>2011-01-01T09:30:00:000-0400</startTime>
<isActive>false</isActive>
<conferenceUri>/v2.0/user/<userid>/services/meetmeconferenc
e/abcd1234/conference/654321</conferenceUri>
</userConference>
</MeetMeConferencingUserConferences>

3.5.3.54.2 services/MeetMeConference/<bridgeId>/conference (AS Only)

This command is used to create a conference.
A successful HTTP POST for a request returns:
 The created conference ID.
 The moderator PIN.
 The security PIN associated with the conference. It is not present in the response if
the conference being added did not require a security PIN.
 A Location header with the URL of the conference created.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userId>/services/meetmeconference/<bridg
eid>/conference
Command
Category
Service Management

Methods POST
POST <?xml version="1.0" encoding="ISO-8859-1"?>
Request <MeetMeConferencingConference
Content xmlns="http://schema.broadsoft.com/xsi">
<conferenceTitle>Code Review</conferenceTitle>
<estimatedParticipants>10</estimatedParticipants>
<maxParticipants>10</maxParticipants>
<accountCode>1</accountCode>
<muteAllAttendeesOnEntry >true</muteAllAttendeesOnEntry>
<endConferenceOnModeratorExit>
false</endConferenceOnModeratorExit>
<moderatorRequired>true</moderatorRequired>
<allowUniqueIdentifier>true</allowUniqueIdentifier>
<requireSecurityPin>true</requireSecurityPin>
<attendeeNotification>Play Recorded Name
</attendeeNotification>
<conferenceSchedule>
<scheduleReservationLess>
<startTime>1130</startTime>
<endTime>1200</endTime>
</scheduleReservationLess>
</conferenceSchedule>
</MeetMeConferencingConference>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 152 OF 521
 POST <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MeetMeConferencingConferenceInfo
Content xmlns="http://schema.broadsoft.com/xsi">
<conferenceId>123456</conferenceId>
<moderatorPin>1098769</moderatorPin>
<securityPin>898769</securityPin>
</MeetMeConferencingConferenceInfo>

3.5.3.54.3 services/MeetMeConference/<bridgeid>/conference/<conferenceId> (AS Only)

This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) Meet-Me Conferences owned by the user.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/meetmeconference/<bridg
eid>/conference/<conferenceId>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MeetMeConferencingConference
Content xmlns="http://schema.broadsoft.com/xsi">
<conferenceTitle>Code Review</conferenceTitle>
<estimatedParticipants>10</estimatedParticipants>
<maxParticipants>10</ maxParticipants >
<accountCode>1</accountCode>
<muteAllAttendeesOnEntry>true</muteAllAttendeesOnEntry >
<endConferenceOnModeratorExit>
false</endConferenceOnModeratorExit>
<moderatorRequired>true</moderatorRequired>
<allowUniqueIdentifier>true</allowUniqueIdentifier>
<requireSecurityPin>true</requireSecurityPin>
<attendeeNotification>Play Recorded Name
</attendeeNotification>
<conferenceSchedule>
<scheduleReservationLess>
<startTime>1130</startTime>
<endTime>1200</endTime>
</scheduleReservationLess>
</conferenceSchedule>
<moderatorPin>123456</moderatorPin>
<securityPin>125634</securityPin>
</MeetMeConferencingConference>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 153 OF 521
 PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <MeetMeConferencingConference
Content xmlns="http://schema.broadsoft.com/xsi">
<conferenceTitle>Code Review</conferenceTitle>
<estimatedParticipants>10</estimatedParticipants >
<maxParticipants>10</maxParticipants>
<accountCode>1</accountCode>
<muteAllAttendeesOnEntry >true</muteAllAttendeesOnEntry>
<endConferenceOnModeratorExit>
false</endConferenceOnModeratorExit>
<moderatorRequired>true</moderatorRequired>
<allowUniqueIdentifier>true</allowUniqueIdentifier>
<requireSecurityPin>false</requireSecurityPin>
<attendeeNotification>Play Recorded Name
</attendeeNotification>
<conferenceSchedule>
<scheduleReservationLess>
<startTime>1130</startTime>
<endTime>1200</endTime>
</scheduleReservationLess>
</conferenceSchedule>
</MeetMeConferencingConference>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.55 services/MusicOnHold
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Music On Hold service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/MusicOnHold
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MusicOnHold xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
</MusicOnHold>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <MusicOnHold xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
</MusicOnHold>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 154 OF 521
 PUT
Response No Content
Content

3.5.3.56 services/MwiDeliveryToMobileEndpoint
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the MWI Delivery to Mobile Endpoint service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/MwiDeliveryToMobileEndp
oint
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <MWIDeliveryToMobileEndpoint
Content xmlns="http://schema.broadsoft.com/xsi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<active>false</active>
<mobilePhoneNumber xsi:nil="true"/>
</MWIDeliveryToMobileEndpoint>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <MWIDeliveryToMobileEndpoint
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<mobilePhoneNumber>011273754524</mobilePhoneNumber>
</MWIDeliveryToMobileEndpoint>
PUT
Response No Content
Content

3.5.3.57 services/NumberPortabilityAnnouncement (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the
configuration settings of the Number Portability Announcement service.
The playStatusAnnouncement element indicates whether an announcement is played to
the calling party when it originates a call to a number that is defined on the system with a
number portability status.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/NumberPortabilityAnnoun
cement
Command
Category
Services

Methods GET, PUT

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 155 OF 521
 GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <NumberPortabilityAnnouncement
Content xmlns="http://schema.broadsoft.com/xsi">
<playStatusAnnouncement>false</playAnnouncement>
</NumberPortabilityAnnouncement>
PUT <?xml version="1.0" encoding="iso-8859-1"?>
Request <NumberPortabilityAnnouncement
Content xmlns="http://schema.broadsoft.com/xsi">
<playStatusAnnouncement>true</playAnnouncement>
</NumberPortabilityAnnouncement>
PUT
Response No Content
Content

3.5.3.58 services/OutgoingMwi
This command is used to retrieve (GET method) or modify (PUT method) the advanced
settings of Outgoing Message Waiting Indicator settings related to Voice Messaging user
service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/OutgoingMwi
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <OutgoingMWI xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
<outgoingSMDIMWIPhoneNumberList>
<phoneNumber>1234567899</phoneNumber>
</outgoingSMDIMWIPhoneNumberList>
</OutgoingMWI>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <OutgoingMWI xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
<outgoingSMDIMWIPhoneNumberList>
<phoneNumber>1234567890</phoneNumber>
<phoneNumber>2345678901</phoneNumber>
</outgoingSMDIMWIPhoneNumberList>
</OutgoingMWI>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 156 OF 521
 3.5.3.59 services/PersonalAssistant (AS Only)
This command is used to retrieve (GET method) or update (PUT method) the settings of
the Personal Assistant service.
The following element is read-only. The element is ignored if included.
 callToNumberList
The following command can be used to modify the Call to Numbers list:
 /user/<userid>/services/personalassistant/assignedcalltonumbers
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/personalassistant
Command Service Management
Category
Methods GET, PUT
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PersonalAssistant xmlns="http://schema.broadsoft.com/xsi">
Content <presence>Business Trip<presence>
<enableExpirationTime>true</enableExpirationTime>
<expirationTime>2014-04-16T17:00:00.327-
05:00</expirationTime>
<enableTransferToAttendant>true</enableTransferToAttendant>
<attendantNumber>5512</attendantNumber>
<ringSplash>true</ringSplash>
<alertMeFirst>true</alertMeFirst>
<numberOfRings>3</numberOfRings>
<callToNumberList>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>30164182222</mobilePhoneNumber>
</callToNumber>
</callToNumberList>
</PersonalAssistant>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <PersonalAssistant xmlns="http://schema.broadsoft.com/xsi">
Content <presence>Business Trip<presence>
<enableExpirationTime>true</enableExpirationTime>
<expirationTime>2014-04-16T17:00:00.327-
05:00</expirationTime>
<enableTransferToAttendant>true</enableTransferToAttendant>
<attendantNumber>5512</attendantNumber>
<ringSplash>true</ringSplash>
<alertMeFirst>true</alertMeFirst>
<numberOfRings>3</numberOfRings>
</PersonalAssistant >

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 157 OF 521
 PUT
Response No Content
Content

3.5.3.59.1 services/PersonalAssistant/AssignedCallToNumbers (AS Only)

This command is used to retrieve (GET method) or update (PUT method) the Call to
Numbers list.
In a PUT request on the callToNumberList, the existing Call to Numbers list is replaced
with the callToNumberList from the request.
If the callToNumberList is set to “nil”, then the excution of the request clears the configured
Call to Numbers list. Therefore, the Personal Assistant service is applicable to any called
number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
personalassistant/assignedcalltonumbers
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PersonalAssistantAssignedCallToNumbers
Content xmlns="http://schema.broadsoft.com/xsi">
<callToNumberList>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>
2144779687
</mobilePhoneNumber>
</callToNumber>
</callToNumberList>
</PersonalAssistantAssignedCallToNumbers>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <PersonalAssistantAssignedCallToNumbers
Content xmlns="http://schema.broadsoft.com/xsi">
<callToNumberList>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>
2144779687
</mobilePhoneNumber>
</callToNumber>
</callToNumberList>
</PersonalAssistantAssignedCallToNumbers>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 158 OF 521
 3.5.3.59.2 services/PersonalAssistant/AvailableCallToNumbers (AS Only)
This command is used to retrieve (GET method) the list of numbers that can be used for
the Call To criteria.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/personalassistant/
availablecalltonumbers
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PersonalAssistantAvailableCallToNumbers
Content xmlns="http://schema.broadsoft.com/xsi">
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>30164182222</mobilePhoneNumber>
</callToNumber>
</PersonalAssistantAvailableCallToNumbers>

3.5.3.59.3 services/PersonalAssistant/ExclusionNumber (AS Only)

This command is used to add (POST method) an exclusion number entry to the exclusion
list.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
personalassistant/exclusionnumber
Command
Category
Service Management

Methods POST
POST <?xml version="1.0" encoding="ISO-8859-1"?>
Request <PersonalAssistantExclusionNumberEntry
Content xmlns="http://schema.broadsoft.com/xsi">
<number>9723542001</number>
<description>Manager</description>
</PersonalAssistantExclusionNumberEntry>
POST
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 159 OF 521
 3.5.3.59.4 services/PersonalAssistant/ExclusionNumber/<number> (AS Only)
This command is used to retrieve (GET method), update (PUT method), and delete
(DELETE method) an exclusion number entry on the exclusion number list.
The number in the URI is the number element of the exclusion number entry and it is used
to search the exclusion number entry for the GET, PUT, and DELETE methods.
The number is allowed to include the wildcard character (“*”, “?”). For the URI with the
number including the wildcard character “?” and “*”, the “?” and “*” must be escaped as
%3F and %2A respectively, since they can also be used as the delimiter and the
sub-delimiter for the query string.
The PUT method is designed to modify the description element in the exclusion number
entry. The number element may be included in the message body; however, it is ignored.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
personalassistant/exclusionnumber/<number>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PersonalAssistantExclusionNumberEntry
Content xmlns="http://schema.broadsoft.com/xsi">
<number>9723542001</number>
<description>Manager</description>
</PersonalAssistantExclusionNumberEntry>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <PersonalAssistantExclusionNumberEntry
Content xmlns="http://schema.broadsoft.com/xsi">
<description>Customer</description>
</PersonalAssistantExclusionNumberEntry>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.59.5 services/PersonalAssistant/ExclusionNumberList (AS Only)

This command is used to retrieve (GET method) the exclusion number list currently
assigned to the user’s Personal Assistant service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/personalassistant/exclu
sionumberlist

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 160 OF 521
 Command
Service Management
Category
Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PersonalAssistantExclusionNumberList
Content xmlns="http://schema.broadsoft.com/xsi">
<exclusionNumber>
<number>9723542001</number>
<description>Manager</description>
</exclusionNumber>
<exclusionNumber>
<number>9723544211</number>
<description>Director</description>
</exclusionNumber>
</PersonalAssistantExclusionNumberList>

3.5.3.60 services/PriorityAlert
This command is used to retrieve (GET method) or modify (PUT method) the activation
status of a Priority Alert service criteria.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.
The PUT method is used to activate or deactivate a specific criterion. To modify the
attributes of a specific criterion, the application should be using the PUT method on the
/services/priorityalert/criteria/<criteriaName>. The criterion attributes included in the XML
document (other than the “active” element) are ignored. The criteria not included in the
XML document are unchanged.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PriorityAlert
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 161 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PriorityAlert xmlns="http://schema.broadsoft.com/xsi">
Content
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>

<uri>/v2.0/user/userSP1A@broadworks/services/priorityalert/
criteria/Criteria1</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>false</active>

<uri>/v2.0/user/userSP1A@broadworks/services/priorityalert/
criteria/Criteria2</uri>
</criteriaActivation>
</criteriaActivations>
</PriorityAlert>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <PriorityAlert xmlns="http://schema.broadsoft.com/xsi">
Content
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</PriorityAlert>
PUT
Response No Content
Content

3.5.3.60.1 services/PriorityAlert/Criteria
This command is used to add a Priority Alert service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PriorityAlert/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <PriorityAlertCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 162 OF 521
 <name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</PriorityAlertCriteria>
POST
Response No Content
Content

3.5.3.60.2 services/PriorityAlert/Criteria /<criteriaName>

This command is used to retrieve (GET method), modify (PUT method), or remove
(DELETE method) the specified Priority Alert service criterion.
The PUT method is used to modify the attribute of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/priorityalert command. The “active” and “uri” criteria elements are ignored when
included in the XML document.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 163 OF 521
 URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PriorityAlert/Criteria
/<criteriaName>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PriorityAlertCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/
TimeSched1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/
HolidaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 164 OF 521
 <callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</PriorityAlertCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <PriorityAlertCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</PriorityAlertCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 165 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.61 services/Privacy
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Privacy service.
In an HTTP PUT, the existing Privacy details are replaced with the details in the request.
For the modification of the allowedUsers, only the user ID of monitored users is required;
other elements are ignored. If the allowedUsers is set to “nil”, then the configured
monitored users list is simply cleared.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/Privacy
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Privacy xmlns="http://schema.broadsoft.com/xsi"
Content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<isEnableDirectoryPrivacy>false</isEnableDirectoryPrivacy>

<isEnableAutoAttendantExtensionDialingPrivacy>false</isEnab
leAutoAttendantExtensionDialingPrivacy>

<isEnableAutoAttendantNameDialingPrivacy>false</isEnableAut
oAttendantNameDialingPrivacy>

<isEnablePhoneStatusPrivacy>false</isEnablePhoneStatusPriva
cy>
<allowedUsers>
<userDetails>
<userId>asmith</userId>
<firstName>Arthur</firstName>
<lastName>Smith</lastName>
<hiranganaLastName>Smith</hiranganaLastName>
<hiranganaFirstName>Arthur</hiranganaFirstName>
<extension>0003</extension>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 166 OF 521
 </userDetails>
</allowedUsers>
</Privacy>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <Privacy xmlns="http://schema.broadsoft.com/xsi">
Content
<isEnableDirectoryPrivacy>true</isEnableDirectoryPrivacy>
<isEnableAutoAttendantExtensionDialingPrivacy>true</isEnabl
eAutoAttendantExtensionDialingPrivacy>

<isEnableAutoAttendantNameDialingPrivacy>true</isEnableAuto
AttendantNameDialingPrivacy>

<isEnablePhoneStatusPrivacy>false</isEnablePhoneStatusPriva
cy>
<allowedUsers>
<userDetails>
<userId>asmith@broadworks</userId>
</userDetails>
</allowedUsers>
</Privacy>
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this
search criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this
search criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 167 OF 521
 3.5.3.61.1 services/privacy/AllowedUsers
This service is a subset of the Privacy service for allowed users.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/privacy/AllowedUsers
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <allowedUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>asmith</userId>
<firstName>Arthur</firstName>
<lastName>Smith</lastName>
<hiranganaLastName>Smith</hiranganaLastName>
<hiranganaFirstName>Arthur</hiranganaFirstName>
<extension>0003</extension>
</userDetails>
</allowedUsers>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <allowedUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>asmith@broadworks</userId>
</userDetails>
</allowedUsers>
PUT
Response No Content
Content

3.5.3.61.2 services/privacy/AvailableUsers
The services/privacy/availableusers URL allows the retrieval of a list of users who may be
added to a user's list of permitted monitor users. These selected members can view the
user's phone status even if phone status privacy has been enabled.
The number of entries included in the response message body is limited and is subject to
a maximum value configured on the system. The default configuration value is “1000”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/privacy/AvailableUsers
Command
Category
Services

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 168 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AvailableUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>asmith</userId>
<firstName>Arthur</firstName>
<lastName>Smith</lastName>
<hiranganaLastName>Smith</hiranganaLastName>
<hiranganaFirstName>Arthur</hiranganaFirstName>
<extension>0002</extension>
</userDetails>
<userDetails>
<userId>djones</userId>
<firstName>David</firstName>
<lastName>Jones</lastName>
<hiranganaLastName>Jones</hiranganaLastName>
<hiranganaFirstName>David</hiranganaFirstName>
<extension>0003</extension>
</userDetails>
</AvailableUsers>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this
search criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this
search criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

3.5.3.62 services/PushNotification (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Push Notification service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PushNotification

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 169 OF 521
 Command
Services
Category
Methods GET, PUT
GET
Request No Content
Content
GET <?xml version=”1.0” encoding=”ISO-8859-1”?>
Response <PushNotification xmlns=http://schema.broadsoft.com/xsi>
Content
<sendPushNotificationForClickToDial>true</
sendPushNotificationForClickToDial>
<sendPushNotificationForGroupPaging>true</
sendPushNotificationForGroupPaging>
</PushNotification>
PUT <?xml version=”1.0” encoding=”ISO-8859-1”?>
Request <PushNotification xmlns=http://schema.broadsoft.com/xsi>
Content
<sendPushNotificationForClickToDial>true</
sendPushNotificationForClickToDial>
<sendPushNotificationForGroupPaging>true</
sendPushNotificationForGroupPaging>
</PushNotification>
PUT
Response No Content
Content

3.5.3.63 services/PushTotalk
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Push To Talk service.
In an HTTP PUT, the existing Push To Talk details are replaced with the details in the
request. If the allowedUsers is set to “nil”, then the configured selected users list is simply
cleared.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PushTotalk
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <PushToTalk xmlns="http://schema.broadsoft.com/xsi">
Content
<allowAutoAnswer>true</allowAutoAnswer>
<outgoingConnectionSelection>One
Way</outgoingConnectionSelection>
<accessListSelection>Allow Calls From Selected
Users</accessListSelection>
<allowedUsers>
<userId>jsmith</userId>
<userId>djones</userId>
</allowedUsers>
</PushToTalk>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 170 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <PushToTalk xmlns="http://schema.broadsoft.com/xsi">
Content
<allowAutoAnswer>true</allowAutoAnswer>
<outgoingConnectionSelection>Two
Way</outgoingConnectionSelection>
<accessListSelection>Allow Calls From Selected
Users</accessListSelection>
<allowedUsers>
<userId>djones</userId>
</allowedUsers>
</PushToTalk>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 171 OF 521
 Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this
search criterion.

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this
search criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

3.5.3.63.1 services/PushTotalk/AllowedUsers
This service is a subset of the Push To Talk service for allowed users.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PushTotalk/AllowedUsers
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <allowedUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userId>jsmith</userId>
<userId>djones</userId>
</allowedUsers>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <allowedUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userId>djones</userId>
</allowedUsers>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 172 OF 521
3.5.3.63.2 services/PushTotalk/AvailableUsers
This command is used to retrieve (GET method) the list of users who may be added to a
user's list of selected users of the Push To Talk service.
The number of entries included in the response message body is limited and is subject to
a maximum value configured on the system. The default configuration value is “1000”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/PushTotalk/AvailableUse
rs
Command
Category
Services

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <AvailableUsers xmlns="http://schema.broadsoft.com/xsi">
Content
<userDetails>
<userId>asmith</userId>
<firstName>Arthur</firstName>
<lastName>Smith</lastName>
<hiranganaLastName>Smith</hiranganaLastName>
<hiranganaFirstName>Arthur</hiranganaFirstName>
<extension>0002</extension>
</userDetails>
<userDetails>
<userId>djones</userId>
<firstName>David</firstName>
<lastName>Jones</lastName>
<hiranganaLastName>Jones</hiranganaLastName>
<hiranganaFirstName>David</hiranganaFirstName>
<extension>0003</extension>
</userDetails>
</AvailableUsers>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

firstName String O Search criteria for a user’s first name.

Search criteria for a user’s first name.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

groupId String O Search criteria for a user’s group.

Wild cards are not supported for this search
criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 173 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

deptId String O Search criteria for a user’s department.

Wild cards are not supported for this search
criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

3.5.3.64 services/RemoteOffice (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Remote Office service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/RemoteOffice
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <RemoteOffice xmlns="http://schema.broadsoft.com/xsi">
Content <active>true</active>
<remoteOfficeNumber>121212</remoteOfficeNumber>
</RemoteOffice>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <RemoteOffice xmlns="http://schema.broadsoft.com/xsi">
Content <active>false</active>
<remoteOfficeNumber>121212</remoteOfficeNumber>
</RemoteOffice>
PUT
Response No Content
Content

3.5.3.65 services/SecurityClassification (AS Only)

GET command
The services/SecurityClassification URL allows the retrieval of configuration data
associated with the Security Classification service.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 174 OF 521
 The response returns an ordered list of security classification levels allowed for the user
(allowedLevels); the list is ordered from highest to lowest classification. The response
includes the user-enabled override security classification level (overrideLevel). The
overrideLevel element value is populated when the user has set their current classification
to a level that is lower than their assigned classification; otherwise, if the user is not in
override mode, the element value is “nil”.
For illustration purposes, assume that a system is configured with the following three
security classification levels: Top Secret, Secret, Restricted and the system defined
security classification Unclassified. In this example, Top Secret has the highest priority
and Unclassified has the lowest priority. In a scenario in which a user is assigned the Top
Secret classification, this command returns the following in the allowedLevels element:
Top Secret, Secret, Restricted, Unclassified
However, if a user is assigned the Restricted classification, this command returns the
following in the allowedLevels element:
Restricted, Unclassified
PUT Command
The PUT command allows the remote application to issue a command to the Application
Server to enable or disable the override mode of the Security Classification service. The
command supports setting the user’s override classification level to any value within the
user’s range of allowed classifications.
The overrideLevel is the only required element in the PUT command, any other element
included in the PUT command is discarded for this operation.
Upon changing the user’s override classification level, the classification level of all existing
calls for that user is recomputed. When this command is successfully processed, the
CallSecurityClassificationUpdatedEvent (event) is generated for each call in the user
session that has its call classification changed as a result of the user updating their current
classification.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SecurityClassification
Command
Category
Services

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response xmlns=http://schema.broadsoft.com/xsi
Content
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<SecurityClassification>
<allowedLevels>
<classification>Top Secret</classification>
<classification>Secret</classification>
<classification>Restricted</classification>
<classification>Classified</classification>
<classification>Unclassified</classification>
</allowedLevels>
<overrideLevel>Secret</overrideLevel>
</SecurityClassification>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 175 OF 521
 PUT <?xml version="1.0" encoding="iso-8859-1"?>
Request xmlns="http://schema.broadsoft.com/xsi">
Content
<SecurityClassification>
<overrideLevel>Secret</overrideLevel>
</SecurityClassification>
PUT
Response No Content
Content

3.5.3.66 services/SelectiveCallAcceptance
This command is used to retrieve (GET method) or modify (PUT method) the activation
status of a Selective Call Acceptance service criteria.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.
The PUT method is used to activate or deactivate a specific criterion. To modify the
attributes of a specific criterion, the application should be using the PUT method on the
/services/selectivecallacceptance/criteria/<criteriaName>. The criterion attributes included
in the XML document (other than the “active” element) are ignored. The criteria not
included in the XML document are unchanged.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallAcceptance
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SelectiveCallAcceptance
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>

<uri>/v2.0/user/userSP1A@broadworks/services/selectivecalla
cceptance/criteria/Criteria1</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>false</active>

<uri>/v2.0/user/userSP1A@broadworks/services/selectivecalla
cceptance/criteria/Criteria2</uri>
</criteriaActivation>
</criteriaActivations>
</SelectiveCallAcceptance>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 176 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallAcceptance
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</SelectiveCallAcceptance>
PUT
Response No Content
Content

3.5.3.66.1 services/SelectiveCallAcceptance/Criteria
This command is used to add a Selective Call Acceptance service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallAcceptance
/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallAcceptanceCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 177 OF 521
 <phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallAcceptanceCriteria>
POST
Response No Content
Content

3.5.3.66.2 services/SelectiveCallAcceptance/Criteria /<criteriaName>

This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Selective Call Acceptance service criterion.
Modifications made using the PUT method to a criteria element will not affect any other
existing criteria elements for the selectivecallacceptance service, which are not included in
the PUT request.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallAcceptance
/Criteria/<criterianame>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SelectiveCallAcceptanceCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 178 OF 521
 <uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallAcceptanceCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallAcceptanceCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 179 OF 521
 <holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallAcceptanceCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 180 OF 521
 3.5.3.67 services/SelectiveCallRejection
This command is used to retrieve (GET method) or modify (PUT method) the activation
status of a Selective Call Rejection service criteria.
The response to the HTTP GET contains the list of criteria configured for the service.
Each criterion included provides a URL (“uri” element) that can be used to obtain details
on the configured criteria.
The PUT method is used to activate or deactivate a specific criterion. To modify the
attributes of a specific criterion, the application should be using the PUT method on the
/services/selectivecallrejection/criteria/<criteriaName>. The criterion attributes included in
the XML document (other than the “active” element) are ignored. The criteria not included
in the XML document are unchanged.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallRejection
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SelectiveCallRejection
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria1</criteriaName>
<active>true</active>

<uri>/v2.0/user/userSP1A@broadworks/services/selectivecalla
cceptance/criteria/Criteria1</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>false</active>

<uri>/v2.0/user/userSP1A@broadworks/services/selectivecalla
cceptance/criteria/Criteria2</uri>
</criteriaActivation>
</criteriaActivations>
</SelectiveCallRejection>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallRejection
Content xmlns="http://schema.broadsoft.com/xsi">
<criteriaActivations>
<criteriaActivation>
<criteriaName>Criteria2</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivations>
</SelectiveCallRejection>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 181 OF 521
 PUT
Response No Content
Content

3.5.3.67.1 services/SelectiveCallRejection/Criteria
This command is used to add a Selective Call Rejection service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallRejection/
Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallRejectionCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 182 OF 521
 </callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallRejectionCriteria>
POST
Response No Content
Content

3.5.3.67.2 services/SelectiveCallRejection/Criteria /<criteriaName>

This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Selective Call Rejection service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attribute of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/selectivecallrejection command. The “uri” schedule element is ignored when
included in the XML document.
The callToNumber list provided in the PUT command replaces the previous list. Setting
this list to “nil” results in clearing the callToNumber list, and the criterion is satisfied by calls
to any called number.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SelectiveCallRejection/
Criteria/<criterianame>
Command
Category
Services

Methods GET, PUT,DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SelectiveCallRejectionCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/
TimeSched1?scheduleLevel=User
</uri>
</timeSchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 183 OF 521
 <holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Primary</type>
</callToNumber>
<callToNumber>
<type>Alternate</type>
<alternateNumberId>1</alternateNumberId>
</callToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>2223334444</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallRejectionCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SelectiveCallRejectionCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>false</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 184 OF 521
 <fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
<criteriaCallToNumber>
<callToNumber>
<type>Mobility</type>
<mobilePhoneNumber>1234567890</mobilePhoneNumber>
</callToNumber>
</criteriaCallToNumber>
</criteria>
</SelectiveCallRejectionCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.68 services/SequentialRing
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Sequential Ring service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SequentialRing

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 185 OF 521
 Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SequentialRing xmlns="http://schema.broadsoft.com/xsi">
Content <ringBaseLocationFirst>true</ringBaseLocationFirst>
<baseLocationNumberOfRings>7</baseLocationNumberOfRings>
<continueIfBaseLocationIsBusy>true</continueIfBaseLocatio
nIsBusy>
<callerMayStopSearch>true</callerMayStopSearch>
<location1>
<address>11111111</address>
<numberOfRings>3</numberOfRings>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</location1>
<location2>
<address>660066000</address>
<numberOfRings>6</numberOfRings>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</location2>
<location3>
<address>333333333</address>
<numberOfRings>3</numberOfRings>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</location3>
<location4>
<numberOfRings>3</numberOfRings>
<answerConfirmationRequired>false</answerConfirmationRequ
ired>
</location4>
<location5>
<numberOfRings>3</numberOfRings>
<answerConfirmationRequired>false</answerConfirmationRequ
ired>
</location5>
<criteriaActivationList>
<criteriaActivation>
<criteriaName>Criteria One</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivationList>
</SequentialRing>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SequentialRing xmlns="http://schema.broadsoft.com/xsi”>
Content <ringBaseLocationFirst>true</ringBaseLocationFirst>
<baseLocationNumberOfRings>6</baseLocationNumberOfRings>
<continueIfBaseLocationIsBusy>true</continueIfBaseLocatio
nIsBusy>
<callerMayStopSearch>true</callerMayStopSearch>
<location1>
<address xs:nil="true"
xmlns:xs="http://www.w3.org/2001/XMLSchema-instance" />
<numberOfRings>4</numberOfRings>
<answerConfirmationRequired>true</answerConfirmationRequi
red>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 186 OF 521
 </location1>
<criteriaActivationList>
<criteriaActivation>
<criteriaName>Criteria One</criteriaName>
<active>true</active>
</criteriaActivation>
</criteriaActivationList>
</SequentialRing>
PUT
Response No Content
Content

3.5.3.68.1 services/SequentialRing/Criteria
This command is used to add a to Sequential Ring service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SequentialRing/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <SequentialRingCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaB</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>timeURI</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>holidayURI</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 187 OF 521
 </criteriaFromDn>
</criteria>
</SequentialRingCriteria>
POST
Response No Content
Content

3.5.3.68.2 services/SequentialRing/Criteria/<criteriaName>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Sequential Ring service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attributes of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/sequentialring command. The “uri” schedule element is ignored when included
in the XML document.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SequentialRing/Criteria
/<criterianame>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request
Content No Content

GET <?xml version="1.0" encoding="ISO-8859-1"?>

Response <SequentialRingCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Tim
eSched1?scheduleLevel=User
</uri>
</holidaySchedule>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 188 OF 521
 <criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
</criteria>
</SequentialRingCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SequentialRingCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
</criteria>
</SequentialRingCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 189 OF 521
 DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.69 services/SimultaneousRingPersonal
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Simultaneous Ring Personal service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SimultaneousRingPersona
l
Command
Category
Service Management

Methods GET, PUT

GET
Request
Content No Content

GET <?xml version="1.0" encoding="ISO-8859-1"?>

Response <SimultaneousRingPersonal
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<incomingCalls>Do not Ring if on a Call</incomingCalls>
<simRingLocations>
<simRingLocation>
<address>5006007003</address>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</simRingLocation>
<simRingLocation>
<address>5006007006</address>
<answerConfirmationRequired>false</answerConfirmationRequ
ired>
</simRingLocation>
<simRingLocation>
<address>5006007005</address>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</simRingLocation>
</simRingLocations>
<criteriaActivationList>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 190 OF 521
 <criteriaActivation>
<criteriaName>allthetime11</criteriaName>
<active>true</active>
<uri>/v2.0/user/john@broadworks/services/simultaneousringpe
rsonal/criteria/allthetime11</uri>
</criteriaActivation>
<criteriaActivation>
<criteriaName>atllthetime22</criteriaName>
<active>true</active>
<uri>/v2.0/user/john@broadworks/services/simultaneousringpe
rsonal/criteria/atllthetime22</uri>
</criteriaActivation>
</criteriaActivationList>
</SimultaneousRingPersonal>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <SimultaneousRingPersonal
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<incomingCalls>Do not Ring if on a Call</incomingCalls>
<simRingLocations>
<simRingLocation>
<address>5006007003</address>
<answerConfirmationRequired>true</answerConfirmationRequi
red>
</simRingLocation>
<simRingLocation>
<address>5006007006</address>
<answerConfirmationRequired>false</answerConfirmationRequ
ired>
</simRingLocation>
<simRingLocation>
<address>5006007005</address>
<answerConfirmationRequired>false</answerConfirmationRequ
ired>
</simRingLocation>
</simRingLocations>
<criteriaActivationList>
<criteriaActivation>
<criteriaName>allthetime11</criteriaName>
<active>false</active>
</criteriaActivation>
<criteriaActivation>
<criteriaName>allthetime22</criteriaName>
<active>false</active>
</criteriaActivation>
</criteriaActivationList>
</SimultaneousRingPersonal>
PUT
Response No Content
Content

3.5.3.69.1 services/ SimultaneousRingPersonal/Criteria

This command is used to add a to Simultaneous Ring Personal service criterion.
A successful HTTP POST request returns a Location header with the URL of the criterion
created in the HTTP response.
Method Description

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 191 OF 521
 URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/
SimultaneousRingPersonal/Criteria
Command
Category
Services

Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <SimultaneousRingPersonalCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaP</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
</criteria>
</SimultaneousRingPersonalCriteria>
POST
Response No Content
Content

3.5.3.69.2 services/SimultaneousRingPersonal/Criteria /<criteriaName>

This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) the specified Simultaneous Ring Personal service criterion.
The response to the HTTP GET contains the time and holiday schedules, when
applicable. Each schedule included provides a URL (“uri” element) that can be used to
obtain details on the configured schedule.
The PUT method is used to modify the attributes of a selected criterion. To activate or
deactivate a specific criterion, the application should be using the PUT method on the
/services/simultaneousringpersonal command. The “uri” schedule element is ignored
when included in the XML document.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 192 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SimultaneousRingPersona
l/Criteria/<criterianame>
Command
Category
Services

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SimultaneousRingPersonalCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>
<criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/time/TimeSc
hed1?scheduleLevel=User
</uri>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
<uri>
/v2.0/user/userSP1A@broadworks/profile/schedule/holiday/Hol
idaySched1?scheduleLevel=User
</uri>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
</criteria>
</SimultaneousRingPersonalCriteria>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SimultaneousRingPersonalCriteria
Content xmlns="http://schema.broadsoft.com/xsi">
<blackListed>true</blackListed>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 193 OF 521
 <criteria>
<criteriaName>criteriaAcc</criteriaName>
<timeSchedule>
<level>User</level>
<name>TimeSched1</name>
</timeSchedule>
<holidaySchedule>
<level>User</level>
<name>HolidaySched1</name>
</holidaySchedule>
<criteriaFromDn>
<fromDnCriteriaSelection>
Specified Only
</fromDnCriteriaSelection>
<includeAnonymousCallers>
true
</includeAnonymousCallers>
<includeUnavailableCallers>
true
</includeUnavailableCallers>
<phoneNumberList>
<phoneNumber>0001</phoneNumber>
</phoneNumberList>
</criteriaFromDn>
</criteria></SimultaneousRingPersonalCriteria>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

scheduleLevel String O Specifies the level to query for the

schedule.
The default value is “User” and is
applied when no scheduleLevel is
supplied.
The following values are valid:
 Group
 Enterprise
 User

3.5.3.70 services/SilentAlerting (AS Only)

This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Silent Alerting service.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 194 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SilentAlerting
Command Services
Category
Methods GET, PUT
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SilentAlerting
Content xmlns="http://schema.broadsoft.com/xsi">
<active>false</active>
</SilentAlerting>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <SilentAlerting
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
</SilentAlerting>
PUT
Response No Content
Content

3.5.3.71 services/SpeedDial100
This command is used to retrieve (GET method) the list of Speed Dial 100 entries or to
create a new Speed Dial 100 entry.
A successful HTTP POST for a request returns a Location header with the URL of the
Speed Dial 100 entry created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SpeedDial100
Command
Category
Service Management

Methods GET, POST

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 195 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SpeedDial100 xmlns="http://schema.broadsoft.com/xsi">
Content <prefix>#</prefix>
<speedDial100Entry>
<speedCode>0</speedCode>
<phoneNumber>0000000</phoneNumber>
<description>Zero</description>
</speedDial100Entry>
<speedDial100Entry>
<speedCode>1</speedCode>
<phoneNumber>1111111</phoneNumber>
<description>One</description>
</speedDial100Entry>
<speedDial100Entry>
<speedCode>3</speedCode>
<phoneNumber>333333</phoneNumber>
<description>Three</description>
</speedDial100Entry>
</SpeedDial100>
POST <?xml version="1.0" encoding="UTF-8"?>
Request <SpeedDial100 xmlns="http://schema.broadsoft.com/xsi">
Content <speedDial100Entry>
<speedCode>04</speedCode>
<phoneNumber>44444</phoneNumber>
<description>Four</description>
</speedDial100Entry>
</SpeedDial100>
POST
Response No Content
Content

3.5.3.71.1 services/SpeedDial100/<code>
This command is used to retrieve (GET method), modify (PUT method), or delete
(DELETE method) a single Speed Dial 100 entry.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SpeedDial100/<code>
Command
Category
Service Management

Methods GET, PUT, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?> <SpeedDial100
Response xmlns="http://schema.broadsoft.com/xsi">
Content <speedDial100Entry>
<speedCode>3</speedCode>
<phoneNumber>21222121</phoneNumber>
<description>cccxcxc</description>
</speedDial100Entry>
</SpeedDial100>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 196 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SpeedDial100 xmlns="http://schema.broadsoft.com/xsi”>
Content
<speedDial100Entry>
<speedCode>01</speedCode>
<phoneNumber>21222121</phoneNumber>
<description>cccxcxc</description>
</speedDial100Entry>
</SpeedDial100>
PUT
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.72 services/SpeedDial8
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Speed Dial 8 service.
An HTTP PUT contains a list of Speed Dial 8 entries to create or modify. Speed Dial 8
entries that are not included in the message body are not impacted.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/SpeedDial8
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <SpeedDial8 xmlns="http://schema.broadsoft.com/xsi">
Content <speedDialEntry>
<speedCode>2</speedCode>
<phoneNumber>1213323</phoneNumber>
<description>testing</description>
</speedDialEntry>
<speedDialEntry>
<speedCode>3</speedCode>
<phoneNumber>11111</phoneNumber>
<description>testing2</description>
</speedDialEntry>
<speedDialEntry>
<speedCode>4</speedCode>
</speedDialEntry>
<speedDialEntry>
<speedCode>5</speedCode>
</speedDialEntry>
<speedDialEntry>
<speedCode>6</speedCode>
</speedDialEntry>
<speedDialEntry>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 197 OF 521
 <speedCode>7</speedCode>
</speedDialEntry>
<speedDialEntry>
<speedCode>8</speedCode>
</speedDialEntry>
<speedDialEntry>
<speedCode>9</speedCode>
</speedDialEntry>
</SpeedDial8>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <SpeedDial8 xmlns="http://schema.broadsoft.com/xsi">
Content <speedDialEntry>
<speedCode>2</speedCode>
<phoneNumber>1213323</phoneNumber>
<description>testing</description>
</speedDialEntry>
<speedDialEntry>
<speedCode>3</speedCode>
<phoneNumber>11111</phoneNumber>
<description>testing2</description>
</speedDialEntry>
</SpeedDial8>
PUT
Response No Content
Content

3.5.3.73 services/ThirdPartyVoicemailSupport
This command is used to retrieve (GET method) or modify (PUT method) the settings of
the Third Party Voice Mail Support service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/ThirdPartyVoicemailSupp
ort
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ThirdPartyVoiceMailSupport
Content xmlns="http://schema.broadsoft.com/xsi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<active>false</active>
<busyRedirectToVoiceMail>true</busyRedirectToVoiceMail>
<noAnswerRedirectToVoiceMail>
true
</noAnswerRedirectToVoiceMail>
<alwaysRedirectToVoiceMail>
false
</alwaysRedirectToVoiceMail>
<outOfPrimaryZoneRedirectToVoiceMail>
false
</outOfPrimaryZoneRedirectToVoiceMail>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 198 OF 521
 <noAnswerNumberOfRings>
4
</noAnswerNumberOfRings>
</ThirdPartyVoiceMailSupport>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <ThirdPartyVoiceMailSupport
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<busyRedirectToVoiceMail>false</busyRedirectToVoiceMail>
<noAnswerRedirectToVoiceMail>
false
</noAnswerRedirectToVoiceMail>
<alwaysRedirectToVoiceMail>
true
</alwaysRedirectToVoiceMail>
<outOfPrimaryZoneRedirectToVoiceMail>
true
</outOfPrimaryZoneRedirectToVoiceMail>
<noAnswerNumberOfRings>5</noAnswerNumberOfRings>
</ThirdPartyVoiceMailSupport>
PUT
Response No Content
Content

3.5.3.74 services/VoiceMessaging
This command is used to retrieve (GET method) or modify (PUT method) the settings of
Voice Messaging user service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoiceMessaging
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoiceMessaging xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
<processing>Deliver To Email Address Only</processing>

<voiceMessageDeliveryEmailAddress>[email protected]</voiceMessa
geDeliveryEmailAddress>

<usePhoneMessageWaitingIndicator>true</usePhoneMessageWaiti
ngIndicator>

<sendVoiceMessageNotifyEmail>true</sendVoiceMessageNotifyEm
ail>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 199 OF 521
 <voiceMessageNotifyEmailAddress>[email protected]</voiceMessa
geNotifyEmailAddress>

<sendCarbonCopyVoiceMessage>false</sendCarbonCopyVoiceMessa
ge>

<voiceMessageCarbonCopyEmailAddress>[email protected]</voiceMessa
geCarbonCopyEmailAddress>

<transferOnZeroToPhoneNumber>false</transferOnZeroToPhoneNu
mber>
<transferPhoneNumber>001</transferPhoneNumber>

<alwaysRedirectToVoiceMail>false</alwaysRedirectToVoiceMail
>
<busyRedirectToVoiceMail>false</busyRedirectToVoiceMail>

<noAnswerRedirectToVoiceMail>false</noAnswerRedirectToVoice
Mail>

<outOfPrimaryZoneRedirectToVoiceMail>false</outOfPrimaryZon
eRedirectToVoiceMail>
</VoiceMessaging>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <VoiceMessaging xmlns="http://schema.broadsoft.com/xsi">
Content
<active>true</active>
<processing>Deliver To Email Address Only</processing>

<voiceMessageDeliveryEmailAddress>[email protected]</vo
iceMessageDeliveryEmailAddress>

<usePhoneMessageWaitingIndicator>true</usePhoneMessageWa
itingIndicator>

<sendVoiceMessageNotifyEmail>true</sendVoiceMessageNotif
yEmail>

<voiceMessageNotifyEmailAddress>[email protected]</voiceM
essageNotifyEmailAddress>

<sendCarbonCopyVoiceMessage>false</sendCarbonCopyVoiceMe
ssage>

<voiceMessageCarbonCopyEmailAddress>[email protected]</voiceMe
ssageCarbonCopyEmailAddress>

<transferOnZeroToPhoneNumber>false</transferOnZeroToPhon
eNumber>
<transferPhoneNumber>0001</transferPhoneNumber>

<alwaysRedirectToVoiceMail>false</alwaysRedirectToVoiceM
ail>

<busyRedirectToVoiceMail>false</busyRedirectToVoiceMail>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 200 OF 521
 <noAnswerRedirectToVoiceMail>false</noAnswerRedirectToVo
iceMail>

<outOfPrimaryZoneRedirectToVoiceMail>false</outOfPrimary
ZoneRedirectToVoiceMail>
</VoiceMessaging>
PUT
Response No Content
Content

3.5.3.74.1 services/VoiceMessaging/Aliases
This command is used to retrieve (GET method) the list of Voice Messaging Alias entries
or to create a new Alias entry (POST method).
A successful HTTP POST for a request returns a Location header with the URL of the
Voice Messaging Alias entry created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoiceMessaging/Aliases
Command
Category
Services

Methods GET, POST

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoiceMessagingAliasList
Content xmlns="http://schema.broadsoft.com/xsi">
<phoneNumber>0123456789</phoneNumber>
<phoneNumber>9876543210</phoneNumber>
</VoiceMessagingAliasList>
POST <?xml version="1.0" encoding="UTF-8"?>
Request <VoiceMessagingAliasList
Content xmlns="http://schema.broadsoft.com/xsi">
<phoneNumber>2222233333</phoneNumber>
</VoiceMessagingAliasList>
POST
Response No Content
Content

3.5.3.74.2 services/VoiceMessaging/Aliases /<phoneNumber>

This command is used to delete (DELETE method) a single Voice Messaging Alias entry.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoiceMessaging/Aliases
/<phoneNumber>
Command
Category
Services

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 201 OF 521
 Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.3.74.3 services/VoiceMessaging/DistributionLists/<listid>
This command is used to retrieve (GET method) or modify (PUT method) a single Voice
Messaging Distribution List entry.
There are 15 pre-defined distribution lists with ids from 0 through 14.
If the phoneNumberList is set to “nil”, then the configured distribution list is simply cleared.
Modifications made using the PUT method to the phoneNumberList element will replace
existing phone number elements in the phoneNumberList.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoiceMessaging/Distribu
tionLists/<listid>
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoiceMessagingDistributionList
Content xmlns="http://schema.broadsoft.com/xsi">
<description>list1</description>
<phoneNumberList>
<phoneNumber>123</phoneNumber>
<phoneNumber>456</phoneNumber>
</phoneNumberList>
</VoiceMessagingDistributionList>
PUT <?xml version="1.0" encoding="UTF-
Request 8"?><VoiceMessagingDistributionList
Content xmlns="http://schema.broadsoft.com/xsi">
<description>list5</description>
<phoneNumberList>
<phoneNumber>123</phoneNumber>
<phoneNumber>456 </phoneNumber>
</phoneNumberList>
</VoiceMessagingDistributionList>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 202 OF 521
3.5.3.74.4 services/VoiceMessaging/MailServer
This command is used to retrieve (GET method) or modify (PUT method) the advanced
settings of the Voice Messaging user service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/voicemessaging/mailserv
er
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoiceMessagingMailServer
Content
xmlns="http://schema.broadsoft.com/xsi"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<mailServerSelection>Group Mail
Server</mailServerSelection>

<groupMailServerEmailAddress>[email protected]</groupMailServerE
mailAddress>
<groupMailServerUserId>testID</groupMailServerUserId>

<groupMailServerFullMailboxLimit>100</groupMailServerFullMa
ilboxLimit>

<useGroupDefaultMailServerFullMailboxLimit>false</useGroupD
efaultMailServerFullMailboxLimit>
<personalMailServerNetAddress xsi:nil="true"/>

<personalMailServerProtocol>IMAP</personalMailServerProtoco
l>

<personalMailServerRealDeleteForImap>false</personalMailSer
verRealDeleteForImap>
<personalMailServerEmailAddress xsi:nil="true"/>
<personalMailServerUserId xsi:nil="true"/>
</VoiceMessagingMailServer>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <VoiceMessagingMailServer
Content
xmlns="http://schema.broadsoft.com/xsi">
<mailServerSelection>Group Mail
Server</mailServerSelection>

<groupMailServerEmailAddress>[email protected]</group
MailServerEmailAddress>
<groupMailServerUserId>group1</groupMailServerUserId>

<groupMailServerPassword>passwordX</groupMailServerPassw
ord>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 203 OF 521
 <useGroupDefaultMailServerFullMailboxLimit>true</useGrou
pDefaultMailServerFullMailboxLimit>
</VoiceMessagingMailServer>

3.5.3.74.5 services/VoiceMessaging/Greetings
This command is used to retrieve (GET method) or modify (PUT method) the settings of
Message Greetings related to Voice Messaging user service.
The following elements are only available on an Application Server:
 disableMessageDeposit
 disableMessageDepositAction
 greetingOnlyForwardDestination
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoiceMessaging/Greetings
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoiceMessagingGreetings
Content
xmlns="http://schema.broadsoft.com/xsi">

<busyAnnouncementSelection>Personal</busyAnnouncementSelecti
on>
<busyPersonalAudioFile>
<description>test-personal-busy</description>
<mediaType>WAV</mediaType>
</busyPersonalAudioFile>
<busyPersonalVideoFile>
<description>H.263 test-personal-video</description>
<mediaType>MOV</mediaType>
</busyPersonalVideoFile>

<noAnswerAnnouncementSelection>Alternate03</noAnswerAnnounce
mentSelection>
<noAnswerPersonalAudioFile>
<description>call-waiting.wav</description>
</noAnswerPersonalAudioFile>
<noAnswerPersonalVideoFile>
<description>H.263
QueueDefaultWhisperMsg.mov</description>
</noAnswerPersonalVideoFile>
<noAnswerAlternateGreeting01>
<name>GREETING ONE</name>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 204 OF 521
 <audioFile>

<description>VMdefaultLongMsgWarningTone.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
QueueEntranceWaitTimeMinute36.mov</description>
<mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting01>
<noAnswerAlternateGreeting02>
<name>GREETING TWO</name>
<audioFile>
<description>prepaid-low-credits-warning-
tone.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
TrtInterceptDeniedCall.mov</description>
<mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting02>
<noAnswerAlternateGreeting03>
<name>GREETING THREE</name>
<audioFile>
<description>call-waiting-1.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
QueueEntranceWaitTimeMinute76.mov</description>
<mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting03>
<noAnswerNumberOfRings>10</noAnswerNumberOfRings>
<disableMessageDeposit>true</disableMessageDeposit>

<disableMessageDepositAction>Forward</disableMessageDepositA
ction>

<greetingOnlyForwardDestination>0001</greetingOnlyForwardDes
tination>
</VoiceMessagingGreetings>
PUT <?xml version="1.0" encoding="ISO-8859-1"?>
Request <VoiceMessagingGreetings
Content xmlns="http://schema.broadsoft.com/xsi">

<busyAnnouncementSelection>Personal</busyAnnouncementSelectio
n>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 205 OF 521
 <busyPersonalAudioFile>
<description>test-personal-busy</description>
<mediaType>WAV</mediaType>
</busyPersonalAudioFile>
<busyPersonalVideoFile>
<description>H.263 test-personal-video</description>
<mediaType>MOV</mediaType>
</busyPersonalVideoFile>

<noAnswerAnnouncementSelection>Alternate03</noAnswerAnnouncem
entSelection>
<noAnswerPersonalAudioFile>
<description>call-waiting.wav</description>
</noAnswerPersonalAudioFile>
<noAnswerPersonalVideoFile>
<description>H.263
QueueDefaultWhisperMsg.mov</description>
</noAnswerPersonalVideoFile>
<noAnswerAlternateGreeting01>
<name>GREETING ONE</name>
<audioFile>

<description>VMdefaultLongMsgWarningTone.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
QueueEntranceWaitTimeMinute36.mov</description>
<mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting01>
<noAnswerAlternateGreeting02>
<name>GREETING TWO</name>
<audioFile>
<description>prepaid-low-credits-warning-
tone.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
TrtInterceptDeniedCall.mov</description>
<mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting02>
<noAnswerAlternateGreeting03>
<name>GREETING THREE</name>
<audioFile>
<description>call-waiting-1.wav</description>
<mediaType>WAV</mediaType>
</audioFile>
<videoFile>
<description>H.263
QueueEntranceWaitTimeMinute76.mov</description>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 206 OF 521
 <mediaType>MOV</mediaType>
</videoFile>
</noAnswerAlternateGreeting03>
<noAnswerNumberOfRings>10</noAnswerNumberOfRings>
<disableMessageDeposit>true</disableMessageDeposit>

<disableMessageDepositAction>Forward</disableMessageDepositAc
tion>

<greetingOnlyForwardDestination>0001</greetingOnlyForwardDest
ination>
</VoiceMessagingGreetings>
PUT
Response No Content
Content

3.5.3.75 services/VoicePortal
This command is used to retrieve (GET method) or modify (PUT method) a personalized
name (upload audio file) for the Voice Messaging user service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/services/VoicePortal
Command
Category
Services

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <VoicePortal xmlns="http://schema.broadsoft.com/xsi">
Content
<usePersonalizedName>true</usePersonalizedName>
<voicePortalAutoLogin>true</voicePortalAutoLogin>
<personalizedNameAudioFile>
<description>desc2</description>
<mediaType>WAV</mediaType>
</personalizedNameAudioFile>
</VoicePortal>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <VoicePortal xmlns="http://schema.broadsoft.com/xsi">
Content
<usePersonalizedName>true</usePersonalizedName>
<voicePortalAutoLogin>true</voicePortalAutoLogin>
<personalizedNameAudioFile>
<description>desc2</description>
<mediaType>WAV</mediaType>
<content>UklGRsxLAQBXQVZFZm1…</content>
</personalizedNameAudioFile>
</VoicePortal>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 207 OF 521
 3.5.4 User Call Commands: /user/<userid>/calls
This section describes every call control command available in the Xtended Services
Interface, targeting a Cisco BroadWorks-hosted end-user subscriber.
A key concept in call control commands is the address element/URL parameter. The
address represents the identity of a user’s phone or device. The most common example
of an address is the phone number. A call control address in the Xtended Services
Interface can be provided in various forms as follows:
 +12221001002 (E.164-formatted phone number)
 1002 (phone number extension)
 [email protected] (user ID)
 sip:[email protected] (SIP URI)
 tel: +12221001002 (Tel URI)
Any one of these formats can be specified when sending an “address” as documented in
Xtended Services Interface call control commands.

3.5.4.1 calls
This service returns the list of active calls for a given user. If a user is in a conference, the
call leg that is part of the conference is identified. The response to this command contains
a URL that can be used to obtain details on each active call that the user is in.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls
Command
Category
Call Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <Calls xmlns="http://schema.broadsoft.com/xsi">
Content <call inConference="false">
<callId>callhalf-722:0</callId>
<uri>/v2.0/user/[email protected]/calls/callhalf-
722:0</uri>
</call>
</Calls>

3.5.4.2 calls/New
This service triggers a click-to-dial call origination for the user.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/new
Example http(s)://<host:port>/com.broadsoft.xsi-
URI actions/v2.0/user/<userid>/calls/new?address=5006007001

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 208 OF 521
 Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Response <callId>callhalf-488:0</callId>
Content <externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String M This is the address to dial once the user has
picked up the phone on the local end of the
call.

clid personal, O The calling line identity (CLID) to be

<dnisNumber> presented while placing the call can be
identified. This is used when a call center
agent must place a call with an automatic
call distribution (ACD) number different from
their default configuration.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 209 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains mobile directory number. The
directory number can be in E.164 format or
it can just contain digits. The following are
valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

info String O This is an opaque information provided by

the client for the Application Server to
correlate this information with the call
session. The Application Server stores this
information against the call session and is
transmitted to both ends of the call session
during call setup.

conferenceId String O This is the conference ID for the conference

to join.

pin String O This is the security PIN for the conference

to join, if the conference requires a security
PIN.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 210 OF 521
 3.5.4.3 calls/<callid>
This command is used to retrieve the details of a call (GET method) or to release a call
(DELETE method).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>
Command
Category
Call Management

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <Call xmlns="http://schema.broadsoft.com/xsi"
Content xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<callId>callhalf-770:0</callId>
<extTrackingId>97:1</extTrackingId>
<personality>Originator</personality>
<state>Active</state>
<remoteParty>
<name>Subhash negi002</name>
<address>tel:7002</address>
<userId>[email protected]</userId>
<userDN
countryCode="1">tel:+15006007002;ext=7002</userDN>
<callType>Group</callType>
</remoteParty>
<endpoint xsi1:type="xsi:AccessEndpoint"
xmlns:xsi="http://schema.broadsoft.com/xsi”>
<addressOfRecord>[email protected]</addressOfRecor
d>
</endpoint>
<appearance>1</appearance>
<diversionInhibited />
<startTime>1269437349112</startTime>
<answerTime>1269437354737</answerTime>
</Call>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 211 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

decline True, False O This parameter is only applicable to the

DELETE method and is used to terminate a
call in the alerting state.
When decline is set to “True”, it indicates
whether the call should be immediately
rejected with Temporarily Unavailable
processing.
The default value is “False”. This means
that the user stops being alerted, but the
call remains in the alerting state until the
call is released from the remote end or the
answer timeout processing is triggered.

allowDetached True, False O This parameter is only applicable to the

GET method.
When allowDetached is set to “True”, it
indicates that the details should be returned
for the call if the state is detached;
otherwise, the details for the call are not
returned if the state of the call is detached.
The default value is “False”.

declineReason Busy, O This parameter is only applicable to the

TemporarilyUn DELETE method and it is only applicable
available when the decline parameter is set to “true”.
When declining a call, if the declineReason
parameter is not set, the call is sent to
“Temporarily Unavailable” processing,
which can trigger No Answer services such
as Voice Mail and Call Forwarding No
Answer. If the declineReason parameter is
present, then the call is sent to the specified
processing and it triggers the applicable
services.

3.5.4.4 calls/DispositionCode/<code> (As Only)

This command is used to request Cisco BroadWorks to tag the most recent ACD call the
specified user was involved in, with a disposition code. In this command, the specific call
is not identified by a client application but determined by Cisco BroadWorks.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/DispositionCode/<code>
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 212 OF 521
 3.5.4.5 calls/<callid>/DispositionCode/<code> (AS Only)
This command is used to request the specified disposition code to be applied on the
specified call.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/DispositionCode/<
code>
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.6 calls/<callid>/BlindTransfer
This command is used to transfer the specified call to the specified address.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/BlindTransfer
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String M This is the address to use for the call

redirection.

toFront True, False O If the parameter is set to “True” and the call
is being transferred to a call center queue,
then the call is transferred to the front in the
queue.
The default value is “False”.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 213 OF 521
 3.5.4.7 calls/<callid>/ClientSessionInfo (AS Only)
A remote application uses this command to explicitly associate the client session info with
the existing call session. The client session info is specified as a URL parameter and is
mandatory for this command. Upon receiving this command, the Application Server
stores the client session info against the call session and triggers notifications for
both ends of the call session. The notifications are sent over the SIP and/or Xsi
interfaces. In the case of the Xsi interface, the CallClientSessionInfoUpdateEvent is
triggered by this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/ClientSessionI
nfo
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

info String M This is an opaque information provided by

the client for the Application Server to
correlate this information with the call
session. The Application Server stores this
information against the call session and
triggers notifications for both ends of the call
session over the SIP and/or Xsi interface.

3.5.4.7.1 /user/<userid>/calls/CoachAgent
Version: 23.4
This command is used to allow a supervisor to coach an agent when the agent is on a call
with a customer.
The response that is returned can be “call start” information or an error response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/coachagent
Command Call Management
Category
Methods POST
POST
Request No content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 214 OF 521
 POST <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Response <callId>callhalf-3673:0</callId>
Content
<externalTrackingId>2:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Allowed Optional/ Description
Name Values Mandatory

address String M The address of the agent to be coached.

location String O When present, specifies the location of the

calling user to ring for the call.
When not present, locations are alerted per
the calling user's profile on Cisco
BroadWorks.

locationAddress String O Specific address of location to ring. This

element should only be present if the
“location” element is present and set to
“BroadWorksAnywhere”,
“SharedCallAppearance”, or “Mobility”.

3.5.4.8 calls/<callid>/ConsultTransfer/<callid>
This command is used to transfer the specified calls after consulting with the receiving
party.
This is referred to as an Attended Transfer, a Consultative Transfer, or a Transfer with
Consultation. The user must have the Call Transfer service to use this command.
Consultation Transfer requires two call IDs, the call ID of the party to be transferred, and
the call ID of the consulted party.
In the URI, callid1 refers to the call ID of the party to be transferred and callid2 refers to the
call ID of consulted party.
The scope and privacy control is provided by the Cisco BroadWorks platform, and not
Xsi-Actions, as mentioned in previous sections.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid1>/ConsultTransfer/
<callid2>
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 215 OF 521
 3.5.4.9 calls/<callid>/EmergencyEscalate (AS Only)
This command is used to place an emergency call from an agent to a supervisor. The call
ID for which the emergency call applies is identified in the URI. This triggers the creation
of a new call to the supervisor. This is different from a click-to-dial origination in that the
current call is not placed on hold. The new call is placed to the supervisor and a
conference is automatically created upon answer.
The user must have either the Call Center Basic, Call Center Standard, or Call Center
Premium service.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/EmergencyEscalate
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the supervisor to

whom to escalate the call.
When this is not specified, Cisco
BroadWorks selects an available supervisor
for the escalation.

3.5.4.10 calls/Escalate (AS Only)

This command is used to originate a call (a Click-To-Dial call) from an agent to a
supervisor. When the request is received, the Application Server emulates feature access
code (FAC) dialing by the user. A new call is originated as if the user dialed a feature
access code.
The user must have the Call Center Standard or Call Center Premium service.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 216 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Escalate
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the supervisor to

whom to escalate the call.
When this is not specified, Cisco
BroadWorks selects an available supervisor
for the escalation.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 217 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.11 calls/<callid>/ExecutiveAssistantCallPush (AS Only)

This command allows a remote application to initiate the Call Push action for the
Executive Assistant feature.
The calls/<callid>/ExecutiveAssistantCallPush URL allows the remote application to issue
a command to the Application Server to push the call back to the Executive associated
with the call. The response that is returned can be a success response or an error
response.
A success response is returned if the following conditions are met:
 The user must be an Assistant.
 The call for the specified call ID must exist for the Assistant.
 The call must be an Executive call for the Assistant.
 The Executive call must have already been answered.

Otherwise, an error response is returned.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 218 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/ExecutiveAssistant
CallPush
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response 200
Content

3.5.4.12 calls/ExecutiveAssistantInitiateCall (AS Only)

The calls/ExecutiveAssistantInitiateCall URL allows the remote application to issue a
command to the Application Server to make a call from the Executive Assistant on behalf
of the Executive.
The Executive’s address and the address to be dialed are necessary for this command.
The client application can retrieve the list of Executives to whom the Assistant has been
assigned to by invoking the /user/<userid>/services/executiveassistant command.
The response that is returned can be call start information or an error response.
If the Call Initiate request succeeds, a new call is placed to the address specified in the
command on behalf of the Executive. A successful HTTP POST request returns a
Location header with the URL of the callId of the call created in the HTTP response. The
HTTP response returned is a 200 OK.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/ExecutiveAssistantInitiateC
all
Command
Category
Call Management

Methods POST
POST
Request No content
Content
POST
Response 201
Content

Parameter Description
The following parameters are necessary to initiate a call by the Executive Assistant on
behalf of the Executive.

Parameter Allowed Optional / Description

Name Values Mandatory
executive String M This is the address of the Executive on
Address whose behalf the Assistant is initiating the
call.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 219 OF 521
 Parameter Allowed Optional / Description
Name Values Mandatory

address String M The address to which the call is to be

initiated.

3.5.4.13 calls/<callid>/FindMeFollowMeCallPush/<callId> (AS Only)

This command allows Cisco BroadWorks to push the specified call back to the FMFM
group associated with the call. The response that is returned can be a success response
or an error response.
An error response is returned for the following conditions:
 If the call identified by the call ID is not a call received by an FMFM group
 If the call identified by the call ID is no longer available on the Application Server
 If call <callid> is an emergency call
 If the user is not a member of an alerting group that belongs to the FMFM group
 If diversions are inhibited for the call
 If it is blocked by the maximum Concurrent Redirections policy
 If it is blocked by Account/Authorization Codes service
 If it is blocked by Outgoing Calling Plan service
 If it is blocked by Communication Barring service
If the Call Push request succeeds, then the call is redirected to the selected FMFM group.
All the users in the alerting groups are alerted again, except for the user who pushed the
call.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/FindMeFollowMeCall
Push/<callId>
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.14 calls/<callid>/GroupCallPark
This command is used to park the specified call using Group Call Park (GCP). To use this
command, the user must be a member of a GCP. Upon handling the request, Cisco
BroadWorks selects an address in the group against which to park the call.
A successful HTTP PUT request returns a Content-Location header with a URL that
reflects the selected address and that can be used to retrieve the parked call.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 220 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/GroupCallPark
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.15 calls/<callid>/Hold
This command is used to hold the specified call.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/Hold
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.16 calls/<callid>/MuteTransfer
This command is used to transfer the specified call to the specified address. The user
must have the Call Transfer service to use this command. In contrast with the
calls/<callid>/BlindTransfer service, the transfer actually takes place when the call to the
specified address reaches the alerting state.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/MuteTransfer
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 221 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String M This is the address to use for call

redirection.

3.5.4.17 calls/<callid>/PauseRecording (AS Only)

The PauseRecording URL allows a call recording to be paused. The recording modes
that support “pause” are Always with Pause/Resume, On Demand, and On Demand with
User Initiated Start. The response returned can be a success response or an error
response.
If the pause recording request is received and there are validation errors, an error
response is returned; otherwise, a success response is returned.
If a subsequent pause recording request is received while the recording is already paused
or while processing an earlier pause request, a success response is returned.
Only when the recording is successfully paused, the CallRecordingPausedEvent is sent.
The recordingState element is set to “Paused” and the allowedRecordingControls element
is updated according to the recording mode.
If the pause was not successful, the CallRecordingPausedEvent notification is not sent.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/PauseRecording
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.18 calls/<called>/PlayMusicOnHold
The URL allows the remote application to issue a command to the Cisco BroadWorks
Application Server to play music on a held call.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userId>/calls/<callId>/playmusiconhold
Command
Category
Call Management

Methods PUT

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 222 OF 521
 PUT Request <?xml version="1.0" encoding="UTF-8"?>
Content <PlayDynamicMusicOnHold
xmlns="http://schema.broadsoft.com/xsi">
<audioUrlList>
<uri>http://10.94.171.108:80/media/en/MusicOnHold1.wav</ur
i>
<uri>http://10.94.171.108:80/media/en/MusicOnHold2.wav</ur
i>
<uri>http://10.94.171.108:80/media/en/MusicOnHold3.wav</ur
i>
<uri>http://10.94.171.108:80/media/en/MusicOnHold4.wav</ur
i>
</audioUrlList>
<videoUrlList>
<uri>http://10.94.171.110:80/media/en/VideoOnHold1.mov</ur
i>
<uri>http://10.94.171.110:80/media/en/VideoOnHold2.mov</ur
i>
<uri>http://10.94.171.110:80/media/en/VideoOnHold3.mov</ur
i>
<uri>http://10.94.171.110:80/media/en/VideoOnHold4.mov</ur
i>
</videoUrlList>
</PlayDynamicMusicOnHold>
PUT
Response No Content
Content

3.5.4.19 calls/<callid>/Park
This command is used to park a call so that any member of the group/enterprise can
retrieve it later. A call can be parked against any user of the group/enterprise, including
the user who parks the call. However, a user can only have one call parked at a time
against them.
The user’s group must have the Call Park service to use this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/Park
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 223 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the user against which

to park the call.
When not specified, the call is parked
against the user’s own address.

3.5.4.20 calls/<callid>/Record (AS Only)

This command is used to record the specified call. The user must have the Call
Recording service to use this command.
Receiving a success response to the command does not guarantee success of the record
action requested; the success response only means that the command is being
processed. However, receiving an error response is definitive; it means the command is
not being processed because the validation checking detected conditions that prevent the
command from being processed.
In addition, a CallRecordingStartedEvent is sent when the recording is started
successfully.
The record command has additional capabilities if the user’s call recording mode is On
Demand with User Initiated Start. In this mode, the calls/<callid>/record URL allows the
remote application to issue a command to the Application Server to record the call. Upon
reception of this command in this mode, the Application Server starts the Call Recording
service for the user’s call.
There are situations in which the command is issued more than once during the life of a
call. The following describes how the situation is handled in the On Demand with User
Initiated Start mode.
 If the first record command came back with an error response, it is reasonable that the
user would want to try the command again. In this situation, if the command is issued
again, the Application Server reattempts to record the call. If the recording started
successfully, the CallRecordingStartedEvent is sent. If not successful,
CallRecordingStartedEvent is not sent.
 If the first record command resulted in a CallRecordingStartedEvent notification and
the user issues the command a second time, the resulting response depends on
whether the call is currently being recorded. If the user has stopped the recording
prior to the second record command, then the success or failure of the reattempt is
based on whether the CallRecordingStartedEvent is sent. If there is already an active
recording, the Application Server returns a success response because the call is
already being recorded.
If the user’s call recording mode is On Demand, the calls/<callid>/record URL allows the
remote application to issue a command to the Application Server to record the call. The
response returned can be a success response or an error response.
There may be situations in which the command is issued more than once during the life of
a call. The following describes how these situations are handled.
 If the first record command came back with an error response, it is reasonable that the
user would want to try the command again. In this situation, if the command is issued
again, the Application Server reattempts to record the call. If the recording started
successfully, the CallRecordingStartedEvent is sent. If not successful,
CallRecordingStartedEvent is not sent.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 224 OF 521
  If the first record command resulted in a CallRecordingStartedEvent and the user
issues the command a second time, the Application Server returns a success
response because the call is already being recorded.
If the record request is received and there are validation errors, an error response is
returned; otherwise, a success response is returned.
If a subsequent record request is received while the recording is already underway or
while processing an earlier record request, a success response is returned.
The CallRecordingStartedEvent is only sent when the recording is successfully started.
The recordingState element is set to “Started” and the allowedRecordingControls element
is updated according to the recording mode. When processing the record request, it is
possible that the CallRecordingStartingEvent is sent prior to the
CallRecordingStartedEvent. If the record request was not successful, the
CallRecordingStartedEvent notification is not sent.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/Record
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.21 calls/<callid>/Reconnect (AS Only)

This command is used to retrieve the specified held call and release all other calls.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/Reconnect
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.22 calls/<callid>/ResumeRecording (AS Only)

The ResumeRecording URL allows a call recording to be resumed. The recording modes
that support “resume” are Always with Pause/Resume, On Demand, and On Demand with
User Initiated Start. The response returned can be a success response or an error
response.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 225 OF 521
 If the resume recording request is received and there are validation errors, an error
response is returned; otherwise, a success response is returned.
If a subsequent resume recording request is received while the recording is already
underway or while processing an earlier resume request, a success response is returned.
The CallRecordingResumedEvent is only sent when the recording is successfully
resumed. The recordingState element is set to “Started” and the
allowedRecordingControls element is updated according to the recording mode.
If the resume was not successful, the CallRecordingResumedEvent notification is not sent.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/ResumeRecording
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.23 calls/<callid>/StopRecording (AS Only)

The StopRecording URL allows a call recording to be stopped. The only recording mode
that supports “stop” is On-Demand with User Initiated Start. The response returned can
be a success response or an error response.
If the stop recording request is received and there are validation errors, an error response
is returned; otherwise, a success response is returned.
If a subsequent stop recording request is received while the recording is already stopped
or while processing an earlier stop request, a success response is returned.
The CallRecordingStoppedEvent is only sent when the recording is successfully stopped.
The recordingState element is removed and the allowedRecordingControls element is
updated according to the recording mode. In addition, a reason element with “User
Requested” is included.
If the stop was not successful, the CallRecordingStoppedEvent notification is not sent.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/StopRecording
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 226 OF 521
 3.5.4.24 calls/<callid>/Talk
This command is used to answer the specified call if it is unanswered or to retrieve the
specified call if it is held (that is, to start talking).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/Talk
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.25 calls/<callid>/TransmitDTMF
This command is used to send a series of dual-tone multi-frequency (DTMF) digits on
behalf of the user for the specified call.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/TransmitDTMF
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

playdtmf String of digits: M These are the digits to transmit.

0,1,2,3,4,5,6,7 Including a comma indicates a pause
,8,9,*,#, A, B, between digits.
C, D, comma In this example, the digits 2405551000 are
transmitted followed by a pause, followed
by the digits 2345: “2405551000, 2345”.

3.5.4.26 calls/<callid>/VmTransfer
This command is used to transfer the specified call to the user’s own voice mail or to
another user’s voice mail.
The user must have the Call Transfer service to use this command. There must also be a
valid Cisco BroadWorks voice portal for the user and/or target or a valid third-party voice
mail support configuration for the target to use this request.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 227 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callid>/VmTransfer
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the target user’s

mailbox.
If no address is specified, then the call is
transferred to the transferring user’s own
voice mail.

3.5.4.27 calls/AutomaticCallback
This command is used to remove all pending Automatic Callbacks.
The user must have the Automatic Callback service to use this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/AutomaticCallback
Command
Category
Call Management

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.4.28 calls/CallMeNow (AS Only)

The service is used to make a CallMeNow call to the specified user. The invoking party
cannot be a Cisco BroadWorks user and specifies an address to be reached. The
invoking party is called first, and the call proceeds to the specified user once the invoking
party has been reached.
The specified user must have the Call Me Now service.
This service does not initiate an authentication challenge as the invoking party cannot be a
Cisco BroadWorks user, and any authentication headers received in the request are
ignored. However, the provided address parameter is screened per the user’s outgoing
calling plan or communication barring profile.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 228 OF 521
 If the HTTP POST request is rejected (for example, the specified user does not have the
Call Me Now service enabled or the screening of the provided address fails), then an error
response is returned.
Otherwise, a 200 OK success response is returned. If the specified user has the Call Me
Now service’s Answer Confirmation option set to “Passcode”, then the
CallMeNowStartInfo returned in the success response includes the passcode to be used.
For all other answer confirmation settings, the CallMeNowStartInfo returned in the success
response contains no passcode.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/CallMeNow
Command
Call Management
Category
Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallMeNowStartInfo
Content xmlns="http://schema.broadsoft.com/xsi">
<passcode>1234</passcode>
</CallMeNowStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String M This is the address to use for calling the

external party that is invoking the Call Me
Now service.
The following are examples of valid content
for the address parameter:
 2403645555
 +12403645555
 5555
 tel:+12403645555
 sip:2403645555@broadworks

transactionId String O When present, the transactionId parameter

1 to 128 is captured in the originating CDR created
characters for the Call-Me-Now call from the target
user to the external party. It can be used
for various purposes such as capturing an
identifier of the application or external party
that is invoking the Call Me Now service.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 229 OF 521
 3.5.4.29 calls/CallPickup
This command is used to pick up an alerting call. The user must be a member of a Call
Pickup Group to use this request.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/CallPickup
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 230 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.30 calls/CallRetrieve
This command is used to invoke the Call Retrieve function for the specified user. This
service effectively pulls the specified call for the target user from its current location to a
different location for the target user. The target user must have a multiple appearance
service active, such as BroadWorks Mobility, BroadWorks Anywhere, or Shared Call
Appearance. When the request is received, the Application Server emulates feature
access code (FAC) dialing by the user. A new call is originated as if the user dialed a
feature access code.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call retrieved in the HTTP response.
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/CallRetrieve

Command
Call Management
Category
Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 231 OF 521
 POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content
<callid>callhalf-1115:1</callid>
<externalTrackingId>40:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 232 OF 521
 3.5.4.31 calls/CallReturn
This command is used to start a new call (that is, a Click To Dial call) using the address of
the last call missed or received by the user. When the request is received, the Application
Server emulates feature access code (FAC) dialing by the user. A new call is originated
as if the user dialed a feature access code.
The user must have the Call Return service to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/CallReturn
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 233 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.32 calls/Conference
This command is used to retrieve conference details, to start a conference, to add or
remove participants to a conference, and to release a conference.
 Start Conference
An HTTP POST requests a conference to be started with the specified call IDs in the
call element. The user must have the N-Way Call or Three-Way Call service to make
this request. A minimum of two call IDs is required to start a conference.
 Remove Participant
Removing a participant is accomplished by ending the corresponding call that is part
of the conference. An HTTP DELETE on the call’s URL with the call ID of the
participant’s call removes the participant from the conference. Only one participant
can be removed at a time.
 Retrieve Conference Detail
An HTTP GET requests conference details for the specified user’s active session.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 234 OF 521
  End Conference
An HTTP DELETE requests the user’s conference to be released. Note that this
releases the user’s leg to the conference and all the calls that are part of the
conference as well.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference
Command
Category
Call Management

Methods GET, POST, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8" ?>
Response <Conference xmlns="http://schema.broadsoft.com/xsi">
Content <state>Active</state>
<appearance>2</appearance>
<conferenceType>Barge-In</conferenceType>
<conferenceParticipantList>
<conferenceParticipant>
<callId>localhost1:0</callId>
</conferenceParticipant>
<conferenceParticipant>
<callId>localhost1:1</callId>
</conferenceParticipant>
</conferenceParticipantList>
</Conference>
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Conference xmlns="http://schema.broadsoft.com/xsi">
Content <conferenceParticipantList>
<conferenceParticipant>
<callId>localhost1:0</callId>
</conferenceParticipant>
<conferenceParticipant>
<callId>localhost1:1</callId>
</conferenceParticipant>
</conferenceParticipantList>
</Conference>
POST
Response No Content
Content
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 235 OF 521
 3.5.4.32.1 calls/Conference/<callid>
This command is used to add the specified call ID as a participant in the user’s
conference. Only one participant can be added at a time.
The participant’s call ID can be specified in the URL or in the XML body.
 If the call ID is not specified in either the URL or the body, then the request is rejected.
 If the call ID is sent both in the URL and the body, then the call ID in the URL is added
and the call ID in the body is ignored.
 If more than one call ID is sent in the body, then only the first call ID is added as a
participant; the remaining call IDs are ignored.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/<callid>
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.2 calls/Conference/<callid>/Deaf
This command is used to “make deaf” a call participating in a conference. When deaf, the
conference audio stream from the conference controller is not transmitted to the
conference participant associated with the call. However, every participant can hear the
deaf party. The video stream to the deaf party (if applicable) is blacked out.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/<callid>/Deaf
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 236 OF 521
 3.5.4.32.3 calls/Conference/<callid>/Mute
This command is used to mute a call participating in a conference. When muted, no audio
stream is transmitted from the muted participant associated with the call to the other
participants. The video stream of the call (if applicable) is not affected.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/<callid>/Mute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.4 calls/Conference/<callid>/UnDeaf
This command is used to undeaf a call participating in a conference. When this request is
completed, the audio stream is transmitted again to the conference participant associated
with the call. The video stream (if applicable) is restored.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/<callid>/UnDeaf
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.5 calls/Conference/<callid>/UnMute
This command is used to unmute a call participating in a conference. When unmuted, the
audio stream can again be transmitted from the conference participant associated with the
call to the other participants. The video stream (if applicable) is not affected.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/<callid>/UnMute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 237 OF 521
 PUT
Response No Content
Content

3.5.4.32.6 calls/conference/BargeIn
This command is used to allow a supervisor to transition to barge-in mode.
The response that is returned can be a success response or an error response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actionsr6
Command
Category
Call Management

Methods PUT
PUT Request
Content
No content

PUT
Response No content
Content

Parameter Description
Parameter Allowed Optional/ Description
Name Values Mandatory

userId String M The user ID of the supervisor.

3.5.4.32.7 calls/Conference/Hold
This command is used to hold a conference.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/Hold
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.8 calls/Conference/Talk
This command is used to retrieve a held conference.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/Conference/Talk

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 238 OF 521
 Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.9 calls/Conference/Mute
This command allows the remote application to issue a command to mute the controller of
a conference. The controller’s user ID is necessary for the request.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/conference/mute
Command
Call Management
Category
Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.4.32.10 calls/Conference/Unmute
This command is used to unmute a conference. When unmuted, the audio stream can be
transmitted from the controller of the conference (that is, the supervisor) to the other
participants. This is typically used in the context of call center silent monitoring. When a
supervisor initiates silent monitoring of an agent’s call, then the call topology is reorganized
into a conference call hosted by the supervisor and the supervisor is automatically muted.
This command allows the supervisor to escalate silent monitoring to an actual barge-in.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/conference/unmute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 239 OF 521
 3.5.4.32.11 calls/conference/SilentMonitor
This command is used to allow a supervisor to transition to silent monitoring mode.
The response that is returned can be a success response or an error response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/conference/silentmonitor
Command
Category
Call Management

Methods PUT
PUT Request
Content
No content

PUT
Response No content
Content

Parameter Description
Parameter Allowed Optional/ Description
Name Values Mandatory

userId String M The user ID of the supervisor.

3.5.4.32.12 calls/conference/SupervisorCoach
This command is used to allow a supervisor to transition to supervisor coaching mode.
The response that is returned can be a success response or an error response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/conference/supervisorcoa
ch
Command
Category
Call Management

Methods PUT
PUT Request
Content
No content

PUT
Response No content
Content

Parameter Description
Parameter Name Allowed Optional/ Description
Values Mandatory

userId String M The user ID of the supervisor.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 240 OF 521
 3.5.4.33 calls/<callId>/CustomerOriginatedTrace
This command is used to initiate a Customer Originated Trace for the specified call. The
user must have the Customer Originated Trace service to use this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/<callId>/CustomerOriginate
dTrace
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST
Response No Content
Content

3.5.4.34 calls/CustomerOriginatedTrace
This command is used to initiate a Customer Originated Trace. The trace is made for the
user’s most recently received/missed call. The user must have the Customer Originated
Trace service to use this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/CustomerOriginatedTrace
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST
Response No Content
Content

3.5.4.35 calls/DirectedCallPickup
This command is used perform a Directed Call Pickup. When the request is received, the
Application Server emulates feature access code (FAC) dialing by the user. A new call is
originated as if the user dialed a feature access code.
The user must have the Directed Call Pickup service assigned to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/DirectedCallPickup
Command
Category
Call Management

Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 241 OF 521
 POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the user to pick up.

When not specified, the user is connected is
to an IVR and prompted for the target user’s
address.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA Default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 242 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.36 calls/DirectedCallPickupBargeIn
This command is used perform a Directed Call Pickup with Barge-in. When the request is
received, the Application Server emulates feature access code (FAC) dialing by the user.
A new call is originated as if the user dialed a feature access code.
The user must have the Directed Call Pickup with Barge-in service assigned to use this
command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/DirectedCallPickupBargeIn
Command
Category
Call Management

Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 243 OF 521
 POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the user to barge-in.

When not specified, automatic target
selection is used (if enabled) or the user is
connected is to an IVR and prompted for
the target user’s address.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 244 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a BroadWorks
address of record. The address of record
can be user@domain for SIP locations or
user for MGCP locations. The following are
valid address of records for the
locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains mobile directory number. The
directory number can be in E.164 format or
it can just contain digits. The following are
valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.37 calls/HookStatus (AS Only)

This command allows the remote application to get the hook status for the user.
The response returned can be a success response or an error response.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/HookStatus
Command
Category
Call Management

Methods GET
GET
Request No Content
Content
GET <?xml version=“1.0” encoding=“UTF-8”?>
Response <HookStatus xmlns=“http://schema.broadsoft.com/xsi”
Content xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”>
<hookStatus>On-Hook</hookStatus>
</HookStatus>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 245 OF 521
 3.5.4.38 calls/Imrn
The imrn command allows the user to create an IMRN resource on the Cisco BroadWorks
Application Server to anchor a mobile call. The response generally contains the IMRN
number allocated by the Application Server.
This is a POST operation and a response contains the allocated or created IMRN
resource.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
user/<userid>/calls/imrn
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST
Response <?xml version="1.0" encoding="UTF-8"?>
Content <IMRNInfo xmlns:p="http://schema.broadsoft.com/xsi">
When <imrn>+15125556666</imrn>
status code </IMRNInfo>
is 201.

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

callingPartyAddress String M This is the address of the calling party who

is originating this call.
The following are examples of valid content
for this parameter:
 9725551111
 +19725551111

calledPartyAddress String M This is the dialed digits of the called party

address where the call is terminated.
The following are examples of valid content
for this parameter:
 9725551111
 +19725551111
 Feature access codes
 Service access codes such as 711, 411

conferenceId String O A conference ID for the conference to join

the Meet-Me conference.

pin String O This is the security PIN for the Meet-Me

conference to join if the conference
requires a security PIN. The length of this
parameter should be a maximum of 10
digits.
Valid examples:
 123456789
001234

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 246 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

roomId String O A room ID for a collaborate room

conference.

3.5.4.39 calls/LastNumberRedial
This command is used to originate a new call (a Click To Dial call) using the last address
that was dialed. When the request is received, the Application Server emulates feature
access code (FAC) dialing by the user. A new call is originated as if the user dialed a
feature access code.
The user must have the Last Number Redial service to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/LastNumberRedial
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 247 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 248 OF 521
 3.5.4.40 calls/MessageSummary
This command is used to retrieve the message summary or to reset the message
summary. This service can also be used in a third-party voice messaging system to
indicate the presence or absence of new messages.
 Get message summary
An HTTP GET request retrieves the message summary. The user must have the
Voice Messaging service or the Third-Party Voice Mail Support service to use the
GET method.
 Clear message summary
An HTTP DELETE request clears the message summary. The user must have the
Voice Messaging service or the Third-Party Voice Mail Support service to use the
DELETE method.
 Indicate presence or absence of new messages (Third-Party Voice Messaging)
An HTTP PUT request sets the number of new messages to either “0” or “1”. All other
elements of the message summary are cleared. This command is typically used by a
third-party voice messaging system to control the message waiting indicator of the
user’s devices. The new message indicator is included in a parameter and any
message body included in the request is ignored. The user must have the Third-Party
Voice Mail Support service to use the PUT method.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/MessageSummary
Command
Category
Calls

Methods GET, DELETE, PUT

GET
Request No Content
Content
GET <VoiceMailMessageSummary
Response xmlns="http://schema.broadsoft.com/xsi”>
Content <summary>
<newMessages>2</newMessages>
<oldMessages>3</oldMessages>
<newUrgentMessages>2</newUrgentMessages>
<oldUrgentMessages>3</oldUrgentMessages>
</summary>
</VoiceMailMessageSummary>
DELETE
Request No Content
Content
DELETE
Response No Content
Content
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 249 OF 521
 Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

thirdPartyNewMessage True/False M This parameter is mandatory and

applicable only for the PUT method. It can
be used to set the number of new
messages to “0” (false) or “1” (true).
This is only applicable for users that have
the Third-Party Voice Mail Support service.
If Third-Party Voice Mail Support is
enabled, then the number of new
messages for the service is set as
specified and the necessary message
summary notifications are sent.
Using the PUT method with this command
for a user without Third-Party Voice Mail
Support results in an error response to the
request.

3.5.4.41 calls/ParkRetrieve
This command is used to retrieve a parked call. When the request is received, the
Application Server emulates feature access code (FAC) dialing by the user. A new call is
originated as if the user dialed a feature access code.
The user’s group must have the Call Park service to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/ParkRetrieve
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi”>
Content
<callId>localhost13:0</callId>
<externalTrackingId>12</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address where a call is parked.

When not specified, the retrieving user's
primary extension/DN is used as the
address.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 250 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.42 calls/PushToTalk
This command is used to originate Push To Talk call (a Click-To-Dial call) to the specified
address. When the request is received, the Application Server emulates feature access
code (FAC) dialing by the user. A new call is originated as if the user dialed a feature
access code.
The user must have the Push To Talk service to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 251 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/PushToTalk
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the remote party to

call.
When not specified, the user is connected is
to an IVR and prompted for the called party
address.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 252 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.4.43 calls/SilentMonitor (AS Only)

This command is used by a supervisor to silently monitor an agent. When the request is
received, the Application Server emulates feature access code (FAC) dialing by the user.
A new call is originated as if the user dialed a feature access code.
The user must have the Directed Call Pickup with Barge-in and Call Center Monitoring
services to use this command.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/SilentMonitor
Command
Category
Call Management

Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 253 OF 521
 POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

address String O This is the address of the user to monitor.

When not specified, the user is
connected is to an IVR and prompted for
the target user’s address.

location Primary, O Specifies the Click To Dial locations to

BroadWorksA ring.
nywhere, The default value is “All”.
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 254 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

locationAddress String O The locationAddress parameter identifies

a specific BroadWorks Anywhere
directory number, a specific Shared Call
Appearance location, or a specific
BroadWorks Mobility user’s mobile
directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains
a directory number. The directory
number can be in E.164 format or it can
just contain digits. The following are
valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain
for SIP locations or user for MGCP
locations. The following are valid
address of records for the
locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for
the locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified,
then it defaults to all mobile directory
numbers associated with the user.

3.5.4.44 calls/SilentMonitorNext (AS Only)

This command is used by a supervisor to silently monitor the next ACD call to an agent or
the next call to a call center or route point. When the request is received, the Application
Server emulates feature access code (FAC) dialing by the user. A new call is originated
as if the user dialed a feature access code.
The user must have the Directed Call Pickup with Barge-in and Call Center Monitoring
services to use this command. If the target of the request is a call center, then the call
center type must be Premium.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
This functionality is only available for users hosted on an Application Server. An error is
returned when invoked for users hosted on an Execution Server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 255 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/calls/SilentMonitorNext
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Content <callId>localhost13:0</callId>
<externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O This is the address of the user to pick up.

When not specified, the user is connected is
to an IVR and prompted for the target user’s
address.

location Primary, O Specifies the Click To Dial locations to ring.

BroadWorksA The default value is “All”.
nywhere,
SharedCallAp
pearance,
Mobility,
FlexibleSeatin
gGuest, All

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 256 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

locationAddress String O The locationAddress parameter identifies a

specific BroadWorks Anywhere directory
number, a specific Shared Call Appearance
location, or a specific BroadWorks Mobility
user’s mobile directory number.
When the location parameter is set to
“BroadWorksAnywhere”, the
locationAddress is optional and contains a
directory number. The directory number
can be in E.164 format or it can just contain
digits. The following are valid directory
numbers for the locationAddress parameter:
 9725551000
 +19725551000
When the location parameter is set to
“SharedCallAppearance”, the
locationAddress contains a Cisco
BroadWorks address of record. The
address of record can be user@domain for
SIP locations or user for MGCP locations.
The following are valid address of records
for the locationAddress:
 [email protected]
 9725551000
When the location parameter is set to
“Mobility”, the locationAddress is optional
and contains a mobile directory number.
The directory number can be in E.164
format or it can just contain digits. The
following are valid directory numbers for the
locationAddress parameter:
 9725551000
 +19725551000
If the locationAddress is not specified, then
it defaults to all mobile directory numbers
associated with the user.

3.5.5 User Collaborate Commands: /user/<userid>/Collaborate

3.5.5.1 collaborate/room/<roomid> (AS Only)

This command allows the retrieval of the current status for a particular room. It gives
details of the participants that are present in the room. External participants are shown
once their Room Id has been entered. Participants that joined the conference via outdial
are added only after Answer Confirmation.
The delete option removes all participants from the room. It does not remove the room.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/collaborate/room/<roomid>
Command Call Management
Category
Methods GET, DELETE
GET Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 257 OF 521
 GET <?xml version="1.0" encoding="UTF-8"?>
Response <CollaborateRoom xmlns="http://schema.broadsoft.com/xsi">
Content <roomSessionInfo>
<name>My Collaboration</name>
<roomType>MyRoom</roomType>
<roomId>228870</roomId>
<locked/>
<clientSessionInfo>11061971</clientSessionInfo>
</roomSessionInfo>
<roomParticipants>
<roomParticipant>
<callId>callhalf-201:0</callId>
<partyInformation>
<name>John Doe</name>
<address>tel:503</address>
<userId>[email protected]</userId>
<userDN
countryCode="1">tel:+19726971503;ext=503</userDN>
<callType>Group</callType>
</partyInformation>
<owner/>
</roomParticipant>
<roomParticipant>
<callId>callhalf-201:1</callId>
<partyInformation>
<name>Jane Doe</name>
<address>tel:500</address>
<userId>[email protected]</userId>
<userDN
countryCode="1">tel:+19726971500;ext=500</userDN>
<callType>Group</callType>
</partyInformation>
<muted/>
</roomParticipant>
<roomParticipant>
<callId>callhalf-201:2</callId>
<partyInformation>
<name>Anthony Brown</name>
<address>tel:504</address>
<userId>[email protected]</userId>
<userDN
countryCode="1">tel:+19726971504;ext=504</userDN>
<callType>Group</callType>
</partyInformation>
<activeTalker/>
</roomParticipant>
</roomParticipants>
</CollaborateRoom>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 258 OF 521
 3.5.5.2 collaborate/room/<roomid>/calls/<callid> (AS Only)
This command allows the remote application to remove a participant from a room.
The response code for the request is 200.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/collaborate/room/<roomid>/calls/<
callid>
Command
Call Management
Category
Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.5.3 collaborate/room/<roomid>/outgoingdial (AS Only)

This command is used to originate a call from the room to the specified destination. The
response code for the request is 200.
This request is not authenticated.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/collaborate/room/<roomid>/outgoingdial
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST
Response No Content
Content

3.5.5.4 collaborate/room/<roomid>/lock (AS Only)

This command is used to lock a specified room. Once the room is locked, no participant
can join the conference by dialing into the conference bridge, or with outgoing dial
command. The response code for the request is 200.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
collaborate/room/<roomid>/lock
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 259 OF 521
 PUT
Response No Content
Content

3.5.5.5 collaborate/room/<roomid>/unlock (AS Only)

This command is used to unlock a specified collaborate room that was previously locked.
Once successful, participants can join the conference by dialing in to the bridge, or with
outgoing dial command. The response code for the request is 200.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
collaborate/room/<roomid>/unlock
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.5.6 collaborate/room/<roomid>/calls/<callid>/mute (AS Only)

This command mutes a particular participant in the room. When muted, no audio stream
is transmitted from the muted participant associated with the call to the other participants.
The video stream of the call (if applicable) is not affected. The response code for the
request is 200.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
collaborate/room/<roomid>/calls/<callid>/mute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.5.7 collaborate/room/<roomid>/calls/<callid>/unmute (AS Only)

This command makes a request to unmute a participant in a room. When unmuted, the
audio stream can again be transmitted from the conference participant associated with the
call to the other participants. The video stream (if applicable) is not affected. The
response code for the request is 200.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
collaborate/room/<roomid>/calls/<callid>/unmute

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 260 OF 521
 Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.5.8 collaborate/room/<roomid>/ClientSessionInfo (AS Only)

The room owner uses this command to explicitly associate the client session information
with the existing Collaborate conference. The client session information is specified as a
URL parameter and is mandatory for this command. Upon receiving this command, the
Application Server stores the client session information against all call sessions that are
connected to the room prior to the reception of this command. The Application Server
also updates the call session of any new call that is connected to the room conference
focus after the reception of this command. The Application triggers notifications to the
remote end of these call sessions. The notifications are sent over the SIP and/or Xtended
Services Interfaces.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
user/<userid>/collaborate/room/<roomid>/clientsessioninfo
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.6 User Fax Commands: /user/<userid>/fax

When initiating a fax call, the request expects the actual fax file to be attached as
multipart/form-data content. The file must be a TIFF file, with a resolution of 204 x 196
DPI. The maximum allowed file size is configurable with a range of from 1 MB through 30
MB. The default file size is 15 MB.

NOTE: Because the fax file is to be uploaded to the Xtended Services Interface, this action
depends upon the OCIFiles’ web application to have already been deployed on the Xtended
Services Interface.

When retrieving the fax statuses for the user, the response returns all of the user’s non-
expired fax statuses, of which there may be none.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 261 OF 521
 3.5.6.1 fax/ (AS Only)
This command allows the remote application to send (POST) a file to be faxed to a
specified destination or to retrieve (GET) the non-expired statuses of previous fax requests
initiated by the user.
As an HTTP POST request, the fax file to send and the fax destination address are
mandatory.
The response that is returned can contain the UUID that represents this fax request or can
be an error response.
If the fax request succeeds, a new call is placed to the address specified in the command
on behalf of the user. A successful HTTP POST request returns a unique identifier for the
fax call created in the HTTP response. The HTTP response returned is a 200 OK.
As an HTTP GET request, the response returns all of the non-expired statuses of previous
fax requests initiated by the user (of which there may be none) or an error response.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/fax
Command User
Category
Methods POST, GET
POST Request
multipart/form-data content
Content
POST <?xml version="1.0" encoding="UTF-8"?>
Response <FaxEntry xmlns="http://schema.broadsoft.com/xsi">
Content <faxId>bw_297a860808c44cf6a5f03baafa74d7ad</faxId>
</FaxEntry>
GET Request There is no content.
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 262 OF 521
 GET <?xml version="1.0" encoding="UTF-8"?>
Response <FaxStatusEntryList
Content xmlns="http://schema.broadsoft.com/xsi">
<fax>
<faxId>bw_297a860808c44cf6a5f03baafa74d7ad</faxId>
<faxStatus>Transmitting</faxStatus>
<faxFileName>BWFaxDoc.tiff</faxFileName>

<faxDestination>sip:5146977500@domain</faxDestination>
<timestamp>1507735485410</timestamp>
</fax>
<fax>
<faxId>bw_573826bda7e44de695179ce2889492e9</faxId>
<faxStatus>Error - File Transfer Failed</faxStatus>
<faxFileName>1PageDoc.tif</faxFileName>

<faxDestination>sip:5146977500@domain</faxDestination>
<timestamp>1507735486870</timestamp>
</fax>
<fax>
<faxId>bw_1aa12511669341c6a9e787124bd08c7b</faxId>
<faxStatus>Preparing To Transmit</faxStatus>
<faxFileName>5PagesDoc.tif</faxFileName>

<faxDestination>sip:5146977500@domain</faxDestination>
<timestamp>1507735525147</timestamp>
</fax>
<fax>
<faxId>bw_5bb12511669341c6a9e787124bd09aab</faxId>
<faxStatus>File Conversion In Progress</faxStatus>
<faxFileName>10PagesPdf.pdf</faxFileName>

<faxDestination>sip:5146977500@domain</faxDestination>
<timestamp>1507735745147</timestamp>
</fax>
</FaxStatusEntryList>

Parameter Description
Parameter Allowed Optional/ Description
Name Values Mandatory
faxDestination Address M This parameter is only applicable to the
POST command.
The destination phone number for the fax.

3.5.6.2 fax/<faxid> (AS Only)

This command allows the remote application to retrieve (GET) the current status of a
specific fax request indicated by the UUID fax ID.
The response that is returned contains the status of the specified fax request or an error
response.
If the fax request succeeds, the non-expired status of the specified fax request is returned.
However, there may not be any returned. The HTTP response returned is a 200 OK.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/fax/<faxid>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 263 OF 521
 Command
Category
User

Methods GET
GET
Request There is no content.
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <FaxStatusEntryList xmlns="http://schema.broadsoft.com/xsi">
Content
<fax>
<faxId>bw_297a860808c44cf6a5f03baafa74d7ad</faxId>
<faxStatus>Transmitting</faxStatus>
<faxFileName>BWFaxDoc.tiff</faxFileName>
<faxDestination>sip:5146977500@domain</faxDestination>
<timestamp>1507735485410</timestamp>
</fax>
</FaxStatusEntryList>

3.5.7 User Directories Commands: /user/<userid>/directories

3.5.7.1 directories/Agents (AS Only)

This command is used by a call center supervisor user to retrieve the list of call center
agents being supervised.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Agents
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallCenterAgents
Content xmlns="http://schema.broadsoft.com/xsi”>
<callCenter>
<serviceUserID>[email protected]</serviceUserID>
<agentList>
<userDetails>
<userId>[email protected]</userId>
<firstName>Subhash</firstName>
<lastName>Negi</lastName>
<hiranganaLastName>Negi</hiranganaLastName>
<hiranganaFirstName>Subhash</hiranganaFirstName>
<number>+15146987606</number>
<extension>7606</extension>
<additionalDetails>
<locationDialingCode>005</locationDialingCode>
</additionalDetails>
</userDetails>
</agentList>
</callCenter>
</CallCenterAgents>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 264 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

callcenter String O This can be specified to return the list of

agents that belong to a specific call center.

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

number String O Search criteria for a user’s number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

Extension String O Search criteria for a user’s extension. This

parameter should not contain the location
code.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaMode True, False O The search criteria parameters can be

Or logically combined with an AND operation
or an OR operation.
 If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the results.
The default value is “false”.

3.5.7.2 directories/BroadWorksAnywherePortal
This command is used to retrieve the BroadWorks Anywhere Portal numbers for a user.
These are the numbers that can be used to initiate a Cisco BroadWorks call from a mobile
phone using BroadWorks Anywhere.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/BroadWorksAnywherePo
rtal
Command
Category
Directories

Methods GET

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 265 OF 521
 GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <BroadWorksAnywherePortal
Content xmlns="http://schema.broadsoft.com/xsi">
<phoneNumbers>
<phoneNumber>2003004001</phoneNumber>
<phoneNumber>2003004002</phoneNumber>
</phoneNumbers>
</BroadWorksAnywherePortal>

3.5.7.3 directories/CallCenters (AS Only)

This command is used to retrieve the list of call centers that a user is associated with as
an agent or as a supervisor.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallCenters
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallCenters xmlns="http://schema.broadsoft.com/xsi">
Content <callCenter>
<serviceUserID>[email protected]</serviceUserID>
<numberCallsInQueue>4</numberCallsInQueue>
</callCenter>
<callCenter>
<serviceUserID>[email protected]</serviceUserID>
<numberCallsInQueue>2</numberCallsInQueue>
</callCenter>
</CallCenters>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

user Agent, M Determines the type of relationship to look

Supervisor up.
 When set to “Agent”, the command returns
the list of call centers where the user is an
agent.
 When set to “Supervisor”, the command
returns the list of call centers where the
user is a supervisor.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 266 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

onlyLastStaffing True, False O This parameter is only applicable when the

user is set to “Agent”.
When this parameter is set to “true”, then
the response includes a list of call centers
for which the user is the last staffing agent
and includes the number of calls remaining
in those queues.
The default value is “False”.

3.5.7.4 directories/CallLogs
This command is used to retrieve (GET method) or delete (DELETE method) all call logs.
The user must have the Basic Call Logs service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CallLogs xmlns="http://schema.broadsoft.com/xsi”>
Content <placed>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:39:39.811+05:30</time>
<callLogId>47:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:38:41.101+05:30</time>
<callLogId>48:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7004</phoneNumber>
<name>Subhash Negi</name>
<time>2010-03-26T15:38:33.844+05:30</time>
<callLogId>49:0</callLogId>
</callLogsEntry>
</placed>
<received />
<missed>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-24T11:45:46.138+05:30</time>
<callLogId>55:0</callLogId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 267 OF 521
 </callLogsEntry>
</missed>
</CallLogs>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.4.1 directories/CallLogs/Missed
This service is a subset of Call Logs service for missed call logs.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Missed
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <missed>
Content
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:39:39.811+05:30</time>
<callLogId>47:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:38:41.101+05:30</time>
<callLogId>46:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7004</phoneNumber>
<name>Subhash Negi</name>
<time>2010-03-26T15:38:33.844+05:30</time>
<callLogId>45:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007003</phoneNumber>
<name>Subhash negi003</name>
<time>2010-03-26T15:24:08.564+05:30</time>
<callLogId>44:0</callLogId>
</callLogsEntry>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 268 OF 521
 </missed>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.4.1.1 directories/CallLogs/Missed/<callLogId>
This service allows the deletion of a specific missed call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Missed/<cal
lLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.4.2 directories/CallLogs/Placed
This service is a subset of Call Logs service for placed call logs.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Placed
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 269 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <placed>
Content <callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:39:39.811+05:30</time>
<callLogId>47:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:38:41.101+05:30</time>
<callLogId>46:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>7004</phoneNumber>
<name>Subhash Negi</name>
<time>2010-03-26T15:38:33.844+05:30</time>
<callLogId>45:0</callLogId>
</callLogsEntry>
<callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007003</phoneNumber>
<name>Subhash negi003</name>
<time>2010-03-26T15:24:08.564+05:30</time>
<callLogId>44:0</callLogId>
</callLogsEntry>
</placed>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.4.2.1 directories/CallLogs/Placed/<callLogId>
This service allows the deletion of a specific placed call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Placed/<cal
lLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 270 OF 521
 3.5.7.4.3 directories/CallLogs/Received
This service is a subset of Call Logs service for received call log.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Received
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <received>
Content <callLogsEntry>
<countryCode>1</countryCode>
<phoneNumber>5006007002</phoneNumber>
<name>Subhash negi002</name>
<time>2010-03-26T15:39:39.811+05:30</time>
<callLogId>47:0</callLogId>
</callLogsEntry>
</received>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.4.3.1 directories/CallLogs/Received/<callLogId>
This service allows the deletion of a specific received call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CallLogs/Received/<c
allLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.5 directories/CustomContact
This command is used to get the list of directory names.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CustomContact

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 271 OF 521
 Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <CustomContact xmlns="http://schema.broadsoft.com/xsi”>
Content <directory>
<name>customDir1</name>
</directory>
<directory>
<name>customDir2</name>
</directory>
</CustomContact>

3.5.7.5.1 directories/CustomContact/<directoryName>
This command is used to retrieve the contact details for a particular custom contact
directory.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/CustomContact/<direc
toryName>
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="windows-1251"?>
Response <Directory xmlns="http://schema.broadsoft.com/xsi">
Content <startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2</totalAvailableRecords>
<contacts>
<userId>[email protected]</userId>
<firstName>john3</firstName>
<lastName>north</lastName>
<department>Engineering</department>
<number>5146987503</number>
<extension>875-503</extension>
<name>north,john3</name>
</contact>
<contact>
<userId>[email protected]</userId>
<firstName>john8</firstName>
<lastName>south</lastName>
<department>Marketing</department>
<number>5146987608</number>
<extension>608</extension>
<name>south,john8</name>
<mobile>123-456-7890</mobile>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 272 OF 521
 <emailAddress>[email protected]</emailAddress>
</contact>
</contacts>
</Directory>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

number String O Search criteria for a user’s number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

Extension String O Search criteria for a user’s extension.

Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

mobile String O Search criteria for a user’s mobile.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

department String O Search criteria for a user’s department.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaMode True, False O The search criteria parameters can be

Or logically combined with an AND operation
or an OR operation.
If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
If the searchCriteriaModeOr is set to “false”,
only results that match all the search criteria
are included in the results.
The default value is “False”.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 273 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

sortColumn lastName, O Sort criteria for sorting returned result. If

firstName, not specified, defaults to “lastName”.
department The “/I” can also be added to the end of the
Sort column. If it exists, it acts as a flag
specifying that a case-insensitive sort
should be performed.
The “/desc” can also be added to the end of
the Sort column. If it exists, it acts as a flag
specifying that the sort should be
descending instead of ascending.

start Positive O This is the starting result position to return.

Integer The default value is “1”.
Value of “0” is
not allowed.

results Positive O This is the number of results to return per

integer in the page.
range from 1 The default and maximum value for this
through 1000. parameter is configured as a system option
Value of “0” is on Cisco BroadWorks.
not allowed. If the parameter is not included, then the
configured value is used as default.
If the parameter is included but exceeds the
configured value, then the configured value
is used and supersedes the parameter
value.

3.5.7.6 directories/EnhancedCallLogs
This command is used to retrieve (GET method) or delete (DELETE method) all call logs.
The user must have the Enhanced Call Logs service to use this command.
This command supports paging. For more information about URL parameters and
message body elements related to paging, see section 3.5.18 Paging Responses.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <EnhancedCallLogs xmlns="http//schema.broadsoft.com/xsi">
Content <startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
<placed>
<enhancedCallLogsExtendedEntry>
<countryCode>1</countryCode>
<callLogId>12345</callLogId>
<callId>337</callId>
<subscriberType>User</subscriberType>
<dialedNumber>1004</dialedNumber>
<calledNumber>1004</calledNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 274 OF 521
 <callingAssertedNumber>12131001003
</callingAssertedNumber>
<callingPresentationNumber>1003
</callingPresentationNumber>
<callingPresentationNumberSource>User
</callingPresentationNumberSource>
<callingPresentationName>Charlie
</callingPresentationName>
<callingPresentationIndicator>Public
</callingPresentationIndicator>
<calledGroupId>CC</calledGroupId>
<connectedNumber>1004</connectedNumber>
<connectedPresentationIndicator>Public
</connectedPresentationIndicator>
<typeOfNetwork>Private</typeOfNetwork>
<callCategory>Local</callCategory>
<basicCallType>Group</basicCallType>
<time>2001-12-31T12:00:00</time>
<startTime>5678901234</startTime>
<answerTime>5678901250</answerTime>
<releaseTime>5678901400</releaseTime>
<detachedTime>5678901300</detachedTime>
<serviceInvocationDisposition>Voice Mail Transfer
</serviceInvocationDisposition>
<serviceInvocationDialedNumber>1050
</serviceInvocationDialedNumber>
<serviceInvocationCalledNumber>1050
</serviceInvocationCalledNumber>
<serviceInvocationBasicCallType>User
</serviceInvocationBasicCallType>
<serviceInvocationCalledDirectoryName>Voice
Portal
</serviceInvocationCalledDirectoryName>
<serviceInvocationCalledGroupId>CC
</serviceInvocationCalledGroupId>
<callAuthorizationCode>111222333
</callAuthorizationCode>
<directRouteNumber>12131001003</directRouteNumber>
<routeListNumber>2131001025</routeListNumber>
</enhancedCallLogsExtendedEntry>
</placed>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
Enhanced call logs can be filtered by specifying various optional query parameters.
Parameters applicable for the GET method are categorized in different groups.
 Paging query parameters (see section 3.5.18 Paging Responses)
 Date range query parameters
 Number and call type query parameters
 Service invocation query parameters
 Account authorization code query parameters

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 275 OF 521
  Call authorization code query parameters
Date Range Query Parameters
Date range query parameters can be applied to retrieve enhanced call logs from a certain
time interval. The URI method can (optionally) include both or any of these parameters
from this group. If none of these is specified, the call logs are filtered with the endTime as
the current time and the startTime as the beginning of the previous month. The endTime
should always be greater than the startTime. If the query parameters contain invalid
values, then an error response is returned. If the Call Detail Server solution is being used,
these query parameters have no effect and are ignored to provide the existing
functionality.
It should be noted that only enhanced call log entries with the start time within the
specified date range are selected and these date range values are inclusive in the
selection.
The following table describes the parameters applicable in this group.
Parameter Allowed Values Optional / Description
Name Mandatory

startTime String in Date O The filter for the start time specifies the start
Time format as time of the data range. When this filter is
per xs:dateTime used, all call log entries that have the
specification startTime value after or at the specified value
are returned.
Note that this parameter can be associated
with only one value and therefore, it cannot
be repeated. If it is assigned more than one
value, only the first assigned value is used,
and others are ignored.
If this parameter is not present, then the
default value is calculated as of the
beginning of previous month.
The startTime can be specified in
xs:dateTime in the following form:
 “YYYY-MM-DDThh:mm:ss”, where:
 YYYY indicates the year
 MM indicates the month
 DD indicates the day
 T indicates the start of the required time
section
 hh indicates the hour
 mm indicates the minute
 ss indicates the second
The startTime in UTC time can be specified
by adding “Z” behind the time or it can be
specified in other time zones by providing an
offset from UTC time.
For example, 2011-06-15T12:00:00-05:00
represents noon on June 15, 2011, Central
Daylight Savings Time, which is same as
2011-06-15T17:00:00Z, when specified in
UTC time.
For information on xs:dateTime, see the
W3C Recommendation 28, XML Schema
Part 2: Datatypes Second Edition [5].

endTime String in Date O The filter for the release time specifies the
Time format as end time of the date range. When this filter is
per xs:dateTime used, all call log entries that have the end
specification.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 276 OF 521
 Parameter Allowed Values Optional / Description
Name Mandatory
The format for time before or at the specified end time are
endTime is same returned.
as startTime. Note that this parameter can be associated
with only one value and therefore, it cannot
be repeated. If it is assigned more than one
value, only the first assigned value is used;
others are ignored.
If this parameter is not present, then the
default value is calculated as current time.

Number and Call Type Query Parameters

The URI method can only have one query parameter from this group. If two or more
different query parameters from this group are present, then only the first valid query
parameter is selected and others are ignored as if they are not present. The first valid
query parameter is determined by looking for the occurrence of query parameters in the
same order as described in the following table.
The query parameters in this group can be associated with multiple values. For
information on how to include different values for the same parameter in the query string,
see section 3.3 Message Encoding.
The following table describes the parameters that are applicable in this filter group.
Parameter Allowed Values Optional / Description
Name Mandatory

basicCallType Group O This is the filter for basic call types.

Enterprise This query parameter can be associated with
Network multiple values. When multiple values are
specified, call log entries that match any one
NetworkURL of the specified values are returned.
Repair Multiple values are combined using a logical
Emergency OR operation.
Internal For Missed or Received call logs, the allowed
values are “Group”, “Enterprise”, and
“Network”.

callCategory Local O This is the filter for call categories.

National This query parameter can be associated with
Interlata multiple values. When multiple values are
specified, call log entries that match any one
International of the specified values are returned.
Private Multiple values are combined using a logical
Emergency OR operation.
Other

configurableC Values that are O This is the filter for configurable call types.
allType provisioned in This query parameter can be associated with
the Application multiple values. When multiple values are
Server specified, call log entries that match any one
of the specified values are returned.
Multiple values are combined using a logical
OR operation.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 277 OF 521
 Parameter Allowed Values Optional / Description
Name Mandatory

dialedNumber String containing O This is the filter for dialed numbers.

digits or URI This query parameter can be associated with
multiple values to represent different criteria
sets. When this filter option is used, Placed
call log entries that match all of the specified
values are selected.
Multiple values are combined using a logical
AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in 3.5.17 Wild Card and Flag
Usage in Search Criterion.

calledNumber String containing O This is the filter for called numbers.

digits or URI This query parameter can be associated with
multiple values to represent different criteria
sets. When this filter option is used, Placed
call log entries that match all of the specified
values are selected.
Multiple values are combined using a logical
AND operation.
Values for this parameter can contain wild
card character search criteria as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

networkTransl String containing O This is the filter for network translated

atedAddress digits or URI number or address.
This query parameter can be associated with
multiple values to represent different criteria
sets. When this filter option is used, Placed
call log entries that match all of the specified
values are selected.
Multiple values are combined using a logical
AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in section 3.5.17 Wild Card and
Flag Usage in Search Criterion.

callingPresent String containing O This is the filter for calling presentation

ationNumber digits or URI number.
This query parameter can be associated with
multiple values to represent different criteria
sets. When this filter option is used,
Received or Missed call log entries that
match all of the specified values are
selected.
Multiple values are combined using a logical
AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in section 3.5.17 Wild Card and
Flag Usage in Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 278 OF 521
 Service Invocation Query Parameters
The following table describes the parameters that are applicable in this category. The URI
method can have only one parameter from this group. If more than one query parameter
from this group is present, only the first valid query parameter is selected and others are
ignored as if they are not present. The first valid query parameter is determined by looking
for the occurrence of query parameters in the same order as described in the table.
The query parameters in this group can be associated with multiple values. For
information on how to include different values for the same parameter in the query string,
see section 3.3 Message Encoding.
Parameter Name Allowed Values Optional / Description
Mandatory

serviceInvocationDi ANY, NONE O This is the filter for calls that have
sposition For a list of all other service invocation disposition codes.
allowed values, see This query parameter can be
the definition of the associated with multiple values.
type If the value is “ANY”, call log entries
ServiceInvocationDi that have any service invocation
sposition in the codes are selected.
XML schema for
Xsi. If the value is “NONE”, call log entries
that have no service invocation codes
are selected.
Even though this query parameter
can have multiple values, the
following filter criteria are applied in
the following order.
 NONE: If present, any other values
are ignored.
 ANY: If present, any other values
are ignored.
If the value is not “ANY” or “NONE”,
call log entries that match any one of
the specified values are selected.
If the values contain both “NONE”
and “ANY”, then “NONE” is
considered as the value of this filter.
Multiple values are combined using a
logical OR operation.

serviceInvocationB Group O This is the filter for service invocation

asicCallType Enterprise basic call types.
Network This query parameter can be
associated with multiple values.
NetworkURL When multiple values are specified,
Repair call log entries that match any one of
Emergency the specified values are returned.
Internal Multiple values are combined using a
logical OR operation.

serviceInvocationC Local O This is the filter for service invocation

allCategory National call categories.
Interlata This query parameter can be
associated with multiple values.
International When multiple values are specified,
Private call log entries that match any one of
Emergency the specified values are returned.
Other Multiple values are combined using a
logical OR operation.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 279 OF 521
 Parameter Name Allowed Values Optional / Description
Mandatory

serviceInvocationC Values provisioned O This filter is for service invocation

onfigurableCallType in the Application configurable call types.
Server This query parameter can be
associated with multiple values.
When this filter option is used, call log
entries that match all of the specified
values are selected.
Values for this parameter can contain
wildcard character search criteria.
Multiple values are combined using a
logical OR operation.

serviceInvocationDi String containing O This is the filter for service invocation

aledNumber digits or URI dialed numbers.
This query parameter can be
associated with multiple values to
represent different criteria sets.
When this filter option is used, call log
entries that match all of the specified
values are selected.
Multiple values are combined using a
logical AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in section 3.5.17 Wild Card
and Flag Usage in Search Criterion.

serviceInvocationN String containing O This is the filter for service invocation

etworkCalledNumb digits or URI called numbers.
er This query parameter can be
associated with multiple values to
represent different criteria sets.
When this filter option is used, call log
entries that match all of the specified
values are selected.
Multiple values are combined using a
logical AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in section 3.5.17 Wild Card
and Flag Usage in Search Criterion.

serviceInvocationN String containing O This is the filter for service invocation

etworkTranslatedAd digits or URI network translated numbers.
dress This query parameter can be
associated with multiple values to
represent different criteria sets.
When this filter option is used, call log
entries that match all of the specified
values are selected.
Multiple values are combined using a
logical AND operation.
Values for this parameter can contain
wildcard character search criteria as
described in section 3.5.17 Wild Card
and Flag Usage in Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 280 OF 521
 Account/Authorization Code Query Parameter
This group has only one query parameter. Account or authorization codes are a
sequence of digits associated with a given user. This query filters the call log entries for
account or authorization codes. Valid values for this parameter are “ANY”, NONE”, or a
string containing digits. The interface rejects a request that has explicit invalid parameter
values.
Parameter Allowed Values Optional / Description
Name Mandatory

accountAuthor ANY, NONE, O This is the filter for account/authorization

izationCode String containing codes.
only digits to This parameter is associated with only one
represent value. If more than one value is present,
specific account others are ignored.
or authorization If the value is “NONE”, then all call log
code entries that do not have an
account/authorization code are selected.
If the value is “ANY”, then all call log entries
that have any authorization code are
selected.
If the value is for a specific account code,
then all call log entries matching the specified
value are selected.
If the values contain both “NONE” and
“ANY”, then “NONE” is considered as the
value of this filter.

Call Authorization Code Filter Group

This group has only one query parameter. Call authorization codes are a sequence of
digits associated with a call. This query filters the call log entries for call authorization
codes. Valid values for this parameter are “ANY”, NONE”, or a string containing digits.
The interface rejects a request that has explicit invalid parameter values.
Parameter Allowed Values Optional / Description
Name Mandatory

callAuthorizati ANY, NONE, or O This parameter is a filter that selects call logs
onCode an authorization based on a call authorization code.
code.  If more than one value is present, only the
An authorization first is used.
code is a string  If the value is “NONE”, then all call log
of 2 through 14 entries that do not have an authorization
digits. code are selected.
 If the value is “ANY”, then all call log entries
that have an authorization code are
selected.
If the value is a specific authorization code,
then all call log entries that match this code
are selected.

Examples of URIs with different query parameters

Example 1:
The following URI command selects all enhanced call log entries between June 1, 2011
and June 15, 2011.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 281 OF 521
 http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs?start=1&results=5
0& startTime=2011-06-01&endTime=2011-06-15

Example 2:
The following URI command selects the enhanced call log entries between June 1, 2011
and June 15, 2011, with the basic call type as group or enterprise, and with the service
invocation disposition as Call Forward No Answer or Voice Mail Transfer.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs?start=1&results=5
0&startTime=2011-06-01&endTime=2011-06-
15&basicCallType=Group&basicCallType=Enterprise&serviceInvocationDisposit
ion=Call+Forward+No+Answer&serviceInvocationDisposition=Voice+Mail+
Transfer

Example 3:
The following URI command selects the enhanced call log entries between June 1, 2011
and June 15, 2011 that have any accountAuthorization code.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs?start=1&results=5
0&startTime=2011-06-01&endTime=2011-06-15&accountAuthorizationCode=ANY

Example 4:
The following URI command selects the enhanced call log entries between June 1, 2012
and June 15, 2012 that have an authorization code of 111222333.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs?start=1&results=5
0&startTime=2012-06-01&endTime=2012-06-15&callAuthorizationCode=111222333

3.5.7.6.1 directories/EnhancedCallLogs/Missed
This service is a subset of Enhanced Call Logs service for missed call logs.
When a call is redirected due to the Personal Assistant transfer, a missed call log is
generated for the user and the service invocation disposition is set as “Personal Assistant
Transfer”.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Mis
sed
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <EnhancedCallLogs xmlns:"http//schema.broadsoft.com/xsi">
Content <startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
<missed>
<startIndex>1</startIndex>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 282 OF 521
 <numberOfRecords>1</numberOfRecords>
<enhancedCallLogsExtendedEntry>
<countryCode>1</countryCode>
<callLogId>23456</callLogId>
<callId>195</callId>
<subscriberType>User</subscriberType>
<callingAssertedNumber>13015550005
</callingAssertedNumber>
<callingPresentationNumber>[email protected]
</callingPresentationNumber>
<callingPresentationName>Cisco-Ata
</callingPresentationName>
<callingPresentationIndicator>Public
</callingPresentationIndicator>
<connectedNumber>12131001003</connectedNumber>
<connectedNumberSource>User</connectedNumberSource>
<connectedName>Charlie</connectedName>
<connectedPresentationIndicator>Public
</connectedPresentationIndicator>
<typeOfNetwork>Private</typeOfNetwork>
<basicCallType>Network</basicCallType>
<time>2001-12-31T12:00:00</time>
<startTime>5678901234</startTime>
<releaseTime>5678901400</releaseTime>
<detachedTime>5678901234</detachedTime>
<detachedAnswerTime>5678901300</detachedAnswerTime>
<serviceInvocationDisposition>Call Forward Always
</serviceInvocationDisposition>
<serviceInvocationDialedNumber>1045
</serviceInvocationDialedNumber>
<serviceInvocationCalledNumber>1045
</serviceInvocationCalledNumber>
<serviceInvocationBasicCallType>Group
</serviceInvocationBasicCallType>
<serviceInvocationCalledDirectoryName>gstream
</serviceInvocationCalledDirectoryName>
<serviceInvocationCalledGroupId>CC
</serviceInvocationCalledGroupId>
<directRouteNumber>12131001003</directRouteNumber>
<routeListNumber>2131001025</routeListNumber>
</enhancedCallLogsExtendedEntry>
</missed>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
The parameters described in section 3.5.7.6 directories/EnhancedCallLogs are applicable
to this method as well.
Example of URIs with different query parameters
Examples for URI method directories/EnhancedCallLogs/Received are applicable to this
method as well.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 283 OF 521
 3.5.7.6.1.1 directories/EnhancedCallLogs/Missed/<callLogId>
This service allows the deletion of a specific missed call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Mis
sed/<callLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.6.2 directories/EnhancedCallLogs/Placed
This service is a subset of EnhancedCallLogs service for placed call logs.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Pla
ced
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <EnhancedCallLogs xmlns:"http//schema.broadsoft.com/xsi">
Content <startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
<placed>
<startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
<enhancedCallLogsExtendedEntry>
<countryCode>1</countryCode>
<callLogId>12345</callLogId>
<callId>337</callId>
<subscriberType>User</subscriberType>
<dialedNumber>1004</dialedNumber>
<calledNumber>1004</calledNumber>
<callingAssertedNumber>12131001003
</callingAssertedNumber>
<callingPresentationNumber>1003
</callingPresentationNumber>
<callingPresentationNumberSource>User
</callingPresentationNumberSource>
<callingPresentationName>Charlie
</callingPresentationName>
<callingPresentationIndicator>Public
</callingPresentationIndicator>
<calledGroupId>CC</calledGroupId>
<connectedNumber>1004</connectedNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 284 OF 521
 <connectedPresentationIndicator>Public
</connectedPresentationIndicator>
<typeOfNetwork>Private</typeOfNetwork>
<callCategory>Local</callCategory>
<basicCallType>Group</basicCallType>
<time>2001-12-31T12:00:00</time>
<startTime>5678901234</startTime>
<answerTime>5678901250</answerTime>
<releaseTime>5678901400</releaseTime>
<detachedTime>5678901300</detachedTime>
<serviceInvocationDisposition>Voice Mail Transfer
</serviceInvocationDisposition>
<serviceInvocationDialedNumber>1050
</serviceInvocationDialedNumber>
<serviceInvocationCalledNumber>1050
</serviceInvocationCalledNumber>
<serviceInvocationBasicCallType>User
</serviceInvocationBasicCallType>
<serviceInvocationCalledDirectoryName>Voice
Portal
</serviceInvocationCalledDirectoryName>
<serviceInvocationCalledGroupId>CC
</serviceInvocationCalledGroupId>
<directRouteNumber>12131001003</directRouteNumber>
<routeListNumber>2131001025</routeListNumber>
</enhancedCallLogsExtendedEntry>
</placed>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
The parameters described in section 3.5.7.6 directories/EnhancedCallLogs are applicable
to this method as well. The only exception is that callingPresentationNumber the query
parameter mentioned in the number and call type parameters group is not applicable for
this method.
Example of URIs with different query parameters
Example 1:
The following URI command selects all placed enhanced call log entries between June 1,
2011 and June 15, 2011, where the dialed numbers start with 972 and contain 354.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed?start=1&re
sults=50&startTime=2011-06-01&endTime=2011-06-
15&dialedNumber=972*&dialedNumber=*354*

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 285 OF 521
 Example 2:
The following URI command selects all placed enhanced call log entries between June 1,
2011 and June 15, 2011, where the call category is International or National, that is, all
long distance and international calls placed by the user.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed?start=1&re
sults=50&startTime=2011-06-01&endTime=2011-06-
15&callCategory=National&callcategory=International

Example 3:
The following URL command selects all placed enhanced call log entries between June 1,
2011 and June 15, 2011, where the basic call type is group and the service invocation
disposition is Voice Mail Transfer.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Placed?start=1&re
sults=50&startTime=2011-06-01&endTime=2011-06-
15&basicCallType=Group&serviceInvocationDisposition=Voice+Mail+Transfer

3.5.7.6.2.1 directories/EnhancedCallLogs/Placed/<callLogId>
This service allows the deletion of a specific missed call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Pla
ced/<callLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.6.3 directories/EnhancedCallLogs/Received
This service is a subset of EnhancedCallLogs service for received call logs.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Rec
eived
Command
Category
Directories

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <EnhancedCallLogs xmlns:"http//schema.broadsoft.com/xsi">
Content <startIndex>1</startIndex>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 286 OF 521
 <numberOfRecords>1</numberOfRecords>
<received>
<startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
<enhancedCallLogsExtendedEntry>
<countryCode>1</countryCode>
<callLogId>1234</callLogId>
<callId>341</callId>
<subscriberType>User</subscriberType>
<callingAssertedNumber>13015550005
</callingAssertedNumber>
<callingPresentationIndicator>Public
</callingPresentationIndicator>
<connectedNumber>12131001045</connectedNumber>
<connectedNumberSource>User</connectedNumberSource>
<connectedName>gstream</connectedName>
<connectedPresentationIndicator>Public
</connectedPresentationIndicator>
<basicCallType>Group</basicCallType>
<time>2001-12-31T12:00:00</time>
<startTime>5678901234</startTime>
<answerTime>5678901250</answerTime>
<releaseTime>5678901400</releaseTime>
<redirectingNumber>12131001003</redirectingNumber>
<redirectingName>Charlie</redirectingName>
<redirectingPresentationIndicator>Public
</redirectingPresentationIndicator>
<redirectingReason>Follow-Me</redirectingReason>
<directRouteNumber>12131001003</directRouteNumber>
<routeListNumber>2131001025</routeListNumber>
</enhancedCallLogsExtendedEntry>
</received>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

Parameter Description
The parameters described in section 3.5.7.6 directories/EnhancedCallLogs are applicable
to this method as well. However, some query parameters mentioned in the number and
call type parameter group are not applicable for this method. Following is the list of query
parameters not applicable to this method:
 dialedNumber
 calledNumber
 networkTranslatedAddress
Example of URIs with different query parameters
Example 1:
The following URI command selects all received enhanced call log entries between June
1, 2011 and June 15, 2011, where a caller’s number starts with 972 and contains 354.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Received?start=1&
results=50&startTime=2011-06-01&endTime=2011-06-
15&callingPresentationNumber=972*&callingPresentationNumber=*354*

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 287 OF 521
 Example 2:
The following URI command selects all placed enhanced call log entries between June 1,
2011 and June 15, 2011, where calls are forwarded to different destinations as a result of
the Do Not Disturb service invocation code.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Received?start=1&
results=50&startTime=2011-06-01&endTime=2011-06-
15&serviceInvocationCode=Do+Not+Disturb

Example 3:
The following URL command selects all placed enhanced call log entries between June 1,
2011 and June 15, 2011, where incoming group calls are forwarded to a different number
9723544306.
http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Received?start=1&
results=50&startTime=2011-06-01&endTime=2011-06-
15&basicCallType=Group&serviceInvocationDialedNumber=9723544306

3.5.7.6.3.1 directories/EnhancedCallLogs/Received/<callLogId>
This service allows the deletion of a specific missed call log by specifying its callLogId.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/EnhancedCallLogs/Rec
eived/<callLogId>
Command
Category
Directories

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.7 directories/Enterprise
This service allows the retrieval of a user’s enterprise directory.
This command supports paging. For more information about the URL parameters and
message body elements related to paging, see section 3.5.18 Paging Responses.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Enterprise
Command
Category
Directories

Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 288 OF 521
 GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Enterprise xmlns="http://schema.broadsoft.com/xsi">
Content
<startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2
</totalAvailableRecords>
<enterpriseDirectory>
<directoryDetails>
<userId>[email protected]</userId>
<firstName>agent1</firstName>
<lastName>agent1</lastName>
<hiranganaLastName>agent1
</hiranganaLastName>
<hiranganaFirstName>agent1
</hiranganaFirstName>
<groupId>WebClientGrp1</groupId>
<number>+19008005006</number>
<extension>5006</extension>
<firstNameUnicode>agent1</firstNameUnicode>
<lastNameUnicode>agent1</lastNameUnicode>
<additionalDetails>
<yahooId>[email protected]</yahooId>
</additionalDetails>
</directoryDetails>
<directoryDetails>
<userId>[email protected]</userId>
<firstName>ankur</firstName>
<lastName>ankur</lastName>
<hiranganaLastName>ankur</hiranganaLastName>
<hiranganaFirstName>ankur
</hiranganaFirstName>
<groupId>WebClientGrp1</groupId>
<number>+19008005003</number>
<extension>5003</extension>
<firstNameUnicode>ankur</firstNameUnicode>
<lastNameUnicode>ankur</lastNameUnicode>
<additionalDetails>
<yahooId>[email protected]</yahooId>
<locationDialCode>005</locationDialingCode>
</additionalDetails>
</directoryDetails>
</enterpriseDirectory>
</Enterprise>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 289 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

lastName String O Search criteria for a user’s last name.

Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

name String O Search criteria for a user’s name search on

both first and last name simultaneously.
This search criterion is compared against
multiple combinations of first name and last
name:
 First Name + “ ” + Last Name
 Last Name + “ ” + First Name
 Last Name + “, ” + First Name
 Hiragana Last Name + Hiragana First
Name
Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

userId String O Search criteria for a user’s userId.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

groupId String O Search criteria for a user’s groupId. Wild

cards are not supported for the groupId
parameter.

number String O Search criteria for a user’s number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

extension String O Search criteria for a user’s extension. This

parameter should not contain the location
code.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

yahooId String O Search criteria for a user’s yahooId.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

mobileNo String O Search criteria for a user’s mobile.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

department String O Search criteria for a user’s department.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

emailAddress String O Search criteria for a user’s email address.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 290 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaMode True, False O The search criteria parameters can be

Or logically combined with an AND operation
or an OR operation.
 If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the results.
The default value is “false”.

sortColumn lastName, O Sort criteria for sorting returned result. If

firstName, not specified, defaults to lastName.
department

mpName String O This is the search criterion for a user’s

multipart name search.
The server matches each individual part
against the combination name values
(“FirstName LastName” and
“HiraganaLastName HiraganaFirstName”).
The server applies the AND logical clause
for each part. The default search mode is
“Contains”.
This parameter can occur multiple times in
the URL, one per individual search
parameter requested.
The order in which the individual parts are
provided does not impact the search result.

locationDialingCode String O Search criteria for a location dialing code.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

3.5.7.8 directories/EnterpriseCommon
This service allows the retrieval of a user’s enterprise common phone list for a user.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/enterprisecommon
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="windows-1251"?>
Response <EnterpriseCommon
Content
xmlns="http://schema.broadsoft.com/xsi">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 291 OF 521
 <startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2</totalAvailableRecords>
<commonPhoneEntry>
<name>John</name>
<number>514-333-1234</number>
</commonPhoneEntry>
<commonPhoneEntry>
<name>Jane</name>
<number>514-333-1235</number>
</commonPhoneEntry>
</EnterpriseCommon>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

name String O Search criteria for a directory name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

number String O Search criteria for a directory number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaMode True, False O The search criteria parameters can be

Or logically combined with an AND operation
or an OR operation.
 If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the results.
Default value is “False”.

sortColumn name, number O Sort criteria, if not specified, default to name

ascending and the sort is case-sensitive.
The “/I” can also be added to the end of the
Sort column. If it exists, it acts as a flag
specifying that a case-insensitive sort
should be performed.
The “/desc” can also be added to the end of
the Sort column. If it exists, it acts as a flag
specifying that the sort should be
descending instead of ascending.

start Positive O This is the starting result position to return.

integer. The default value is “1”.
Value of “0” is
not allowed.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 292 OF 521
 Parameter Name Allowed Value Optional / Description
Mandatory

results Positive O This is the number of results to return per

integer in the page.
range from 1 The default and maximum value for this
through 1000. parameter is configured as a system option
Value of “0” is on Cisco BroadWorks.
not allowed. If the parameter is not included, then the
configured value is used as default.
If the parameter is included but exceeds the
configured value, then the configured value
is used and supersedes the parameter
value.

mpName String O This is the search criterion for a user’s

multipart name search.
The server matches each individual part
against the combination name values
(“FirstName LastName” and
“HiraganaLastName HiraganaFirstName”).
The server applies the AND logical clause
for each part. The default search mode is
“Contains”.
This parameter can occur multiple times in
the URL, one per individual search
parameter requested.
The order in which the individual parts are
provided does not impact the search result.

3.5.7.9 directories/FlexibleSeatingHosts (AS Only)

The Flexible Seating Guest service allows the retrieval of the list of available flexible
seating hosts for a user to use with the flexible seating guest configuration.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/FlexibleSeatingHosts
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <AvailableFlexibleSeatingHosts
Response xmlns="http://schema.broadsoft.com/xsi">
Content <hostUserIdList>
<userid>[email protected]</userid>
<userid>[email protected]</userid>
</hostUserIdList>
</AvailableFlexibleSeatingHosts>

3.5.7.10 directories/Group
This service allows the retrieval of a user’s group directory.
This command supports paging. For more information about the URL parameters and
message body elements related to paging, see section 3.5.18 Paging Responses.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 293 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Group
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Group xmlns="http://schema.broadsoft.com/xsi">
Content
<startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2
</totalAvailableRecords>
<groupDirectory>
<directoryDetails>
<userId>[email protected]</userId>
<firstName>Subhash</firstName>
<lastName>Negi</lastName>
<hiranganaLastName>Negi</hiranganaLastName>
<hiranganaFirstName>Subhash
</hiranganaFirstName>
<groupId>WebClientGrp1</groupId>
<number>+19008005010</number>
<extension>5010</extension>
<firstNameUnicode>Subhash</firstNameUnicode>
<lastNameUnicode>Negi</lastNameUnicode>
<additionalDetails>
<yahooId>[email protected]</yahooId>
<emailAddress>[email protected]
</emailAddress>
<zip>201301</zip>
<country>India</country>
</additionalDetails>
</directoryDetails>
<directoryDetails>
<userId>[email protected]</userId>
<firstName>negi002</firstName>
<lastName>negi002</lastName>
<hiranganaLastName>negi002
</hiranganaLastName>
<hiranganaFirstName>negi002
</hiranganaFirstName>
<groupId>WebClientGrp1</groupId>
<number>+19008005009</number>
<extension>5003</extension>
<firstNameUnicode>negi002</firstNameUnicode>
<lastNameUnicode>negi002</lastNameUnicode>
<additionalDetails>
<yahooId>[email protected]</yahooId>
<locationDialingCode>005</locationDialingCode>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 294 OF 521
 </additionalDetails>
</directoryDetails>
</groupDirectory>
</Group>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

firstName String O Search criteria for a user’s first name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

lastName String O Search criteria for a user’s last name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

name String O Search criteria for a user’s name search on

both first and last name simultaneously.
This search criterion is compared against
multiple combinations of first name and last
name:
 First Name + “ ” + Last Name
 Last Name + “ ” + First Name
 Last Name + “, ” + First Name
 Hiragana Last Name + Hiragana First
Name
Wild cards can be used, as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

userId String O Search criteria for a user’s userId.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

groupId String O Search criteria for a user’s groupId. Wild

cards are not supported for the groupId
parameter.

number String O Search criteria for a user’s number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

extension String O Search criteria for a user’s extension. This

parameter should not contain the location
code.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

yahooId String O Search criteria for a user’s yahooId.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 295 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

mobileNo String O Search criteria for a user’s mobile.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

department String O Search criteria for a user’s department.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

emailAddress String O Search criteria for a user’s email address.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

impId String O Search criteria for a user’s instant

messaging and presence ID.
Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaMode True, False O The search criteria parameters can be

Or logically combined with an AND operation
or an OR operation.
 If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the results.
The default value is “False”.

sortColumn lastName, O Sort criteria for sorting returned result. If

firstName, not specified, defaults to “lastName”.
department

mpName String O This is the search criterion for a user’s

multipart name search.
The server matches each individual part
against the combination name values
(“FirstName LastName” and
“HiraganaLastName HiraganaFirstName”).
The server applies the AND logical clause
for each part. The default search mode is
“Contains”.
This parameter can occur multiple times in
the URL, one per individual search
parameter requested.
The order in which the individual parts are
provided does not impact the search result.

3.5.7.11 directories/GroupCommon
This service allows the retrieval of a user’s group common phone list.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/groupcommon
Command
Category
Directories

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 296 OF 521
 Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="windows-1251"?>
Response <GroupCommon
Content
xmlns="http://schema.broadsoft.com/xsi">
<startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2</totalAvailableRecords>
<commonPhoneEntry>
<name>John</name>
<number>514-333-1234</number>
</commonPhoneEntry>
<commonPhoneEntry>
<name>Jane</name>
<number>514-333-1235</number>
</commonPhoneEntry>
</GroupCommon>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

name String O Search criteria for a directory name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

number String O Search criteria for a directory number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage
in Search Criterion.

searchCriteriaModeOr True, False O The search criteria parameters can be

logically combined with an AND
operation or an OR operation.
 If the searchCriteriaModeOr is set to
“true”, then any result that matches any
of the criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the
results.
The default value is “False”.

sortColumn name, O Sort criteria, if not specified, default to

number name ascending and the sort is case-
sensitive.
The “/I” can also be added to the end of
the Sort column. If it exists, it acts as a
flag specifying that a case-insensitive
sort should be performed.
The “/desc” can also be added to the end
of the Sort column. If it exists, it acts as
a flag specifying that the sort should be
descending instead of ascending.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 297 OF 521
 Parameter Name Allowed Optional / Description
Value Mandatory

start Positive O This is the starting result position to

integer. return.
Value of “0” The default value is “1”.
is not
allowed.

results Positive O This is the number of results to return per

integer in the page.
range from 1 The default and maximum value for this
through parameter is configured as a system
1000. option on Cisco BroadWorks.
Value of “0” If the parameter is not included, then the
is not configured value is used as default.
allowed.
If the parameter is included but exceeds
the configured value, then the configured
value is used and supersedes the
parameter value.

mpName String O This is the search criterion for a user’s

multipart name search.
The server matches each individual part
against the combination name values
(“FirstName LastName” and
“HiraganaLastName
HiraganaFirstName”). The server applies
the AND logical clause for each part.
The default search mode is “Contains”.
This parameter can occur multiple times
in the URL, one per individual search
parameter requested.
The order in which the individual parts
are provided does not impact the search
result.

3.5.7.12 directories/HotelingHosts
This service allows the retrieval of the list of available hoteling host stations for a user to
use with the hoteling guest configuration.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/HotelingHosts
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <AvailableHotelingHosts
Response xmlns="http://schema.broadsoft.com/xsi">
Content <hostUserIdList>
<userid>[email protected]</userid>
<userid>[email protected]</userid>
</hostUserIdList>
</AvailableHotelingHosts>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 298 OF 521
 3.5.7.13 directories/Personal
The personal directory request retrieves all the personal contacts of a user, sorted in
alphabetical order by name. The POST method can only be used to add a new personal
contact. Modifying contacts is not currently supported.
This command supports paging. For more information about the URL parameters and
message body elements related to paging, see section 3.5.18 Paging Responses.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Personal
Command
Category
Directories

Methods GET, POST

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <Personal xmlns="http://schema.broadsoft.com/xsi”>
Content
<startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2</totalAvailableRecords>
<entry>
<name>someName<name>
<number>+919900000000<number>
</entry>
<entry>
<name>someOtherName<name>
<number>2400000000<number>
</entry>
</Personal>
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Personal xmlns="http://schema.broadsoft.com/xsi”>
Content
<startIndex>1</startIndex>
<numberOfRecords>2</numberOfRecords>
<totalAvailableRecords>2</totalAvailableRecords>
<entry>
<name>someName<name>
<number>+919900000000<number>
</entry>
<entry>
<name>someOtherName<name>
<number>2400000000<number>
</entry>
</Personal>
POST
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 299 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

name String O Search criteria for a directory name.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

number String O Search criteria for a directory number.

Wild cards can be used as described in
section 3.5.17 Wild Card and Flag Usage in
Search Criterion.

searchCriteriaModeOr True, False O The search criteria parameters can be

logically combined with an AND operation
or an OR operation.
 If the searchCriteriaModeOr is set to “true”,
then any result that matches any of the
criteria is included in the result.
 If the searchCriteriaModeOr is set to
“false”, only results that match all the
search criteria are included in the results.
The default value is “false”.

sortColumn name, number O Sort criteria, if not specified, default to name

ascending and the sort is case-sensitive.
The “/I” can also be added to the end of the
Sort column. If it exists, it acts as a flag
specifying that a case-insensitive sort
should be performed.
The “/desc” can also be added to the end of
the Sort column. If it exists, it acts as a flag
specifying that the sort should be
descending instead of ascending.

mpName String O This is the search criterion for a user’s

multipart name search.
The server matches each individual part
against the combination name values
(“FirstName LastName” and
“HiraganaLastName HiraganaFirstName”).
The server applies the AND logical clause
for each part. The default search mode is
“Contains”.
This parameter can occur multiple times in
the URL, one per individual search
parameter requested.
The order in which the individual parts are
provided does not impact the search result.

3.5.7.13.1 Directories/Personal/<name>
This service allows the deletion of a specific personal directory entry by specifying its
name.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Personal/<name>
Command
Category
Directories

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 300 OF 521
 Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.7.14 directories/Supervisors (AS Only)

This service provides a list of a user’s supervisors for route point and all call centers for
which a user is associated.
This command can be executed by an administrator, an agent, or a supervisor for the
agent.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/directories/Supervisors
Command
Category
Directories

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Supervisors xmlns="http://schema.broadsoft.com/xsi”>
Content <callCenters>
<callCenter>
<serviceUserID>[email protected]</serviceUserID>
<supervisorList>
<userDetails>
<userId>[email protected]</userId>
<firstName>Subhash</firstName>
<lastName>Negi</lastName>
<hiranganaLastName>Negi</hiranganaLastName>
<hiranganaFirstName>Subhash</hiranganaFirstName>
<number>5006007004</number>
<extension>5003</extension>
<additionalDetails>
<locationDialingCode>005</locationDialingCode>
</additionalDetails>
</userDetails>
</supervisorList>
</callCenter>
<callCenter>
<serviceUserID>[email protected]</serviceUserID>
<supervisorList />
</callCenter>
</callCenters>
<routePoint>
<supervisorList>
<userDetails>
<userId>[email protected]</userId>
<firstName>Subhash</firstName>
<lastName>Negi</lastName>
<hiranganaLastName>Negi</hiranganaLastName>
<hiranganaFirstName>Subhash</hiranganaFirstName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 301 OF 521
 <number>5006007004</number>
<extension>5003</extension>
<additionalDetails>
<locationDialingCode>005</locationDialingCode>
</additionalDetails>
</userDetails>
</supervisorList>
</routePoint>
</Supervisors>

Parameter Description
Parameter Name Allowed Optional / Description
Value Mandatory

type CallCenter, O Specifies to filter the list based on the type

RoutePoint of supervisor being requested, that is,
whether the supervisors are call center
supervisors or route point supervisors.

callCenterId String O This parameter is only applicable if type is

set to CallCenter.
Used to filter the list of supervisors for a
given call center, specified by the call center
ID.

3.5.8 User Voice Messaging Commands: /user/<userid>/VoiceMessagingMessages

3.5.8.1 VoiceMessagingMessages (AS Only)

This command is used to retrieve a list of detailed information regarding each of the
subscriber’s voice messages.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/VoiceMessagingMessages
Command
Category
Voice Messaging

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <VoiceMessagingMessages
Content xmlns="http://schema.broadsoft.com/xsi">
<messageInfoList>
<messageInfo>
<duration>114530</duration>
<callingPartyInfo>
<address>tel:0002</address>
</callingPartyInfo>
<time>1352533144935</time>
</messageInfo>
<messageInfo>
<duration>110030</duration>
<callingPartyInfo>
<name>Ken Watson</name>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 302 OF 521
 <address>tel:0002</address>
</callingPartyInfo>
<video/>
<time>1359383144935</time>
<messageId>/v2.0/user/jbloggs@broadworks/voicemessagi
ngmessages/e5c3a18b-3508-45e7-9577-e8889e4efffb</messageId>
</messageInfo>
<messageInfo>
<duration>114530</duration>
<callingPartyInfo>
<address>tel:0563</address>
</callingPartyInfo>
<urgent/>
<confidential/>
<time>1359388944935</time>
<messageId>/v2.0/user/jbloggs@broadworks/voicemessagi
ngmessages/e81d6820-9957-4991-9d06-af6c8d280d5e</messageId>
</messageInfo>
<messageInfo>
<duration>210030</duration>
<callingPartyInfo>
<name>Simon Johnson</name>
</callingPartyInfo>
<read/>
<urgent/>
<time>1359322144935</time>
<messageId>/v2.0/user/jbloggs@broadworks/voicemessagi
ngmessages/f3bf896f-a59b-4732-87fa-3e57d3c0efb0</messageId>
</messageInfo>
<messageInfo>
<callingPartyInfo>
<privacy/>
</callingPartyInfo>
<read/>
<fax/>
<time>1359383144935</time>
<faxPageCount>3</faxPageCount>
<messageId>/v2.0/user/jbloggs@broadworks/voicemessagi
ngmessages/55e76141-ae75-450a-80d0-3857095b1989</messageId>
</messageInfo>
</messageInfoList>
</VoiceMessagingMessages>

3.5.8.1.1 VoiceMessagingMessages/MarkAllAsUnread (AS Only)

This command is used to modify (PUT) voice messages for a subscriber, marking all their
messages as “new” that is, not “read” yet.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/VoiceMessagingMessages/MarkAllAs
Unread

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 303 OF 521
 Command
Voice Messaging
Category
Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.8.1.2 VoiceMessagingMessages/MarkAllAsRead (AS Only)

This command is used to modify (PUT) voice messages for a subscriber, marking all their
messages as “read” (that is, not “new”).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/voicemessagingmessages/markAllAs
Read
Command
Voice Messaging
Category
Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.8.1.3 VoiceMessagingMessages/<messageId> (AS Only)

This command is used to retrieve (GET method) the full content of a voice message or to
delete (DELETE method) a voice message.
In the event that a second download request arrives for the same subscriber while another
download is already in progress, an error is returned to the second caller.

NOTE: The voice messaging aging feature is not supported by Xsi-Actions. Fetching messages
marked for deletion through Xsi-Actions will not delete the messages like accessing the
voicemail from a phone would.

Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/VoiceMessagingMessages/<messageI
d>
Command Voice Messaging
Category
Methods GET, DELETE
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 304 OF 521
 GET <?xml version="1.0" encoding="UTF-8"?>
Response <VoiceMessage xmlns="http://schema.broadsoft.com/xsi">
Content <messageInfo>
<duration>110030</duration>
<callingPartyInfo>
<name>Ken Watson</name>
<address>tel:0002</address>
</callingPartyInfo>
<video/>
<time>1363014750766</time>
<messageId>/v2.0/user/jbloggs@broadworks/voicemessaging
messages/e5c3a18b-3508-45e7-9577-e8889e4efffb</messageId>
</messageInfo>
<messageMediaContent>
<description></description>
<mediaType>MOV</mediaType>
<content>
BASE 64 content omitted for reasons of space.
</content>
</messageMediaContent>
</VoiceMessage>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.8.1.3.1 VoiceMessagingMessages/<messageId>/MarkAsUnread (AS Only)

This command is used to modify (PUT) a voice message, marking it as “new” (that is, not
“read” yet).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/VoiceMessagingMessages/<messageI
d>/MarkAsUnread
Command Voice Messaging
Category
Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.8.1.3.2 VoiceMessagingMessages/<messageId>/MarkAsRead (AS Only)

This command is used to modify (PUT) a voice message, marking it as “read” (that is, not
“new”).
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/user/<userid>/VoiceMessagingMessages/<messageI
d>/MarkAsRead
Command Voice Messaging
Category

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 305 OF 521
 Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.9 Call Center Profile Commands: /callcenter/<callcenterid>/profile

3.5.9.1 Profile (AS Only)

This command is used to get the details of a call center instance. This command is used
by agents or supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDProfile xmlns="http://schema.broadsoft.com/xsi">
Content
<serviceInstanceProfile>
<name>g1PremiumCallCenter</name>
<callingLineIdLastName>g1PremiumCC_Last
</callingLineIdLastName>
<callingLineIdFirstName>g1PremiumCC_First
</callingLineIdFirstName>
<hiraganaLastName>Call Center</hiraganaLastName>
<phoneNumber>9728880010</phoneNumber>
<extension>0010</extension>
<language>English</language>
<timeZone>US/Central</timeZone>
<timeZoneDisplayName>(GMT-05:00) US/Central
</timeZoneDisplayName>
</serviceInstanceProfile>
<type>Premium</type>
<routingType>Skill-Based</routingType>
<policy>Regular</policy>
<enableVideo>false</enableVideo>
<queueLength>1</queueLength>
<allowCallerToDialEscapeDigit>true
</allowCallerToDialEscapeDigit>
<escapeDigit>0</escapeDigit>
<resetCallStatisticsUponEntryInQueue>false
</resetCallStatisticsUponEntryInQueue>
<allowAgentLogoff>true</allowAgentLogoff>
<allowCallWaitingForAgents>false

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 306 OF 521
 </allowCallWaitingForAgents>
<allowCallsToAgentsInWrapUp>false
</allowCallsToAgentsInWrapUp>
<overrideAgentWrapUpTime>false
</overrideAgentWrapUpTime>
<forceDeliveryOfCalls>false</forceDeliveryOfCalls>
<enableAutomaticStateChangeForAgents>false
</enableAutomaticStateChangeForAgents>
<agentStateAfterCall>Available</agentStateAfterCall>
<externalPreferredAudioCodec>None
</externalPreferredAudioCodec>
<internalPreferredAudioCodec>None
</internalPreferredAudioCodec>
<playRingingWhenOfferingCall>true
</playRingingWhenOfferingCall>
<externalReporting>true</externalReporting>
<enableThreshold>true</enableThreshold>
</ACDProfile>

3.5.9.2 profile/DispositionCodes (AS Only)

This command is used to retrieve the Call Center call disposition code settings. This is
only applicable for Call Centers of type Premium. This command is used by agents or
supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile/DispositionC
odes
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDCallDispostionCodes
Content xmlns="http://schema.broadsoft.com/xsi">
<enableCallDispositionCodes>
true
</enableCallDispositionCodes>
<includeOrganizationCodes>true</includeOrganizationCodes>
<forceUseOfCallDispositionCodes>
true
</forceUseOfCallDispositionCodes>
<dispositionCodes>
<dispositionCodeDetail isDefault="true">
<code>01</code>
<description>test</description>
<level>Queue</level>
</dispositionCodeDetail>
<dispositionCodeDetail>
<code>02</code>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 307 OF 521
 <description>DispositionCodeTwo</description>
<level>Queue</level>
</dispositionCodeDetail>
</dispositionCodes>
</ACDCallDispostionCodes>

3.5.9.3 profile/Dnis (AS Only)

This command is used to get the list of Dialed Number Identification services (DNISs)
configured for a Call Center. This service is only available for Call Centers of type
Premium. This command is used by agents or supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile/Dnis
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDDNIS xmlns="http://schema.broadsoft.com/xsi">
Content
<dnisDisplaySetting>
<displayDNISNumber>false</displayDNISNumber>
<displayDNISName>false</displayDNISName>
</dnisDisplaySetting>
<dnisPrioritySetting>
<promoteCallsFromPriority1to0>
true
</promoteCallsFromPriority1to0>
<promoteCallsFromPriority1to0Seconds>
900
</promoteCallsFromPriority1to0Seconds>
<promoteCallsFromPriority2to1>
true
</promoteCallsFromPriority2to1>
<promoteCallsFromPriority2to1Seconds>
900
</promoteCallsFromPriority2to1Seconds>
<promoteCallsFromPriority3to2>
true
</promoteCallsFromPriority3to2>
<promoteCallsFromPriority3to2Seconds>
900
</promoteCallsFromPriority3to2Seconds>
</dnisPrioritySetting>
<dnisInfoList>
<dnisInfo>
<name>Premium(Primary)</name>
<priority>0 - Highest</priority>
</dnisInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 308 OF 521
 <dnisInfo>
<name>Secondary</name>
<extension>2345</extension>
<priority>0 - Highest</priority>
</dnisInfo>
</dnisInfoList>
</ACDDNIS>

3.5.9.3.1 profile/Dnis/<dnisName> (AS Only)

This command is used to get a specific Call Center’s DNIS details. This command is used
by agents or supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile/dnis/<dnisNa
me>
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDDNISKey xmlns="http://schema.broadsoft.com/xsi"
Content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<dnisPhoneNumber>5006007000</dnisPhoneNumber>
<extension>2345</extension>
<useCustomCLIDSettings>true</useCustomCLIDSettings>
<callingLineIdLastName>Dey</callingLineIdLastName>
<callingLineIdFirstName>Kanchan</callingLineIdFirstName>
<useCustomDnisAnnouncementSettings>
true
</useCustomDnisAnnouncementSettings>
<priority>2-Medium</priority>
<allowOutgoingACDCall>true</allowOutgoingACDCall>
</ACDDNISKey>

3.5.9.4 profile/policies/ForcedForwarding (AS Only)

This command is used to retrieve or configure the call center’s Forced Forwarding policy.
The service is only applicable for Call Centers of type Premium. This command is used by
agents or supervisors of a target Call Center.
 Retrieve policy’s configuration
An HTTP GET request retrieves the configuration. The authenticated user must be
an authorized administrator, and agent of the Call Center, or a supervisor of the Call
Center.
 Modify policy’s configuration

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 309 OF 521
 An HTTP PUT request modifies the configuration. The authenticated user must be an
authorized administrator or a supervisor of the Call Center. AudioMediaType List and
VideoMediaType List are ignored if sent in a PUT method’s request content.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile/policies/For
cedForwarding
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDForcedForwarding
Content
xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>1251251
</forwardToPhoneNumber>
<allowEnableViaFAC>true</allowEnableViaFAC>
<playAnnouncementBeforeForwarding>true
</playAnnouncementBeforeForwarding>
<audioMessageSelection>File
</audioMessageSelection>
<audioUrlList>
<url1>http://www.example.com/file1.wav</url1>
</audioUrlList>
<audioFileList>
<file1>
<sourceFileName>AACAccept.wav
</sourceFileName>
</file1>
</audioFileList>
<audioMediaTypeList>
<mediaType1>WAV</mediaType1>
</audioMediaTypeList>
<videoMessageSelection>File
</videoMessageSelection>
<videoUrlList>
<url1>http://www.example.com/file1.mov</url1>
</videoUrlList>
<videoFileList>
<file1>
<sourceFileName>H.264
AAdefaultAfterHoursGreeting.mov
</sourceFileName>
</file1>
</videoFileList>
<videoMediaTypeList>
<mediaType1>MOV</mediaType1>
</videoMediaTypeList>
</ACDForcedForwarding>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 310 OF 521
 PUT <?xml version="1.0" encoding="UTF-8"?>
Request <ACDForcedForwarding
Content xmlns="http://schema.broadsoft.com/xsi">
<active>true</active>
<forwardToPhoneNumber>1251251
</forwardToPhoneNumber>
<allowEnableViaFAC>false</allowEnableViaFAC>
<playAnnouncementBeforeForwarding>true
</playAnnouncementBeforeForwarding>
</ACDForcedForwarding>
PUT
Response 200 OK
Content

3.5.9.5 profile/policies/NightService (AS Only)

This command is used to retrieve or configure the Call Center’s Night Service policy.
The service is only applicable for Call Centers of type Premium. This command is used by
agents or supervisors of a target Call Center.
 Retrieve policy’s configuration
An HTTP GET request retrieves the configuration. The authenticated user must be
an authorized administrator, and agent of the Call Center, or a supervisor of the Call
Center.
 Modify policy’s configuration
An HTTP PUT request modifies the configuration. The authenticated user must be an
authorized administrator or a supervisor of the Call Center. AudioMediaType List and
VideoMediaType List are ignored if sent in a PUT method’s request content.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/profile/policies/Nig
htService
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDNightService xmlns="http://schema.broadsoft.com/xsi">
Content
<action>Transfer</action>
<forceNightService>true</forceNightService>
<allowManualOverrideViaFAC>true
</allowManualOverrideViaFAC>
<transferPhoneNumber>11111111
</transferPhoneNumber>
<playAnnouncementBeforeAction>true
</playAnnouncementBeforeAction>
<audioMessageSelection>File
</audioMessageSelection>
<audioFileList>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 311 OF 521
 <file1>
<sourceFileName>AACAccept.wav
</sourceFileName>
</file1>
</audioFileList>
<audioMediaTypeList>
<mediaType1>WAV</mediaType1>
</audioMediaTypeList>
<videoMessageSelection>File
</videoMessageSelection>
<videoFileList>
<file1>
<sourceFileName>H.264
AAdefaultAfterHoursGreeting.mov
</sourceFileName>
</file1>
</videoFileList>
<videoMediaTypeList>
<mediaType1>MOV</mediaType1>
</videoMediaTypeList>
<manualAnnouncementMode>Manual Announcement
</manualAnnouncementMode>
<manualAudioMessageSelection>File
</manualAudioMessageSelection>
<manualAudioFileList>
<file1>
<sourceFileName>AACDeniedByCalled.wav
</sourceFileName>
</file1>
</manualAudioFileList>
<manualAudioMediaTypeList>
<mediaType1>WAV</mediaType1>
</manualAudioMediaTypeList>
<manualVideoMessageSelection>File
</manualVideoMessageSelection>
<manualVideoFileList>
<file1>
<sourceFileName>H.264 RecordVideoPrompt.mov
</sourceFileName>
</file1>
</manualVideoFileList>
<manualVideoMediaTypeList>
<mediaType1>MOV</mediaType1>
</manualVideoMediaTypeList>
</ACDNightService>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <ACDNightService xmlns="http://schema.broadsoft.com/xsi">
Content
<forceNightService>true</forceNightService>
<allowManualOverrideViaFAC>true
</allowManualOverrideViaFAC>
<transferPhoneNumber>2222
</transferPhoneNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 312 OF 521
 <playAnnouncementBeforeAction>true
</playAnnouncementBeforeAction>
</ACDNightService>
PUT
Response 200 OK
Content

3.5.10 Call Center Call Commands: /callcenter/<callcenterid>/calls

3.5.10.1 Calls (AS Only)

This command is used to return the details of all calls currently queued in the ACD queue.
This command is used by agents or supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/calls
Command
Category
Call Management

Methods GET
GET
Request No Content
Content
GET <ACDQueue xmlns="http://schema.broadsoft.com/xsi">
Response <queueEntries>
Content <queueEntry>
<callId> callhalf-199:0</callId>
<extTrackingId>97:1</extTrackingId>
<remoteParty>
<name>Subhash</name>
<userId>[email protected]</userId>
<privacy/>
<callType>Group</callType>
</remoteParty>
<addTime>1274964256057</addTime>
<removeTime>1274964256088</removeTime>
<mandatoryEntrance/>
<bounced/>
<reordered/>
<preservedWaitTime>4</preservedWaitTime>
<acdName> </acdName>
<acdNumber countryCode="0"/>
<acdPriority>0-Highest</acdPriority>
<addTimeInPriorityBucket/>
<preservedWaitTimeInPriorityBucket>6
</preservedWaitTimeInPriorityBucket>
</queueEntry>
</queueEntries>
</ACDQueue>

3.5.10.2 calls/<callId> (AS Only)

This command is used to release a call that is currently queued in the ACD queue. This
command is used by agents or supervisors of a target Call Center.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 313 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/calls/<callid>
Command
Category
Call Management

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response NO Content
Content

3.5.10.3 calls/<callid>/BlindTransfer (AS Only)

This request is used to transfer an existing call to a new destination. This command is
used by agents or supervisors of a target Call Center.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/calls/<callid>/Blind
Transfer
Command
Category
Call Management

Methods PUT
GET
Request NO Content
Content
GET
Response NO Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

phoneno String M Specifies the number to use for call

redirection.

3.5.10.4 calls/<callid>/Promote (AS Only)

This request is used to change the priority of a call queued in an ACD. The call can only
be promoted and not demoted (that is, the ACDPriority value can only be reduced. Cisco
BroadWorks rejects any request to move a call to a lower priority (that is, increase the
ACDPriority value). Only calls that have not been bounced and that are not being played
a mandatory entrance message can be promoted.
The new position is returned in the response.
This is only applicable for Call Centers of type Premium. This command is used by agents
or supervisors of a target Call Center.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 314 OF 521
 Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/calls/<callid>/Promo
te
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <ACDPromote xmlns="http://schema.broadsoft.com/xsi">
Content <priority>1-High</priority>
</ACDPromote>
PUT <QueueCallOrder xmlns="http://schema.broadsoft.com/xsi">
Response <position>0</position>
Content </QueueCallOrder>

3.5.10.5 calls/<callid>/Reorder (AS Only)

This request is used to move the call in an ACD queue to the specified position.
The position specifies the location of a call in an ACD queue. The call at position 0 in the
queue is the next call to be distributed to an agent. A remote application can modify the
position of a call if its priority is set to “0-Highest” if it has not been bounced and if it not
being played a mandatory entrance message. The new position is returned in the
response. This command is used by agents or supervisors of a target Call Center.

NOTE: The new position does not always match the requested position due to the dynamic
nature of the queue.

Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/callcenter/<callcenterid>/calls/<callid>/Reord
er
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT <QueueCallOrder
Response xmlns="http://schema.broadsoft.com/xsi">
Content <position>0</position>
</QueueCallOrder>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

index Number O Specifies the number to use for call

redirection.
The default value is “0”.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 315 OF 521
 3.5.11 Route Point Profile Commands: /routepoint/<routepointid>/profile

3.5.11.1 profile/State (AS Only)

This command is used to retrieve the state of a route point. A route point can be normal or
failed. The state it is in determines the Call Handling policy of that route point. This
command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/profile/State
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointState
Content xmlns="http://schema.broadsoft.com/xsi">Normal
</RoutePointState>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointState
Content xmlns="http://schema.broadsoft.com/xsi">Failed
</RoutePointState>
PUT
Response No Content
Content

3.5.12 Route Point Call Commands: /routepoint/<routepointid>/calls

3.5.12.1 Calls (AS Only)

This command is used to get the list of calls along with their details that are queued in a
route point queue. This command is used by agents or supervisors of a target Route
Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls
Command
Category
Call Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointQueue xmlns="http://schema.broadsoft.com/xsi">
Content <queueEntries>
<queueEntry>
<callId>localhost13:0</callId>
<extTrackingId></extTrackingId>
<remoteParty></remoteParty>
<addTime>1200022</addTime>
<removeTime>15644646</removeTime>
<routePointName>routePointTesting</routePointName>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 316 OF 521
 <routePointNumber>5006007001</routePointNumber>
<playCollectInfo>
<playCollectId>1</playCollectId>
<playCollectType>Treatment</playCollectType>
</playCollectInfo>
<outgoingCall></outgoingCall>
<outgoingCallAnswerTime>232323</outgoingCallAnswerTime>
</queueEntry>
<queueEntry>
<callId>localhost13:0</callId>
<extTrackingId></extTrackingId>
<remoteParty></remoteParty>
<addTime>2323234</addTime>
<removeTime>6767678</removeTime>
<bounced></bounced>
<routePointName>routePointTesting_one</routePointName>
<routePointNumber>5006007003</routePointNumber>
<playCollectInfo>
<playCollectId>1</playCollectId>
<playCollectType>Treatment</playCollectType>
</playCollectInfo>
<outgoingCall></outgoingCall>

<outgoingCallAnswerTime>4545455</outgoingCallAnswerTime>
</queueEntry>
</queueEntries>
</RoutePointQueue>

3.5.12.2 calls/New (AS Only)

This request is used to originate a call from the Route Point to the specified destination.
The destination address and Calling Line ID to use are specified in HTTP message body.
A successful HTTP POST request returns a Location header with the URL of the call ID
for the call created in the HTTP response.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid/calls/new
Command
Category
Call Management

Methods POST
POST <?xml version="1.0" encoding="utf-8"?>
Request <RoutePointOutgoingDial
Content xmlns="http://schema.broadsoft.com/xsi">
<address>5145551212</address>
<xsi:routePointName>routepoint1</xsi:routePointName>
</RoutePointOutgoingDial>
POST <CallStartInfo xmlns="http://schema.broadsoft.com/xsi">
Response <callId>callhalf-488:0</callId>
Content <externalTrackingId>70:1</externalTrackingId>
</CallStartInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 317 OF 521
 3.5.12.3 calls/<callid> (AS Only)
This command is used to release a queued route point call. This command is used by
agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>
Command
Category
Call Management

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.12.4 calls/<callId>/Admit (AS Only)

This command is used to admit a call in to the Route Point queue. This command is used
by a remote application before a call is added to the Route Point queue.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointId>/calls/<callId>/adm
it
Command Call Management
Category
Methods PUT
PUT Request No Context.
Content
PUT
Response No Context.
Content

3.5.12.5 calls/<callid>/Bounce (AS Only)

This command is used to bounce a route point call that was distributed to an agent back to
the route point queue. This command is used by agents or supervisors of a target Route
Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/Bounc
e
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 318 OF 521
 PUT
Response No Content
Content

3.5.12.6 calls/<callid>/BlindTransfer (AS Only)

This command is used to transfer a call in the route point queue to another location.
The target destination can be specified via a URL parameter or using the address element
in a message body. If a target destination is specified as a parameter in the URL, as well
as in the message body, then the parameter value fetched from URL takes precedence.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/Blind
Transfer
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointBlindTransfer
Content xmlns="http://schema.broadsoft.com/xsi">
<address countryCode="1">55001100</address>
</RoutePointBlindTransfer>
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address String O Specifies the number to use for call

redirection.

3.5.12.6.1 calls/<callid>/ConnectToVoiceXml
This command is used to distribute a call in the Route Point queue to a VoiceXML
subscriber for script execution.
The VoiceXML user ID and the script URL are necessary for this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/C
onnectToVoiceXML
Command Call Management
Category
Methods PUT

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 319 OF 521
 PUT Request <xsi:RoutePointConnectToVoiceXML
Content xmlns:xsi="http://schema.broadsoft.com/xsi">

<xsi:voicexmlId>[email protected]</xsi:vo
icexmlId>

<xsi:scriptUrl>https://application.net/script.vxml</xsi
:scriptUrl>
</xsi:RoutePointConnectToVoiceXML>
PUT
Response No content.
Content

Parameter Allowed Optional/ Description

Name Values Mandatory

voicexmlId SubscriberId M The subscriber ID of the VoiceXML to

whom the Route Point call is distributed.

scriptURL String M The URL of the VoiceXML script.

3.5.12.7 calls/<callid>/Distribute (AS Only)

This command is used to distribute a call from a route point queue to a specified agent.
The agent is specified in the message body.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/Distr
ibute
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointDistribute
Content xmlns="http://schema.broadsoft.com/xsi">
<agentId>[email protected]</agentId>
<callingLineIdNumber>5007001002</callingLineIdNumber>
<callingLineIdName>userOne</callingLineIdName>
<timeInQueue>10</timeInQueue>
<numberOfCallsInQueue>5</numberOfCallsInQueue>
<longestWaitTime>5</longestWaitTime>
</RoutePointDistribute>
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 320 OF 521
 3.5.12.8 calls/<callid>/Fail (AS Only)
This command is used to fail a call that is currently in the route point queue. The failed call
is processed per route point configurations for failed calls. This command is used by
agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/Fail
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.12.9 calls/<callid>/PlayBusy (AS Only)

This request is used to play localized busy to a selected call in the route point queue.
The duration of the play busy can be optionally specified. If duration is provided, busy is
played and discontinued when duration expires. If duration is not provided, busy is played
without interruption.
When the request is accepted by Cisco BroadWorks, a play-collect operation is started. A
playCollectId is assigned to the operation and is returned in the response.
A remote application can update duration by sending another request for the same call.
The duration is replaced by the new specified value and the playback timer is reset to
zero. The original playCollectId must be specified in the request with the new duration. If
the request is successfully accepted by Cisco BroadWorks, the same playCollectId is
returned in the response.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/PlayB
usy
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointPlayBusyxmlns="http://schema.broadsoft.com/xsi">
Content <duration>10</duration>
<busyPattern>Normal</busyPattern>
<playCollectId></playCollectId>
</RoutePointPlayBusy>
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointPlayInfoxmlns="http://schema.broadsoft.com/xsi">
Content <playCollectId>1</playCollectId>
<RoutePointPlayInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 321 OF 521
 3.5.12.10 calls/<callid>/PlayMusicOnHold (AS Only)
This request is used to play Music On Hold (MOH) to a selected call in the route point
queue.
The Music On Hold to be played is defined through route point configuration. Digits can
be collected while the Music On Hold is being played if a Media Gateway Control Protocol
(MGCP) digit map is specified in the request. If the Music On Hold is played from an
external source to Cisco BroadWorks (as a configuration option), no digit collection can be
performed.
The duration of the Music On Hold to play can be optionally specified.
 If duration is provided, then the Music On Hold is discontinued when duration expires.
 If duration is not provided, Music On Hold is played without interruption.
When the request is accepted by Cisco BroadWorks, a play-collect operation is started. A
playCollectId is assigned to the operation and is returned in the response.
A remote application can update the duration by sending another request for the same
call. The duration is replaced by the new specified value and the playback timer is reset to
zero. When extending duration, no new MGCP digit map can be specified. The original
playCollectId must be specified in the request with the new duration. If the request is
successfully accepted by Cisco BroadWorks, the same playCollectId is returned in the
response.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/PlayM
usicOnHold
Command
Category
Call Management

Methods PUT
GET <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointPlayMusicOnHold
Content xmlns="http://schema.broadsoft.com/xsi">
<duration>10</duration>
<digitMap></digitMap>
<playCollectId></playCollectId>
</RoutePointPlayMusicOnHold>
GET <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointPlayInfoxmlns="http://schema.broadsoft.com/xsi">
Content <playCollectId>1</playCollectId>
<RoutePointPlayInfo>

3.5.12.11 calls/<callid>/PlayRingback (AS Only)

This request is used to play localized ringback to a selected call in the route point queue.
If an MGCP digit map is specified in the request, digits are collected while the ringback is
being played.
The duration of ringback to play can be optionally specified.
 If the ringback duration is provided, then the ringback is discontinued when the time is
reached.
 If the duration is not provided, the ringback is played without interruption.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 322 OF 521
 When the request is accepted by Cisco BroadWorks, a play-collect operation is started. A
playCollectId is assigned to the operation and is returned in the response.
A remote application can update duration by sending another request for the same call.
The duration is replaced by the new specified value and the playback timer is reset to
zero. When extending duration, no new MGCP digit map can be specified. The original
playCollectId must be specified in the request with the new duration. If the request is
successfully accepted by Cisco BroadWorks, the same playCollectId is returned in the
response.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/PlayR
ingback
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointPlayRingBack
Content xmlns="http://schema.broadsoft.com/xsi">
<duration>10</duration>
<digitMap></digitMap>
<playCollectId></playCollectId>
</RoutePointPlayRingBack>
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointPlayInfoxmlns="http://schema.broadsoft.com/xsi">
Content <playCollectId></playCollectId>
<RoutePointPlayInfo>

3.5.12.12 calls/<callid>/PlaySilence (AS Only)

This request is used to play localized silence to a selected call in the route point queue. If
an MGCP digit map is specified in the request, digits are collected while the silence is
being played.
The duration of silence to play can be optionally specified.
 If duration is provided, then the silence is discontinued when the time is reached.
 If duration is not provided, silence is played without interruption.
When the request is accepted by Cisco BroadWorks, a play-collect operation is started. A
playCollectId is assigned to the operation and is returned in the response.
A remote application can update duration by sending another request for the same call.
The duration is replaced by the new specified value and the playback timer is reset to
zero. When extending duration, no new MGCP digit map can be specified. The original
playCollectId must be specified in the request with the new duration. If the request is
successfully accepted by Cisco BroadWorks, the same playCollectId is returned in the
response.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/PlayS
ilence

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 323 OF 521
 Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointPlaySilence
Content xmlns="http://schema.broadsoft.com/xsi">
<duration>10</duration>
<digitMap></digitMap>
<playCollectId></playCollectId>
</RoutePointPlaySilence>
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointPlayInfoxmlns="http://schema.broadsoft.com/xsi">
Content <playCollectId>1</playCollectId>
<RoutePointPlayInfo>

3.5.12.13 calls/<callid>/PlayTreatment (AS Only)

This command is used to play a treatment to the specified call in the route point’s queue.
The treatment is defined by a series of up to four audio or video URLs to be played
sequentially and can be repeated up to five times.
 For an audio-only call, the treatment is played using the audio URLs, which are played
in sequence.
 For a video call, the treatment is played using the video URLs, which are played in
sequence.
If a digit map is specified in the request, digits can be collected while the treatment is
playing.
This command is used by agents or supervisors of a target Route Point.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointid>/calls/<callid>/PlayT
reatment
Command
Category
Call Management

Methods PUT
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <RoutePointPlayTreatment
Content xmlns="http://schema.broadsoft.com/xsi">
<audioUrlList>
<uri></uri>
<uri></uri>
</audioUrlList>
<numberOfPlay>4</numberOfPlay>
<digitMap></digitMap>
</RoutePointPlayTreatment>
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <RoutePointPlayInfoxmlns="http://schema.broadsoft.com/xsi">
Content <playCollectId>1</playCollectId>
<RoutePointPlayInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 324 OF 521
 3.5.12.14 calls/<callId>/Reject (AS Only)
This command is used to reject a call before the call is placed in the Route Point queue.
This command is used by a remote application to prevent calls from being added to the
Route Point queue.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/routepoint/<routepointId>/calls/<callId>/reject
Command
Category
Call Management

Methods PUT
PUT Request
Content
No content.

PUT
Response No Context.
Content

3.5.13 Meet-Me Conference: /meetmeconference/<bridgeid>/conference

3.5.13.1 conference/<conferenceid> (AS Only)

This command is used to retrieve the details related to a Meet-Me Conference or to
release a Meet-Me Conference.
 Get conference details
An HTTP GET requests the conference details, including the list of all participants.
Participants who joined using outdial are added to the list only after the Answer
Confirmation occurs. Other participants are shown on list after the conference PIN
entered by the participant has been accepted.
 Release conference
An HTTP DELETE releases the conference by dropping all participants from the
conference.
Method Description
URI http(s)://<hostaddress:port>/com.broadsoft.xsi-
actions/v2.0/meetmeconference/<bridgeid>/conference/<confer
enceid>
Command
Category
Call Management

Methods GET, DELETE

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8" ?>
Response <MeetMeConference
Content xmlns="http://schema.broadsoft.com/xsi">
<conferenceInfo>
<lectureMode></lectureMode>
<automaticLectureMode></automaticLectureMode>
<recordingState>Recording</recordingState>
</conferenceInfo >
<conferenceParticipants>
<conferenceParticipant>
<callId>loaclhost1:0</callId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 325 OF 521
 <partyInformation>
<name>Test User</name>
<address>1002</address>
<userId>[email protected]</userId>
<userDN>1002</userDN>
<callType>Group</callType>
</partyInformation>
<activeTalker></activeTalker>
<moderator></moderator>
</conferenceParticipant>
<conferenceParticipant>
<callId>loaclhost10:0</callId>
<partyInformation>
<name>New User</name>
<address>1003</address>
<userId>[email protected]</userId>
<userDN>1003</userDN>
<callType>Group</callType>
</partyInformation>
<uniqueIdentifier>123456789</uniqueIdentifier>
</conferenceParticipant>
</conferenceParticipants>
</conferenceInfo>
</MeetMeConference>
DELETE
Request No Content
Content
DELETE
Response No Content
Content

3.5.13.2 conference/<conferenceid>/outgoingdial (AS Only)

This command is used to originate a call from the conference to the specified destination.
The called party is joined to the conference upon (confirmed) answer.
The conferenceId can be the conferenceId or the moderator PIN. If the moderator PIN is
used, the resulting call leg inherits the moderator’s functions since creation was triggered
using the moderator PIN. Moderator functions are then available to the answering user of
that call leg.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/meetmeconference/<bridgeId>/conference/<confer
enceid>/outgoingdial
Command
Category
Call Management

Methods POST
POST
Request No Content
Content
POST
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 326 OF 521
 Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

address Number M Specifies the number to use for the

outgoing call.

uniqueIdentifier String O Allows a participant to identify themselves

with a code when joined a conference. The
length of this parameter should be within 10
digits.
Valid examples:
 123456789
 001234

3.5.13.3 conference/<conferenceid>/calls/<callid>/mute (AS Only)

This command is used to mute a particular participant on the call. When muted, no audio
stream is transmitted from the muted participant associated with the call to the other
participants. The video stream of the call (if applicable) is not affected.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/calls
/<callid>/mute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.4 conference/<conferenceid>/calls/<callid>/unmute (AS Only)

This command is used to unmute a call participating in a conference. When unmuted, the
audio stream can again be transmitted from the conference participant associated with the
call to the other participants. The video stream (if applicable) is not affected.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/calls
/<callid>/unmute
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 327 OF 521
 3.5.13.5 conference/<conferenceid>/calls/<callid>/hold (AS Only)
This command is used to allow the host to put a participant on hold.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/calls
/<callid>/hold
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.6 conference/<conferenceid>/calls/<callid>/retrieve (AS Only)

This command is used to retrieve a participant that was previously held.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/calls
/<callid>/retrieve
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.7 conference/<conferenceid>/calls/<callid> (AS Only)

This command is used to drop a particular participant from the conference.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>conference/<conferenceid>/calls/
<callid>
Command
Category
Call Management

Methods DELETE
DELETE
Request No Content
Content
DELETE
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 328 OF 521
 3.5.13.8 conference/<conferenceid>/ClientSessionInfo (AS Only)
The moderator uses this command to explicitly associate the client session info with the
existing Meet-Me conference. The client session info is specified as a URL parameter and
is mandatory for this command. Upon receiving this command, the Application Server
stores the client session info against all call sessions that are connected to the Meet-
Me conference focus prior to the reception of this command. The Application Server
also updates the call session of any new call that is connected to the Meet-Me
conference focus after the reception of this command. The Application Server (Meet-
Me conference focus) triggers notifications to the remote end of those call sessions.
Notifications are sent over the SIP and/or Xsi interfaces.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<userid>/conference/<conferenceid>/Clie
ntSessionInfo
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

info String M This is an opaque information provided by

the client for the Application Server to
correlate this information with all the call
sessions connected to the Meet-Me
conference focus. The Application Server
stores this information against all call
sessions and triggers notifications to the
remote end of these call session over the
SIP and/or Xsi interface.

3.5.13.9 conference/<conferenceid>/lock (AS Only)

This command is used lock a conference. Once the conference is locked, no participant
can join the conference by dialing into the conference bridge. The only way to add the
participant is to use the conference/<conferenceid>/outgoingdial service.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/lock
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 329 OF 521
 PUT
Response No Content
Content

3.5.13.10 conference/<conferenceid>/unlock (AS Only)

This command is used can be used to unlock a specified Meet-Me Conference that was
previously locked.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/unloc
k
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.11 conference/<conferenceid>/startrecording (AS Only)

This command is used to start recording for a conference. An error response is returned if
there is an attempt to start recording twice without stopping.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/start
recording
Command
Category
Call Management

Methods PUT
POST
Request No Content
Content
POST
Response No Content
Content

3.5.13.12 conference/<conferenceid>/pauserecording (AS Only)

This command is used to pause a recording for a conference that is being recorded.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/pause
recording
Command
Category
Call Management

Methods PUT

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 330 OF 521
 PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.13 conference/<conferenceid>/PlaySecurityClassification (AS Only)

This command is used to play a message that announces the current security
classification level calculated for the conference call.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/
PlaySecurityClassification
Command
Category
Call Management

Methods PUT
PUT
Request No content
Content
PUT
Response No content
Content

3.5.13.14 conference/<conferenceid>/resumerecording (AS Only)

This command is used to resume recording for the Meet-Me Conference that was
previously paused.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/resum
erecording
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 331 OF 521
 3.5.13.15 conference/<conferenceid>/stoprecording (AS Only)
This command is used to stop recording for a conference. If the recording was not
started, this command returns an error. Stopping the recording causes the recording file
to be uploaded to a file repository.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/stopr
ecording
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.16 conference/<conferenceid>/setlecturemode (AS Only)

This command is used to set the lecture mode. Once the lecture mode is set, only the
conference moderator can talk and all the other participants in the conference are muted.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/setle
cturemode
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content
PUT
Response No Content
Content

3.5.13.17 conference/<conferenceid>/unsetlecturemode (AS Only)

This is used to unset the lecture mode.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-actions/v2.0/
meetmeconference/<bridgeId>/conference/<conferenceid>/unset
lecturemode
Command
Category
Call Management

Methods PUT
PUT
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 332 OF 521
 PUT
Response No Content
Content

3.5.14 Group Services Commands: /group/<groupid>/services

3.5.14.1 group/<groupid>/services/CallCenter/ExternalReporting (AS Only)

This command is used to the retrieve the group/enterprise level call center external
reporting setting. The external reporting setting specifies the external reporting mode
configured in the Application Server, which can be set to one of the following two values:
 Enhanced: External reporting is provided through the enhanced reporting capabilities.
 Off: External reporting is not used.
For more information on the external reporting capabilities, see the Call Center Reporting
Feature Description [3].
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/group/<groupid>/services/CallCenter/ExternalRe
porting
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="iso-8859-1"?>
Response <ACDExternalReporting
Content xmlns="http://schema.broadsoft.com/xsi">
<mode>Enhanced</mode>
</ACDExternalReporting>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

serviceProviderId String O Specifies the service provider for the

specified group ID.

enterpriseId String O Specifies the enterprise for the specified

group ID.
The serviceProviderId and the enterpriseId
parameters are mutually exclusive. When
both are included, the enterpriseId
parameter has precedence.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 333 OF 521
 3.5.14.2 services/CallCenter/UnavailableCodes (AS Only)
This command is used to retrieve the agent unavailable codes settings for the
group/enterprise.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/group/<groupid>/services/CallCenter/Unavailabl
eCodes
Command
Category
Service Management

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <ACDAgentUnavailableCodes
Content xmlns="http://schema.broadsoft.com/xsi">
<enableAgentUnavailableCodes>true
</enableAgentUnavailableCodes>
<defaultAgentUnavailableCodeOnDND>default
</defaultAgentUnavailableCodeOnDND>
<defaultAgentUnavailableCodeOnPersonalCalls> default
</defaultAgentUnavailableCodeOnPersonalCalls>
<defaultAgentUnavailableCodeOnConsecutiveBounces>
default
</defaultAgentUnavailableCodeOnConsecutiveBounces>
<forceUseOfAgentUnavailableCodes>true
</forceUseOfAgentUnavailableCodes>
<unavailableCodes>
<unavailableCodeDetail
isDefault="true">
<active>true</active>
<code>default</code>
<description>Default Code</description>
</unavailableCodeDetail>
</unavailableCodes>
</ACDAgentUnavailableCodes>

Parameter Description
Parameter Name Allowed Value Optional / Description
Mandatory

serviceProviderId String O Specifies the service provider for the

specified group ID.
The serviceProviderId and the enterpriseId
parameters are mutually exclusive. When
both are included, the enterpriseId has
precedence. Although both parameters are
optional, at least one must be included.

enterpriseId String O Specifies the enterprise for the specified

group ID.
The serviceProviderId and the enterpriseId
parameters are mutually exclusive. When
both are included, the enterpriseId has
precedence. Although both parameters are
optional, at least one must be included.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 334 OF 521
 3.5.15 System Commands: /system/services

3.5.15.1 services/RoutePoint/ApplicationController/<applicationControllerId> (AS Only)

This command is used to retrieve an application controller’s state details.
The application controller is associated with an event channel set through configuration. If
the event channel set is empty, then Cisco BroadWorks rejects any attempt to set the
state to “ready”. The remote application must create event channels for the associated
event channel set hand as synchronized with all subscribed resources related to the
application controller before setting the state to “ready”. A route point external system is
associated with a list of application controllers via configuration (applicationControllerList
option). A route point external system state depends on the state of the application
controllers with which it is associated. The external system state is said to be “ready”
when at least one of its application controllers is in the “ready” state. The external system
is said to be “not ready” when all of its configured application controllers are in the “not
ready” state.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/system/services/RoutePoint/ApplicationControll
er/<applicationControllerId>
Command
Category
Service Management

Methods GET, PUT

GET
Request No Content
Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <ApplicationController
Content xmlns="http://schema.broadsoft.com/xsi">
<state>not ready</state>
</ApplicationController>
PUT <?xml version="1.0" encoding="UTF-8"?>
Request <ApplicationController
Content xmlns="http://schema.broadsoft.com/xsi">
<state>ready</state>
</ApplicationController>
PUT
Response No Content
Content

3.5.16 Version Command

3.5.16.1 Version Command: /versions (AS Only)

This command allows for the retrieval of Xsi-Actions version information. Version
information includes the baseline Xsi version and patched commands with their
corresponding versions.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
actions/v2.0/versions
Command
Category
Versions

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 335 OF 521
 Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Versions xmlns="http://schema.broadsoft.com/xsi">
Content
<commands>
<baseline>21.0</baseline>
<patchedCommand>
<uri>/v2.0/user/%userid%/directories/enterprise</uri>
<version>
<value>21.1</value>
</version>
</patchedCommand>
<patchedCommand>
<uri>/v2.0/user/%userid%/service/securityclassification</ur
i>
<version>
<value>22.0</value>
<feature>12345</feature>
</version>
<version>
<value>21.2</value>
</version>
</patchedCommand>
</commands>
</Versions>

3.5.17 Wild Card and Flag Usage in Search Criterion

A search can often be performed with wildcard characters (“ * ”) to perform a “start with”,
“containing”, or “equal to” search. For example:
 If firstName is set to “john*”, then a “start with” search is performed for any firstName
that starts with the string “john”.
 If firstName is set to “*john*”, then a “containing” search is performed for any
firstName that contains the string “john”.
 Finally, if firstName does not contain any wild card “john”, then an “equal to” search is
performed for any firstName that is set to “john”.
The “/i” can also be added at the end of the search string. It then acts as a flag specifying
that a case-insensitive search be performed. For example, if firstName is set to “john/i”,
then a case-insensitive search is performed. This search would successfully match the
strings “John” and “john”. If firstName is simply set to “john”, then a case-sensitive search
is performed. To use the “/” as a “literal” in a search string, it must be “escaped” with a
backslash. In other words, to search for a value that contains the “/” character, make sure
to add a backslash (“\”) before the “/” character, to avoid confusion between the slashes in
the URL and the slashes meant to be searched in the data fields.
For example, to search for a Yahoo ID set to “john/[email protected]”, one must set the
search string to “john\/[email protected]”; otherwise, an error is returned.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 336 OF 521
 3.5.18 Paging Responses
Commands that are used to retrieve a list of items can support paging responses. Paging
support is implemented via URL parameters in the HTTP GET command. For example:
…/com.broadsoft.xsi-
actions/v2.0/<command>?start=val1&results=val2&otherparam=val3

A paging response echoes the parameters in the response message body. Example:
<?xml version="1.0" encoding="UTF-8"?>
<SomeElement xmlns:"http//schema.broadsoft.com/xsi">
<startIndex>1</startIndex>
<numberOfRecords>1</numberOfRecords>
…
</SomeElement>

Result numbering is 1-based, that is, an index of 1 identifies the first result. The number of
results per page is inclusive, that is, the nth result is included for a page size of n. If either
one or both of the above parameters are not specified in a GET request, the default values
of these parameters are applied.

Paging Query Parameters

Parameter Name Allowed Value Optional / Description
Mandatory

start Positive Integer O This is the starting result position to return.

Value of 0 is The default value is “1”.
not allowed.

results Positive Integer O This is the number of results to return per

in the range page.
from 1 through The default and maximum value for this
1000. parameter is configured as a system option
Value of 0 is on Cisco BroadWorks. If the parameter is
not allowed. not included, then the configured value is
used as default. If the parameter is included
but exceeds the configured value, then the
configured value is used and supersedes the
parameter value.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 337 OF 521
 4 Xsi-Events

4.1 Overview
Xsi-Events provide asynchronous event notifications to a remote application. Event
notifications are modeled as subscription and notification requests. A remote application
sends a subscription request, and if the subscription is successful, Cisco BroadWorks
generates an initial event notification. Future events trigger additional notifications.
Event notifications are carried in HTTP messages. This allows web applications to receive
notifications when resources change their state on Cisco BroadWorks. Xsi-Events
notifications cover two main areas:
 Call Events – Allows event notification of real-time call information on active calls.
Notifications are sent when calls are ringing, answered, transferred, and so on.
 Service Events – Allows event notification when a service configuration has changed.

4.2 Functional Description

4.2.1 Architecture and Messaging

Remote applications have two ways to receive event notifications from Cisco BroadWorks.
Events can be delivered by Cisco BroadWorks using an HTTP contact or using an event
channel. The following subsections provide an overview of each method.

4.2.1.1 HTTP Contact

With this approach, a remote application first creates a subscription by issuing an HTTP(S)
POST message to a specific URL.
The subscription sent by a remote application specifies the subscription target. This target
is typically a subscriber hosted in Cisco BroadWorks.
The subscription also specifies an HTTP contact and an event package or an event
package list. The contact represents the HTTP callback, which is a location at which Xsi-
Events can send back notifications. The event package corresponds to various types of
notifications that are asynchronously sent by Cisco BroadWorks back to the subscribing
client or application.
When successful, Xsi-Events respond to the HTTP POST with an HTTP 200 OK.
After sending this response, Cisco BroadWorks sends an event that allows the remote
application to know the initial state of the target. Note that if the subscription target is a
collection of subscribers (for example, a group), then no such event is sent.
Then at various points in the life of a subscription, Xsi-Events send events to the remote
client application
Notifications are HTTP(S) POST methods issued by Cisco BroadWorks on the contact
URL identified in a subscription. A client application is expected to respond to this POST
with a 200 OK.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 338 OF 521
 HTTP(S)

POST /com.broadsoft.xsi-events/v2.0/user/[email protected]
<?xml version="1.0" encoding="utf-8"?>
<Subscription xmlns="http://schema.broadsoft.com/xsi">
<subscriberId>[email protected]</subscriberId>
<targetIdType>User</targetIdType>
<targetId>[email protected]</targetId>
<event>Advanced Call</event>
<httpContact>
<uri>http://www.test.xyz:80/events/user</uri>
</httpContact>
<applicationId>AClientApplication</applicationId>
</Subscription>

200 OK
<?xml version="1.0" encoding="utf-8"?>
<Subscription xmlns="http://schema.broadsoft.com/xsi">
<subscriptionId>
e1588dcb-2f10-47f9-9660-61307c377877</subscriptionId>
<expires>3600</expires>
</Subscription>

POST https://www.test.xyz:80/events/user
<?xml version="1.0" encoding="UTF-8"?>
<Event xmlns="http://schema.broadsoft.com/xsi-events">
<sequenceNumber>1</sequenceNumber>
<subscriberId>[email protected]<subscriberId>
<applicationId>AClientApplication</applicationId>
<subscriptionId>bc123480-3c13-43d9-90d8-ae3c592346ab</subscriptionId>
<targetId>[email protected]<targetId>
<eventData>
<eventName>
CallEvent

200 OK

Figure 3 Subscription Creation Using HTTP Contact

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 339 OF 521
 4.2.1.2 Event Channel
With this method, a remote application first establishes an event channel for event
delivery. Xsi-Events then deliver events for this subscription over the event channel.
The event channel is established as a streaming HTTP connection. This persistent
connection is created using HTTP streaming semantics (chunked). The channel creation
process proceeds as follows:
 The client opens an HTTP(S) connection to Cisco BroadWorks by issuing an Xtended
Services Interface Event Channel Add request.
Cisco BroadWorks processes this and responds with a chunked response, that is,
either a success or an error response with a Transfer-Encoding: chunked header.
 The client processes the response but keeps the connection open as the response is
chunked, maintaining a streaming HTTP semantic.
 The client issues an Xtended Services Interface Subscribe for one or more event
packages over a second HTTP(S) connection to Cisco BroadWorks. This connection
is not a streaming connection, but rather a standard HTTP 1.1 request-response
connection.
 Cisco BroadWorks responds to this Subscribe, if successful, with a valid subscription
identifier.
 Cisco BroadWorks delivers initial and subsequent events matching the subscription
as individual chunks over the established event channel connection, if and when
events trigger in Cisco BroadWorks.
 The client processes these events and sends an event response for each event over
a second (standard) HTTP(S) connection to Cisco BroadWorks.
 The client sends a periodic heartbeat request, to ensure downstream firewalls or
proxies do not tear down the streaming (chunked) HTTP connection due to inactivity.
The client sends the heartbeat request over a second HTTP(S) connection to Cisco
BroadWorks. Cisco BroadWorks provides a success response for the request and
sends a heartbeat message as an individual chunk over the established event
channel connection.
When a channel is established, the client application should cache the address of the
specific server it reached, as it will need to establish a new HTTP connection to it to send
a channel heartbeat. Since the channel heartbeat must be invoked on the server hosting
the streaming connection, sending it to a FQDN can result in it being sent to another
server, invalidating the heartbeat. The same applies to the channel/EventResponse
command (for more information, see section 4.6.3.2 channel/eventresponse).
For example, while establishing an event channel, a streaming HTTP connection should
be established. A client application would issue the POST HTTP command to a URL in
the following format.
POST http(s)://<host:port>/com.broadsoft.xsi-events/v2.0/channel

The following figures illustrate channel creation, event delivery triggered by subscription,
and channel heartbeat:
 Figure 4 Channel Creation shows how the client opens a streaming connection and
creates a channel for event delivery. The request includes the URL prefix described
above. The response uses chunked transfer encoding and the initial chunk provides
the identity of the channel created.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 340 OF 521
  Figure 5 Event Subscription shows how the client creates a subscription. The
request is sent on a separate HTTP(S) connection and does not include the URL
prefix. The Subscription document included in the request body includes a reference
to the same channel set identifier used to create the channel. The response provides
the identifier of the subscription created.
 Figure 6 Event Notification shows how Cisco BroadWorks sends events to the client.
The event is sent as an individual chunk over the HTTP(S) streaming connection.
The client receives the event and sends an event response on a separate HTTP(S)
connection. The EventResponse included in the request body includes the same
event ID that was received in the event.
 Figure 7 Channel HeartBeat shows how the client triggers the channel heartbeat.
The request is sent on a separate HTTP(S) connection and does not include the URL
prefix. Upon handling the request, Cisco BroadWorks sends a channel heartbeat
document as an individual chunk over the HTTP(S) streaming connection. The client
is expected to receive and discard the chunk.
When subscribing to a collection of users for events, the HTTP streaming method is
preferred to the HTTP contact method since it does not require opening a new HTTP
connection for each event. The CTI interface can also be used to retrieve call-related
events in an efficient way. For more information about CTI, see Cisco BroadWorks
Computer Telephony Integration Interface Specification [2].

NOTE: Cisco BroadWorks tears down the HTTP streaming connection if it does not receive a
channel heartbeat within eventTimeout seconds. As a general rule, a remote application should
send the heartbeat request at eventTimeout/2 intervals to avoid connection tear down.
Therefore, if eventTimeout is 30 seconds, then the client should send a heartbeat every 15
seconds. The eventTimeout value is configurable. For more information, see the Cisco
BroadWorks Xtended Services Interface Configuration Guide [6].

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 341 OF 521
 Figure 4 Channel Creation

NOTE: It is recommended to cache the server address at the channel creation to be able to
send the heartbeat and event responses to the same server.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 342 OF 521
 Figure 5 Event Subscription

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 343 OF 521
 Figure 6 Event Notification

NOTE: The EventResponse must be sent to the server on which the channel was created.
The address cached earlier is useful to reach a specific server instead of any server of a cluster
that can be reached through a FQDN.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 344 OF 521
 HTTP(S)

PUT /com.broadsoft.xsi-events/v2.0/channel/557b1660-a9b0-4030-b240-0ade37b8d8fb/heartbeat

200 OK

Comet HTTP(S) 61
Connection <?xml version="1.0" encoding="UTF-8"?>
<ChannelHeartBeat xmlns ="http://schema.broadsoft.com/xsi"/>

Figure 7 Channel HeartBeat

NOTE: The channel heartbeat must be sent to the server on which the channel was created.
The address cached earlier is useful to reach a specific server instead of any server of a cluster
that can be reached through a FQDN.

A more complete description of subscriptions and event channels is provided in the Cisco
BroadWorks Computer Telephony Integration Interface Specification [2].

4.2.2 Authorization and Security

Xsi-Events offer the same authorization and security functionality as Xsi-Actions. For
more information, see section 3.2 Functional Description.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 345 OF 521
 4.2.3 Channel
A channel contains the following attributes:
 A channel set identifier (channel set ID). This is any free-form text that identifies the
event channel set to which this channel belongs. For more information, see section
4.2.3.1 Channel Set ID.
 The priority and weight of the channel within the event channel set. This is used by
Cisco BroadWorks when determining the event channel on which to deliver an event.
 An expiration value. The expiration value specifies the life duration of the event
channel.
 An application ID. This optional parameter uniquely identifies a remote application
and can be used as a mechanism to limit the number of instances of a remote
application. For more information, see section 4.2.3.2 Application ID.
 A channel ID that uniquely identifies the channel.
For more information, see the Cisco BroadWorks Computer Telephony Integration
Interface Specification [2].

4.2.3.1 Channel Set ID

The channel set ID should be unique per application/user. When a subscription is created
against a channel, it is not terminated when the channel is terminated. Using a unique
channel set ID per application/user allows the application to reuse existing subscriptions
instead of having to create new ones.
If an application uses a new channel set ID every time along with the creation of new
subscriptions, the subscription limit can be “hit” and the application may no longer be able
to create new subscriptions.
It is therefore suggested that every application instance (for example, an Xtended
Services Interface client on a user’s device) uses a unique immutable channel set ID.
When the application is closed and reopened, it can get active subscriptions to see
whether they are still active and avoid having to recreate them. Because it is using the
same channel set ID, active subscriptions are automatically continued on this channel.

4.2.3.2 Application ID
A remote application may include an application ID when creating a channel to enforce a
limit of one single channel set per application. If a second channel set is created with the
same application ID, then Cisco BroadWorks terminates all channels associated with the
first channel set (effectively terminating the channel set itself). This mechanism can be
used to limit the number of instances of a remote application by specifying the same
application ID in a channel creation request.
For this mechanism to work properly, the application ID and user ID combination must be
identical when adding two channels using different channel set IDs. On the creation of the
second channel, previously created channels are closed.
When a new channel is created, previously created channels are closed with the reason
marked as DuplicateChannelSet.
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xsi1:type="xsi:ChannelTerminatedEvent">
<xsi:channelId>a8fdaeff-5810-44b8-aa1e-27193b9d3b92</xsi:channelId>
<xsi:reason>DuplicateChannelSet</xsi:reason>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 346 OF 521
 </xsi:Event>

4.2.4 Subscription
A subscription contains the following attributes:
 A target. A target is typically a subscriber hosted in Cisco BroadWorks. The target
can also be a collection of subscribers (that is, a group, service provider/enterprise, or
the system) or a sub-component of a subscriber.
 A channel set identifier or an http contact depending on the mechanism chosen for
event delivery.
 An application ID. The application ID uniquely identifies a remote client application.
By using different applicationId, more than one client application can “subscribe
against” the same target for the same event. Normally a remote application provides
the same applicationId for all subscriptions.
 An event package. The event package defines how the subscription behaves,
including what types of notifications are sent and when. Each event corresponds to
various types of notifications that are asynchronously sent by Cisco BroadWorks back
to the subscribing client application.
 An event package list. Unless a specific event package is specified, it is possible to
specify a list of event packages to subscribe to. This allows subscribing to many
event packages at once.
 An expiration value. The expiration value specifies the life duration of the
subscription.
 A shared subscription ID. Subscription sharing is an optional functionality. For more
information, see section 4.2.4.3 Shared Subscription.
 A subscription ID that uniquely identifies the subscription.

4.2.4.1 Subscription Target

The subscription target (the entity being monitored for the subscription) can be any one of
the following:
 System – Indicates that the target of the subscription is the entire system.
 Service Provider ID – The ID of the target service provider/enterprise for the
subscription.
 Group ID – The key of the target group for the subscription.
 User ID – The ID of the target user for the subscription.
 User subID – The subID of the target user for the subscription. Used only by some
event packages, for example, Meet Me Conference.
While Virtual Users (such as a Call Center or an Auto Attendant) cannot be individually
subscription targets, creating subscriptions that target System, Service Provider, or Group
will allow for events to be generated for Virtual Users. This applies only to call packages
(Basic Call, Standard Call, and Advanced Call).

4.2.4.2 Initial Event

An initial event is issued only for subscription against the smallest target scope. Typically,
this means that an initial event is issued for subscription with user target. No initial event is
issued if the subscription target is a collection of users (for example, a group).

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 347 OF 521
 Some event packages however support subscription against a user subID (see section
4.7.19 Meet-Me Conference Events for example). In such a case, an initial event is only
issued for subscriptions against the target subID, not for subscription against a user, or
any larger scope target (group, enterprise, system).

4.2.4.3 Shared Subscription

Subscription sharing allows a remote application who has multiple subscriptions to the
same target and event package to share a user-level subscription in Cisco BroadWorks.
When shared subscriptions are used, only one notification will be sent for each state
update for a particular target user and event package combination, regardless of the
number of users subscribing to the same event package and target combination. This
improves the performance and scalability of the solution as it reduces the volume of event
notifications between Cisco BroadWorks and the remote application.
To share subscriptions, each remote application must send independent subscription
requests to Cisco BroadWorks with the same shared subscription ID (SSID). Cisco
BroadWorks uses the SSID in the subscription to link and correlate the subscriptions, and
it only sends a single notification for state updates to the target, regardless of the number
of remote applications sharing the subscription.
A more complete description of subscriptions sharing is provided in the Cisco BroadWorks
Computer Telephony Integration Interface Specification [2].

4.2.4.4 Events Sequence

Events are sent on a user basis for a subscription. For a user subscription, that means all
the events for the subscription will be in order. For a collection subscription (subscription
to a group, enterprise, service provider, or system), all the events for each user in the
subscription will be in order.
However, there is no guarantee that events for different users will be in order. For
example, an event with the sequence number of 50 for UserA can be sent before an event
with the sequence number of 49 for UserB.
The following Route Point events are sent in order on a call basis, guaranteeing that only
events related to the same call for the same subscription will be sent in order:
 RoutePointCallForwardedEvent
 RoutePointCallForwardedTreatmentCompletedEvent
 RoutePointHolidayPolicyAppliedEvent
 RoutePointHolidayPolicyTreatmentCompletedEvent
 RoutePointNightPolicyAppliedEvent
 RoutePointNightPolicyTreatmentCompletedEvent
 RoutePointCallAddedEvent
 RoutePointCallAbandonedEvent
 RoutePointCallUpdatedEvent
 RoutePointCallAnsweredByAgentEvent
 RoutePointCallBouncedEvent
 RoutePointCallOfferedToAgentEvent
 RoutePointCallOverflowedEvent
 RoutePointCallOverflowedTreatmentCompletedEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 348 OF 521
  RoutePointCallReleasedEvent
 RoutePointCallFailedEvent
 RoutePointCallTransferredEvent
 RoutePointOutgoingCallOriginatedEvent
 RoutePointOutgoingCallAnsweredEvent
 RoutePointWhisperStartedEvent
 RoutePointTreatmentStartedEvent
 RoutePointTreatmentCompletedEvent
 RoutePointMOHStartedEvent
 RoutePointMOHCompletedEvent
 RoutePointSilenceStartedEvent
 RoutePointSilenceCompletedEvent
 RoutePointRingbackStartedEvent
 RoutePointRingbackCompletedEvent
 RoutePointBusyStartedEvent
 RoutePointBusyCompletedEvent
The initial subscription event (RoutePointSubscriptionEvent) will not be sent until any
queued events of the types previously listed are sent. Furthermore, when the initial
subscription event is being sent, the events from the types previously listed will not be sent
until the initial subscription event is sent. This special handling applies only to
subscriptions that directly target a Route Point instead of a collection (that is, group,
service provider/enterprise, or system).

4.2.4.5 Refreshing Subscriptions

To refresh a subscription, the command 4.6.2.6 subscription/<subscriptionid> can be used
with the PUT method to modify the subscription by changing the expires attribute. To
avoid network delays which could occur if trying to refresh the subscription near its
expiration time, it is recommended to refresh subscription expiration when half of it has
passed.

4.2.4.6 Event Package List

An event package list allows remote applications to subscribe to more than one event
package in one subscription. This has the benefit of reducing the number of subscription
requests sent by a remote application.
A remote application is allowed to send one subscription with an event package list per
target. Subsequent subscription with an event package list from the same owner against
the same target replaces the previous one regardless whether the event package lists are
the same.
When the subscription target is a user, each event package within the list is validated
against the target user.
 If the target user is not a virtual subscriber, then any event package on the list that can
only be applied to a virtual subscriber is invalid and the subscription is rejected.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 349 OF 521
  Similarly, if the target user is a virtual subscriber, then an event package on the list
that can only be applied to a non-virtual subscriber is invalid and the subscription is
rejected. Event packages on the list are not subjected to service assignment
validation.
Upon subscription creation, if an event package on the list is not recognized by the
Xtended Services Platform or Execution Server, the subscription is rejected. However, if a
saved subscription contains an event package that is not recognized by the Execution
Server, it is ignored during loading or during query. Ignored event packages are not
returned in a query response and do not generate events.
If a query is performed on a specific event package, it only returns a subscription created
with a single event package. Subscriptions with an event package list cannot be queried
based on an event package. Subscriptions with an event package list can be queried
based on the subscription identifier, and the query response contains all the event
packages on the list that are recognized by the Execution Server.

4.2.4.7 Expiration
A subscription can have a specified expiration value in seconds, or it can be set to never
expire. The minimum subscription time is 3600 seconds. The maximum subscription time
is 2147483646 seconds, although a lower value can be forced on either the Application
Server or the Execution Server on the CLI context CLI/System/EventNotification.
To create a subscription that will never expire, the value is 2147483647 and must be
allowed and specified in the subscription creation request. Although the subscription list
on the Application Server will show an expiration date, the subscription on its own will not
expire.
The general recommendation is to use an expiration value not smaller than a day (86400
seconds) for server-to-client usage and “unexpiring” subscriptions (2147483647 seconds)
for server-to-server usage (middleware).

4.3 Message Encoding

Each Xsi-Events command is encoded in an HTTP request and is identified using the
following attributes:
 For all commands (except for the Add Event Channel) a URL is in the format:
http(s)://<host:port>/com.broadsoft.xsi-events/v2.0/…
 For the Add Event Channel command, a URL is in the format: http(s)://<host:port>/
com.broadsoft.xsi-events/v2.0/channel
 A Method, that is, GET, POST, DELETE or PUT

4.3.1 Versioning
Similar to Xsi-Actions, Xsi-Events commands are versioned using the URL version and
the protocol version specified in the HTTP header. For more information, see section
3.3 Message Encoding.

4.3.2 HTTP Headers

4.3.2.1 Commands
HTTP request headers of interest to the Xtended Services Interface from the remote
application include:
 Authorization – Contains the user credentials.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 350 OF 521
  Content-type – Should be set to “application/xml; charset=UTF-8”. Note, however,
that this is a recommendation that is not enforced by the Xtended Services Interface.
It can also contain “application/json”. For more information, see section 4.3.2.2
Events.
 X-BroadWorks-Protocol-Version – This header is optional. When set, it specifies the
Xsi-Events API version to use. For more information, see section 3.4.1.1 Specify
Request Version.
 Accept – This header is optional and can be set to “application/json”. For more
information, see section 3.3.3.1 JSON.
 Transfer-Encoding – This is an optional header that is used when adding an event
channel.
HTTP response headers of interest to the remote application and sent by Xsi-Events
include:
 Status header with status codes 200, 201, and so on.
 Content-type –“application/xml” or “application/json”. The character set (charset)
depends on the type of response. For more information, see section 4.3.4 Character
Sets.

4.3.2.2 Events
When an event is delivered by Cisco BroadWorks using an HTTP contact, Cisco
BroadWorks sends an HTTP request to the remote application with the event included in
the message body and the Content-Type header is set to “application/xml; charset=UTF-
8”. HTTP response headers and message bodies are ignored by Cisco BroadWorks.

4.3.3 HTTP Body

Similar to Xsi-Actions, the body of an Xsi-Events request or response can optionally carry
an entire XML document or can be encoded using JSON. The same mechanisms,
described in section 3.3.3 HTTP Body, are used to provide details related to body content.
Note that event notification messages sent from Cisco BroadWorks to the remote
application can only be encoded in XML and not JSON.

4.3.4 Character Sets

The following describes how Xsi-Events determine the character set to use for the
encoding of message bodies included in responses:
 Subscription and channel command responses – UTF-8 is always used.
 Events – UTF-8 is always used.
 Platform-level error responses – The Xtended Services Platform’s default character
set is used.

4.3.4.1 Slash Character in Cisco BroadWorks Identifiers

The slash character (“/”) is not allowed in identifiers. Although some identifiers such as
user ID can be provisioned with a slash character, they cannot be referenced from Xsi
applications (Xsi-Actions and Xsi-Events).

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 351 OF 521
 4.4 Event Packages
A list of event packages is part of the Xtended Services Interface schema documentation.
This list is in the XsiSubscription.xsd schema file. The following sections describe the
events that Cisco BroadWorks triggers for an active subscription for each Xtended
Services Interface event package.

4.4.1 Basic Call

The Basic Call event package consists of events that identify a call’s basic progression
through each state, that is, Alerting/Ringing, Answered, and Released. Client applications
should use this event package to monitor or take action for a subscriber call presence or
basic call state activity.
The following events are generated for the Basic Call event package:
 CallOriginating
 CallOriginated
 CallCollecting
 CallReceived
 CallAnswered
 CallReleased
 CallReleasing
 CallSubscription
 CallSubscriptionResyncEvent
 HookStatusEvent

4.4.2 Standard Call

The Standard Call event package consists of all events generated by Basic Call, as well
as other call state notifications, such as, Hold, Park, Conference, and so on. Client
applications should use this event package for a complete view of a subscriber’s call state
or call details while the call is present against that subscriber. This package does not
provide a view of redirections a call might go through because of Cisco BroadWorks
services, such as, Call Forwarding, and so on. It is expected that most third-party end-
user applications use either the Basic or Standard Call event packages.
The following events are generated for the Standard Call event package:
 CallOriginating
 CallOriginated
 CallCollecting
 CallReceived
 CallAnswered
 CallHeld
 CallRetrieved
 CallReleasing
 CallReleased
 CallRecordingStartingEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 352 OF 521
  CallRecordingStartedEvent
 CallRecordingPausedEvent
 CallRecordingResumedEvent
 CallRecordingStoppedEvent
 CallTransferred
 CallMonitored
 CallBargedIn
 CallParkRetrieved
 CallPickedUp
 CallForwarded
 CallUpdated
 ConferenceStarted
 ConferenceHeld
 ConferenceRetrieved
 ConferenceReleased
 ConferenceUpdated
 ConferenceMutedEvent
 ConferenceUnmutedEvent
 CallSubscription
 CallSubscriptionResyncEvent
 CallSecurityClassificationUpdatedEvent
 CallClientSessionInfoUpdated
 HookStatusEvent
 PlayMusicOnHoldFailureEvent

4.4.3 Advanced Call

The Advanced Call event package provides a complete picture of a call as it is processed
by Cisco BroadWorks. Events triggering on service execution that could prevent a call
from reaching a subscriber, such as Do Not Disturb or Call Forwarding Always, are
reported as part of the Advanced Call event package.
The following events are generated for the Advanced Call event package:
 CallOriginating
 CallOriginated
 CallCollecting
 CallReceived
 CallAnswered
 CallHeld
 CallRecordingStartingEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 353 OF 521
  CallRecordingStartedEvent
 CallRecordingPausedEvent
 CallRecordingResumedEvent
 CallRecordingStoppedEvent
 CallRetrieved
 CallReleasing
 CallReleased
 CallRedirected
 CallTransferred
 CallMonitored
 CallBargedIn
 CallParkRetrieved
 CallPickedUp
 CallForwarded
 CallUpdated
 ConferenceStarted
 ConferenceHeld
 ConferenceRetrieved
 ConferenceReleased
 ConferenceUpdated
 ConferenceMutedEvent
 ConferenceUnmutedEvent
 CallSubscription
 CallSubscriptionResyncEvent
 CallSecurityClassificationUpdatedEvent
 CallClientSessionInfoUpdated
 HookStatusEvent
 CallDetachedEvent
 PlayMusicOnHoldFailureEvent

4.4.4 Call Center Queue (AS Only)

The Call Center Queue event package provides notifications for calls in a Cisco
BroadWorks-based call center’s queue. Queue activity, such as calls added, removed, or
reordered, and so on, can be monitored by subscribing to this event package.
The following events are generated for this event package:
 ACDCallAddedEvent
 ACDCallOfferedToAgentEvent
 ACDCallAnsweredByAgentEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 354 OF 521
  ACDCallAbandonedEvent
 ACDCallReleasedEvent
 ACDCallOverflowedEvent
 ACDCallOverflowedTreatmentCompletedEvent
 ACDCallTransferredEvent
 ACDCallUpdatedEvent
 ACDCallBouncedEvent
 ACDCallForwardedEvent
 ACDCallForwardedTreatmentCompletedEvent
 ACDCallReorderedEvent
 ACDCallStrandedEvent
 ACDCallStrandedTreatmentCompletedEvent
 ACDCallEscapedEvent
 ACDHolidayPolicyAppliedEvent
 ACDHolidayPolicyTreatmentCompletedEvent
 ACDNightPolicyAppliedEvent
 ACDNightPolicyTreatmentCompletedEvent
 ACDCallPromotedEvent
 ACDSubscriptionEvent
 ACDWhisperStartedEvent
 ACDCallStrandedUnavailableEvent
 ACDCallStrandedUnavailableTreatmentCompleteEvent
 ACDSubscriptionResyncEvent

4.4.5 Route Point Queue (AS Only)

The Route Point Queue event package provides notifications for calls in a Cisco
BroadWorks-based route point queue. A route point differs in functionality from a call
center. For more information, see the Cisco BroadWorks Computer Telephony Integration
Interface Specification [2].
The following events are generated for this event package:
 RoutePointCallAddedEvent
 RoutePointCallOfferedToAgentEvent
 RoutePointCallAnsweredByAgentEvent
 RoutePointCallAbandonedEvent
 RoutePointCallOverflowedEvent
 RoutePointCallOverflowedTreatmentCompletedEvent
 RoutePointCallTransferedEvent
 RoutePointCallUpdatedEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 355 OF 521
  RoutePointCallBouncedEvent
 RoutePointCallForwardedEvent
 RoutePointCallForwardedTreatmentCompletedEvent
 RoutePointCallReleasedEvent
 RoutePointCallFailedEvent
 RoutePointOutgoingCallOriginatedEvent
 RoutePointOutgoingCallAnsweredEvent
 RoutePointTreatmentStartedEvent
 RoutePointTreatmentCompletedEvent
 RoutePointMOHStartedEvent
 RoutePointMOHCompletedEvent
 RoutePointRingbackStartedEvent
 RoutePointRingbackCompletedEvent
 RoutePointBusyStartedEvent
 RoutePointBusyCompletedEvent
 RoutePointSilenceStartedEvent
 RoutePointSilenceCompletedEvent
 RoutePointHolidayPolicyAppliedEvent
 RoutePointHolidayPolicyTreatmentCompletedEventEvent
 RoutePointNightPolicyAppliedEvent
 RoutePointNightPolicyTreatmentCompletedEvent
 RoutePointFailedEvent
 RoutePointRecoveredEvent
 RoutePointSubscriptionEvent
 RoutePointEvent
 RoutePointWhisperStartedEvent
 RoutePointSubscriptionResyncEvent
 RoutePointNewCallEvent
 RoutePointCallRejectedEvent

4.4.6 Voice Mail Message Summary

The Voice Mail Message Summary event package notifies applications when a voice mail
message has been left against a Cisco BroadWorks subscriber for either the Voice
Messaging or Third-Party Voice Mail Support services. Notifications for changes to the
service’s message summary status, such as, a new voice mail being left or a voice mail
being deleted, are sent.
Any Cisco BroadWorks end user or a virtual subscriber, such as, a Call Center or Auto
Attendant that could have these services assigned to them, can be the target of a voice
mail message summary subscription.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 356 OF 521
 Note that the Third-Party Voice Mail Support and Voice Messaging services are not a
supported configuration. If a user has both services and a valid subscription for this event
package exists, then the user receives events for both services. However, the messages
do not identify to which service the notification is related.
VoiceMailMessageSummaryEvent is generated for this event package.

4.4.7 Three-Way Calling

The Three-Way Calling event package notifies subscribers when changes are made to a
subscription target’s Three-Way Calling service.
ThreeWayCallEvent is generated for this event package.

4.4.8 BroadWorks Anywhere

The BroadWorks Anywhere event package notifies subscribers when changes are made
to a subscription target’s BroadWorks Anywhere service.
BroadWorksAnywhereEvent is generated for this event package.

4.4.9 Call Center Agent (AS Only)

The Call Center Agent event package notifies subscribers for actions taken or occurring
for BroadWorks Call Center agents, such as, an agent’s ACD state, a disposition code
entered by an agent, and so on.
The following events are generated for this event package:
 ACDAgentJoinUpdateEvent
 AgentSubscriptionEvent
 AgentDispositionCodeAddedEvent
 AgentStateEvent

4.4.10 Call Center Agent Monitoring (AS Only)

The Call Center Agent Monitoring event package allows a subscriber to receive
notifications related to the overall performance of the agent, such as, the average handling
time, average outgoing call handing time, and so on.
The following events are generated for this event package:
 CallCenterAgentMonitoringEvent
 CallCenterAgentOnCallAlertEvent
 CallCenterAgentMonitoringSubscriptionEvent

4.4.11 Call Center Configuration (AS Only)

The Call Center Configuration event package notifies subscribers when a service mode,
such as, Forced Forwarding, Holiday Service, and Night Service, for a Cisco BroadWorks
call center change.
The following events are generated for this event package:
 ACDForcedForwardingEvent
 ACDHolidayServiceEvent
 ACDNightServiceEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 357 OF 521
  ACDConfigurationSubscriptionEvent

4.4.12 Call Center Monitoring (AS Only)

The Call Center Monitoring event package allows a subscriber to receive notifications
related to the overall performance of the call center, such as, the expected wait time,
longest wait time, and so on.
CallCenterMonitoringEvent is generated for this event package.

4.4.13 Call Forwarding Always

The Call Forwarding Always event package notifies subscribers when changes are made
to a subscription target’s Call Forwarding Always service.
CallForwardingAlwaysEvent is generated for this event package.

4.4.14 Call Forwarding Always Secondary

The Call Forwarding Always Secondary event package notifies subscribers when changes
are made to a subscription target’s Call Forwarding Always Secondary service.
CallForwardingAlwaysEventSecondary is generated for this event package.

4.4.15 Call Forwarding Busy

The Call Forwarding Busy event package notifies subscribers when changes are made to
a subscription target’s Call Forwarding Busy service.
CallForwardingBusyEvent is generated for this event package.

4.4.16 Call Forwarding No Answer

The Call Forwarding No Answer event package notifies subscribers when changes are
made to a subscription target’s Call Forwarding No Answer service.
CallForwardingNoAnswerEvent is generated for this event package.

4.4.17 Call Park

The Call Park event package notifies subscribers when a call is parked or when it is no
longer parked against the target user (for example, the parked call is retrieved or
released).
CallParkedAgainstEvent is generated for this event package.

4.4.18 Call Transfer

The Call Transfer event package notifies subscribers when changes are made to a
subscription target’s Call Transfer service.
CallTransferEvent is generated for this event package.

4.4.19 Call Waiting

The Call Waiting event package notifies subscribers when changes are made to a
subscription target’s Call Waiting service.
CallWaitingEvent is generated for this event package.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 358 OF 521
 4.4.20 Do Not Disturb
The Do Not Disturb event package notifies subscribers when changes are made to a
subscription target’s Do Not Disturb service.
DoNotDisturbEvent is generated for this event package.

4.4.21 Hoteling Guest

The Hoteling Guest event package notifies subscribers when changes are made to a
subscription target’s Hoteling Guest service.
HotelingGuestEvent is generated for this event package.

4.4.22 Last Number Redial

The Last Number Redial event package notifies subscribers when changes are made to a
subscription target’s Last Number Redial service.
LastNumberRedialEvent is generated for this event package.

4.4.23 Meet Me Conference (AS Only)

The Meet Me Conference event package provides notifications for calls in a Meet-Me
conference. Conference activity, such as, conference started, participant joined,
participant muted, and so on, can be monitored by subscribing to this event package.
For Meet-Me Conferencing, a subscription is not terminated
(SubscriptionTerminationEvent is generated) due to the status of a conference. For
example, if a subscription is made to a targetSubId and the conference ends, the
subscription is still active. The same is true for subscriptions that do not have a
targetSubId specified.
The following events are generated for this event package:
 Meet-Me Conference Auto Lecture Mode Started
 Meet-Me Conference Lecture Mode Started
 Meet-Me Conference Lecture Mode Stopped
 Meet-Me Conference Locked
 Meet-Me Conference Recording Paused
 Meet-Me Conference Recording Resumed
 Meet-Me Conference Recording Started
 Meet-Me Conference Recording Stopped
 Meet-Me Conference Started
 Meet-Me Conference Stopped
 Meet-Me Conference Subscription
 Meet-Me Conference Unlocked
 Meet-Me Participant Held
 Meet-Me Participant Joined
 Meet-Me Participant Left
 Meet-Me Participant Muted

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 359 OF 521
  Meet-Me Participant Retrieved
 Meet-Me Participant Unmuted
 Meet-Me Participant Updated
 Meet-Me Conference Subscription Resync
 Meet-Me Conference Security Classification Updated
 Meet-Me Conference Client Session Info Updated

4.4.24 Music On Hold

The Music On Hold event package notifies subscribers when changes are made to a
subscription target’s Music On Hold service.
MusicOnHoldEvent is generated for this event package.

4.4.25 N-Way Calling

The N-Way Calling event package notifies subscribers when changes are made to a
subscription target’s N-Way Calling service.
N-WayCallEvent is generated for this event package.

4.4.26 Remote Office (AS Only)

The Remote Office event package notifies subscribers when changes are made to a
subscription target’s Remote Office service.
RemoteOfficeEvent is generated for this event package.

4.4.27 Sequential Ringing

The Sequential Ringing event package notifies subscribers when changes are made to a
subscription target’s Sequential Ringing service.
SequentialRingEvent is generated for this event package.

4.4.28 Simultaneous Ringing Personal

The Simultaneous Ringing Personal event package notifies subscribers when changes
are made to a subscription target’s Simultaneous Ringing Personal service.
SimultaneousRingPersonalEvent is generated for this event package.

4.4.29 Third-Party Voice Mail Support

The Third-Party Voice Mail Support event package notifies subscribers when changes are
made to a subscription target’s Third Party Voice Mail Support service.
ThirdPartyVoiceMailSupportEvent is generated for this event package.

4.4.30 Voice Messaging

The Voice Messaging event package notifies subscribers when changes are made to a
subscription target’s Voice Messaging service.
VoiceMessagingEvent is generated for this event package.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 360 OF 521
 4.4.31 Security Classification (AS Only)
The Security Classification event package notifies subscribers when changes are made to
a subscription target’s security classification service.
SecurityClassificationEvent is generated for this event package.

4.4.32 Flexible Seating Guest (AS Only)

The Flexible Seating Guest event package notifies subscribers when changes are made
to a subscription target’s Flexible Seating Guest service.
FlexibleSeatingGuestEvent is generated for this event package.

4.4.33 Personal Assistant (AS Only)

The Personal Assistant event package notifies subscribers when changes are made to a
subscription target’s Personal Assistant service.
PersonalAssistantEvent is generated for this event package.

4.4.34 Collaborate Room (AS Only)

The Collaborate Room event package allows a remote application to subscribe to receive
notifications related to a Collaborate Room’s conference session.
For collaborate room conference, a subscription is not terminated based on the status of
the conference.
The following events are generated for this event package:
 CollaborateRoomSubscriptionEvent
 CollaborateRoomSubscriptionResyncEvent
 CollaborateRoomStartedEvent
 CollaborateRoomStoppedEvent
 CollaborateRoomLockedEvent
 CollaborateRoomUnlockedEvent
 CollaborateRoomParticipantJoinedEvent
 CollaborateRoomParticipantLeftEvent
 CollaborateRoomParticipantMutedEvent
 CollaborateRoomParticipantUnmutedEvent
 CollaborateRoomParticipantUpdatedEvent

4.4.35 Silent Alerting (AS Only)

The Silent Alerting event package notifies subscribers when changes are made to a
subscription target’s Silent Alerting service.
SilentAlertingEvent is generated for this event package.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 361 OF 521
 4.4.36 Push Notification Registration (AS Only)
The remote application subscribes to this event package to receive notifications related to
push notification registrations. This event package is added for the purposes of
synchronizing registrations between the Application Server and the subscriber. The
primary subscriber of this event package is the Messaging Server. Its enterprise/service
provider-level subscription ensures that push notification registrations are synchronized
between the Application Server and the Messaging Server.
PushNotificationRegistrationEvent is generated for this event package.

4.5 Backward Compatibility

Similar to Xsi-Actions, Xsi-Events is backward compatible for up to two major releases.
The same backward compatibility mechanism described for Xsi-Actions request and
schema applies to Xsi-Events requests. For more information, see section 3.4 Backward
Compatibility. The following subsections explain event package versioning.

4.5.1 Events
Xsi-Events are delivered to the remote application when it subscribes to one or more
event packages. Each event package in Xsi-Events is versioned. The version of the
event package is specified by the remote application via the various subscription methods.
Examples of event package versions are “19.0”, “20.0”, and so on.
Each version maps to a specific event package functionality. If a new event is to be sent
as part of an event package or if there is any change in the parameters for a specific
event, then a new version of the event package is created and the existing version
remains unchanged.
If a remote application subscribes to an event package with a given version, it is
guaranteed to receive event notifications in a defined and unchanged format for as long as
that event package version is supported, (which is two major Cisco BroadWorks releases).
If there is any change in an event delivered by Cisco BroadWorks, that changed event can
only be viewed by subscribing to the newer version of the applicable event package.

4.5.1.1 Specify Event Package Version

An event package version is specified via a custom HTTP header in the Xtended Services
Interface request’s HTTP method URL. This header is X-BroadWorks-Protocol-Version.
If a version does not accompany a request, Cisco BroadWorks executes the command as
if the latest version of the event package was requested.

4.5.1.2 Example
Assuming that a new event is delivered as part of the Advanced Call subscription on a
BroadWorks Release 21.0 deployment, a subscription can be made with a version of 20.0
or 21.0. Creating an Advanced Call subscription with X-BroadWorks-Protocol-Version set
to “20.0” on a BroadWorks Release 21.0 deployment would continue to deliver events
identical to a BroadWorks Release 20.0 deployment. Creating an Advanced Call
subscription with X-BroadWorks-Protocol-Version set to “21.0” on a BroadWorks Release
21.0 deployment would deliver events according to the new version of the event package,
including the new event.

4.5.1.3 Version Value

The value assigned to the event package version does not necessarily correspond to the
Cisco BroadWorks software release number. The version value follows the same rule as
for Xsi-Actions. For more information, see section 3.4.2 Version Value.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 362 OF 521
 4.5.1.4 XML Schema
The XML schema defines the types used by the Xtended Services Interface (Xsi) and is
published with release of the interface. For more information, see section 3.4.3 XML
Schema.

4.6 Command Description

The following listings represent the complete API for Xsi-Events. Note that since
“http(s)://<host:port>” is common to all command URLs, the following listings start with
“/v2.0”.

4.6.1 Command Listing

The following commands are used to create, retrieve, and modify event subscriptions.
/com.broadsoft.xsi-events/v2.0/enterprise/<enterpriseId>
/com.broadsoft.xsi-events/v2.0/enterprise/<enterpriseId>/group/<groupId>
/com.broadsoft.xsi-events/v2.0/serviceprovider/<serviceProviderId>
/com.broadsoft.xsi-events/v2.0/serviceprovider/<serviceProviderId>/group/
<groupId>
/com.broadsoft.xsi-events/v2.0/subscription
/com.broadsoft.xsi-events/v2.0/subscription/<subscriptionId>
/com.broadsoft.xsi-events/v2.0/system
/com.broadsoft.xsi-events/v2.0/user/<userId>
/com.broadsoft.xsi-events/v2.0/user/<userid>/subId/<subid>

The following commands are used to establish channels and channel sets and produce
heartbeat.
/com.broadsoft.xsi-events/v2.0/channel
/com.broadsoft.xsi-events/v2.0/channel/<channelId>
/com.broadsoft.xsi-events/v2.0/channel/<channelId>/heartbeat
/com.broadsoft.xsi-events/v2.0/channelset/<channelsetId>

The following command is used to retrieve Xsi-Events version information.

/com.broadsoft.xsi-events/v2.0/versions

The details of each command are provided in the following subsections.

4.6.2 Subscription Commands

4.6.2.1 enterprise/<enterpriseId>
This command allows a user, in an allowed scope, to subscribe to events for an
enterprise. A subscription is issued by a subscription owner (typically an enterprise or
system administrator), against a subscription target, that is, a Cisco BroadWorks
enterprise, for an event package that identifies the set of events the application is
interested in receiving.

NOTE: The enterprise/<enterpriseId> and the serviceprovider/<serviceProviderId> URIs are

interchangeable. As a result, this command can also be used against a service provider by
replacing the enterpriseId by the serviceProviderId in the URI in the table.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 363 OF 521
 Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/enterprise/<enterpriseId>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/enterprise/<enterpriseId>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content <event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</uri>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.2 enterprise/<enterpriseId>/group/<groupid>
This command allows an application to submit an initial subscription for events that are
required by the application against an enterprise group. A subscription is issued by a
subscription owner, against a subscription target that is a group, for an event package that
identifies the set of events the application is interested in receiving.

NOTE: The enterprise/<enterpriseId>/group/<groupid> and the

serviceprovider/<serviceProviderId>/group/<groupid> URIs are interchangeable. As a result,
this command can also be used against a service provider group by replacing the enterpriseId
with the serviceProviderId in the URI in the table.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 364 OF 521
 Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/enterprise/<enterpriseId>/group/<groupid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/enterprise/<enterpriseId>/group/<groupid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.3 serviceprovider/<serviceProviderId>
This command allows a user in an allowed scope to subscribe for events for a service
provider. A subscription is issued by a subscription owner, typically a service provider or
system administrator, against a subscription target that is a Cisco BroadWorks service
provider, for an event package that identifies the set of events the application is interested
in receiving.

NOTE: The serviceprovider/<serviceProviderId> and the enterprise/<enterpriseId> URIs are

interchangeable. As a result, this command can also be used against an enterprise by replacing
the serviceProviderId with the enterpriseId in the URI in the table.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 365 OF 521
 Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/serviceprovider/<serviceProviderId>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/serviceprovider/<serviceProviderId>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.4 serviceprovider/<serviceProviderId>/group/<groupid>
This command allows an application to submit an initial subscription for events that are
required by the application against a service provider group. A subscription is issued by a
subscription owner, against a subscription target that is a group for an event package that
identifies the set of events the application is interested in receiving.

NOTE: The serviceprovider/<serviceProviderId>/group/<groupid> and the

enterprise/<enterpriseId>/group/<groupid> URIs are interchangeable. As a result, this command
can also be used against an enterprise group by replacing the serviceProviderId with the
enterpriseID in the URI in the table.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 366 OF 521
 Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-events/v2.0/
serviceprovider/<serviceProviderId>/group/<groupid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-events/v2.0/
serviceprovider/<serviceProviderId>/group/<groupid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.5 Subscription
Subscription information can be retrieved by querying a single subscription using its
subscriptionId or by using a combination of filters using optional URL parameters to
retrieve a list. The following filters can be used:
 subscriberId – Used to filter subscriptions owned by the given subscriber.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 367 OF 521
 If this parameter is not specified, the authenticated user (the user matching the
authenticated credentials in the HTTP command) is used as the subscriberId on
which to filter. Essentially, if a user wants to see subscriptions that they own, they do
not need to use the subscriberId parameter. If they want to see subscriptions owned
by others, they need to use the subscriberId parameter. In this case, the subscriberId
value used must be within the allowed scope of the authenticated user, otherwise a
403 error response is generated.
 event – Used to filter subscriptions matching this event.
 extAppId – Used to filter subscription against the given external Application ID.
 targetId – Used to filter subscriptions against the given target (user or collection of
users).
 targetGrpParentId – If the targetId is “group”, targetGrpParentId should be sent with
the corresponding service provider or enterprise of the group. If the targetEntityType
filter value is “Group” and a targetGrpParentId value is not provided, a 400 XCap error
is returned.
 targetEntityType – Identifies the type of the given target. If the targetEntityType is not
set, by default the targetEntity type used is “User”. Allowed values for
targetEntityType are “User”, “ServiceProvider”, “Group”, and “System”.
 targetSubId – Used to filter subscriptions against the given subId.

NOTE: For a subscription with a target as “enterprise” or “service provider”, the targetIdType
returned is ServiceProvider.

An identified target must be within the allowed scope of the authenticated user; otherwise,
a 403 error response is generated.
Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/subscription?[
subscriberId=]&[targetId=]&[event=]&[]&[
targetGrpParentId=]&[targetEntityType=]
Methods GET
GET
Request No Content
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 368 OF 521
 GET <?xml version="1.0" encoding="UTF-8"?>
Response <SubscriptionList
Content xmlns="http://schema.broadsoft.com/xsi ">
<subscription>
<subscriptionId> bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<subscriberId>[email protected]<subscriberId>
<targetId>[email protected]<targetId>
<event>Basic Call</event>
<expires>4800</expires>
<contact>
<uri>http://www.test.xyz/events/user</uri>
</contact>
<applicationId>ApplicationOne</applicationId>
</subscription>
<subscription>
<subscriptionId>ed126780-3d15-41d9-11d3-
463c592346ab</subscriptionId>
<subscriberId>[email protected]<subscriberId>
<targetId>[email protected]<targetId>
<event>Basic Call</event>
<expires>4800</expires>
<channelSetId>ChannelSetOne</channelSetId>
<applicationId>ApplicationTwo</applicationId>
</subscription>
</SubscriptionList>

4.6.2.6 subscription/<subscriptionid>
These commands are used to query, modify, or delete a single subscription by specifying
its subscriptionId.
Xsi-Events responds with a 200 OK containing a SubscriptionList element for a GET, a
200 OK containing a SubscribeResponse element for a PUT, an empty 200 OK response
for a DELETE, and a 403 error response for all unsuccessful responses.
A notification POST message is issued from Cisco BroadWorks to the client or application
if an existing subscription is successfully refreshed or modified and the subscription is
against an end-user target. If the target is a collection of users (that is, group, service
provider/enterprise, or system), a notification POST is not generated following a
successful refresh.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/subscription/<subscriptionid>
Methods GET, PUT, DELETE
GET Content No Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 369 OF 521
 GET <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>ed126780-3d15-41d9-11d3-
463c592346ab</subscriptionId>
<subscriberId>[email protected]<subscriberId>
<targetIdType>User</targetIdType>
<targetId>[email protected]<targetId>
<event>Basic Call</event>
<expires>4800</expires>
<channelSetId>ChannelSetOne</channelSetId>
<applicationId>AClientApplication</applicationId>
</Subscription>
PUT Content <?xml version="1.0" encoding="UTF-8"?>
<Subscription xmlns="http://schema.broadsoft.com/xsi">
<expires>3600</expires>
</Subscription>
PUT <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>ed126780-3d15-41d9-11d3-
463c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>
DELETE No Content Sent
Content
DELETE No Content Sent
Response
Content

4.6.2.7 system
This command is used by a user, within an allowed scope, to subscribe to events across
an entire Cisco BroadWorks system. A subscription is issued by a subscription owner,
typically a system administrator, against the Cisco BroadWorks system target, for an event
package that identifies the set of events the application is requesting.
Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/system
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 370 OF 521
 Method Description (HTTP contact)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/system
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.8 user/<userid>
This command allows an application to submit an initial subscription for events that are
required by the application. A subscription is issued by a subscription owner, against a
subscription target for an event package, which identifies the set of events the application
is requesting.
Note that Privacy can be enabled for an end-user target, but not for a collection of users
such as a group, service provider/enterprise, or system.
Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/user/<userid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/user/<userid>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 371 OF 521
 Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Advanced Call</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.9 user/<userid>/subId/<subid>
This command allows an application to submit a subscription for events that are required
by the application. A subscription is issued by a subscription owner, against a subscription
target for an event package, which identifies the set of events the application is requesting.
The target is identified by a userid and a subid. This type of subscription can only be
issued against event package that supports subid (for example, Meet-Me Conference
Events explained in section 4.7.19 Meet-Me Conference Events).
Method Description (event channel)
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/user/<userid>/subId/<subid>
Methods POST
POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Meet Me Conference</event>
<expires>3600</expires>
<channelSetId>ChannelSetIdOne</channelSetId>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

Method Description (HTTP contact)

URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/user/<userid>/subId/<targetSubId>
Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 372 OF 521
 POST <?xml version="1.0" encoding="UTF-8"?>
Request <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<event>Meet Me Conference</event>
<expires>3600</expires>
<httpContact>
<uri>172.16.25.114:8800/MyApplication/eventConsumer</ur
i>
</httpContact>
<applicationId>CommPilotApplication</applicationId>
</Subscription>
POST <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content
<subscriptionId>bc123480-3c13-43d9-90d8-
ae3c592346ab</subscriptionId>
<expires>3600</expires>
</Subscription>

4.6.2.10 systemSubscription (AS Only)

The systemsubscription URL command allows a clientApp to subscribe to events for a
Cisco BroadWorks user, group, enterprise, or service provider. A subscription is issued by
a subscription owner (a clientApp in this case), against a subscription target, for an event
package that identifies the set of events the clientApp is interested in receiving. The
subscription command is sent to an Execution Server hosting the subscription target.
The system channel identifier parameter is required for this command.
A success response is always returned for this command.
For more information, consult the document Simplify Notifications to UCaaS and
Collaborate Feature Description [10].
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/systemsubscription?[targetId=]&[targetIdType=
]&[targetGrpParentId=]
Methods POST
POST Request <xsi:Subscription
Content xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:targetIdType>User</xsi:targetIdType>
<xsi:targetId>[email protected]</xsi:ta
rgetId>
<xsi:event>Do Not Disturb</xsi:event>
<xsi:channelSetId>channelSetId0</xsi:channelSetId>
<xsi:applicationId>appId0</xsi:applicationId>
</xsi:Subscription>
POST <Subscription xmlns="http://schema.broadsoft.com/xsi">
Response <subscriptionId>64cdb459-cdd4-44d1-ab1a-
Content a277b000b9f2</subscriptionId></Subscription>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 373 OF 521
 4.6.2.11 systemSubscription/<subscriptionId> (AS Only)
This command is used to query or delete a single subscription by specifying a targetId and
targetIdType.
Xsi-Events responds with a 200 OK containing a subscription element for a GET, an
empty 200 OK response for a DELETE, and a 403 error response for all unsuccessful
responses.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/subscription/<subscriptionid>?[targetId=]&[targetIdT
ype=]&[targetGrpParentId=]
Method(s) GET, DELETE
GET Content No Content
GET <?xml version="1.0" encoding="UTF-8"?>
Response <Subscription xmlns="http://schema.broadsoft.com/xsi">
Content <subscriptionId>64cdb459-cdd4-44d1-ab1a-
a277b000b9f2</subscriptionId>
<clientId>UCaaS</clientId>
<targetIdType>User</targetIdType>
<targetId>[email protected]</targetId>
<event>Do Not Disturb</event>
<expires>2147483647</expires>
<channelSetId>channelSetId0</channelSetId>
<applicationId>appId0</applicationId>
</Subscription>
DELETE No Content Sent
Content
DELETE No Content Sent
Response
Content

4.6.3 Channel Commands

4.6.3.1 channel
This command establishes a new event channel with Xsi-Events via the HTTP POST
method on the documented URL. This event channel is then used to stream events back
to the external application when event subscriptions in Cisco BroadWorks trigger events.
An event channel is created on behalf of the authorized Cisco BroadWorks subscriber
issuing the command. Multiple event channels can be created that belong to one channel
set; the maximum allowed number of event channels per channel set is a configurable
number. For more information on adding an event channel, see the Cisco BroadWorks
Computer Telephony Integration Interface Specification [2].
Each event channel created must be over a separate streaming HTTP connection. If a
second POST method is issued over an existing streaming HTTP connection, Cisco
BroadWorks does not have access to any HTTP headers or the HTTP URL of this second
POST, possibly resulting in inconsistent event delivery over this second channel.
While creating an event channel, a client application identifies the channel set to which it
belongs. This channel set is a value that is established by the client application and is
used to group event channels into a set. For information on event channel and event
channel set concepts and associated behavior, see the Cisco BroadWorks Computer
Telephony Integration Interface Specification [2].

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 374 OF 521
 A successful channel creation command results in a chunked HTTP response from Xsi-
Events, with the channel identifier as the response content. Clients can use this channel
identifier to modify or remove the event channel. Xsi-Events does not close this streaming
HTTP connection upon delivery of the add channel response content.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-events/v2.0/channel
Methods POST
POST <Channel xmlns="http://schema.broadsoft.com/xsi">
Request <channelSetId>ChannelSetA</channelSetId>
Content
<priority>1</priority>
<weight>50</weight>
<expires>3600</expires>
</Channel>
POST <Channel xmlns="http://schema.broadsoft.com/xsi">
Response <channelId>channelId1</channelId>
Content
<expires>3600</expires>
</Channel>

4.6.3.2 channel/eventresponse
This command is used to acknowledge an event received through a channel. A 200 OK
response is returned by Cisco BroadWorks when processed.
An event response must be sent for each event (except ChannelTerminatedEvent)
received through a channel. Client applications are expected to send this command over
a new, non-streaming HTTP connection.
This command must be invoked on the server that is hosting the streaming connection.
For more information, see section 4.2.1.2 Event Channel.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/channel/eventresponse
Methods POST
POST <EventResponse xmlns="http://schema.broadsoft.com/xsi">
Request <eventID>46228196-3dfa-45c3-a4d5-2e7e53c10d7e</eventID>
Content
<statusCode>200</statusCode>
<reason>OK</reason>
</Channel>
POST
Response No Content
Content

4.6.3.3 channel/<channelId>
This command is used to modify and remove an established event channel.
Deleting a channel causes Cisco BroadWorks to issue a ChannelTerminatedEvent over
the established streaming HTTP connection. Xsi-Events expect client applications to
issue the command to delete a channel, process the resulting ChannelTerminatedEvent,
and only then close the HTTP connection.
Cisco BroadWorks does not expect to receive a response after sending
ChannelTerminatedEvent.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 375 OF 521
 Xsi-Events do not expect this command to be issued via the established streaming HTTP
event channel HTTP connection. Doing this results in invalid behavior as the HTTP
headers and method URL issued are not available. Client applications are expected to
send a channel modification/removal command over a new, non-streaming HTTP
connection.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/channel/<channelId>
Methods PUT, DELETE
PUT <Channel xmlns="http://schema.broadsoft.com/xsi">
Request <expires>3800</expires>
Content
</Channel>
PUT <Channel xmlns="http://schema.broadsoft.com/xsi">
Response <channelId>channelId1</channelId>
Content
<expires>3600</expires>
</Channel>
DELETE
Request No Content Sent
Content
DELETE
Response No Content Sent
Content

4.6.3.4 channel/<channelId>/heartbeat
This command allows the client application to trigger a channel heartbeat. A 200 OK
response is retuned by Cisco BroadWorks if process successfully.
Upon handling this command, Cisco BroadWorks sends a heartbeat message over the
streaming connection identified in the URI. This is to ensure that connectivity to the
remote application remains open. The heartbeat message consists of a channel
heartbeat document and is sent as an individual chunk and appears as follows.
<ChannelHeartbeat xmlns="http://schema.broadsoft.com/xsi"/>

Client applications are expected to send this command over a new, non-streaming HTTP
connection.
This command must be invoked on the server that is hosting the streaming connection.
For more information, see section 4.2.1.2 Event Channel.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/channel/<channelid>/heartbeat
Methods PUT
PUT
Request No Content Sent
Content
PUT
Response No Content Sent
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 376 OF 521
 4.6.3.5 channelset/<channelSetId>
This command is used to retrieve event channel set data, which consists of a list of event
channels belonging to that event channel set, along with channel details.
Client applications are expected to send this command over a new, non-streaming HTTP
connection.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/channelset/<channelSetId>
Methods GET
GET
Request No Content Sent
Content
GET <ChannelSet xmlns="http://schema.broadsoft.com/xsi">
Response <channel>
Content
<channelId>channelIdOne</channelId>
<channelSetId>channelSetOne</channelSetId>
<priority>1</priority>
<weight>50</weight>
<expires>3700</expires>
</channel>
<channel>
<channelId>channelIdTwo</channelId>
<channelSetId>channelSetOne</channelSetId>
<priority>2</priority>
<weight>50</weight>
<expires>3600</expires>
</channel>
</ChannelSet>

4.6.3.6 systemChannel (AS Only)

The systemChannel URL command allows a clientApp to issue a command to all
Execution Servers to create a logical event channel for the delivery of events triggered by
system subscriptions.
The system channel set identifier is required for this command.
A success response indicates a system channel is created on at least one Execution
Server. The success response includes a unique identifier for the channel created. An
error response indicates that no channel has been created for this command.
For more information, see the Simplify Notifications to UCaaS and Collaborate Feature
Description, Release 23.0 [10].
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/systemChannel
Command System channel
Category
Methods POST

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 377 OF 521
 POST <xsi:SystemChannel xmlns:xsi="http://schema.broadsoft.com/xsi">
Request <xsi:channelSetId>channelSetId0</xsi:channelSetId>
Content <xsi:priority>1</xsi:priority>
<xsi:weight>50</xsi:weight>
</xsi:SystemChannel>
POST <SystemChannel xmlns="http://schema.broadsoft.com/xsi">
Response <channelId>e8879c99-f97a-4fce-817c-8787d2a6eda4</channelId>
Content </SystemChannel>

4.6.3.7 systemChannel/<channelId> (AS Only)

The systemChannel/<channelId> URL command allows a clientApp to issue a command
to all Execution Servers to delete a logical event channel previously created by the
systemChannel URL.
The system channel identifier parameter is required for this command.
A success response is always returned for this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/systemChannel/<channelId>
Command System channel
Category
Methods DELETE
DELETE
Request No content
Content
DELETE
Response No content
Content

4.6.3.8 systemChannelSet/<channelSetId> (AS Only)

The systemChannelSet/<channelSetId> URL command allows a clientApp to issue a
command to all Execution Servers to query channel information created for the system
channel set specified by the channelSetId.
The system channel set identifier is required for this command.
A success response is always returned for this command.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/systemChannelSet/<channelSetId>
Command
System channel
Category
Methods GET
GET
Request No content
Content
GET <SystemChannelSet xmlns="http://schema.broadsoft.com/xsi">
Response <channel>
<channelId>a538abe5-5776-41f5-9476-997fe9e98877</channelId>
Content
<channelSetId>channelSetId0</channelSetId>
<priority>1</priority>
<weight>50</weight>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 378 OF 521
 </channel>
</SystemChannelSet>

4.6.4 Version Command

4.6.4.1 Versions (AS Only)

This command allows for the retrieval of Xsi-Events version information. Version
information includes the baseline Xsi version for commands and baseline Xsi version for
event packages, patched commands with their corresponding versions, and patched
event packages with their corresponding version.
Method Description
URI http(s)://<host:port>/com.broadsoft.xsi-
events/v2.0/versions
Command
Category
Versions

Methods GET
GET
Request No Content
Content
GET <?xml version="1.0" encoding="ISO-8859-1"?>
Response <Versions xmlns="http://schema.broadsoft.com/xsi">
Content
<commands>
<baseline>21.0</baseline>
<patchedCommand>
<uri>/v2.0/serviceprovider/%serviceProviderId%</uri>
<version>
<value21.1</value>
</version>
</patchedCommand>
</commands>
<eventPackages>
<baseline>21.0</baseline>
<patchedEventPackage>
<name>Basic Call</name>
<version>
<value>21.1</value>
</version>
<version>
<value>21.2</value>
</version>
<patchedEventPackage>
</eventPackages>
</Versions>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 379 OF 521
 4.7 Events

4.7.1 Call and Conference Events

A call event is an event that reports a change in the state of a call. A conference event is
an event that reports a change in the state of a conference. Call and conference events
are created when subscribing to the Advanced Call event package. Note that the Basic
Call and Standard Call event packages contain only a subset of the events in the
Advanced Call event package. For more information, see section 4.4 Event Packages.

4.7.1.1 Call Events

The following subsections provide detailed information for all available call event types as
follows:
 CallOriginatingEvent
 CallOriginatedEvent
 CallReceivedEvent
 CallAnsweredEvent
 CallHeldEvent
 CallRetrievedEvent
 CallUpdatedEvent
 CallRedirectedEvent
 CallTransferredEvent
 CallReleasingEvent
 CallReleasedEvent
 CallCollectingEvent
 CallPickedUpEvent
 CallBargedInEvent
 CallMonitoredEvent
 CallForwardedEvent
 CallSubscriptionResyncEvent
 CallRecordingStartingEvent
 CallRecordingStartedEvent
 CallRecordingPausedEvent
 CallRecordingResumedEvent
 CallRecordingStoppedEvent
 CallSecurityClassificationUpdatedEvent
 CallClientSessionInfoUpdatedEvent
 HookStatusEvent
 CallDetachedEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 380 OF 521
 4.7.1.1.1 CallOriginatingEvent
A CallOriginatingEvent is generated when a Click-to-Dial request is accepted by Cisco
BroadWorks and an attempt is made to alert the subscriber’s endpoint(s). At this point,
the callId and externalTrackingId are generated and included in the event. The call state
is “Alerting” and the personality is “Click-To-Dial”. The address element of the
remoteParty is set to the dialed phone number.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>46228196-3dfa-45c3-a4d5-2e7e53c10d7e</xsi:eventID>
<xsi:sequenceNumber>8</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>AppCtlId
</xsi:externalApplicationId>
<xsi:subscriptionId>
ceaec03b-a6b7-4681-b4de-287d34cc2b89</xsi:subscriptionId>
<xsi:channelId>
a94890bf-73ae-43d4-87e4-5da75e9a28f7</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallOriginatingEvent">
<xsi:call>
<xsi:callId>callhalf-10201:0</xsi:callId>
<xsi:extTrackingId>62:1</xsi:extTrackingId>
<xsi:personality>Click-to-Dial</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:1012</xsi:address>
<xsi:callType>Unknown</xsi:callType>
</xsi:remoteParty>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271253522275</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.2 CallOriginatedEvent
A CallOriginatedEvent is generated when a call is originated by a subscriber. This occurs
in the following two cases:
 When the calling subscriber manually initiates a call by dialing a destination on its
device.
In this case, a new callId and the externalTrackingId are generated by Cisco
BroadWorks.
 When the remote application has initiated a Click To Dial call.
In this case, a CallOriginatingEvent is generated when the system accepts the
request. Once the subscriber accepts the dial attempt (by going off-hook), then the
call personality changes from “Click-to-Dial” to “Originator”, and a CallOriginatedEvent
is issued. Both the CallOriginatingEvent and CallOriginatedEvent have the same
callId and extTrackingId.
In both cases, the call state is “Alerting” and the personality is “Originator”.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 381 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>302cb2c3-99bd-43a7-ba1b-1fef618e5e81</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7f09c36a-3ee1-44f9-93fc-fe54fbf16519</xsi:subscriptionId>
<xsi:channelId>
4989a025-e801-4150-9bc1-8696c2e4d387</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallOriginatedEvent">
<xsi:call>
<xsi:callId>callhalf-11927:3</xsi:callId>
<xsi:extTrackingId>108:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS3FirstName
subscriberS3LastName</xsi:name>
<xsi:address>tel:1013</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001013;ext=1013</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:startTime>1271273072015</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 382 OF 521
 4.7.1.1.3 CallReceivedEvent
A CallReceivedEvent is generated when a subscriber receives an incoming call. When
subscribed to the Advanced Call event package, the event is generated before service
processing, for example, for Call Forwarding Always (CFA). When subscribed to the
Standard Call or Basic Call event packages, the event is generated after service
processing, when the subscriber’s device receives the incoming call. This event is also
generated when a subscriber is being recalled (for example, for Call Transfer Recall). It
contains information about the caller in the remoteParty element. The call state is
“Alerting” and the personality is “Terminator”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>eaf8103b-1e6f-4f72-b254-8a719ff3ea90</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7f09c36a-3ee1-44f9-93fc-fe54fbf16519</xsi:subscriptionId>
<xsi:channelId>
4989a025-e801-4150-9bc1-8696c2e4d387</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallReceivedEvent">
<xsi:call>
<xsi:callId>callhalf-12215:0</xsi:callId>
<xsi:extTrackingId>108:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:startTime>1271273072015</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 383 OF 521
 4.7.1.1.4 CallAnsweredEvent
A CallAnsweredEvent event is generated when a call, that is originated or received by the
subscriber, is answered.
For a given call, there can be more than one CallAnsweredEvent generated. This
happens when an active call is redirected following a blind transfer. In this case, the call
goes back to the “Alerting” state. Once the transferred destination answers the call, a new
CallAnsweredEvent is generated. As a result, a total of two CallAnsweredEvent have
been received: The first one before the transfer, (since the call was already in the active
state before the transfer) and the second one after the successful transfer.
The answerTime captured in the event always indicates the time of the first call answer.
The call state is “Active”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>8414b50e-77a0-46ae-ad3d-0b2e4b7b0051</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7f09c36a-3ee1-44f9-93fc-fe54fbf16519</xsi:subscriptionId>
<xsi:channelId>
4989a025-e801-4150-9bc1-8696c2e4d387</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallAnsweredEvent">
<xsi:call>
<xsi:callId>callhalf-12215:0</xsi:callId>
<xsi:extTrackingId>108:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271273072015</xsi:startTime>
<xsi:answerTime>1271273073756</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 384 OF 521
 4.7.1.1.5 CallHeldEvent
A CallHeldEvent is generated when a subscriber or remote party holds the call. The event
indicates whether the call was held by the subscriber or remote party. The call state is
“Held” or “Remote Held” depending on which party held the call. Remote party call hold is
only reported for group or enterprise calls in a stand-alone application. In addition, if the
call is already held locally, then the remote party call hold is not reported.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>acfa58d1-a49a-4832-9fe4-60875fe996ba</xsi:eventID>
<xsi:sequenceNumber>12</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
f650bd48-4785-4369-9f2d-16ba3ae6c0a3</xsi:subscriptionId>
<xsi:channelId>
681e0150-6bb5-4888-9758-3ffd056c0c1f</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallHeldEvent">
<xsi:call>
<xsi:callId>callhalf-11283:0</xsi:callId>
<xsi:extTrackingId>18:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Held</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS2FirstName
subscriberS2LastName</xsi:name>
<xsi:address>tel:1012</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001012;ext=1012</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:allowRetrieve />
<xsi:startTime>1271265744119</xsi:startTime>
<xsi:answerTime>1271265745924</xsi:answerTime>
<xsi:heldTime>1271265909363</xsi:heldTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.6 CallRetrievedEvent
A CallRetrievedEvent is generated when the subscriber or remote party retrieves a held
call. The event indicates whether the call was retrieved by the subscriber or remote party.
The call state is “Active”. The remote party call retrieve is only reported for group or
enterprise calls in a stand-alone application. In addition, if the call is already held locally,
then the remote party call retrieved is not reported.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 385 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>ffe89c56-57f3-445b-aa4c-9cb6c558de57</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
c13c9c7b-de6f-4e30-8fc4-784ecb74eca4</xsi:subscriptionId>
<xsi:channelId>
f63b07e0-445f-4bca-8311-ab305cf5402e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallRetrievedEvent">
<xsi:call>
<xsi:callId>callhalf-63879:0</xsi:callId>
<xsi:extTrackingId>536:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS3FirstName
subscriberS3LastName</xsi:name>
<xsi:address>tel:1013</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001013;ext=1013</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271798055993</xsi:startTime>
<xsi:answerTime>1271798058313</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.7 CallUpdatedEvent
A CallUpdatedEvent is generated when call attributes are modified and the call state is not
modified. Examples of these updates are changes to remote party information, changes
to the local endpoint, and changes to personality. A change to a local endpoint occurs
when a subscriber has multiple access endpoints and performs a Call Retrieve from a
phone, and then the AccessEndpoint is modified. A change to personality occurs during a
Directed Call Pickup with Barge-in.
As a result, a remote application must inspect the fields in the CallUpdatedEvent to
determine if a change occurred since the last notification.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 386 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>949dbf49-ef1f-4175-974a-e1ffb6039f03</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
9475a584-7db6-4d47-a2aa-1ca7b10e5e91</xsi:subscriptionId>
<xsi:channelId>
0624d2ee-bf0b-4103-8d17-32dcb766ff8c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallUpdatedEvent">
<xsi:call>
<xsi:callId>callhalf-89339:0</xsi:callId>
<xsi:extTrackingId>23:1</xsi:extTrackingId>
<xsi:personality>Click-to-Dial</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:*98</xsi:address>
<xsi:callType>Unknown</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:allowAnswer />
<xsi:startTime>1271950897182</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.8 CallRedirectedEvent
A CallRedirectedEvent is event is generated when one or more calls are redirected by the
subscriber. The event includes the redirection reason that indicates the type of redirection
(for example, Simultaneous Ringing, Call Forwarding Always, or Blind Transfer). The call
state is set to “Detached”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>2ac1819a-de17-486d-8b06-dd0422c7359f</xsi:eventID>
<xsi:sequenceNumber>9</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 387 OF 521
 b3240ceb-9a4e-4fef-9e30-848817930dd3</xsi:subscriptionId>
<xsi:channelId>
f63b07e0-445f-4bca-8311-ab305cf5402e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallRedirectedEvent">
<xsi:calls>
<xsi:call>
<xsi:callId>callhalf-63883:0</xsi:callId>
<xsi:extTrackingId>536:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Held</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS2FirstName
subscriberS2LastName</xsi:name>
<xsi:address>tel:1012</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001012;ext=1012</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1013</xsi:address>
<xsi:reason>transfer</xsi:reason>
<xsi:redirectTime>1271798576165</xsi:redirectTime>
</xsi:redirect>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:allowRetrieve />
<xsi:startTime>1271798055993</xsi:startTime>
<xsi:answerTime>1271798058313</xsi:answerTime>
<xsi:heldTime>1271798113802</xsi:heldTime>
</xsi:call>
<xsi:call>
<xsi:callId>callhalf-63883:1</xsi:callId>
<xsi:extTrackingId>536:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Detached</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS3FirstName
subscriberS3LastName</xsi:name>
<xsi:address>tel:1013</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001013;ext=1013</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1012</xsi:address>
<xsi:reason>transfer</xsi:reason>
<xsi:redirectTime>1271798576165</xsi:redirectTime>
</xsi:redirect>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 388 OF 521
 <xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:startTime>1271798112635</xsi:startTime>
<xsi:answerTime>1271798114251</xsi:answerTime>
<xsi:detachedTime>1271798576166</xsi:detachedTime>
</xsi:call>
</xsi:calls>
</xsi:eventData>
</xsi:Event>

4.7.1.1.9 CallTransferredEvent
A CallTransferredEvent is generated when a call is transferred by a remote party, resulting
in a call state or externalTrackingId change. This event is only generated for group or
enterprise call redirections. For a transfer with consultation, the extTrackingId and
personality are modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>2f4ddc49-ebf6-4abc-81d6-f35f5728cbf3</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
c13c9c7b-de6f-4e30-8fc4-784ecb74eca4</xsi:subscriptionId>
<xsi:channelId>
f63b07e0-445f-4bca-8311-ab305cf5402e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallTransferredEvent">
<xsi:call>
<xsi:callId>callhalf-63879:0</xsi:callId>
<xsi:extTrackingId>536:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Remote Held</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS3FirstName
subscriberS3LastName</xsi:name>
<xsi:address>tel:1013</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001013;ext=1013</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 389 OF 521
 </xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271798055993</xsi:startTime>
<xsi:answerTime>1271798058313</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.10 CallReleasingEvent
A CallReleasingEvent is generated when a call is connecting to a treatment. The call is
eventually released when the treatment finishes playing or when the subscriber hangs up.
The release cause is set to the appropriate value. The address element of the
remoteParty is set to the dialed digits.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>0dbc6361-ec82-45ff-bc78-33c9112ae4c4</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
af69b323-01a0-4bdd-86c2-3283559da973</xsi:subscriptionId>
<xsi:channelId>
06b47983-554d-49fa-8010-a43c55851094</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallReleasingEvent">
<xsi:call>
<xsi:callId>callhalf-14969:0</xsi:callId>
<xsi:extTrackingId>447:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:releaseCause>
<xsi:internalReleaseCause>User Not
Found</xsi:internalReleaseCause>
<xsi:cdrTerminationCause>111</xsi:cdrTerminationCause>
</xsi:releaseCause>
<xsi:remoteParty>
<xsi:address>tel:10</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271279652256</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 390 OF 521
 4.7.1.1.11 CallReleasedEvent
A CallReleasedEvent is generated when a call is released, by either the subscriber or the
remote party. The event is also generated when the dial request is aborted without the
subscriber going off-hook. The call state is “Released” and the release cause is set.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>79e9706f-676a-4ffd-b24b-dd1ab1f39c41</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
cfb45092-433c-49cf-852c-337ae8f2bcdc</xsi:subscriptionId>
<xsi:channelId>
116f5d24-7756-4517-8276-c9a69a2cadbf</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallReleasedEvent">
<xsi:call>
<xsi:callId>callhalf-11403:0</xsi:callId>
<xsi:extTrackingId>26:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Released</xsi:state>
<xsi:releasingParty>remoteRelease</xsi:releasingParty>
<xsi:remoteParty>
<xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:startTime>1271267126217</xsi:startTime>
<xsi:answerTime>1271267126953</xsi:answerTime>
<xsi:releaseTime>1271269018907</xsi:releaseTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.12 CallCollectingEvent
A CallCollectingEvent is generated when Cisco BroadWorks needs to collect information
by interacting with a subscriber. This event generated in the following two cases:
 When programming a service through a feature access code. This occurs for
instance when a subscriber activates Call Forwarding Always.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 391 OF 521
  When Cisco BroadWorks requires some information before calling the remote party.
This happens for instance when a subscriber invoke the Calling Line ID Blocking
service before dialing. This can also happen when Cisco BroadWorks require an
authentication or accounting code before calling the remote party. Note that in these
cases, the CallCollectingEvent is not generated if the service activation precedes the
setup of a call and the destination is already known from the dialed digits.
The callId and externalTrackingId are generated when the call is established with Cisco
BroadWorks and included in the event. The call state is “Active” and the personality is
“Originator”. The address element of the remoteParty is set to the dialed digits.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>f381f0be-b25e-4552-b102-d6e60a74f4d4</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
4bea32d2-5ddb-415e-a218-8f975d44c57d</xsi:subscriptionId>
<xsi:channelId>
b55a2261-5d10-4a46-b0a1-cc6f63c2ec5b</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallCollectingEvent">
<xsi:call>
<xsi:callId>callhalf-73893:0</xsi:callId>
<xsi:extTrackingId>24:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:*69</xsi:address>
<xsi:callType>Unknown</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271859657027</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.13 CallPickedUpEvent
A CallPickedUpEvent is generated when a call is picked up as a result of a Directed Call
Pickup or Directed Call Pickup with Barge-in where the call state was “Alerting”. The
event is generated against the subscriber for which the call is picked up. The new
externalTrackingId is reported in this event. The call state is “Alerting”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>0b5bcb5c-fc1a-4c2f-84f2-c56126635f90</xsi:eventID>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 392 OF 521
 <xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
462c460e-3517-467d-8462-47093a6604f4</xsi:subscriptionId>
<xsi:channelId>
0624d2ee-bf0b-4103-8d17-32dcb766ff8c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallPickedUpEvent">
<xsi:call>
<xsi:callId>callhalf-89327:0</xsi:callId>
<xsi:extTrackingId>23:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271950879175</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.14 CallBargedInEvent
A CallBargedInEvent is generated when a call is conferenced in as a result of a Directed
Call Pickup with Barge-in. The event is generated against the subscriber for which the call
has been barged in. The new externalTrackingId is reported in this event. The call state
is either “Active” or “Held”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>457c33cf-547c-492c-9851-b59706626395</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
dfa0649f-331a-4a95-a0fe-4f4f528f0b9d</xsi:subscriptionId>
<xsi:channelId>
b62257b5-48b4-42c2-ad57-ffdc2182a3ca</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallBargedInEvent">
<xsi:call>
<xsi:callId>callhalf-75553:0</xsi:callId>
<xsi:extTrackingId>59:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 393 OF 521
 <xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271870620175</xsi:startTime>
<xsi:answerTime>1271870620175</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.15 CallMonitoredEvent
A CallMonitoredEvent is generated when a call is monitored as a result of a Monitor Call
or Monitor Next Call. The new externalTrackingId is reported in this event. The call state
is “Active”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>17b03e1b-7499-478f-b045-
7d5fe34fbb75</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>

<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>085c0648-f286-4027-b107-
3ee2a52fc548</xsi:subscriptionId>
<xsi:channelId>af04ad96-8218-48a8-abec-
8a3cbd215ae5</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallMonitoredEvent">
<xsi:call>
<xsi:callId>callhalf-76977:0</xsi:callId>
<xsi:extTrackingId>143:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS1FirstName
subscriberS1LastName</xsi:name>
<xsi:address>tel:1011</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+15006001011;ext=1011</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 394 OF 521
 <xsi:startTime>1271876443442</xsi:startTime>
<xsi:answerTime>1271876443442</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.16 CallForwarded
A CallForwarded event is generated when a call is forwarded as a result of the application
of a Cisco BroadWorks service (for example, Call Forwarding Always). The call state is
“Alerting” and the personality is “Originator”. The remoteParty value depends on the
service assigned to the subscriber as follows:
 If the subscriber has the Connected Line Identification Presentation assigned, then
the remoteParty specifies where the call was redirected.
 If the subscriber does not have the Connected Line Identification Presentation
assigned, then the remoteParty specifies the destination initially dialed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>6f9a54c1-8743-4c9b-be19-
df8d2c2687fe</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>

<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>565d954d-9c5d-4ec9-8f0a-
88e9b3aa5136</xsi:subscriptionId>
<xsi:channelId>2809487c-4a23-4f43-af28-
c5dccdbf1267</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallForwardedEvent">
<xsi:call>
<xsi:callId>callhalf-12695:0</xsi:callId>
<xsi:extTrackingId>150:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:name>subscriberS3FirstName
subscriberS3LastName</xsi:name>
<xsi:address>tel:1013</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+15006001013;ext=1013</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>[email protected]
-</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1271277128598</xsi:startTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 395 OF 521
 4.7.1.1.17 CallParkRetrieved
A CallParkRetrieved event is generated when a parked call is retrieved. The event is
generated against the subscriber for which the call was parked and now retrieved. The
new externalTrackingId is reported in this event.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>343499f3-455f-4e85-87e8-3dcbd84b3536</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
e747a753-c250-4260-a7c1-6c9634f257ed</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallParkRetrievedEvent">
<xsi:call>
<xsi:callId>callhalf-69:0</xsi:callId>
<xsi:extTrackingId>13:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:name>john2 south</xsi:name>
<xsi:address>tel:602</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987602;ext=602</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1292355282325</xsi:startTime>
<xsi:answerTime>1292355283511</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.18 CallSubscription
The CallSubscription event is issued immediately after a subscription is added or
refreshed, provided that the subscription target is not a collection of subscribers (for
example, a group) and that contact was registered with the subscription.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>083d2b5a-6d83-4847-a63e-593980ab04d0</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 396 OF 521
 <xsi:externalApplicationId>com.broadsoft.remoteapp.routepoint.sg</xsi:ext
ernalApplicationId>
<xsi:subscriptionId>2da63711-46c0-403a-a7c8-
359d0fb9ffa6</xsi:subscriptionId>
<xsi:channelId>875652dd-a09f-4dc9-a5d5-53d480d30531</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallSubscriptionEvent">
<xsi:calls>
<xsi:call>
<xsi:callId>callhalf-2427:0</xsi:callId>
<xsi:extTrackingId>4:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1292254494886</xsi:startTime>
<xsi:answerTime>1292254496345</xsi:answerTime>
</xsi:call>
</xsi:calls>
<xsi:hookStatus>Off-Hook</xsi:hookStatus>
</xsi:eventData>
</xsi:Event>

4.7.1.1.19 CallSubscriptionResyncEvent
The CallSubscriptionResyncEventevent is issued whenever the Application Server shuts
down abnormally.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>b25f06e6-d258-40d4-82eb-245b11aabe00</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>e9c3c03e-dece-4339-95b8-
5cbd2d11d5d7</xsi:subscriptionId>
<xsi:channelId>194d278c-2bd9-4697-a37d-d751ee5df6ec</xsi:channelId>
<xsi:eventData xsi1:type="xsi:CallSubscriptionResyncEvent">
<xsi:calls>
<xsi:call>
<xsi:callId>callhalf-43:0</xsi:callId>
<xsi:extTrackingId>2:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 397 OF 521
 <xsi:state>Held</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:500</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1345220527460</xsi:startTime>
<xsi:answerTime>1345220528485</xsi:answerTime>
<xsi:heldTime>1345220530795</xsi:heldTime>
</xsi:call>
<xsi:call>
<xsi:callId>callhalf-43:1</xsi:callId>
<xsi:extTrackingId>3:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:501</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:startTime>1345220535175</xsi:startTime>
<xsi:answerTime>1345220536085</xsi:answerTime>
</xsi:call>
</xsi:calls>
<xsi:hookStatus>Off-Hook</xsi:hookStatus>
</xsi:eventData>
</xsi:Event>

4.7.1.1.20 CallRecordingStartingEvent
This event is generated when the call recording request has been processed but the
recording cannot be started yet. The recordingState element indicates the state of the
recording is “Pending”. The allowedRecordingControls element is updated to reflect what
controls should be displayed by the client application.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

<xsi:externalApplicationId>http://www.broadsoft.com/application/cal
l-client/my-client</xsi:externalApplicationId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 398 OF 521
 <xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallRecordingStartingEvent">
<xsi:call>
<xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:ad
dressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:recordingState>Pending</xsi:recordingState>
<xsi:allowedRecordingControls>stop</xsi:allowedRecordingControls>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.21 CallRecordingStartedEvent
The CallRecordingStartedEvent is generated when call recording has started successfully.
The existing recorded element is present, the new recordingState element is “Started”,
and the new allowedRecordingControls element is set based on the user’s recording
mode and current recording state.
In a situation in which the call is on hold when the request to start recording occurs, the
CallRecordingStartedEvent is not generated until the call is retrieved from hold and the
recording actually starts.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/call-
client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallRecordingStartedEvent">
<xsi:call>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 399 OF 521
 <xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:recorded/>
<xsi:recordingState>Started</xsi:recordingState>
<xsi:allowedRecordingControls>pause</xsi:allowedRecordingControls>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.22 CallRecordingPausedEvent
This event is generated when call recording is paused. The recordingState element is
updated to indicate the state of the recording is “Paused”. The allowedRecordingControls
element is updated to reflect what controls should be displayed by the client application.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/call-
client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallRecordingPausedEvent">
<xsi:call>
<xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 400 OF 521
 <xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:recorded/>
<xsi:recordingState>Paused</xsi:recordingState>
<xsi:allowedRecordingControls>resume</xsi:allowedRecordingControls>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.23 CallRecordingResumedEvent
This event is generated when call recording is resumed. The recordingState element is
updated to indicate the state of the recording is “Started”. The allowedRecordingControls
element is updated to reflect what controls should be displayed by the client application.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/call-
client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallRecordingResumedEvent">
<xsi:call>
<xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 401 OF 521
 <xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:recorded/>
<xsi:recordingState>Started</xsi:recordingState>
<xsi:allowedRecordingControls>pause</xsi:allowedRecordingControls>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.24 CallRecordingStoppedEvent
The CallRecordingStoppedEvent is generated when the recording is stopped because the
user sent an explicit stop recording request or because the call recording failed.
If this was a successful user-initiated stop recording request, the reason element is set to
“User Requested”. Users who can stop their recording are also allowed to start a new
recording. Since a new recording can be started, the allowedRecordingControls element
is set to “record” and the recordingState element is absent, which indicates that there is no
active recording. Even though the recording has been stopped, the recorded element is
present to indicate that the record command was requested at least once for this call.
If the recording was stopped due to a failure, the reason element is set to “Failure”, the
recordingState element is set to “Failed”, and the allowedRecordingControls element is set
to “none”. Even though the recording has been stopped, the recorded element is still
present to indicate that the record command was requested at least once for this call.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/call-
client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallRecordingStoppedEvent">
<xsi:call>
<xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 402 OF 521
 <xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:recorded/>
<xsi:allowedRecordingControls>record</xsi:allowedRecordingControls>
</xsi:call>
<xsi:reason>User Requested</xsi:reason>
</xsi:eventData>
</xsi:Event>

4.7.1.1.25 CallSecurityClassificationUpdatedEvent
The CallSecurityClassificationUpdatedEvent informs the remote application when there
are changes to the security classification characteristics of a call for users who have the
Security Classification service assigned.
The event contains the name of the call classification level.
The event is generated when:
 There is a change in the call classification level caused by a user changing their user
classification level.
 There is a change in the call classification level caused by a remote user changing
their user classification level.
 There are changes to the parties connected to the call as in complex call scenarios
(that is, transfers) and conference calls.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

<xsi:externalApplicationId>http://www.broadsoft.com/application/cal
l-client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData
xsi1:type="xsi:CallSecurityClassificationUpdatedEvent">
<xsi:call>
<xsi:callId>callhalf-55:0</xsi:callId>
<xsi:extTrackingId>3:1</xsi:extTrackingId>
<xsi:personality>Originator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:501</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 403 OF 521
 <xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1303241567248</xsi:startTime>
<xsi:answerTime>1303241571090</xsi:answerTime>
<xsi:securityClassification>Top Secret
</xsi:securityClassification>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.1.1.26 CallClientSessionInfoUpdatedEvent
The CallClientSessionInfoUpdatedEvent informs the remote application when there are
changes to the client session info for the call. The event includes the client session info.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>949dbf49-ef1f-4175-974a-e1ffb6039f03</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
9475a584-7db6-4d47-a2aa-1ca7b10e5e91</xsi:subscriptionId>
<xsi:channelId>
0624d2ee-bf0b-4103-8d17-32dcb766ff8c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallClientSessionInfoUpdatedEvent">
<xsi:call>
<xsi:callId>callhalf-89339:0</xsi:callId>
<xsi:extTrackingId>23:1</xsi:extTrackingId>
<xsi:personality>Click-to-Dial</xsi:personality>
<xsi:state>Alerting</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:*98</xsi:address>
<xsi:callType>Unknown</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:allowAnswer />
<xsi:startTime>1271950897182</xsi:startTime>
<xsi:clientSessionInfo>abcd123456789</xsi:clientSessionInfo>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 404 OF 521
 4.7.1.1.27 HookStatusEvent
The HookStatusEvent indicates whether the user is “Off-Hook” or “On-Hook”.
The HookStatusEvent is sent to the remote application when the user:
 Originates a call.
 Answers a call.
 Releases a call while not being active on any other call.
 Performs a line seize.
 MGCP device places a call.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>7b9e2e1f-487b-4398-80ba-56c7b7722fdc</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>1f53df49-1752-4c84-a527-
6345de68ed59</xsi:subscriptionId>
<xsi:channelId>d7e2818c-7121-44d2-942a-
69eece1b1884</xsi:channelId>
<xsi:eventData xsi1:type="xsi:HookStatusEvent">
<xsi:hookStatus>Off-Hook</xsi:hookStatus>
</xsi:eventData>
</xsi:Event>

4.7.1.1.28 CallDetachedEvent
The CallDetachedEvent is sent to the remote client application when the call is no longer
being presented to the user and call control actions are no longer available. The event is
generated against the subscriber for which the call was detached. The call state is set to
“Detached” and the detachedTime element is set accordingly.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>734b4453-314c-42d6-903f-8d020df7941e</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/call-
client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>56b9a101-0b23-4eba-8cc5-
2c5124e7b764</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>my data</xsi:uri>
</xsi:httpContact>
<xsi:eventData xsi1:type="xsi:CallDetachedEvent">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 405 OF 521
 <xsi:call>
<xsi:callId>callhalf-7:0</xsi:callId>
<xsi:extTrackingId>1:1</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Detached</xsi:state>
<xsi:remoteParty>
<xsi:address>tel:502</xsi:address>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addres
sOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1363388935243</xsi:startTime>
<xsi:answerTime>1363388940988</xsi:answerTime>
<xsi:detachedTime>1363388940988</xsi:detachedTime>
</xsi:call>
</xsi:eventData>

4.7.1.2 Conference Events

The following subsections provide detailed information for all available conference event
types as follows:
 ConferenceStartedEvent
 ConferenceHeldEvent
 ConferenceRetrievedEvent
 ConferenceUpdatedEvent
 ConferenceReleasedEvent
 ConferenceCallMutedEvent
 ConferenceCallUnmutedEvent
 ConferenceCallMadeDeafEvent
 ConferenceCallMadeUndeafEvent

4.7.1.2.1 ConferenceStartedEvent
A ConferenceStartedEvent is generated when a conference is started. The conference
state is “Active”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>542100ce-e2f5-4e21-8a76-53c86d97c9fd</xsi:eventID>
<xsi:sequenceNumber>44</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
66c6e8e4-090b-4be7-b2b7-32f507625eed</xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 406 OF 521
 <xsi:channelId>
b62257b5-48b4-42c2-ad57-ffdc2182a3ca</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceStartedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceType>Silently Monitored</xsi:conferenceType>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-75923:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-75923:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.2 ConferenceHeldEvent
A ConferenceHeldEvent is generated when the conference is put on hold. The
conference state is “Held”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e4608d7c-1154-4e52-afc4-dc07ac382e81</xsi:eventID>
<xsi:sequenceNumber>13</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
baae6a39-cf9f-4420-91a4-8dd734248176</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceHeldEvent">
<xsi:conference>
<xsi:state>Held</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24131:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24131:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 407 OF 521
 </xsi:Event>

4.7.1.2.3 ConferenceRetrievedEvent
A ConferenceRetrievedEvent is generated when the conference is retrieved from hold.
The conference state is “Active”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>ced79306-2fcb-4140-a264-8792e526cfd5</xsi:eventID>
<xsi:sequenceNumber>14</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
baae6a39-cf9f-4420-91a4-8dd734248176</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceRetrievedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24131:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24131:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.4 ConferenceUpdatedEvent
A ConferenceUpdatedEvent is generated when conference elements are modified and the
conference state is not modified. Examples of these updates are changes to the local
endpoint, adding a participant, or removing a participant. A change to a local endpoint
occurs when a subscriber performs a Call Retrieve from a phone and then the
AccessEndpoint is expected to be modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>3dc68d4e-468f-4e9e-8dec-f5d152734905</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 408 OF 521
 4fb8ba19-a2bc-4dd2-abc2-3fcd56c492a4</xsi:subscriptionId>
<xsi:channelId>
115a6437-74d8-4348-9145-3dabff3c2b1a</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceUpdatedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceType>Supervisor Coached</xsi:conferenceType>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24423:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24423:1</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-24423:8</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.5 ConferenceReleasedEvent
The ConferenceReleasedEvent is generated when the conference is released. The
conference state is “Released”.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>cd330db8-3b1c-4dc3-8df4-39208b499f6f</xsi:eventID>
<xsi:sequenceNumber>28</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
de44fd4b-216a-41ee-a4c8-1df3c7076760</xsi:subscriptionId>
<xsi:channelId>
2a17a4d9-02b3-4d0f-bc41-58ac8c1937fa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceReleasedEvent">
<xsi:conference>
<xsi:state>Released</xsi:state>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 409 OF 521
 4.7.1.2.6 ConferenceCallMutedEvent
A ConferenceCallMutedEvent is generated when a call is muted through a Conference
Mute Call request.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>87d93632-12ab-42fd-b0ed-a569ea3d85e8</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceCallMutedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:muted />
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.7 ConferenceCallUnmutedEvent
A ConferenceCallUnmutedEvent is generated when a call is no longer muted through a
Conference UnMute Call request.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>80ee175c-be9e-48bc-be51-d89a6c339a48</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceCallUnMutedEvent">
<xsi:conference>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 410 OF 521
 <xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.8 ConferenceCallMadeDeafEvent
A ConferenceCallMadeDeafEvent is generated when a call is made deaf through a
Conference Deaf Call request.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>691af518-0ab3-462d-a724-6dabadfa70be</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceCallMadeDeafEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:deaf />
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 411 OF 521
 4.7.1.2.9 ConferenceCallMadeUndeafEvent
A ConferenceCallMadeUndeafEvent is generated when a call is no longer deaf through a
Conference Undeaf call.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>df87802e-119b-439f-b220-d2178c7eb74b</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceCallMadeUnDeafEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.10 ConferenceMutedEvent
The event is sent when the controller of a conference is muted.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>df87802e-119b-439f-b220-d2178c7eb74b</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceMutedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 412 OF 521
 <xsi:addressOfRecord>[email protected]</xsi:addressOfRecord
>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:muted/>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-32343:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-32343:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.1.2.11 ConferenceUnmutedEvent
The event is sent when the controller of a conference is muted.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>df87802e-119b-439f-b220-d2178c7eb74b</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
5c43fc11-ca31-4142-9756-ff8559c4eb9d</xsi:subscriptionId>
<xsi:channelId>
d7de7b9b-6335-441a-aba6-b2d7dbd4dc74</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ConferenceUnmutedEvent">
<xsi:conference>
<xsi:state>Active</xsi:state>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:addressOfRecord
>
</xsi:endpoint>
<xsi:appearance>2</xsi:appearance>
<xsi:conferenceParticipantList>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-27:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-27:1</xsi:callId>
</xsi:conferenceParticipant>
</xsi:conferenceParticipantList>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 413 OF 521
 4.7.2 Route Point Events
A Route Point event is an event that reports a change associated with a call maintained in
a Route Point queue. Route Point events are generated when subscribing to the Route
Point Queue event package.
The following subsections provide detailed information for all available Route Point event
types as follows:
 RoutePointCallAddedEvent
 RoutePointCallOfferedtoAgentEvent
 RoutePointCallAnsweredbyAgentEvent
 RoutePointCallAbandonedEvent
 RoutePointCallOverflowedEvent
 RoutePointCallTransferredEvent
 RoutePointCallUpdatedEvent
 RoutePointCallBouncedEvent
 RoutePointCallForwardedEvent
 RoutePointCallReleasedEvent
 RoutePointCallFailedEvent
 RoutePointOutgoingCallOriginatedEvent
 RoutePointOutgoingCallAnsweredEvent
 RoutePointTreatmentStartedEvent
 RoutePointTreatmentCompletedEvent
 RoutePointMOHStartedEvent
 RoutePointMOHCompletedEvent
 RoutePointRingbackStartedEvent
 RoutePointRingbackCompletedEvent
 RoutePointBusyStartedEvent
 RoutePointBusyCompletedEvent
 RoutePointSilenceStartedEvent
 RoutePointSilenceCompletedEvent
 RoutePointWhisperStartedEvent
 RoutePointFailedEvent
 RoutePointRecoveredEvent
 RoutePointSubscriptionEvent
 RoutePointSubscriptionResyncEvent
 RoutePointNewCallEvent
 RoutePointCallRejectedEvent

4.7.2.1 RoutePointCallAddedEvent
A RoutePointCallAddedEvent is generated when a new call is added to a Route Point
queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 414 OF 521
 <xsi:eventID>1e080356-2c5a-45b9-89b1-70b9fc1a29ac</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallAddedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.2 RoutePointCallOfferedtoAgentEvent
A RoutePointCallOfferedEvent is generated when a remote application transfers a call
from a Route Point queue to an agent. This event indicates that the call is offered to the
agent but remains in the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>cb322733-3243-402d-bc0c-5ca8fafdfba7</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallOfferedToAgentEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:eventData>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 415 OF 521
 </xsi:Event>

4.7.2.3 RoutePointCallAnsweredByAgentEvent
A RoutePointCallAnsweredByAgentEvent is generated after a call has been offered to an
agent, the agent has decided to accept the call, and the call has been removed from the
queue. The removeTime element is set to the time when the call was removed from the
queue (that is, answered by an agent).
Note that if a whisper message is played to the agent, then this event is generated at the
end of the whisper message.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e41f8466-13a7-4f8f-ad37-ceea24351948</xsi:eventID>
<xsi:sequenceNumber>9</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:RoutePointCallAnsweredByAgentEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:removeTime>1271449549576</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:answeringUserId>
[email protected]</xsi:answeringUserId>
<xsi:answeringCallId>callhalf-31175:0</xsi:answeringCallId>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.4 RoutePointCallAbandonedEvent
A RoutePointCallAbandonedEvent is generated after a call is released by a remote party
while being in the Route Point queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>41dd7c1d-6369-448b-b36c-d166990ac26c</xsi:eventID>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 416 OF 521
 <xsi:sequenceNumber>18</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
51cd2322-df6b-4249-b33d-a9927fe984d7</xsi:subscriptionId>
<xsi:channelId>
cdc704c3-3f89-4b3b-bccc-10ba0abe29ad</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallAbandonedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-30337:0</xsi:callId>
<xsi:extTrackingId>312:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271443969817</xsi:addTime>
<xsi:removeTime>1271444140325</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.5 RoutePointCallOverflowedEvent
A RoutePointCallOverflowedEvent is generated after a call is marked as “overflow”. The
overFlowReason specifies the cause of the overflow.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>5539b571-3d2f-49a9-b555-8f7f91904aad</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
42e520bf-51f1-4c89-9a35-851009bcc847</xsi:subscriptionId>
<xsi:channelId>
c35e8826-85b6-4088-abd2-2ca7716943ed</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallOverflowedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31629:0</xsi:callId>
<xsi:extTrackingId>427:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271452711590</xsi:addTime>
<xsi:removeTime>1271452721598</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:overFlowReason>time</xsi:overFlowReason>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 417 OF 521
 <xsi:redirect>
<xsi:address>tel:1025</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271452721616</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.2.6 RoutePointCallTransferred
The RoutePointCallTransferredEvent is generated when the remote application performs
a blind transfer against a call queued in a Route Point.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>fb9a4fc1-d056-442c-b244-45cfba9f618b</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
16fb2483-7651-4067-b0a4-807b5f854d6d</xsi:subscriptionId>
<xsi:channelId>
5bdbfbf2-038f-4c64-9032-672ee914f69b</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallTransferredEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-29713:0</xsi:callId>
<xsi:extTrackingId>252:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271439887783</xsi:addTime>
<xsi:removeTime>1271439923771</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:redirect>
<xsi:address>tel:5006001011</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271439923771</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.2.7 RoutePointCallUpdatedEvent
A RoutePointCallUpdatedEvent is generated in the following cases:
 When the extTrackingId has been changed, (this can happen following a consultation
transfer).
 When the call progress detection (CPD) result is available for an outgoing dial.
 When the remote party information has been modified.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 418 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>7adb60f5-da38-42ba-b2a5-fbb609289ff6</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
55c1b1bf-93ac-4bb7-a18e-2e2d31e57e82</xsi:subscriptionId>
<xsi:channelId>
4bfbfdd1-e992-49c2-ad2d-764c282b7db8</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallUpdatedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-77621:0</xsi:callId>
<xsi:extTrackingId>175:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN2FirstName NetworkN2LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003334</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271879264315</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:reason>Call Transferred</xsi:reason>
</xsi:eventData>
</xsi:Event>

4.7.2.8 RoutePointCallBouncedEvent
A RoutePointCallBouncedEvent is generated after a call is bounced. The event reports
that the call has been bounced by adding the bounced element to the queueEntry in the
event. This element is maintained in all future events until the call is removed from the
Route Point queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>eba9df6a-2ca1-49a6-b5ae-19b614ce104c</xsi:eventID>
<xsi:sequenceNumber>15</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
51cd2322-df6b-4249-b33d-a9927fe984d7</xsi:subscriptionId>
<xsi:channelId>
cdc704c3-3f89-4b3b-bccc-10ba0abe29ad</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallBouncedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-30337:0</xsi:callId>
<xsi:extTrackingId>312:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 419 OF 521
 <xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271443969817</xsi:addTime>
<xsi:bounced/>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.9 RoutePointCallForwardedEvent
A RoutePointCallForwardedEvent is generated when a call is forwarded following the
application of the Forced Forwarding policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>56a625ea-45a4-4e50-a741-6061d35f8ada</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
5f496571-8177-4257-b303-b14909ae4966</xsi:subscriptionId>
<xsi:channelId>
9488b2a7-abb4-4dd3-b0f4-0ea7ea4ce0e2</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallForwardedEvent">
<xsi:callId>callhalf-78933:0</xsi:callId>
<xsi:extTrackingId>303:1</xsi:extTrackingId>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1011</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271882708100</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.2.10 RoutePointCallReleasedEvent
A RoutePointCallReleasedEvent is generated in the following cases:
 Following a Route Point Release Call request.
 When an outgoing call is released during the call setup, in which case the Call
Progress Detection (CPD) result is provided (if available).
The removeTime is set to the time the call was released.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 420 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>48fc51b0-3332-4e00-a162-2a9c1960b8ae</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
33df61df-ae00-4494-96c5-72f5faa07653</xsi:subscriptionId>
<xsi:channelId>
e4d4c6c1-611b-4d4a-a00f-127fbca994bf</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallReleasedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-30871:0</xsi:callId>
<xsi:extTrackingId>360:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271446626899</xsi:addTime>
<xsi:removeTime>1271446701922</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.11 RoutePointCallFailedEvent
A RoutePointCallFailedEvent is generated in the following cases:
 When the Route Point per call failure policy is triggered. This can happen for instance
if no request is received for a call within the configurable time period after being added
to the queue.
 When the Route Point failure policy is triggered. This can happen for instance when a
remote application sends a Route Point Fail request and a call is queued at the Route
Point. This can also occur when a call is received for a failed Route Point.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>40ecabfd-e007-4599-8c2e-decd1fffd651</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
42e520bf-51f1-4c89-9a35-851009bcc847</xsi:subscriptionId>
<xsi:channelId>
c35e8826-85b6-4088-abd2-2ca7716943ed</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointCallFailedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31515:0</xsi:callId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 421 OF 521
 <xsi:extTrackingId>417:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271451627658</xsi:addTime>
<xsi:removeTime>1271451651839</xsi:removeTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:failureReason>CallFailureRequested</xsi:failureReason>
</xsi:eventData>
</xsi:Event>

4.7.2.12 RoutePointOutgoingCallOriginatedEvent
A RoutePointOutgoingCallOriginatedEvent is generated when a call is being originated
following an Outgoing Dial action but before the call is added to the Route Point queue.
The outgoingCall element is present to mark the call permanently as an outbound call.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>02b4d14d-5355-40fc-8e12-52fff7b9c0cb</xsi:eventID>
<xsi:sequenceNumber>19</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
99e6fd92-02b3-45e9-9ef5-5a963dba68a7</xsi:subscriptionId>
<xsi:channelId>
d0b58538-045a-4afc-8fe3-51ad1d418cd3</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:RoutePointOutgoingCallOriginatedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-46773:0</xsi:callId>
<xsi:extTrackingId>627:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271682060161</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:outgoingCall />
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 422 OF 521
 4.7.2.13 RoutePointOutgoingCallAnsweredEvent
A RoutePointOutgoingCallAnsweredEvent is generated when a call is answered by the
remote destination. The OutgoingCallAnswerTime is set to the time the call was
answered.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>00591533-1e98-412a-ae58-571ee4d8ad7f</xsi:eventID>
<xsi:sequenceNumber>20</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
99e6fd92-02b3-45e9-9ef5-5a963dba68a7</xsi:subscriptionId>
<xsi:channelId>
d0b58538-045a-4afc-8fe3-51ad1d418cd3</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:RoutePointOutgoingCallAnsweredEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-46773:0</xsi:callId>
<xsi:extTrackingId>627:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271682060161</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:outgoingCall />
<xsi:outgoingCallAnswerTime>
1271682062229</xsi:outgoingCallAnswerTime>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.14 RoutePointSubscriptionEvent
A RoutePointSubscriptionEvent is generated immediately after a subscription is added or
refreshed, provided that the subscription target is not a collection of subscribers (for
example, a group) and that contacts were registered with the subscription.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>c00e01a6-01a1-4d3a-89fe-242399e63cd1</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3b1d8c3d-7b03-4f0a-875a-d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 423 OF 521
 <xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointSubscriptionEvent">
<xsi:queueEntries>
<xsi:queueEntry>
<xsi:callId>callhalf-93:0</xsi:callId>
<xsi:extTrackingId>18:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292355490605</xsi:addTime>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:queueEntries>
</xsi:eventData>
</xsi:Event>

4.7.2.15 RoutePointHolidayPolicyAppliedEvent
A RoutePointHolidayPolicyAppliedEvent is generated when a call is treated according to
the Holiday policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>4ad5f5c0-0ce6-4c6d-b9c3-bbe8eb883e8a</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
c09f2dee-32ab-4408-9ea9-cb9806331191</xsi:subscriptionId>
<xsi:channelId>
e89e1bb5-5223-4af1-849d-0e468ee9c07c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:RoutePointHolidayPolicyAppliedEvent">
<xsi:callId>callhalf-79297:0</xsi:callId>
<xsi:extTrackingId>324:1</xsi:extTrackingId>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1011</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271884332716</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 424 OF 521
 4.7.2.16 RoutePointNightPolicyAppliedEvent
A RoutePointNightPolicyAppliedEvent is generated when a call is treated according to the
Night policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>7e26c0d6-fe20-46f9-a1f9-183f17b6c101</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3b1d8c3d-7b03-4f0a-875a-d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointNightPolicyAppliedEvent">
<xsi:callId>callhalf-101:0</xsi:callId>
<xsi:extTrackingId>19:1</xsi:extTrackingId>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
</xsi:eventData>
</xsi:Event>

4.7.2.17 RoutePointTreatmentStartedEvent
A RoutePointTreatmentStartedEvent is generated when a play treatment is started. The
event specifies the playCollectId of the operation.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>68659f75-a31c-4864-b0dd-b8d57ab17dc0</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointTreatmentStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 425 OF 521
 <xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:playCollectType>Treatment</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.18 RoutePointTreatmentCompletedEvent
A RoutePointTreatmentCompletedEvent is generated when a play treatment is
completed. The playCollectResult element contains the detail of the playback and DTMF
data collection (if any) while the queueEntry identifies the call in the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>51c08374-4e68-402c-8c64-178d42cd5e51</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointTreatmentCompletedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:playCollectResult>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:completionReason>EOF</xsi:completionReason>
</xsi:playCollectResult>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 426 OF 521
 4.7.2.19 RoutePointMOHStartedEvent
A RoutePointMOHStartedEvent is generated when a Music On Hold (MOH) treatment is
started. The event specifies the playCollectId of the operation.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>24b2b5e1-3d0c-413a-8600-805cf75738b3</xsi:eventID>
<xsi:sequenceNumber>16</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
51cd2322-df6b-4249-b33d-a9927fe984d7</xsi:subscriptionId>
<xsi:channelId>
cdc704c3-3f89-4b3b-bccc-10ba0abe29ad</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointMOHStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-30337:0</xsi:callId>
<xsi:extTrackingId>312:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271443969817</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:playCollectType>MOH</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 427 OF 521
 4.7.2.20 RoutePointMOHCompletedEvent
A RoutePointMOHCompletedEvent is generated when a play Music On Hold is
completed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>d75ee47f-ec37-4362-98eb-20ee0a305140</xsi:eventID>
<xsi:sequenceNumber>17</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
51cd2322-df6b-4249-b33d-a9927fe984d7</xsi:subscriptionId>
<xsi:channelId>
cdc704c3-3f89-4b3b-bccc-10ba0abe29ad</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointMOHCompletedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-30337:0</xsi:callId>
<xsi:extTrackingId>312:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271443969817</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:playCollectResult>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:completionReason>EOF</xsi:completionReason>
</xsi:playCollectResult>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 428 OF 521
 4.7.2.21 RoutePointRingbackStartedEvent
A RoutePointRingbackStartedEvent is generated when a ringback is started. The event
specifies the playCollectId of the operation.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>db4bab43-d968-4a24-98f3-70a0fa0ab73e</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3b1d8c3d-7b03-4f0a-875a-d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointRingbackStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-117:0</xsi:callId>
<xsi:extTrackingId>21:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292355745517</xsi:addTime>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:playCollectType>Ringback</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 429 OF 521
 4.7.2.22 RoutePointRingbackCompletedEvent
A RoutePointRingbackCompletedEvent is generated when a play ringback is completed.
The playCollectResult element contains the detail of the playback and DTMF data
collection (if any) while the queueEntry identifies the call in the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>ad7549e6-50ac-4934-ab7f-4b7324add063</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3b1d8c3d-7b03-4f0a-875a-d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointRingbackCompletedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-117:0</xsi:callId>
<xsi:extTrackingId>21:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292355745517</xsi:addTime>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>1</xsi:playCollectId>
<xsi:playCollectType>Silence</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
<xsi:playCollectResult>
<xsi:playCollectId>0</xsi:playCollectId>
<xsi:completionReason>
Stopped-NewPlayCollect</xsi:completionReason>
</xsi:playCollectResult>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 430 OF 521
 4.7.2.23 RoutePointBusyStartedEvent
A RoutePointBusyStartedEvent is generated when a busy treatment is started. The event
specifies the playCollectId of the operation.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>b372980b-415f-4f59-8747-d6d23990b620</xsi:eventID>
<xsi:sequenceNumber>10</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3b1d8c3d-7b03-4f0a-875a-d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>
c754b4a2-7c5e-49a3-b6d7-3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointBusyStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-117:0</xsi:callId>
<xsi:extTrackingId>21:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292355745517</xsi:addTime>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>2</xsi:playCollectId>
<xsi:playCollectType>Busy</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 431 OF 521
 4.7.2.24 RoutePointBusyCompletedEvent
A RoutePointBusyCompletedEvent is generated when a play busy is completed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>4a185799-5d54-4b82-97dd-8657151ba58e</xsi:eventID>
<xsi:sequenceNumber>11</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>com.broadsoft.remoteapp.routepoint.sg
</xsi:externalApplicationId>
<xsi:subscriptionId>3b1d8c3d-7b03-4f0a-875a-
d99418e64a1d</xsi:subscriptionId>
<xsi:channelId>c754b4a2-7c5e-49a3-b6d7-
3ff6e06ebb1e</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointBusyCompletedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-117:0</xsi:callId>
<xsi:extTrackingId>21:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292355745517</xsi:addTime>
<xsi:routePointName>routepoint</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15146987612</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>3</xsi:playCollectId>
<xsi:playCollectType>Silence</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
<xsi:playCollectResult>
<xsi:playCollectId>2</xsi:playCollectId>
<xsi:completionReason>Stopped-NewPlayCollect
</xsi:completionReason>
</xsi:playCollectResult>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 432 OF 521
 4.7.2.25 RoutePointSilenceStartedEvent
A RoutePointSilenceStartedEvent is generated when a play silence is started. The event
specifies the playCollectId of the operation.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>fad528a2-1c8c-4785-b32a-01b2915ea91b</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointSilenceStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:playCollectInfo>
<xsi:playCollectId>1</xsi:playCollectId>
<xsi:playCollectType>Silence</xsi:playCollectType>
</xsi:playCollectInfo>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 433 OF 521
 4.7.2.26 RoutePointSilenceCompletedEvent
A RoutePointSilenceCompletedEvent is generated when a play silence is completed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>78fe6ed0-f32a-4952-bf66-1cf54eb475b5</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointSilenceCompletedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
</xsi:queueEntry>
<xsi:playCollectResult>
<xsi:playCollectId>1</xsi:playCollectId>
<xsi:completionReason>EOF</xsi:completionReason>
</xsi:playCollectResult>
</xsi:eventData>
</xsi:Event>

4.7.2.27 RoutePointWhisperStartedEvent
A RoutePointWhisperStartedEvent is generated when a whisper message is started.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>64fdc43f-6212-4a82-82b7-9f2de10a5b99</xsi:eventID>
<xsi:sequenceNumber>8</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
645aa4dd-5388-472c-8d66-4da9ead72592</xsi:subscriptionId>
<xsi:channelId>
6f1400ca-b86d-4cfe-8b91-0aad6e9b7efa</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointWhisperStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-31157:0</xsi:callId>
<xsi:extTrackingId>389:1</xsi:extTrackingId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 434 OF 521
 <xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271449361084</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber countryCode="1">
tel:+15006001030</xsi:routePointNumber>
<xsi:answeringUserId>
[email protected]</xsi:answeringUserId>
<xsi:answeringCallId>callhalf-31175:0</xsi:answeringCallId>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.2.28 RoutePointFailedEvent
A RoutePointFailedEvent is generated when a Route Point enters the “Failed” state.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e283fc20-a270-4941-8661-9db98c0304f4</xsi:eventID>
<xsi:sequenceNumber>22</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
270a9775-87a0-4a30-8455-cb75e5c62ec2</xsi:subscriptionId>
<xsi:channelId>
a405e60d-087d-4fc4-82ac-4ae260b81f8d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointFailedEvent">
<xsi:stateChangeReason>ExternalRequest</xsi:stateChangeReason>
</xsi:eventData>
</xsi:Event>

4.7.2.29 RoutePointRecoveredEvent
A RoutePointRecoveredEvent is generated when a Route Point enters the “Normal” state.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>4352ec41-d8da-44a1-8a95-621062314618</xsi:eventID>
<xsi:sequenceNumber>25</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
270a9775-87a0-4a30-8455-cb75e5c62ec2</xsi:subscriptionId>
<xsi:channelId>
a405e60d-087d-4fc4-82ac-4ae260b81f8d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RoutePointRecoveredEvent" />

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 435 OF 521
 </xsi:Event>

4.7.2.30 RoutePointSubscriptionResyncEvent
A RoutePointSubscriptionResyncEvent is generated whenever the Application Server
shuts down abnormally.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>b252c783-c6f1-40c0-a330-a804376b3bbb</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4fe7fc20-a70f-4e2c-8486-
863cf67d313d</xsi:subscriptionId>
<xsi:channelId>15e0d0fa-bdce-478b-9be8-a3933765c0d1</xsi:channelId>
<xsi:eventData xsi1:type="xsi:RoutePointSubscriptionResyncEvent">
<xsi:queueEntries>
<xsi:queueEntry>
<xsi:callId>callhalf-79:0</xsi:callId>
<xsi:extTrackingId>4:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john0 north</xsi:name>
<xsi:address>tel:500</xsi:address>

<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726996500;ext=500</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1345222716648</xsi:addTime>
<xsi:routePointName>RoutePointName</xsi:routePointName>
<xsi:routePointNumber
countryCode="1">tel:+19726996519</xsi:routePointNumber>
</xsi:queueEntry>
</xsi:queueEntries>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 436 OF 521
 4.7.2.30.1 RoutePointNewCallEvent
A RoutePointNewCallEvent is generated when a new call is received at the route point.
This event is only sent when Call Admission is enabled for the route point.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>5b7c900a-0535-46f2-8b07-
5f85532a51da</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

<xsi:externalApplicationId>ac1</xsi:externalApplicationId>
<xsi:subscriptionId>8d2efba2-f7ce-4331-b35d-
2b13f7a2543a</xsi:subscriptionId>
<xsi:channelId>c963af94-665c-4edb-bc27-
7188077f3b43</xsi:channelId>
<xsi:eventData xsi1:type="xsi:RoutePointNewCallEvent">
<xsi:callId>callhalf-2023:0</xsi:callId>
<xsi:extTrackingId>28623d37-8cc6-4135-b206-
00d98cc69093</xsi:extTrackingId>

<xsi:routePointName>southRoutePoint</xsi:routePointName>
<xsi:routePointNumber
countryCode="1">tel:+19726969610</xsi:routePointNumber>
<xsi:remoteParty>
<xsi:name>john1 south</xsi:name>
<xsi:address>tel:601</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726969601;ext=601</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:receiveTime>1547729501253</xsi:receiveTime>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 437 OF 521
 4.7.2.30.2 RoutePointCallRejectedEvent
A RoutePointCallRejectedEvent is generated when the call is rejected. A call can be
rejected at the request of the remote application by call admission time-out or when the
call is abandoned. This event is only sent when Call Admission is enabled for the route
point.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>e2dd1ab3-ca7d-411b-b356-
17cfc0662216</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

<xsi:externalApplicationId>ac1</xsi:externalApplicationId>
<xsi:subscriptionId>a0e6843d-21ae-4b62-8554-
2fc9d3cdd1a5</xsi:subscriptionId>
<xsi:channelId>50441369-9e27-41a2-a9d5-
7413755653bb</xsi:channelId>
<xsi:eventData
xsi1:type="xsi:RoutePointCallRejectedEvent">
<xsi:callId>callhalf-2303:0</xsi:callId>
<xsi:extTrackingId>27df75ac-2d2e-4346-9a00-
5fbcef45cf99</xsi:extTrackingId>

<xsi:routePointName>southRoutePoint</xsi:routePointName>
<xsi:routePointNumber
countryCode="1">tel:+19726969610</xsi:routePointNumber>
<xsi:remoteParty>
<xsi:name>john1 south</xsi:name>
<xsi:address>tel:601</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726969601;ext=601</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>

<xsi:rejectReason>CallRejectRequested</xsi:rejectReason>
</xsi:eventData>
</xsi:Event>

4.7.3 Automatic Call Distribution Events

An Automatic Call Distribution (ACD) event is an event that reports a change associated
with a call maintained in an ACD queue. ACD events are generated when subscribing to
the Call Center Queue event package.
The following subsections provide detailed information for all the available ACD event
types as follows:
 ACDCallAddedEvent
 ACDCallOfferedToAgentEvent
 ACDCallAnsweredByAgentEvent
 ACDCallAbandonedEvent
 ACDCallReleasedEvent

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 438 OF 521
  ACDCallOverflowedEvent
 ACDCallTransferredEvent
 ACDCallUpdatedEvent
 ACDCallBouncedEvent
 ACDCallForwardedEvent
 ACDCallReorderedEvent
 ACDCallPromotedEvent
 ACDCallStrandedEvent
 ACDCallEscapedEvent
 ACDSubscriptionEvent
 ACDHolidayPolicyAppliedEvent
 ACDNightPolicyAppliedEvent
 ACDWhisperStartedEvent
 ACDSubscriptionResyncEvent

4.7.3.1 ACDCallAddedEvent
An ACDCallAddedEvent is generated when a new call is added to the ACD queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>689984d9-3959-45ce-822b-9b37a963f653</xsi:eventID>
<xsi:sequenceNumber>10</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallAddedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53149:0</xsi:callId>
<xsi:extTrackingId>90:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271711961291</xsi:addTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271711961291</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:position>1</xsi:position>
</xsi:eventData>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 439 OF 521
 </xsi:Event>

4.7.3.2 ACDCallOfferedToAgentEvent
An ACDCallOfferedToAgentEvent is generated when the ACD transfers the call to an
agent. This event indicates that the call is offered to the agent but remains in the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>a167add9-0654-452c-8716-1d245903785d</xsi:eventID>
<xsi:sequenceNumber>11</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallOfferedToAgentEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53149:0</xsi:callId>
<xsi:extTrackingId>90:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271711961291</xsi:addTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271711961291</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.3 ACDWhisperStartedEvent
An ACDWhisperStartedEvent is generated after a call has been offered to an agent, the
agent has decided to accept the call, and the call has been removed from the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>668babba-1865-4a8d-a1ff-77ece8f24886</xsi:eventID>
<xsi:sequenceNumber>12</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 440 OF 521
 <xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDWhisperStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53149:0</xsi:callId>
<xsi:extTrackingId>90:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271711961291</xsi:addTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271711961291</xsi:addTimeInPriorityBucket>
<xsi:answeringUserId>
[email protected]</xsi:answeringUserId>
<xsi:answeringCallId>callhalf-53153:0</xsi:answeringCallId>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.4 ACDWhisperStartedEvent
An ACDWhisperStartedEvent is generated when a whisper message is started.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>668babba-1865-4a8d-a1ff-77ece8f24886</xsi:eventID>
<xsi:sequenceNumber>12</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDWhisperStartedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53149:0</xsi:callId>
<xsi:extTrackingId>90:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271711961291</xsi:addTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271711961291</xsi:addTimeInPriorityBucket>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 441 OF 521
 <xsi:answeringUserId>
[email protected]</xsi:answeringUserId>
<xsi:answeringCallId>callhalf-53153:0</xsi:answeringCallId>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.5 ACDCallOverflowedEvent
An ACDCallOverflowedEvent is generated after a call is marked as “overflowed”. The
overFlowReason specifies the cause of the overflow.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>3e1f6a19-5861-41f5-9342-99d2d9fb9938</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
1f0bad27-2945-45c3-acfc-556e20b5d931</xsi:subscriptionId>
<xsi:channelId>
f4e45903-2b01-4cfc-86bd-56a73d674560</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallOverflowedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53349:0</xsi:callId>
<xsi:extTrackingId>103:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271713802660</xsi:addTime>
<xsi:removeTime>1271713812670</xsi:removeTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271713802660</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:overflowReason>time</xsi:overflowReason>
<xsi:redirect>
<xsi:address>tel:1026</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271713812671</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 442 OF 521
 4.7.3.6 ACDCallAbandonedEvent
An ACDCallAbandonedEvent is generated after a call has been abandoned by a remote
application (for example, a Cisco BroadWorks client).
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>996c7386-8ce8-4e4e-803d-993064a287c7</xsi:eventID>
<xsi:sequenceNumber>28</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallAbandonedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53197:0</xsi:callId>
<xsi:extTrackingId>94:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271712495635</xsi:addTime>
<xsi:removeTime>1271712593257</xsi:removeTime>
<xsi:bounced />
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271712495635</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.7 ACDCallTransferredEvent
An ACDCallTransferredEvent is generated when a call is removed from a queue as it is
transferred to a new destination following a blind transfer.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>d9eec76e-33c1-4de7-9e63-0b82d02b85cd</xsi:eventID>
<xsi:sequenceNumber>15</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
fab8103d-d7b9-4be7-8cd2-8bc711e8d7ac</xsi:subscriptionId>
<xsi:channelId>
367062da-6573-461e-b5df-595734a68e00</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 443 OF 521
 <xsi:eventData xsi1:type="xsi:ACDCallTransferredEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-58225:0</xsi:callId>
<xsi:extTrackingId>255:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271770544207</xsi:addTime>
<xsi:removeTime>1271770576187</xsi:removeTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271770544207</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:redirect>
<xsi:address>tel:6001011</xsi:address>
<xsi:reason>transfer</xsi:reason>
<xsi:redirectTime>1271770576187</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.3.8 ACDCallUpdatedEvent
An ACDCallUpdatedEvent is generated in the following cases:
 When the extTrackingId has been changed, this can happen for instance following a
consultation transfer.
 When the remote party information has been modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>b0f9a450-9a29-4691-a3ec-6c8de2c277cd</xsi:eventID>
<xsi:sequenceNumber>19</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
fab8103d-d7b9-4be7-8cd2-8bc711e8d7ac</xsi:subscriptionId>
<xsi:channelId>
367062da-6573-461e-b5df-595734a68e00</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallUpdatedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-58365:0</xsi:callId>
<xsi:extTrackingId>262:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:address countryCode="1">tel:+17003334</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271771165048</xsi:addTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 444 OF 521
 <xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271771165048</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:reason>Call Transferred</xsi:reason>
</xsi:eventData>
</xsi:Event>

4.7.3.9 ACDCallBouncedEvent
An ACDCallBouncedEvent is generated after a call is bounced. When a call is bounced,
the bounced parameter is added to the queueEntry reported in the event. This parameter
is maintained in all future events until the call is finally removed from the ACD queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>6121ec09-20ef-401e-9265-dab6019dcff9</xsi:eventID>
<xsi:sequenceNumber>27</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
80208e52-c673-4041-a954-0a1d91b72802</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallBouncedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-53197:0</xsi:callId>
<xsi:extTrackingId>94:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271712495635</xsi:addTime>
<xsi:bounced />
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271712495635</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 445 OF 521
 4.7.3.10 ACDCallForwardedEvent
An ACDCallForwardedEvent is generated when a call is forwarded following the
application of the Forced Forwarding policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>56a625ea-45a4-4e50-a741-6061d35f8ada</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
5f496571-8177-4257-b303-b14909ae4966</xsi:subscriptionId>
<xsi:channelId>
9488b2a7-abb4-4dd3-b0f4-0ea7ea4ce0e2</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallForwardedEvent">
<xsi:callId>callhalf-78933:0</xsi:callId>
<xsi:extTrackingId>332:1</xsi:extTrackingId>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">tel:+15006001025</xsi:acdNumber>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1011</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1271882708100</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.3.11 ACDCallReleasedEvent
An ACDCallReleasedEvent is generated following a released request.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>1b981150-1e11-40dd-b1f7-ab4279a351d7</xsi:eventID>
<xsi:sequenceNumber>26</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
e747a753-c250-4260-a7c1-6c9634f257ed</xsi:subscriptionId>
<xsi:channelId>
2e8c0b90-1f6c-4023-bd14-ad8ec506f398</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallReleasedEvent">
<xsi:call>
<xsi:callId>callhalf-129:0</xsi:callId>
<xsi:extTrackingId>22:1</xsi:extTrackingId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 446 OF 521
 <xsi:personality>Originator</xsi:personality>
<xsi:state>Released</xsi:state>
<xsi:releasingParty>remoteRelease</xsi:releasingParty>
<xsi:remoteParty>
<xsi:name>callcenter callcenter</xsi:name>
<xsi:address>tel:610</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987610;ext=610</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">
<xsi:addressOfRecord>
[email protected]</xsi:addressOfRecord>
</xsi:endpoint>
<xsi:startTime>1292357093018</xsi:startTime>
<xsi:answerTime>1292357093055</xsi:answerTime>
<xsi:releaseTime>1292357166976</xsi:releaseTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

4.7.3.12 ACDCallReorderedEvent
An ACDCallReorderedEvent is generated when a call is reordered.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>101cfad3-1e41-45ed-a185-22aaa26fb078</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7573e2a2-7287-4352-8940-7c04b526dc98</xsi:subscriptionId>
<xsi:channelId>
bdfe939b-fbe1-425e-9370-c9b81097b141</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallReorderedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-59645:0</xsi:callId>
<xsi:extTrackingId>354:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271776555321</xsi:addTime>
<xsi:reordered />
<xsi:acdName>ACD_CTI1_2_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001027</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271776586140</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:position>1</xsi:position>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 447 OF 521
 4.7.3.13 ACDCallPromotedEvent
An ACDCallPromotedEvent is generated when a call has been promoted to another
priority either manually or automatically. The acdPriority element is set to the new priority.
The position parameter is set to the new location of the call in the queue.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>629625f5-f033-400d-884e-3a99af7a62c6</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7573e2a2-7287-4352-8940-7c04b526dc98</xsi:subscriptionId>
<xsi:channelId>
bdfe939b-fbe1-425e-9370-c9b81097b141</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallPromotedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-59645:0</xsi:callId>
<xsi:extTrackingId>354:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271776555321</xsi:addTime>
<xsi:acdName>ACD_CTI1_2_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001027</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271776586140</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<xsi:position>2</xsi:position>
</xsi:eventData>
</xsi:Event>

4.7.3.14 ACDCallStrandedEvent
An ACDCallStrandedEvent is generated when a call is marked as “stranded”. The call is
removed from the queue and handled as specified by the Stranded Call policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>6f0b5bec-a589-45ba-8d05-e3ddcd37271e</xsi:eventID>
<xsi:sequenceNumber>13</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
38d2428a-37b7-4d9a-8f95-08205b7d9147</xsi:subscriptionId>
<xsi:channelId>
2c43bc73-962e-48c8-a324-ad7fba0c4e43</xsi:channelId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 448 OF 521
 <xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallStrandedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-54545:0</xsi:callId>
<xsi:extTrackingId>176:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271724216743</xsi:addTime>
<xsi:removeTime>1271724227613</xsi:removeTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271724216742</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.15 ACDCallStrandedUnavailableEvent
The ACDCallStrandedUnavailableEvent is produced when a call is marked as stranded
due to agent unavailability. The call is removed from the queue and handled as specified
by the Stranded Calls – Unavailable policy.
Example
<?xml version=“1.0” encoding=“UTF-8”?>
<xsi:Event xsi1:type=“xsi:SubscriptionEvent”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsi=“http://schema.broadsoft.com/xsi”>
<xsi:eventID>6f0b5bec-a589-45ba-8d05-e3ddcd37271e</xsi:eventID>
<xsi:sequenceNumber>13</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
38d2428a-37b7-4d9a-8f95-08205b7d9147</xsi:subscriptionId>
<xsi:channelId>
2c43bc73-962e-48c8-a324-ad7fba0c4e43</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type=“xsi:ACDCallStrandedUnavailableEvent”>
<xsi:queueEntry>
<xsi:callId>callhalf-54545:0</xsi:callId>
<xsi:extTrackingId>176:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode=“1”>tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271724216743</xsi:addTime>
<xsi:removeTime>1271724227613</xsi:removeTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber
countryCode=“1”>tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 449 OF 521
 1271724216742</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.16 ACDCallStrandedUnavailableTreatmentCompleteEvent
If an ACDCallStrandedUnavailableEvent is sent with an indication that treatment has been
started, a subsequent ACDCallStrandedUnavailableTreatmentCompleteEvent is sent
when the treatment is complete. Two Stranded Calls – Unavailable policy actions result in
treatment being started as follows:
 Play ringing until caller hangs up
 Play announcement until caller hangs up
In both cases, the completed event indicates a reason of remoteRelease (that is, the caller
hangs up).
Example
<?xml version=“1.0” encoding=“UTF-8”?>
<xsi:Event xsi1:type=“xsi:SubscriptionEvent”
xmlns:xsi1=“http://www.w3.org/2001/XMLSchema-instance”
xmlns:xsi=“http://schema.broadsoft.com/xsi”>
<xsi:eventID>6f0b5bec-a589-45ba-8d05-e3ddcd37271e</xsi:eventID>
<xsi:sequenceNumber>13</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
38d2428a-37b7-4d9a-8f95-08205b7d9147</xsi:subscriptionId>
<xsi:channelId>
2c43bc73-962e-48c8-a324-ad7fba0c4e43</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type=“xsi:ACDCallStrandedUnavailableTreatmentCompletedEvent”>
<xsi:queueEntry>
<xsi:callId>callhalf-54545:0</xsi:callId>
<xsi:extTrackingId>176:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode=“1”>tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271724216743</xsi:addTime>
<xsi:removeTime>1271724227613</xsi:removeTime>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode=“1”>
tel:+15006001025</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271724216742</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
<reason>remoteRelease</reason>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 450 OF 521
 4.7.3.17 ACDCallEscapedEvent
An ACDCallEscapedEvent is generated when the caller dials the configured escape digits
while being in the queue. The call is removed from the queue and the caller is provided
with a Busy treatment. If the queue is configured for the Call Forwarding Busy or the
Voice Messaging service, then the call is handled accordingly.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>ff9aafb7-41b2-4297-b723-5b1af8635dc3</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
7573e2a2-7287-4352-8940-7c04b526dc98</xsi:subscriptionId>
<xsi:channelId>
bdfe939b-fbe1-425e-9370-c9b81097b141</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDCallEscapedEvent">
<xsi:queueEntry>
<xsi:callId>callhalf-59645:0</xsi:callId>
<xsi:extTrackingId>354:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>
<xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1271776555321</xsi:addTime>
<xsi:removeTime>1271777047356</xsi:removeTime>
<xsi:reordered />
<xsi:acdName>ACD_CTI1_2_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15006001027</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1271776586140</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:eventData>
</xsi:Event>

4.7.3.18 ACD Subscription Event

An ACDSubscriptionEvent is generated immediately after a subscription is added or
refreshed, provided that the subscription target is not a collection of subscribers (for
example, a group) and that contact was registered with the subscription.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>b6e78208-83a0-4549-995c-7b959f5df640</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 451 OF 521
 com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
8e934dc5-cfc2-4c99-9234-2503af0b025f</xsi:subscriptionId>
<xsi:channelId>
69b6643e-2c65-472d-ac50-5ca382855262</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDSubscriptionEvent">
<xsi:queueEntries>
<xsi:queueEntry>
<xsi:callId>callhalf-263:0</xsi:callId>
<xsi:extTrackingId>39:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1292360704269</xsi:addTime>
<xsi:acdName>dnis1</xsi:acdName>
<xsi:acdNumber countryCode="1">
tel:+15146987610</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>
<xsi:addTimeInPriorityBucket>
1292360704269</xsi:addTimeInPriorityBucket>
</xsi:queueEntry>
</xsi:queueEntries>
</xsi:eventData>
</xsi:Event>

4.7.3.19 ACDHolidayPolicyAppliedEvent
An ACDHolidayPolicyAppliedEvent is generated when a call is treated according to the
Holiday policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>4ad5f5c0-0ce6-4c6d-b9c3-bbe8eb883e8a</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
c09f2dee-32ab-4408-9ea9-cb9806331191</xsi:subscriptionId>
<xsi:channelId>
e89e1bb5-5223-4af1-849d-0e468ee9c07c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDHolidayPolicyAppliedEvent">
<xsi:callId>callhalf-79297:0</xsi:callId>
<xsi:extTrackingId>70:1</xsi:extTrackingId>
<xsi:acdName>ACD_CTI1_Name</xsi:acdName>
<xsi:acdNumber countryCode="1">tel:+15006001025</xsi:acdNumber>
<xsi:remoteParty>
<xsi:name>NetworkN1FirstName NetworkN1LastName</xsi:name>
<xsi:address countryCode="1">tel:+15007003333</xsi:address>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 452 OF 521
 <xsi:callType>Network</xsi:callType>
</xsi:remoteParty>
<xsi:redirect>
<xsi:address>tel:1011</xsi:address>
<xsi:reason>deflection</xsi:reason>
<xsi:redirectTime>1272036730325</xsi:redirectTime>
</xsi:redirect>
</xsi:eventData>
</xsi:Event>

4.7.3.20 ACDNightPolicyAppliedEvent
An ACDNightPolicyAppliedEvent is generated when a call is treated according to the
Holiday policy.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>0ccab0d0-c9a1-49b4-a5b7-955774dd32ed</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
8e934dc5-cfc2-4c99-9234-2503af0b025f</xsi:subscriptionId>
<xsi:channelId>
69b6643e-2c65-472d-ac50-5ca382855262</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDNightPolicyAppliedEvent">
<xsi:callId>callhalf-271:0</xsi:callId>
<xsi:extTrackingId>40:1</xsi:extTrackingId>
<xsi:acdName>callcenter</xsi:acdName>
<xsi:acdNumber countryCode="1">tel:+15146987610</xsi:acdNumber>
<xsi:remoteParty>
<xsi:name>john3 south</xsi:name>
<xsi:address>tel:603</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+15146987603;ext=603</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
</xsi:eventData>
</xsi:Event>

4.7.3.21 ACDSubscriptionResyncEvent
An ACDSubscriptionResyncEventis generated whenever the Application Server shuts
down abnormally.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>5a15146e-d7ea-48be-b644-89e05ca963c5</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 453 OF 521
 <xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>b28c3fcc-590e-48fe-86a4-
156053222d32</xsi:subscriptionId>
<xsi:channelId>de051934-f32d-44d2-b47a-ac9c2f5f6caf</xsi:channelId>
<xsi:eventData xsi1:type="xsi:ACDSubscriptionResyncEvent">
<xsi:queueEntries>
<xsi:queueEntry>
<xsi:callId>callhalf-167:0</xsi:callId>
<xsi:extTrackingId>6:1</xsi:extTrackingId>
<xsi:remoteParty>
<xsi:name>john0 north</xsi:name>
<xsi:address>tel:500</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726996500;ext=500</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:addTime>1345225598725</xsi:addTime>
<xsi:acdName>CallCenterName</xsi:acdName>
<xsi:acdNumber countryCode="1">tel:+19726996518</xsi:acdNumber>
<xsi:acdPriority>0-Highest</xsi:acdPriority>

<xsi:addTimeInPriorityBucket>1345225598679</xsi:addTimeInPriorityBucket
>
</xsi:queueEntry>
</xsi:queueEntries>
</xsi:eventData>
</xsi:Event>

4.7.4 Agent Events

An Agent event is an event that reports a change associated with an agent. Agent events
are generated when subscribing to the Call Center Agent event package.
The following subsections provide detailed information for all the available agent event
types as follows:
 AgentStateEvent
 AgentDispositionCodeAddedEvent
 ACDAgentJoinUpdateEvent
 AgentSubscriptionEvent

4.7.4.1 AgentStateEvent
An AgentStateEvent is generated when an agent changes state. State changes can be
initiated by a remote application through Xsi-Actions, from the Cisco BroadWorks Call
Center client, from the agent’s endpoint, or from the web portal. This event is also sent if
there is a change in alert severity.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>632030e3-b2c4-4d49-b866-8e2adb0ee87f</xsi:eventID>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 454 OF 521
 <xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>

<xsi:externalApplicationId>com.broadsoft.remoteapp.routepoint.sg</x
si:externalApplicationId>
<xsi:subscriptionId>209389b3-f4f7-44b8-a662-
209959cd8bb7</xsi:subscriptionId>
<xsi:channelId>a61750ee-3bb3-4330-aaa5-
4497322a8a35</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:AgentStateEvent">
<xsi:agentStateInfo>
<xsi:state>Unavailable</xsi:state>
<xsi:stateTimestamp>
<xsi:value>1292361232195</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:prevSeverity>0</xsi:prevSeverity>
<xsi:threshold>600</xsi:threshold>
</xsi:stateTimestamp>
<xsi:signInTimestamp>1292361232195</xsi:signInTimestamp>
<xsi:totalAvailableTime>0</xsi:totalAvailableTime>
<xsi:averageWrapUpTime>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:averageWrapUpTime>
</xsi:agentStateInfo> </xsi:eventData>
</xsi:Event>

4.7.4.2 AgentDispositionCodeAddedEvent
An AgentDispositionCodeAddedEvent is generated when the agent enters a disposition
code during the call or while in the wrap-up state. A disposition code can be added using
the Cisco BroadWorks Call Center client, the agent’s endpoint, or via a remote application
request.
If the ACD or Route Point is configured with a default disposition code, then the code is
added to call events sent in the context of a call received from that ACD or Route Point,
specifically within the acdCallInfo or acdOutgoingCallInfo elements.
The callId element in the event identifies the call associated with the disposition code.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>c45f0448-981b-4a00-a632-3f97c1bb1a76</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>
CTIController</xsi:externalApplicationId>
<xsi:subscriptionId>
725e0c55-265a-49b4-97e8-e3a309b8c88a</xsi:subscriptionId>
<xsi:channelId>
5616863d-9336-4296-921a-1fb1fce69705</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:AgentDispositionCodeAddedEvent">
<xsi:dispositionCode>Promotion</xsi:dispositionCode>
<xsi:callId>callhalf-53153:0</xsi:callId>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 455 OF 521
 4.7.4.3 ACDAgentJoinUpdateEvent
An ACDAgentJoinUpdateEvent is generated when the agent joins or unjoins an ACD. An
agent joins or unjoins an ACD using the Cisco BroadWorks Call Center client or the web
portal.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:eventID>4e819eea-d91c-47a5-b040-d9f85400ee86</xsi:eventID>
<xsi:sequenceNumber>7</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
9f35d69c-bc8c-4dac-91af-f94766e35643</xsi:subscriptionId>
<xsi:channelId>5e565648-7293-4c0b-ba8e-5d8608a1d466</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDAgentJoinUpdateEvent">
<xsi:ccAgentJoinUpdateData>
<xsi:joinInfo>
<xsi:acdUserId>[email protected]</xsi:acdUserId>
<xsi:joined />
<xsi:skillLevel>1</xsi:skillLevel>
</xsi:joinInfo>
</xsi:ccAgentJoinUpdateData>
</xsi:eventData>

4.7.4.4 AgentSubscriptionEvent
An AgentSubscriptionEvent is generated immediately after a subscription is added or
refreshed, provided that the subscription target is not a collection of subscribers (for
example, a group).
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e3fb3eeb-b695-41bc-a775-13f77b976605</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
1716a4f9-3bc6-450a-badc-80ef6ef9a561</xsi:subscriptionId>
<xsi:channelId>
69b6643e-2c65-472d-ac50-5ca382855262</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:AgentSubscriptionEvent">
<xsi:joinData>
<xsi:joinInfos>
<xsi:joinInfo>
<xsi:acdUserId>[email protected]</xsi:acdUserId>
<xsi:joined />
<xsi:skillLevel>12</xsi:skillLevel>
</xsi:joinInfo>
</xsi:joinInfos>
</xsi:joinData>
<xsi:stateInfo>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 456 OF 521
 <xsi:state>Unavailable</xsi:state>
<xsi:stateTimestamp>
<xsi:value>1292361232195</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:threshold>600</xsi:threshold>
</xsi:stateTimestamp>
<xsi:signInTimestamp>1292361232195</xsi:signInTimestamp>
<xsi:totalAvailableTime>0</xsi:totalAvailableTime>
<xsi:averageWrapUpTime>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:averageWrapUpTime>
</xsi:stateInfo>
</xsi:eventData>
</xsi:Event>

4.7.5 Automatic Call Distribution Configuration Events

An Automatic Call Distribution (ACD) configuration event is an event that reports a change
associated with an ACD configuration. ACD configuration events are generated when
subscribing to the Call Center Configuration event package.
The following subsections provide detailed information for all the available ACD
configuration event types:
 ACDForcedForwardingEvent
 ACDHolidayServiceEvent
 ACDNightServiceEvent
 ACDConfigurationSubscriptionEvent

4.7.5.1 ACDForcedForwardingEvent
An ACDForcedForwardingEvent is generated when the ACD Forced Forwarding service
configuration is modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>db352fa3-7f7b-4cf5-b23f-26eb001107c3</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
966e7c4c-b9d6-4322-82a4-7668254aaae8</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDForcedForwardingEvent">
<xsi:active />
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 457 OF 521
 4.7.5.2 ACDHolidayServiceEvent
An ACDHolidayServiceEvent is generated when the ACD Holiday service configuration is
modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>b83744b8-4569-446b-ba8c-ed2abb2317a7</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
966e7c4c-b9d6-4322-82a4-7668254aaae8</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDHolidayServiceEvent" />
</xsi:Event>

4.7.5.3 ACDNightServiceEvent
An ACDNightServiceEvent is generated when the ACD Night service configuration is
modified.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>8405cb6e-3e6b-4b4a-891d-c29815ad8a6f</xsi:eventID>
<xsi:sequenceNumber>9</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
966e7c4c-b9d6-4322-82a4-7668254aaae8</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDNightServiceEvent" />
</xsi:Event>

4.7.5.4 ACDConfigurationSubscriptionEvent
An ACDConfigurationSubscriptionEvent is issued immediately after a subscription is
added or refreshed, provided that the subscription target is not a collection of subscribers
(for example, a group) and that contact was registered with the subscription.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>86eb2697-ea6e-4efc-81f0-c97da1b6cb38</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 458 OF 521
 <xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
f1f1d676-7142-459b-ba6a-d06c15b8714d</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ACDConfigurationSubscriptionEvent">
<xsi:forcedForwarding>
<xsi:active>true</xsi:active>
</xsi:forcedForwarding>
</xsi:eventData>
</xsi:Event>

4.7.6 CallCenterAgentMonitoringEvent
A Call Center Agent Monitoring event is an event that reports a change associated to an
agent performance. The following subsections provide detailed information for all the
available Call Center Agent Monitoring event types:
 CallCenterAgentMonitoringEvent
 CallCenterAgentOnCallAlertEvent
 CallCenterAgentMonitoringSubscriptionEvent

4.7.6.1 CallCenterAgentMonitoringEvent
A CallCenterAgentMonitoringEvent allows a subscriber to receive notifications related to
the overall performance of an agent. A CallCenterAgentMonitoringEvent is generated
when an agent releases or transfers an ACD call, at which time alert severity is evaluated.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>d9949d24-50d2-496b-977f-9fab303fe43d</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>
3dffee47-ce97-49d2-82ea-1df33463a1b1</xsi:subscriptionId>
<xsi:channelId>
a12d6765-643a-456e-a6f6-96edc5e1d221</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallCenterAgentMonitoringEvent">
<xsi:monitoringStatus>
<xsi:averageACDCallTime>
<xsi:value>6154</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:prevSeverity>0</xsi:prevSeverity>
<xsi:threshold>5000</xsi:threshold>
</xsi:averageACDCallTime>
<xsi:averageACDOutgoingCallTime>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:averageACDOutgoingCallTime>
</xsi:monitoringStatus> </xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 459 OF 521
 4.7.6.2 CallCenterAgentOnCallAlertEvent
The CallCenterAgentOnCallAlertEvent is sent to raise or clear alerts regarding an agent’s
on-call state. If the agent has been either idle or on a call for too long, according to
configured thresholds, this event will indicate which alert condition prevails and with what
severity.
If the agent is involved in a call that is longer than the configured threshold, the
“timestamp” element contains the answer time of the longest call the agent is in. The
alertEvent element will indicate “OnCallTime”.
If the agent has been idle longer than the configured threshold, the “timestamp” element
contains the release time of the call most recently released. If the agent receives a new
call while Idle severity is greater than “Green”, the “timestamp” is set to the new call’s start
time and the alert is cleared. The alertEvent element will indicate “IdleTime”.
This event is not sent if the “On Call Time” and “Idle Time” alerts are not enabled.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>d9949d24-50d2-496b-977f-9fab303fe43d</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>
3dffee47-ce97-49d2-82ea-1df33463a1b1</xsi:subscriptionId>
<xsi:channelId>
a12d6765-643a-456e-a6f6-96edc5e1d221</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:
CallCenterAgentOnCallAlertEvent">
<xsi:alertInfo>
<xsi:alertEvent>OnCallTime</xsi:alertEvent>
<xsi:timestamp>
<xsi:value>1292214059085</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:prevSeverity>0</xsi:prevSeverity>
<xsi:threshold>600</xsi:threshold>
</xsi:timestamp>
</xsi:alertInfo>
</xsi:eventData>
</xsi:Event>

4.7.6.3 CallCenterAgentMonitoringSubscriptionEvent
A CallCenterAgentMonitoringSubscriptionEvent is generated immediately after a
subscription is added or refreshed, provided that the subscription target is not a collection
of subscribers (for example, a group).
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>d9949d24-50d2-496b-977f-9fab303fe43d</xsi:eventID>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 460 OF 521
 <xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>
3dffee47-ce97-49d2-82ea-1df33463a1b1</xsi:subscriptionId>
<xsi:channelId>
a12d6765-643a-456e-a6f6-96edc5e1d221</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:CallCenterAgentMonitoringSubscriptionEvent">
<xsi:monitoringStatus>
<xsi:averageACDCallTime>
<xsi:value>6154</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:averageACDCallTime>
<xsi:averageACDOutgoingCallTime>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:averageACDOutgoingCallTime>
</xsi:monitoringStatus>
<xsi:alertInfo>
<xsi:alertEvent>OnCallTime</xsi:alertEvent>
<xsi:timestamp>
<xsi:value>1292214059085</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:threshold>600</xsi:threshold>
</xsi:timestamp>
</xsi:alertInfo>
</xsi:eventData>
</xsi:Event>

4.7.7 CallCenterMonitoringEvent
A CallCenterMonitoringEvent allows a subscriber to receive notifications related to the
overall performance of the call center. A CallCenterMonitoringEvent is generated when
subscribing to the Call Center Monitoring event package. An event is generated when:
 An agent is assigned or unassigned from the call center
 An agent’s staffed status changes
 A staffed agent’s idle status changes
 A staffed agent transitions to or from the Unavailable state
 Following an initial subscription or refresh
Transmission of these events is throttled. Additionally, as long as there are queued calls
in the Call Center, this event will automatically be generated and transmitted at every
throttling interval. If the last call was removed from the queue during the throttling interval,
this event will be generated and transmitted at the end of the throttling interval.
Alert severities for the elements supported in this feature are evaluated at the time the
message is generated.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>d8e3de77-6bad-4c6b-a3b6-62c7c5c41055</xsi:eventID>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 461 OF 521
 <xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>
fb2b57ed-bf7f-449f-993d-bae264487a3a</xsi:subscriptionId>
<xsi:channelId>
a12d6765-643a-456e-a6f6-96edc5e1d221</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallCenterMonitoringEvent">
<xsi:monitoringStatus>
<xsi:averageHandlingTime>
<xsi:value>3633</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:prevSeverity>0</xsi:prevSeverity>
<xsi:threshold>3600</xsi:threshold>
</xsi:averageHandlingTime>
<xsi:expectedWaitTime>
<xsi:value>1816</xsi:value>
<xsi:severity>0</xsi:severity>
<xsi:prevSeverity>1</xsi:prevSeverity>
</xsi:expectedWaitTime>
<xsi:averageSpeedOfAnswer>
<xsi:value>3776</xsi:value>
<xsi:severity>1</xsi:severity>
<xsi:prevSeverity>0</xsi:prevSeverity>
<xsi:threshold>3600</xsi:threshold>
</xsi:averageSpeedOfAnswer>
<xsi:longestWaitTime>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:longestWaitTime>
<xsi:numCallsInQueue>
<xsi:value>0</xsi:value>
<xsi:severity>0</xsi:severity>
</xsi:numCallsInQueue>
<xsi:numAgentsAssigned>3</xsi:numAgentsAssigned>
<xsi:numAgentsStaffed>2</xsi:numAgentsStaffed>
<xsi:numStaffedAgentsIdle>1</xsi:numStaffedAgentsIdle>
<xsi:numStaffedAgentsUnavailable>
0</xsi:numStaffedAgentsUnavailable>
</xsi:monitoringStatus>
</xsi:eventData>
</xsi:Event>

4.7.8 CallForwardingAlwaysEvent
A CallForwardingAlwaysEvent event is generated when subscribing to the Call
Forwarding Always event package. An event is generated when the Call Forwarding
Always service configuration is modified or after a subscription is added or refreshed.
The Call Forwarding Always configuration can be changed through:
 Xsi-Actions request
 Feature access code (for example, *72)
 Cisco BroadWorks web portal
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 462 OF 521
 xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>5eda485f-48e0-4a4e-9960-e51c8af02673</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
8ffb5dee-d982-4b64-a40a-b4667d7b5eda</xsi:subscriptionId>
<xsi:channelId>
027f69b3-79f1-4671-8440-952e203a2d7d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallForwardingAlwaysEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:forwardToPhoneNumber>tel:1020</xsi:forwardToPhoneNumber>
<xsi:ringSplash>true</xsi:ringSplash>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.9 CallForwardingAlwaysSecondaryEvent
A CallForwardingAlwaysSecondaryEvent event is generated when subscribing to the Call
Forwarding Always Secondary event package. An event is generated when the Call
Forwarding Always Secondary service configuration is modified or after a subscription is
added or refreshed.
The Call Forwarding Always Secondary configuration can be changed through:
 Xsi-Actions request
 Cisco BroadWorks web portal
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>5eda485f-48e0-4a4e-9960-e51c8af02673</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
8ffb5dee-d982-4b64-a40a-b4667d7b5eda</xsi:subscriptionId>
<xsi:channelId>
027f69b3-79f1-4671-8440-952e203a2d7d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData
xsi1:type="xsi:CallForwardingAlwaysSecondaryEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:forwardToPhoneNumber>tel:1020</xsi:forwardToPhoneNumber>
<xsi:ringSplash>true</xsi:ringSplash>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 463 OF 521
 4.7.10 CallForwardingNoAnswerEvent
A CallForwardingNoAnswerEvent is generated when subscribing to the Call Forwarding
No Answer event package. An event is generated when the Call Forwarding No Answer
service configuration is modified or after a subscription is added or refreshed.
The Call Forwarding No Answer configuration can be changed through:
 Xsi-Actions request
 Feature access code (for example, *92)
 Cisco BroadWorks web portal
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>caa8f1a3-b7e1-452a-8e10-5dd1307048fe</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
3dac69a4-55ff-42dc-a824-905c97a90775</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallForwardingNoAnswerEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:forwardToPhoneNumber>tel:604</xsi:forwardToPhoneNumber>
<xsi:numberOfRings>3</xsi:numberOfRings>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.11 CallForwardingBusyEvent
A CallForwardingBusyEvent is generated when subscribing to the Call Forwarding Busy
event package. An event is generated when the Call Forwarding Busy service
configuration is modified or after a subscription is added or refreshed.
The Call Forwarding Busy configuration can be changed through:
 Xsi-Actions request
 Feature access code (for example, *90)
 Cisco BroadWorks web portal
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>90be8815-f437-4939-bcf2-9d22ed144d0a</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 464 OF 521
 com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
6106cf16-7e2e-44ea-968b-e3e86e943005</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallForwardingBusyEvent">
<xsi:info>
<xsi:active>false</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.12 HotelingGuestEvent
A HotelingGuestEvent is generated when subscribing to the Hoteling Guest event
package. An event is generated when the Hoteling Guest configuration is modified or
after a subscription is added or refreshed. For example, the guest configuration is
changed when a guest is associated with a host.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>9e36d2e2-ef61-4057-b1e8-a624aefc7ed0</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
57acc139-c7ef-448b-819d-264c24c28bd3</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:HotelingGuestEvent">
<xsi:info>
<xsi:active>false</xsi:active>
<xsi:enableAssociationLimit>true</xsi:enableAssociationLimit>
<xsi:associationLimitHours>12</xsi:associationLimitHours>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.13 DoNotDisturbEvent
A DoNotDisturbEvent is generated when subscribing to the Do Not Disturb event
package. An event is generated when the Do Not Disturb service configuration is modified
or after a subscription is added or refreshed. The Do Not Disturb configuration can be
changed through:
 Xsi-Actions request
 Feature access code
 Cisco BroadWorks web portal

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 465 OF 521
 Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>d2031640-bd7e-4131-9974-7fa529aea361</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
680d3762-75ba-4984-a60c-38ea1ee6cff0</xsi:subscriptionId>
<xsi:channelId>
027f69b3-79f1-4671-8440-952e203a2d7d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:DoNotDisturbEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:ringSplash>true</xsi:ringSplash>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.14 VoiceMailMessageSummaryEvent
A VoiceMailMessageSummaryEvent is generated when subscribing to the Voice Mail
Message event package. An event is generated when the Voice Mail content is modified
or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>cd0dc6cd-45f3-472c-8a26-114557898916</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
ea8a5fa3-8d8e-4469-ae1a-54c0da593086</xsi:subscriptionId>
<xsi:channelId>
04074f9c-b8f6-4431-9f80-4228a674a9b5</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:VoiceMailMessageSummaryEvent">
<xsi:messageSummary />
</xsi:eventData>

4.7.15 BroadWorksAnywhereEvent
A BroadWorksAnywhereEvent is generated when subscribing to the BroadWorks
Anywhere event package. An event is generated when the BroadWorks Anywhere
service configuration is modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>c45fa645-17c2-43ce-b2e6-f0dc4c716d0d</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 466 OF 521
 <xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
4e0b9fad-a00d-47c2-a766-c99be1ed9375</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:BroadWorksAnywhereEvent">
<xsi:info>
<xsi:alertAllLocationsForClickToDialCalls>
false</xsi:alertAllLocationsForClickToDialCalls>
<xsi:locations>
<xsi:location>
<xsi:phoneNumber countryCode="1">
tel:+15145551212</xsi:phoneNumber>
<xsi:active>true</xsi:active>
<xsi:description>Home</xsi:description>
</xsi:location>
</xsi:locations>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.16 CallTransferEvent
A CallTransferEvent is generated when subscribing to the Call Transfer event package.
An event is generated when the Call Transfer service configuration is modified or after a
subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>d025ac89-5cfc-4127-93fb-69285358bf31</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
2db70efc-b030-4e0b-a56d-b83d8685c961</xsi:subscriptionId>
<xsi:channelId>
5f8c13d5-c0bc-4b0a-a7f5-94fade545198</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallTransferEvent">
<xsi:info>
<xsi:recallActive>true</xsi:recallActive>
<xsi:recallNumberOfRings>4</xsi:recallNumberOfRings>
<xsi:busyCampOnActive>false</xsi:busyCampOnActive>
<xsi:busyCampOnSeconds>120</xsi:busyCampOnSeconds>
<xsi:useDiversionInhibitorForBlindTransfer>
false</xsi:useDiversionInhibitorForBlindTransfer>
<xsi:useDiversionInhibitorForConsultativeCalls>
false</xsi:useDiversionInhibitorForConsultativeCalls>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 467 OF 521
 4.7.17 CallWaitingEvent
A CallWaitingEvent is generated when subscribing to the Call Waiting event package. An
event is generated when the Call Waiting service configuration is modified or after a
subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>f186adae-6fc2-40f3-bd01-aba18b0ece8a</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
e3fc1fd4-7bff-47d2-94c6-ec24f26ec05e</xsi:subscriptionId>
<xsi:channelId>
5f8c13d5-c0bc-4b0a-a7f5-94fade545198</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CallWaitingEvent">
<xsi:info>
<xsi:active>true</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.18 LastNumberRedialEvent
A LastNumberRedialEvent is generated when subscribing to the Last Number Redial
event package. An event is generated when the Last Number Redial service configuration
is modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e75434a7-5306-4471-9088-8d964da1efa0</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
60d526ef-7de4-41b2-ae7e-780ee3b8de3c</xsi:subscriptionId>
<xsi:channelId>
5f8c13d5-c0bc-4b0a-a7f5-94fade545198</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:LastNumberRedialEvent" />
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 468 OF 521
 4.7.19 Meet-Me Conference Events
A Meet-Me Conference event is an event that reports a change associated with a Meet-
Me Conference. Meet-Me Conference events are generated when subscribing to the
Meet Me Conference event package.
For Meet-Me conference events, the subscribing application typically provides a target
corresponding to the user ID of a conference bridge virtual subscriber and a target subID,
corresponding to the conference ID of a conference that belongs to the bridge (see section
4.6.2.9 user/<userid>/subId/<subid> for details on the command to create such a
subscription). For this type of subscription:
 An initial subscription event is issued that includes the current state of the conference
(if it has started) along with the participant list.
 Only events specific to the subscribed conference are generated, no event is sent for
the other conferences on this bridge.
If the subscribing application provides the user ID of the conference bridge virtual
subscriber without specifying the conference ID of the conference (in other words, if it
subscribes using the request defined in section 4.6.2.8 user/<userid>), then events are
generated for all conferences on the bridge.
No initial subscription event is issued for a subscription that does not specify the
conference ID (for example, user ID with no subID, group, and so on).
The following subsections provide detailed information for all available Meet Me
Conference event types as follows:
 MeetMeConferenceAutoLectureModeStarted
 MeetMeConferenceLectureModeStartedEvent
 MeetMeConferenceLectureModeStoppedEvent
 MeetMeConferenceLockedEvent
 MeetMeConferenceRecordingPausedEvent
 MeetMeConferenceRecordingResumedEvent
 MeetMeConferenceRecordingStartedEvent
 MeetMeConferenceRecordingStoppedEvent
 MeetMeConferenceStartedEvent
 MeetMeConferenceStoppedEvent
 MeetMeConferenceSubscriptionEvent
 MeetMeConferenceUnlockedEvent
 MeetMeParticipantHeldEvent
 MeetMeParticipantJoinedEvent
 MeetMeParticipantLeftEvent
 MeetMeParticipantMutedEvent
 MeetMeParticipantRetrievedEvent
 MeetMeParticipantUnmutedEvent
 MeetMeParticipantUpdatedEvent
 MeetMeConferenceSubscriptionResync

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 469 OF 521
  MeetMeConferenceSecurityClassificationUpdatedEvent
 MeetMeConferenceClientSessionInfoUpdatedEvent

4.7.19.1 MeetMeAutoLectureModeStartedEvent
A MeetMeAutoLectureModeStartedEvent is generated whenever the Automatic Lecture
Mode starts.
It may include an optional list of (non-moderator) participants who should remain unmuted
when the Automatic Lecture Mode starts. When a conference is transitioned from Lecture
Mode to Automatic Lecture Mode, all the non-moderator participants who are in an
unmuted state should remain unmuted even after the Automatic Lecture Mode is
triggered. This list contains these non-moderator participants.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>
4d60035a-aa4a-4055-ad1f-59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>
localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeAutoLectureModeStartedEvent">
<xsi:unmutedParticipants>
<xsi:participant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:participant>
<xsi:participant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:participant>
</xsi:unmutedParticipants>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 470 OF 521
 4.7.19.2 MeetMeLectureModeStartedEvent
A MeetMeLectureModeStartedEvent is generated when a Meet-Me conference’s lecture
mode is started.
The lecture mode indicates that all non-moderator conference participants are muted. By
contrast, moderators of the conference are not automatically muted when lecture mode
begins. There is no additional MeetMeParticipantMutedEvent event sent for the muting of
the participants when they are muted with the start of lecture mode.
The event provides the information on the participant who started the lecture mode. If the
lecture mode has been initiated by a client Xsi-Action, no participant information is
provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeLectureModeStartedEvent">
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 471 OF 521
 4.7.19.3 MeetMeLectureModeStoppedEvent
A MeetMeLectureModeStoppedEvent is generated when a Meet-Me conference’s lecture
mode is stopped. The event provides the information on the participant who stopped the
lecture mode. If the lecture mode has been stopped by a client Xsi-Action, no participant
information is provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceLockedEvent">
<xsi:conferenceParticipant>
<xsi:callId>loaclhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

4.7.19.4 MeetMeConferenceLockedEvent
A MeetMeConferenceLockedEvent is generated when a Meet-Me conference is locked.
The event provides the information on the participant who locked the conference. If the
conference has been locked by a client Xsi-Action, no participant information is provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 472 OF 521
 </xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceLockedEvent">
<xsi:conferenceParticipant>
<xsi:callId>loaclhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

4.7.19.5 MeetMeConferenceRecordingPausedEvent
A MeetMeConferenceRecordingPausedEvent is generated when a Meet-Me conference’s
recording service is paused. The event provides information on the participant who
paused the recording. If the conference recording has been paused by a client Xsi-Action,
no participant information is provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceLockedEvent">
<xsi:conferenceParticipant>
<xsi:callId>loaclhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 473 OF 521
 4.7.19.6 MeetMeConferenceRecordingResumedEvent
A MeetMeConferenceRecordingResumedEvent is generated when a Meet-Me
conference’s recording service is resumed, having previously been paused. The event
provides information on the participant who resumed recording. If the conference
recording has been resumed by a client Xsi-Action, no participant information is provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceLockedEvent">
<xsi:conferenceParticipant>
<xsi:callId>loaclhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

4.7.19.7 MeetMeConferenceRecordingStartedEvent
A MeetMeConferenceRecordingStartedEvent is generated when a Meet-Me conference’s
recording service is started for the first time or when it is restarted after having previously
been stopped. The event provides information on the participant who started recording. If
the conference recording has been started by a client Xsi-Action, no participant
information is provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 474 OF 521
 <xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData
xsi1:type="xsi:MeetMeConferenceRecordingStartedEvent">
<xsi:conferenceParticipant>
<xsi:callId>localhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
</xsi:eventData>
</xsi:Event>

4.7.19.8 MeetMeConferenceRecordingStoppedEvent
A MeetMeConferenceRecordingStoppedEvent is generated when a Meet-Me
conference’s recording service is stopped. If conference recording is reinitiated after
having been stopped, a MeetMeConferenceRecordingStartedEvent (and not a
MeetMeConferenceRecordingResumedEvent) is generated.
The event provides information on the participant who stopped the recording. If the
conference recording has been stopped by a client Xsi-Action, no participant information is
provided.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData
xsi1:type="xsi:MeetMeConferenceRecordingStoppedEvent">
<xsi:conferenceParticipant>
<xsi:callId>loaclhost1:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 475 OF 521
 <xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
<xsi:reason>normal</xsi:reason>
</xsi:eventData>
</xsi:Event>

4.7.19.9 MeetMeConferenceStartedEvent
A MeetMeConferenceStartedEvent is generated when a Meet-Me conference starts. A
conference starts when the first participant joins unless the Moderator required to start
conference option is selected for the conference, in which case the conference does not
start until a moderator joins the conference.
Note that conferences can be started more than once, for example, a “reservationless”
conference can be instantiated many times. Each time a conference starts it initializes the
conference information according to the configuration of the conference and initializes its
participant list according to the current participants in the conference.
It is possible for a conference to require a moderator before starting. In this case, any
“non-moderators” who connect prior to the moderator joining are placed on hold. Only
when a moderator joins is a MeetMeConferenceStartedEvent sent. It is followed by a join
event that contains a list of the participants who have now entered the call, including the
moderator.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceStartedEvent" />
</xsi:Event>

4.7.19.10 MeetMeConferenceStoppedEvent
A MeetMeConferenceStoppedEvent is generated when a Meet-Me conference stops.
For a conference that is set to end when the moderator departs, when the last moderator
leaves, the conference stops. For a conference that does not have this restriction, the
conference stops when the last participant or moderator leaves.

NOTE: Once the MeetMeConferenceStoppedEvent has been issued, no further

MeetMeParticipantLeftEvent events are sent, since the implication is that all participants have
left.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 476 OF 521
 Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceStoppedEvent" />
</xsi:Event>

4.7.19.11 MeetMeConferenceSubscriptionEvent
A MeetMeConferenceSubscriptionEvent is generated whenever a conference-level
subscription to the Meet-Me Conferencing service is added or refreshed. If the conference
has started, the conference details are returned, otherwise no details are returned.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceSubscriptionEvent">
<xsi:conference>
<xsi:conferenceInfo>
<xsi:lectureMode/>
<xsi:lock/>
<xsi:recordingState>Recording</xsi:recordingState>
</xsi:conferenceInfo>
<xsi:conferenceParticipants>
<xsi:participant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 477 OF 521
 <xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:participant>
<xsi:participant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:participant>
</xsi:conferenceParticipants>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.19.12 MeetMeConferenceSubscriptionEvent
A MeetMeConferenceSubscriptionEvent is generated whenever a conference-level
subscription to the Meet-Me Conferencing service is added or refreshed. If the conference
has started, the conference details are returned. Otherwise, no details are returned.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeConferenceSubscriptionEvent">
<xsi:conference>
<xsi:conferenceInfo>
<xsi:lectureMode/>
<xsi:lock/>
<xsi:recordingState>Recording</xsi:recordingState>
</xsi:conferenceInfo>
<xsi:conferenceParticipants>
<xsi:participant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:participant>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 478 OF 521
 <xsi:participant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:participant>
</xsi:conferenceParticipants>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.19.13 MeetMeConferenceSubscriptionResyncEvent
A MeetMeConferenceUnlockedEvent is generated when the Application Server shuts
down abnormally.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>a3cc53f4-b674-4dd7-9ff8-f425ffc48e25</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>22c44e05-9280-4253-8f5e-
9d3a7f3c3b09</xsi:subscriptionId>
<xsi:channelId>bf191ebe-fe13-4549-9a2b-cf1b365b8b16</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>989718</xsi:targetSubId>
<xsi:eventData
xsi1:type="xsi:MeetMeConferenceSubscriptionResyncEvent">
<xsi:conference>
<xsi:conferenceInfo>
<xsi:recordingState>Not Started</xsi:recordingState>
</xsi:conferenceInfo>
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-27:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>john0 north</xsi:name>
<xsi:address>tel:500</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726996500;ext=500</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker/>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-27:0</xsi:callId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 479 OF 521
 <xsi:partyInformation>
<xsi:name>john2 north</xsi:name>
<xsi:address>tel:502</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726996502;ext=502</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

4.7.19.14 MeetMeParticipantHeldEvent
A MeetMeParticipantHeldEvent is generated when one or more participants are being
held in a Meet-Me conference. The event includes the list of participants being held.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantHeldEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:held>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 480 OF 521
 </xsi:held>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

4.7.19.15 MeetMeParticipantJoinedEvent
A MeetMeParticipantJoinedEvent is generated when one or more participants join a Meet-
Me conference. The event includes the list of participants joining the conference.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantJoinedEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker></xsi:activeTalker>
<xsi:moderator></xsi:moderator>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 481 OF 521
 4.7.19.16 MeetMeParticipantLeftEvent
A MeetMeParticipantLeftEvent is generated when one or more participants leave a Meet-
Me conference. The event includes the list of participants leaving the conference.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantLeftEvent">
<xsi:callIds>
<xsi:callId>callhalf-23865:0</xsi:callId>
</xsi:callIds>
</xsi:eventData>
</xsi:Event>

4.7.19.17 MeetMeParticipantMutedEvent
A MeetMeParticipantMutedEvent is generated when one or more participants are muted
in a Meet-Me conference. The event includes the list of participants being muted.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi: MeetMeParticipantMutedEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 482 OF 521
 </xsi:partyInformation>
<xsi:muted></xsi:muted>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:muted></xsi:muted>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

4.7.19.18 MeetMeParticipantRetrievedEvent
A MeetMeParticipantRetrievedEvent is generated when one or more participants are
unheld in a Meet-Me conference. The event includes the list of participants being unheld.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantRetrievedEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>New User</xsi:name>
<xsi:address>1003</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1003</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 483 OF 521
 </xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

4.7.19.19 MeetMeParticipantUnmutedEvent
A MeetMeParticipantUnmutedEvent is generated when one or more participants are
unmuted in a Meet-Me conference. The event includes the list of participants being
unmuted.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantUnmutedEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
</xsi:conferenceParticipant>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 484 OF 521
 4.7.19.20 MeetMeParticipantUpdatedEvent
A MeetMeParticipantUpdatedEvent is generated when one or more participants have their
participant information updated in a Meet-Me conference. This even is generated in the
following cases:
 When a participant that has already joined to the conference choose to log in as a
moderator
 When a consultation transfer has led to a change in the party information for the
participant
 When a participant has entered or changed his Meet-Me conferencing unique
identifier
 When a participant becomes the new active talker, or is no longer the active talker
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:MeetMeParticipantUpdatedEvent">
<xsi:conferenceParticipants>
<xsi:conferenceParticipant>
<xsi:callId>callhalf-23865:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>Test User</xsi:name>
<xsi:address>1002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN>1002</xsi:userDN>
<xsi:callType>Group</xsi:callType>
<xsi:moderator></xsi:moderator>
</xsi:partyInformation>
</xsi:conferenceParticipant>
</xsi:conferenceParticipants>
</xsi:eventData>
</xsi:Event>

4.7.19.21 MeetMeConferenceSecurityClassificationUpdatedEvent
A MeetMeConferenceSecurityClassificationUpdatedEvent is generated when there is a
change to the security classification level of a Meet-Me conference.
This event is generated if the conference owner has the Security Classification service
assigned.
The event contains the classification level name and classification priority determined by
selecting the lowest-ranked user classification level from all participant(s).

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 485 OF 521
 The event is generated when there is a change to the conference call classification level,
triggered when:
 A participant joins the conference.
 A participant leaves the conference.
 A participant changes their current classification level.
 A participant’s connected identity changes in complex call scenarios (that is,
transfers).
This event is not generated when the conference starts. When the conference starts, the
security classification details are provided in the MeetMeConferenceStartedEvent.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData
xsi1:type="xsi:MeetMeConferenceSecurityClassificationUpdated">
<xsi:securityClassification>Top Secret
</xsi:securityClassification>
</xsi:eventData>
</xsi:Event>

4.7.19.22 MeetMeConferenceClientSessionInfoUpdatedEvent
The MeetMeConferenceClientSessionInfoUpdatedEvent informs the remote application
when there are changes to the client session info for the conference.
The event includes the client session info.
The event is generated when client session info is updated for the conference.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>admin@broadworks</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 486 OF 521
 </xsi:httpContact>
<xsi:targetId>bridge1@broadworks</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData
xsi1:type="xsi:MeetMeConferenceClientSessionInfoUpdatedEvent">
<xsi:conferenceInfo>
<xsi:lectureMode/>
<xsi:lock/>
<xsi:recordingState>Recording</xsi:recordingState>
<xsi:clientSessionInfo>abcd123456789</xsi:clientSessionInfo>
</xsi:conferenceInfo>
</xsi:eventData>
</xsi:Event>

4.7.20 MusicOnHold
A MusicOnHoldEvent is generated when subscribing to the Music On Hold event
package. An event is generated when the Music On Hold service configuration is
modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>1ff6a2f2-c99e-40a9-b60e-a08c25f7e077</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>
com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>
034195d2-be6d-4813-9f78-b4313120fbd9</xsi:subscriptionId>
<xsi:channelId>
5f8c13d5-c0bc-4b0a-a7f5-94fade545198</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:MusicOnHoldEvent">
<xsi:info>
<xsi:active>true</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.21 N-WayCallEvent
An N-WayCallEvent is generated when subscribing to the N-Way Calling event package.
An event is generated when the N-Way Calling service configuration is modified or after a
subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>a5e4afd7-8db1-4c1f-9cbf-c535cc37bd1b</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 487 OF 521
 com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>
<xsi:subscriptionId>a650f857-1301-4121-a46e-
d4c64b36217e</xsi:subscriptionId>
<xsi:channelId>5f8c13d5-c0bc-4b0a-a7f5-
94fade545198</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:N-WayCallEvent"/>
</xsi:Event>

4.7.22 RemoteOfficeEvent
A RemoteOfficeEvent is generated when subscribing to the Remote Office event package.
An event is generated when the Remote Office service configuration is modified or after a
subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>bcbf0887-6555-48cc-8d41-4dd83a8ed7b1</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
902c74a9-b6e2-4355-9186-b6d6cb0a5901</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:RemoteOfficeEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:remoteOfficeNumber>tel:604</xsi:remoteOfficeNumber>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.23 ThirdPartyVoiceMailSupportEvent
A ThirdPartyVoiceMailSupportEvent is generated when subscribing to the Third-Party
Voice Mail Support event package. An event is generated when the Third-Party Voice
Mail Support service configuration is modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>6ee84efd-30a4-4a40-b8f2-4ecb8f398aeb</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
6ce735d1-ca89-4f2b-a1f2-3a3afadbfa42</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ThirdPartyVoiceMailSupportEvent">

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 488 OF 521
 <xsi:info>
<xsi:active>false</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.24 ThreeWayCallEvent
A ThreeWayCallEvent is generated when subscribing to the Three-Way Calling event
package. An event is generated when the Three-Way Calling service configuration is
modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>1e526844-3bf7-40b7-868c-c675635b6d6f</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
0164c3da-7373-428d-a06e-ccf0f730bd16</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:ThreeWayCallEvent" />
</xsi:Event>

4.7.25 VoiceMessagingEvent
A VoiceMessagingEvent is generated when subscribing to the Voice Messaging event
package. An event is generated when the Voice Messaging service configuration is
modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>e3f7c7c0-4938-403b-8943-820d79d6e185</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
a953fcf9-dd50-4f9e-b429-c3f3b35e533b</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:VoiceMessagingEvent">
<xsi:info>
<xsi:active>true</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 489 OF 521
 4.7.26 CommPilotExpressEvent
A CommPilotExpressEvent is generated when subscribing to the CommPilot Express
event package. An event is generated when the CommPilot Express service configuration
is modified or after a subscription is added or refreshed. The profile element is included
and is nil if not the CommPilot Express profile is not set.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>bcf2cb4a-a2e5-4266-948e-7a443f23ab83</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
88712942-8888-4b93-9440-64d632a2e4ec</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:CommPilotExpressEvent">
<xsi:info>
<xsi:profile>Available In Office</xsi:profile>
<xsi:availableInOffice>
<xsi:additionalPhoneNumberToRing>
tel:604</xsi:additionalPhoneNumberToRing>
<xsi:busySetting>
<xsi:action>Transfer To Voice Mail</xsi:action>
</xsi:busySetting>
<xsi:noAnswerSetting>
<xsi:action>Transfer To Voice Mail</xsi:action>
</xsi:noAnswerSetting>
</xsi:availableInOffice>
<xsi:availableOutOfOffice>
<xsi:incomingCalls>
<xsi:action>Transfer To Voice Mail</xsi:action>
</xsi:incomingCalls>
<xsi:incomingCallNotify>
<xsi:sendEmail>false</xsi:sendEmail>
</xsi:incomingCallNotify>
</xsi:availableOutOfOffice>
<xsi:busy>
<xsi:incomingCalls>
<xsi:sendCallsToVoiceMailExceptExcludedAddresses>
false</xsi:sendCallsToVoiceMailExceptExcludedAddresses>
</xsi:incomingCalls>
<xsi:voiceMailNotify>
<xsi:sendEmail>false</xsi:sendEmail>
</xsi:voiceMailNotify>
</xsi:busy>
<xsi:unavailable>
<xsi:incomingCalls>
<xsi:sendCallsToVoiceMailExceptExcludedAddresses>
false</xsi:sendCallsToVoiceMailExceptExcludedAddresses>
</xsi:incomingCalls>
<xsi:voiceMailGreeting>No Answer</xsi:voiceMailGreeting>
</xsi:unavailable>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 490 OF 521
 4.7.27 SequentialRingEvent
A SequentialRingEvent is generated when subscribing to the Sequential Ringing event
package. An event is generated when the Sequential Ringing service configuration is
modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>f2987b1d-1a0a-4f83-9ac7-d08d5858d4de</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
e60ffcf2-21e7-4343-a5ce-e718407826c5</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:SequentialRingEvent">
<xsi:info>
<xsi:ringBaseLocationFirst>true</xsi:ringBaseLocationFirst>
<xsi:baseLocationNumberOfRings>
3</xsi:baseLocationNumberOfRings>
<xsi:continueIfBaseLocationIsBusy>
true</xsi:continueIfBaseLocationIsBusy>
<xsi:callerMayStopSearch>true</xsi:callerMayStopSearch>
<xsi:location1>
<xsi:address>tel:604</xsi:address>
<xsi:numberOfRings>3</xsi:numberOfRings>
<xsi:answerConfirmationRequired>
false</xsi:answerConfirmationRequired>
</xsi:location1>
<xsi:location2>
<xsi:address>tel:5007003333</xsi:address>
<xsi:numberOfRings>3</xsi:numberOfRings>
<xsi:answerConfirmationRequired>
false</xsi:answerConfirmationRequired>
</xsi:location2>
<xsi:location3>
<xsi:numberOfRings>3</xsi:numberOfRings>
<xsi:answerConfirmationRequired>
false</xsi:answerConfirmationRequired>
</xsi:location3>
<xsi:location4>
<xsi:numberOfRings>3</xsi:numberOfRings>
<xsi:answerConfirmationRequired>
false</xsi:answerConfirmationRequired>
</xsi:location4>
<xsi:location5>
<xsi:numberOfRings>3</xsi:numberOfRings>
<xsi:answerConfirmationRequired>
false</xsi:answerConfirmationRequired>
</xsi:location5>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 491 OF 521
 4.7.28 SimultaneousRingPersonalEvent
A SimultaneousRingPersonalEvent is generated when subscribing to the Simultaneous
Ringing Personal event package. An event is generated when the Simultaneous Ringing
Personal service configuration is modified or after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>c3ac598d-4757-45d7-a0ba-2f1ac02d1206</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apid1</xsi:externalApplicationId>
<xsi:subscriptionId>
3781f06e-d5c4-4b41-8e80-79cab0d9c54b</xsi:subscriptionId>
<xsi:channelId>
1a095a63-7efa-4d07-9737-b6a1e5cb339c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:SimultaneousRingPersonalEvent">
<xsi:info>
<xsi:active>true</xsi:active>
<xsi:incomingCalls>Do not Ring if on a
Call</xsi:incomingCalls>
<xsi:simRingLocations>
<xsi:simRingLocation>
<xsi:address>tel:604</xsi:address>
<xsi:answerConfirmationRequired>
true</xsi:answerConfirmationRequired>
</xsi:simRingLocation>
<xsi:simRingLocation>
<xsi:address>tel:610</xsi:address>
<xsi:answerConfirmationRequired>
true</xsi:answerConfirmationRequired>
</xsi:simRingLocation>
<xsi:simRingLocation>
<xsi:address>tel:5007003333</xsi:address>
<xsi:answerConfirmationRequired>
true</xsi:answerConfirmationRequired>
</xsi:simRingLocation>
</xsi:simRingLocations>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 492 OF 521
 4.7.29 SecurityClassificationEvent
A SecurityClassificationEvent is generated when configuration to the user’s Security
Classification service is changed or after a subscription is added or refreshed.
The SecurityClassificationEvent is generated when:
 The subscription is added or refreshed.
 The security classification level assigned to the user is modified.
 The configuration of the system classification levels are modified (new levels added,
removed, or the priority of the levels are modified).
 The user overrides its assigned classification level.
 The user’s override classification level is reset when the user terminates all active
calls.
 The Security Classification service is “unassigned” from the user.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>9b41d3d7-5243-4b7c-abaa-231cb022e500</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/application/c
all-client/my-client</xsi:externalApplicationId>
<xsi:subscriptionId>ec8a20db-25e0-4056-97dc-
f725e8308027</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:SecurityClassificationEvent">
<xsi:info>
<xsi:allowedLevels>
<xsi:classification>Top Secret</xsi:classification>
<xsi:classification>Secret</xsi:classification>
<xsi:classification>Restricted</xsi:classification>
<xsi:classification>Unclassified</xsi:classification>
</xsi:allowedLevels>
<xsi:overrideLevel>Secret</xsi:overrideLevel>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.30 FlexibleSeatingGuestEvent
A FlexibleSeatingGuestEvent is generated when the Flexible Seating Guest configuration
is modified or after a subscription is added or refreshed.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>9e36d2e2-ef61-4057-b1e8-a624aefc7ed0</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>

com.broadsoft.remoteapp.routepoint.sg</xsi:externalApplicationId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 493 OF 521
 <xsi:subscriptionId>
57acc139-c7ef-448b-819d-264c24c28bd3</xsi:subscriptionId>
<xsi:channelId>
7d355c07-5a50-44a1-9f59-c7c3b2e9e25d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi: FlexibleSeatingGuestEvent">
<xsi:info>
<xsi:active>true</xsi:active>

<xsi:enableAssociationLimit>true</xsi:enableAssociationLimit>
<xsi:associationLimitHours>12</xsi:associationLimitHours>
<xsi:unlockPhonePINCode>24222</xsi:unlockPhonePINCode>
<xsi:accessDevice>
<xsi:deviceName>testDevice</xsi:deviceName>
<xsi:deviceLevel>System</xsi:deviceLevel>
<xsi:deviceLinePort>23@testport</xsi:deviceLinePort>
</xsi:accessDevice>
<xsi:hostUserId>[email protected]</xsi:hostUserId>
<xsi:hostLastName>negi002</xsi:hostLastName>
<xsi:hostFirstName>Subhash</xsi:hostFirstName>
<xsi:hostAssociationDateTime>2010-04-
06T14:11:10.918+05:30</xsi:hostAssociationDateTime>
</xsi:info>
</xsi:eventData>
</xsi:Event

4.7.31 PersonalAssistantEvent
A PersonalAssistantEvent is generated when subscribing to the Personal Assistant event
package. An event is generated when the presence and expiration configuration fields of
the Personal Assistant service are modified, the expiration date and time have expired, or
after a subscription is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>5eda485f-48e0-4a4e-9960-e51c8af02673</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
8ffb5dee-d982-4b64-a40a-b4667d7b5eda</xsi:subscriptionId>
<xsi:channelId>
027f69b3-79f1-4671-8440-952e203a2d7d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:PersonalAssistantEvent">
<xsi:info>
<presence>Business Trip<presence>
<enableExpirationTime>true</enableExpirationTime>
<expirationTime>2014-04-16T17:00:00.327-05:00</expirationTime>
</xsi:info>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 494 OF 521
 4.7.32 SilentAlertingEvent
A SilentAlertingEvent event is generated when subscribing to the Silent Alerting event
package. An event is generated when the Silent Alerting service configuration is modified,
after a subscription is added or refreshed, or when the service is “unassigned” from the
user.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>5eda485f-48e0-4a4e-9960-e51c8af02673</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@broadsoft.com</xsi:userId>
<xsi:externalApplicationId>AppCtlId</xsi:externalApplicationId>
<xsi:subscriptionId>
8ffb5dee-d982-4b64-a40a-b4667d7b5eda</xsi:subscriptionId>
<xsi:channelId>
027f69b3-79f1-4671-8440-952e203a2d7d</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:SilentAlertingEvent">
<xsi:info>
<xsi:active>true</xsi:active>
</xsi:info>
</xsi:eventData>
</xsi:Event>

4.7.33 PushNotificationRegistrationEvent
The Push Notification Registration event is generated upon a user-level subscription, and
it is sent when a user’s push notification registration is added, updated, or deleted. The
event contains a complete picture of the user’s push notification registrations stored on the
server.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2
001/XMLSchema-instance">
<xsi:eventID>67af1622-08d6-49eb-8bd4-08ae1ea7bb82</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>079fdf7f-c6fa-4ec9-b33a-
11ea2e9ffc63</xsi:subscriptionId>
<xsi:channelId>4deb2851-5c1a-4128-b10e-7afa23f99da3</xsi:channelId>
<xsi:eventData xsi1:type="xsi: PushNotificationRegistrationEvent ">
<xsi:pushNotificationRegistrations>
<xsi:pushNotificationRegistration>
<xsi:applicationId>com.broadsoft.enterprise.iris</
xsi:applicationId>
<xsi:applicationVersion>1.1.8</xsi:applicationVersion>
<xsi:registrationId>android-res1-johnsmith-
dev1</xsi:registrationId>
<xsi:deviceOSType>Android</xsi:deviceOSType>
<xsi:deviceOSVersion>8.2</xsi:deviceOSVersion>
<xsi:deviceTokenList>
<xsi:deviceToken>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 495 OF 521
 <xsi:token>FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C6660
FE66489F304DC75B8D6E8200DFF8A456E8D518741C92C6660</xsi:token>
<xsi:pushNotificationEvents>
<xsi:event>NEW_CALL</xsi:event>
<xsi:event>CALL_UPD</xsi:event>
<xsi:event>NEW_TEXT_MSG</xsi:event>
</xsi:pushNotificationEvents>
</xsi:deviceToken>
</xsi:deviceTokenList>
</xsi:pushNotificationRegistration>
<xsi:pushNotificationRegistration>
<xsi:applicationId>com.broadsoft.ucone2015</xsi:applicationId>
<xsi:applicationVersion>1.1.1.0</xsi:applicationVersion>
<xsi:registrationId>apple-res1-johnsmith-
dev1</xsi:registrationId>
<xsi:deviceOSType>iOS</xsi:deviceOSType>
<xsi:deviceOSVersion>8.4.0</xsi:deviceOSVersion>
<xsi:deviceTokenList>
<xsi:deviceToken>
<xsi:token>8eea961fda8ea893a2d1bfd7262cbf4c52df4d4d53bdc947c8f7b7475f4cf
b1a</xsi:token>
<xsi:pushNotificationEvents>
<xsi:event>NEW_CALL</xsi:event>
<xsi:event>CALL_UPD</xsi:event>
</xsi:pushNotificationEvents>
</xsi:deviceToken>
<xsi:deviceToken>
<xsi:token>8eea961fda8ea893a2d1bfd7262cbf4c52df4d4d53bdc947c8f7b7475f4c1
111</xsi:token>
<xsi:pushNotificationEvents>
<xsi:event>NEW_TEXT_MSG</xsi:event>
</xsi:pushNotificationEvents>
</xsi:deviceToken>
</xsi:deviceTokenList>
</xsi:pushNotificationRegistration>
</xsi:pushNotificationRegistrations>
</xsi:eventData>
</xsi:Event>

4.7.34 CallParkedAgainstEvent
A CallParkedAgainstEvent is generated when a call is parked against a user, when a call
is no longer parked against a user, and after a subscription is added or refreshed. The
event provides information about the parked user when a call is parked against the target
user or indicates a call is no longer parked against the target user.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>448b7053-471b-4703-ae82-
49421a772949</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>http://www.broadsoft.com/
application/call-client/my-client
</xsi:externalApplicationId>
<xsi:subscriptionId>2447e791-41ed-
3eb4487bbacb</xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 496 OF 521
 <xsi:eventData xsi1:type="xsi:CallParkedAgainstEvent">
<xsi:parkedParty>
<xsi:name>alice south</xsi:name>
<xsi:address>tel:876601</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN countryCode="1">
tel:+19726987601;ext=876601
</xsi:userDN>
<xsi:callType>Enterprise</xsi:callType>
</xsi:parkedParty>
</xsi:eventData>
</xsi:Event>

4.7.35 Collaborate Room Events

A Collaborate Room event is an event that reports a change associated with a Collaborate
Room. Collaborate Room events are generated when subscribing to the Collaborate
Room event package.
For Collaborate Room events, the subscribing application typically provides a target
corresponding to the user ID of a Cisco BroadWorks user. Optionally, a target subID
corresponding to a room ID that belongs to the Cisco BroadWorks user can be specified.
For details on the command to create such a subscription, see section 4.6.2.9
user/<userid>/subId/<subid>.
If the subscribing application provides the user ID without specifying the room ID, the
events will be generated for all the rooms of the user.

4.7.35.1 CollaborateRoomSubscriptionEvent
The CollaborateRoomSubscriptionEvent is generated whenever a subscription to a
collaborate room is added or refreshed.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>0fc567be-1118-4a8c-8759-a0ceffa9b1e0</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{28d735534b20-
9388a}</xsi:externalApplicationId>
<xsi:subscriptionId>01adbf5ca19c-aa6942abd90c</xsi:subscriptionId>
<xsi:channelId>57be7b45-cd1a-47b1-86df-d54cfd10ce52</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>530701</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomSubscriptionEvent">
<xsi:conference>
<roomSessionInfo>
<name>My Collaboration</name>
<roomType>MyRoom</roomType>
<roomId>228870</roomId>
<locked/>
<clientSessionInfo>11061971</clientSessionInfo>
</roomSessionInfo>
<roomParticipants>
<roomParticipant>
<callId>callhalf-201:0</callId>
<partyInformation>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 497 OF 521
 <name>John Doe</name>
<address>tel:503</address>
<userId>[email protected]</userId>
<userDN countryCode="1">tel:+19726971503;ext=503</userDN>
<callType>Group</callType>
</partyInformation>
<owner/>
</roomParticipant>
<roomParticipant>
<callId>callhalf-201:1</callId>
<partyInformation>
<name>Jane Doe</name>
<address>tel:500</address>
<userId>[email protected]</userId>
<userDN countryCode="1">tel:+19726971500;ext=500</userDN>
<callType>Group</callType>
</partyInformation>
<muted/>
</roomParticipant>
<roomParticipant>
<callId>callhalf-201:2</callId>
<partyInformation>
<name>Anthony Brown</name>
<address>tel:504</address>
<userId>[email protected]</userId>
<userDN countryCode="1">tel:+19726971504;ext=504</userDN>
<callType>Group</callType>
</partyInformation>
<activeTalker/>
</roomParticipant>
</roomParticipants>
</xsi:conference>
</xsi:eventData>
</xsi:Event>

If the conference has not started, there are no conference details to embed into the event.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>65b83979-b2f6-487e-96c9-a65617e48977</xsi:eventID>
<xsi:sequenceNumber>1</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>My
Application</xsi:externalApplicationId>
<xsi:subscriptionId>4d60035a-aa4a-4055-ad1f-
59200d6d37ee</xsi:subscriptionId>
<xsi:httpContact>
<xsi:uri>localhost/com.broadsoft.xsi-
events/v2.0/eventCollector/eventProxy</xsi:uri>
</xsi:httpContact>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>2141355</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomSubscriptionEvent"/>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 498 OF 521
 4.7.35.2 CollaborateRoomSubscriptionResyncEvent
A CollaborateRoomSubscriptionResyncEvent is generated when Cisco BroadWorks
needs to resynch the Xsi subscriptions due to the peer Application Server shutting down.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>a3cc53f4-b674-4dd7-9ff8-f425ffc48e25</xsi:eventID>
<xsi:sequenceNumber>5</xsi:sequenceNumber>
<xsi:userId>north02@broadworks</xsi:userId>
<xsi:externalApplicationId>My Application</xsi:externalApplicationId>
<xsi:subscriptionId>22c44e05-9280-4253-8f5e-
9d3a7f3c3b09</xsi:subscriptionId>
<xsi:channelId>bf191ebe-fe13-4549-9a2b-cf1b365b8b16</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>989718</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi: CollaborateRoomSubscriptionResyncEvent">
<xsi:room>
<xsi:roomInfo>
<xsi:type>Project Room</xsi:type>
<xsi:clientSessionInfo>14314098709813</xsi:clientSessionInfo>
</xsi:roomInfo>
<xsi:roomParticipants>
<xsi:participant>
<xsi:callId>callhalf-27:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>david north</xsi:name>
<xsi:address>tel:9725551002</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19725551002;ext=102</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:owner/>
<xsi:activeTalker/>
</xsi:participant>
<xsi:participant>
<xsi:callId>callhalf-27:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>john2 north</xsi:name>
<xsi:address>tel:502</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726996502;ext=502</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:participant>
</xsi:roomParticipants>
</xsi:room>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 499 OF 521
 4.7.35.3 CollaborateRoomStartedEvent
A CollaborateRoomStartedEvent is generated when a Collaborate Room conference
starts. A room starts when the first participant joins unless the owner required to start
room option is selected for the room, in which case the room does not start until an owner
joins the room.
Note that rooms can be started more than once. Each time a room starts, it initializes the
room information according to the configuration of the room.
It is possible for a conference to require an owner before starting. In this case, any other
participants who connect prior to the owner joining are placed on hold. Only when an
owner joins is a CollaborateRoomStartedEvent sent. It is followed by a join event that
contains a list of the participants who have now entered the call, including the owner.
Example
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>150e8061-c374-40a9-a11e-6f15d43e9f03</xsi:eventID>
<xsi:sequenceNumber>47</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{76acfe63-55bb-4ec4-821a-
4ca16b1f29fa}</xsi:externalApplicationId>
<xsi:subscriptionId>698a8af5-1cd4-4e48-b412-
c850b08bb537</xsi:subscriptionId>
<xsi:channelId>0041ec2a-904e-4b16-9d7c-3281076fc020</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomStartedEvent"/>
</xsi:Event>

4.7.35.4 CollaborateRoomStoppedEvent
A CollaborateRoomStoppedEvent is generated when a Collaborate Room conference
stops.
For a room that is set to end when the owner departs, when the owner leaves, the room
stops. For a room that does not have this restriction, the room stops when the last
participant or owner leaves.

NOTE: Once the CollaborateRoomStoppedEvent has been issued, no further

CollaborateRoomParticipantLeftEvent events are sent, since the implication is that all
participants have left.

Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>1fbbdec1-a2d2-4845-afbc-f500cef6d520</xsi:eventID>
<xsi:sequenceNumber>49</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{76acfe63-55bb-4ec4-821a-
4ca16b1f29fa}</xsi:externalApplicationId>
<xsi:subscriptionId>698a8af5-1cd4-4e48-b412-
c850b08bb537</xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 500 OF 521
 <xsi:channelId>0041ec2a-904e-4b16-9d7c-3281076fc020</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomStoppedEvent"/>
</xsi:Event>

4.7.35.5 CollaborateRoomLockedEvent
A CollaborateRoomLockedEvent is generated when a Collaborate Room conference is
locked.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>db2d25bc-ae7d-410c-b06f-f741a0c24d67</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{76acfe63-55bb-4ec4-821a-
4ca16b1f29fa}</xsi:externalApplicationId>
<xsi:subscriptionId>698a8af5-1cd4-4e48-b412-
c850b08bb537</xsi:subscriptionId>
<xsi:channelId>0041ec2a-904e-4b16-9d7c-3281076fc020</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomLockedEvent"/>
</xsi:Event>

4.7.35.6 CollaborateRoomUnlockedEvent
A CollaborateRoomUnlockedEvent is generated when a Collaborate Room conference is
unlocked.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>62dd18d3-d4ed-4fe6-aa08-408291603903</xsi:eventID>
<xsi:sequenceNumber>41</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{76acfe63-55bb-4ec4-821a-
4ca16b1f29fa}</xsi:externalApplicationId>
<xsi:subscriptionId>698a8af5-1cd4-4e48-b412-
c850b08bb537</xsi:subscriptionId>
<xsi:channelId>0041ec2a-904e-4b16-9d7c-3281076fc020</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomUnlockedEvent"/>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 501 OF 521
 4.7.35.7 CollaborateRoomParticipantJoinedEvent
A CollaborateRoomParticipantJoinedEvent is generated when one or more participants
join a Collaborate Room conference.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>197434bc-0564-4897-bd4e-b49d6ea9b347</xsi:eventID>
<xsi:sequenceNumber>4</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{2e13215b-6671-4c2a-b135-
4649a49c8512}</xsi:externalApplicationId>
<xsi:subscriptionId>0f43c3f6-b141-4bec-b892-
cb81add022f6</xsi:subscriptionId>
<xsi:channelId>00be79f2-d4e3-4083-9c31-c1629703347c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomParticipantJoinedEvent">
<xsi:collaborateRoomParticipants>
<xsi:roomParticipant>
<xsi:callId>callhalf-321815:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>antb02 antb02</xsi:name>
<xsi:address>tel:631</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726992631;ext=631</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:roomParticipant>
</xsi:collaborateRoomParticipants>
</xsi:eventData>
</xsi:Event>

4.7.35.8 CollaborateRoomParticipantLeftEvent
A CollaborateRoomParticipantLeftEvent is generated when one or more participants leave
a Collaborate Room conference.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>77ad76f0-7040-4993-b555-1dc792c45a4e</xsi:eventID>
<xsi:sequenceNumber>6</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{2e13215b-6671-4c2a-b135-
4649a49c8512}</xsi:externalApplicationId>
<xsi:subscriptionId>0f43c3f6-b141-4bec-b892-
cb81add022f6</xsi:subscriptionId>
<xsi:channelId>00be79f2-d4e3-4083-9c31-c1629703347c</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomParticipantLeftEvent">
<xsi:callIds>
<xsi:callId>callhalf-321815:1</xsi:callId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 502 OF 521
 </xsi:callIds>
</xsi:eventData>
</xsi:Event>

4.7.35.9 CollaborateRoomParticipantMutedEvent
A CollaborateRoomParticipantMutedEvent is generated when one or more participants
are muted in a Collaborate Room conference.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>1e2308f5-5edd-4ada-95b0-eac9b42fcf5e</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{24f40908-e0e5-44ea-b61c-
f896f97f2ce0}</xsi:externalApplicationId>
<xsi:subscriptionId>4092e6c3-1145-4627-bd50-
17d73281c0f1</xsi:subscriptionId>
<xsi:channelId>9447c70d-4040-4033-8759-3f16a058fbc3</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomParticipantMutedEvent">
<xsi:collaborateRoomParticipants>
<xsi:roomParticipant>
<xsi:callId>callhalf-321099:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>antb02 antb02</xsi:name>
<xsi:address>tel:631</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726992631;ext=631</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:muted/>
</xsi:roomParticipant>
</xsi:collaborateRoomParticipants>
</xsi:eventData>
</xsi:Event>

4.7.35.10 CollaborateRoomParticipantUnmutedEvent
A CollaborateRoomParticipantUnmutedEvent is generated when one or more participants
are unmuted in a Collaborate Room conference.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>a42af5b3-3e4d-44eb-acaf-8cfefa84ab5e</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>{24f40908-e0e5-44ea-b61c-
f896f97f2ce0}</xsi:externalApplicationId>
<xsi:subscriptionId>4092e6c3-1145-4627-bd50-
17d73281c0f1</xsi:subscriptionId>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 503 OF 521
 <xsi:channelId>9447c70d-4040-4033-8759-3f16a058fbc3</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>659889</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomParticipantUnmutedEvent">
<xsi:collaborateRoomParticipants>
<xsi:roomParticipant>
<xsi:callId>callhalf-321099:0</xsi:callId>
<xsi:partyInformation>
<xsi:name>antb02 antb02</xsi:name>
<xsi:address>tel:631</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726992631;ext=631</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
</xsi:roomParticipant>
</xsi:collaborateRoomParticipants>
</xsi:eventData>
</xsi:Event>

4.7.35.11 CollaborateRoomParticipantUpdatedEvent
A CollaborateRoomParticipantUpdatedEvent is generated when one or more participants
have their participant information updated in a Collaborate Room conference. For
example, a consultation transfer may have led to a change in the party information for the
participant. This event allows clients to be notified of this change. In addition, if the active
talker changes this event is also generated to inform the client of the change in the active
talker.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>ad3b5800-608c-472b-b3b1-ba4b7b0b354f</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>
<xsi:externalApplicationId>BroadTouch Business Communicator PC
20.2.0.98.Windows (144)</xsi:externalApplicationId>
<xsi:subscriptionId>c520fe47-8f21-43e0-958c-
6363eaf36cbf</xsi:subscriptionId>
<xsi:channelId>033798ff-17f8-4f3c-9e62-669518cb9de5</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:targetSubId>111751</xsi:targetSubId>
<xsi:eventData xsi1:type="xsi:CollaborateRoomParticipantUpdatedEvent">
<xsi:collaborateRoomParticipants>
<xsi:roomParticipant>
<xsi:callId>callhalf-321999:1</xsi:callId>
<xsi:partyInformation>
<xsi:name>User09 North</xsi:name>
<xsi:address>tel:609</xsi:address>
<xsi:userId>[email protected]</xsi:userId>
<xsi:userDN
countryCode="1">tel:+19726992609;ext=609</xsi:userDN>
<xsi:callType>Group</xsi:callType>
</xsi:partyInformation>
<xsi:activeTalker/>
</xsi:roomParticipant>
</xsi:collaborateRoomParticipants>
</xsi:eventData>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 504 OF 521
 </xsi:Event>

4.7.36 Subscription Event

A Subscription event reports a change associated with a subscription. The only
Subscription event available is the SubscriptionTerminatedEvent.

4.7.36.1 SubscriptionTerminatedEvent
A SubscriptionTerminatedEvent is generated when a subscription terminates.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:eventID>a9d5e4b7-2b14-4139-ba60-bb807dbd2448</xsi:eventID>
<xsi:sequenceNumber>2</xsi:sequenceNumber>
<xsi:userId>[email protected]@mtlasdev87.net</xsi:userId>
<xsi:externalApplicationId>apId1</xsi:externalApplicationId>
<xsi:subscriptionId>
f39acc1f-1349-4293-a940-018dcd1b17dc</xsi:subscriptionId>
<xsi:channelId>
726bfd81-799c-473a-9e32-ed7063ef0b2f</xsi:channelId>
<xsi:targetId>[email protected]</xsi:targetId>
<xsi:eventData xsi1:type="xsi:SubscriptionTerminatedEvent" />
</xsi:Event>

4.7.37 Channel Event

A Channel event reports a change associated with a channel. The only Channel event
available is the ChannelTerminatedEvent.

4.7.37.1 ChannelTerminatedEvent
A ChannelTerminatedEvent is generated when a channel terminates.
Example
<?xml version="1.0" encoding="UTF-8"?>
<xsi:Event xsi1:type="xsi:ChannelTerminatedEvent"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsi="http://schema.broadsoft.com/xsi">
<xsi:channelId>726bfd81-799c-473a-9e32-
ed7063ef0b2f</xsi:channelId>
<xsi:reason>ExplicitDelete</xsi:reason>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 505 OF 521
 4.7.38 PlayMusicOnHoldFailureEvent
The PlayMusicOnHoldFailureEvent is not sent when the PlayMusicOnHold request fails
with an error. The failure event is returned only when the requests are successful, but an
error occurs later in the execution (for example, the Media Server cannot retrieve the file in
the URL).
Description The event is sent upon failure when Cisco BroadWorks handles the
PlayMusicOnHold command from a remote application.
Event <?xml version="1.0" encoding="UTF-8"?>
Content <xsi:Event xsi1:type="xsi:SubscriptionEvent"
xmlns:xsi="http://schema.broadsoft.com/xsi"
xmlns:xsi1="http://www.w3.org/2001/XMLSchema-instance">
<xsi:eventID>e2dd1ab3-ca7d-411b-b356-
17cfc0662216</xsi:eventID>
<xsi:sequenceNumber>3</xsi:sequenceNumber>
<xsi:userId>[email protected]</xsi:userId>

<xsi:externalApplicationId>remoteApp</xsi:externalAppli
cationId>
<xsi:subscriptionId>a0e6843d-21ae-4b62-8554-
2fc9d3cdd1a5</xsi:subscriptionId>
<xsi:channelId>50441369-9e27-41a2-a9d5-
7413755653bb</xsi:channelId>
<xsi:eventData
xsi1:type="xsi:PlayMusicOnHoldFailureEvent">
<xsi:call>
<xsi:callId>callhalf-8231:0</xsi:callId>
<xsi:extTrackingId>caf70021-86e1-4cf0-8568-
944e1a3daeda</xsi:extTrackingId>
<xsi:personality>Terminator</xsi:personality>
<xsi:state>Active</xsi:state>
<xsi:remoteParty>
<xsi:userId>[email protected]</xsi:userId>
<xsi:callType>Group</xsi:callType>
</xsi:remoteParty>
<xsi:endpoint xsi1:type="xsi:AccessEndpoint">

<xsi:addressOfRecord>[email protected]</xsi:add
ressOfRecord>
</xsi:endpoint>
<xsi:appearance>1</xsi:appearance>
<xsi:startTime>1558104261129</xsi:startTime>
<xsi:answerTime>1558104262576</xsi:answerTime>
</xsi:call>
</xsi:eventData>
</xsi:Event>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 506 OF 521
 5 Xsi-MMTel

5.1 Overview
MMTel (Multimedia Telephony) is a specification for simulation services that are standard
in the existing Public Switched Telephone Network (PSTN)/Integrated Services Digital
Network (ISDN).
The following MMTel services are supported via this application:
 Communication Diversion (CDIV)
 Call Waiting (CW)
 Originating Identity Restriction (OIR)
 Terminating Identity Restriction (TIR)
 MMTel Services document

5.2 Functionality
All MMTel actions are user-level configurations for corresponding Cisco BroadWorks
services. All services support “read and update”, which means that when a user has the
service assigned, this user can query on the state of the service and can update the state.
The eXtensible Markup Language (XML) format served by GET methods is the same as
the input format for PUT methods for the same service.

5.2.1 MMTel Services Document

The overall MMTel services method contains Communication Diversion (CDIV) and Call
Waiting (CW) support. With this, the set of services supported are:
 Communication Diversion (CDIV), Call Waiting (CW)
 Originating Identity Presentation/Originating Identity Restriction (OIP/OIR)
 Terminating Identity Presentation/Terminating Identity Restriction (TIP/TIR)
Inclusion of any unassigned service in an MMTel document PUT operation “throws” an x-
cap 409 “cannot-insert” error with the specified details.
Use Case Table:
HTTP Method Action Performed

GET Returns all applicable services configurations, according to the defined

schema.

PUT Sets all applicable service configurations. Inclusion of a service that is

unassigned to the user causes an XCAP error, and no changes are made
to any services.

Method Description:
URI http(s)://<host:port>/com.broadsoft.xsi-mmtel/user/<userid>/mmtel
Methods GET, PUT
GET
Request No Content Sent
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 507 OF 521
 GET <simservs xmlns=http://uri.etsi.org/ngn/params/xml/simservs/xcap
Response xmlns:xsi="http://www.w3.org/2001/XMLSchema--instance">
Content <originating--identity--presentation active="true"/>
<originating--identity--presentation--restriction active="false">
<default—behavior>presentation—restricted</default-behavior>
</originating--identity--presentation--restriction>
<terminating--identity--presentation active="true"/>
<terminating--identity--presentation--restriction active="false">
<default—behavior>presentation-—restricted</default-behavior>
</terminating--identity--presentation--restriction>
<communication-diversion active="true">
<ruleset>
<rule id="CFNR">
<conditions>
<not-registered/>
</conditions>
<actions>
<forward-to>
<target>
</target>
</forward-to>
</actions>
</rule>
</ruleset>
</communication-diversion>
<call-waiting active="true"/>
</simservs>
PUT <simservs xmlns=http://uri.etsi.org/ngn/params/xml/simservs/xcap
Request xmlns:xsi="http://www.w3.org/2001/XMLSchema--instance">
Content <originating--identity--presentation active="true"/>
<originating--identity--presentation--restriction active="false">
<default—behavior>presentation—restricted</default-behavior>
</originating--identity--presentation--restriction>
<terminating--identity--presentation active="true"/>
<terminating--identity--presentation--restriction active="false">
<default—behavior>presentation-—restricted</default-behavior>
</terminating--identity--presentation--restriction>
<communication-diversion active="true">
<ruleset>
<rule id="CFNR">
<conditions>
<not-registered/>
</conditions>
<actions>
<forward-to>
<target>
</target>
</forward-to>
</actions>
</rule>
</ruleset>
</communication-diversion>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 508 OF 521
 <call-waiting active="true"/>
</simservs>
PUT <xcap-error xmlns="urn:ietfaramsml:nscap-error">
Response <cannot-insert phrase=" Partial Execution. Error in processing one or
Content more services”>
(Error <simservs>
Condition
Only) <services>
<service id="originating--identity--presentation" status=”Success”/>
<service id="originating--identity--presentation—restriction”
status=”Failure”/>
<service id="terminating--identity--presentation" status=”Failure”/>
<service id="terminating--identity--presentation--restriction"
status=”Failure”/>
<service id="communication-diversion" status=”Success”/>
<service id="call-waiting" status=”Failure”/>
</services>
</simservs>
</cannot-insert>
</xcap-error>

5.2.2 Originating Identity Restriction Document

The Originating Identity Restriction (OIR) service provides the ability to block calling line
ID. This capability is provided by the Cisco BroadWorks Calling Line ID Delivery Blocking
service.
The default behavior element is added to the OIR response with a value of “presentation--
restricted” but is ignored in the OIR request, assuming it has a valid value defined in the
schema (“presentation--restricted” or “presentation—not--restricted”).
The following table lists response scenarios for this command.
HTTP Method Scenario Action/Response

GET Valid request 200 OK – OIR element as defined in the schema.

Unauthorized user,
GET unknown user or 401 – XCAP Error.
invalid password

Service not assigned

GET 400 – XCAP Error.
to user

200 OK – Enables or disables the user’s Calling Line

PUT Valid request ID Blocking service as per the Boolean value
received.

PUT Unauthorized user 401 – XCAP Error.

Service not assigned

PUT 400 – XCAP Error.
to user

Method Description:
URI http(s)://<host:port>/com.broadsoft.xsi-mmtel/user/<userid>/mmtel/oir
Methods GET, PUT
GET
Request No Content Sent
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 509 OF 521
 GET <originating--identity--presentation--restriction active="true">
Response <default-behavior>presentation-—restricted</default-behavior>
Content
</originating--identity--presentation--restriction>
PUT <originating--identity--presentation--restriction active="true">
Request <default—behavior>presentation--restricted</default-behavior>
Content
</originating--identity--presentation--restriction>
PUT
Response No Content Received
Content

5.2.3 Terminating Identity Restriction Document

The Terminating Identity Restriction (TIR) service enables the terminating party to prevent
presentation of the terminating identify information to the originating party. This capability
is provided by the Cisco BroadWorks Connected Line Identification Restriction (CLIR)
service.
The default behavior element is added to the TIR response with a value of “presentation-
restricted” but is ignored in the TIR request, assuming it has a valid value defined in the
schema (presentation–restricted or presentation–not–restricted).
The following table lists response scenarios for this command.
HTTP Method Scenario Action/Response

GET Valid request 200 OK – TIR element as defined in the schema.

GET Unauthorized user 401 – XCAP Error.

Service not assigned

GET 400 – XCAP Error.
to user

200 OK – Enables or disables the user’s Connected

PUT Valid request Line Identification Restriction service as per the
Boolean value received.

PUT Unauthorized user 401 – XCAP Error.

Service not assigned

PUT 400 – XCAP Error.
to user

Method Description:
URI http(s)://<host:port>/com.broadsoft.xsi-mmtel/user/<userid>/mmtel/tir
Methods GET, PUT
GET
Request No Content Sent
Content
GET <terminating--identity--presentation--restriction active="true">
Response <default—behavior>presentation-—restricted</default-behavior>
Content
</terminating--identity--presentation--restriction active>
PUT <terminating--identity--presentation--restriction active="true">
Request <default—behavior>presentation--restricted</default-behavior>
Content
</terminating--identity--presentation--restriction active>
PUT
Response No Content Received
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 510 OF 521
 5.2.4 Communication Diversion
Communication Diversion (CDIV) is a specification for diverting/forwarding a call based on
certain criteria. In Cisco BroadWorks, there are different call forwarding services but no
overall collection, whereas MMTel specifies a collective set of call diversion (forwarding)
services, with rules within the CDIV document.
The following Cisco BroadWorks services map to the MMTel CDIV document:
 Call Forwarding Not Reachable (CFNR)
 Call Forwarding Always (CFA)
 Call Forwarding No Answer (CFNA)
 Call Forwarding Busy (CFB)
Retrieving the collective CDIV document returns rules in the following order:
 Call Forwarding Not Reachable (CFNR)
 Call Forwarding Always (CFA)
 Call Forwarding No Answer (CFNA)
 Call Forwarding Busy (CFB)

5.2.4.1 CDIV Rules to Cisco BroadWorks Services Mapping

The following tables list each Cisco BroadWorks services against its applicable CDIV
condition.
Cisco
CDIV PUT/GET <rule>
BroadWorks PUT/GET <condition> Tag Value
Rule Tag Value
Service

To activate/when activated: <not-registered/>

Call Forwarding
CFNR “CFNR” To deactivate/when deactivated: <not-registered/><rule-
Not Reachable
deactivated/>

Call Forwarding To activate/when activated: empty

CFU “CFU”
Always To deactivate/when deactivated: <rule-deactivated/>

To activate/when activated: <no-answer/>

Call Forwarding
CFNA “CFNA” To deactivate/when deactivated: <no-answer/><rule-
No Answer
deactivated/>

To activate/when activated: <busy/>

Call Forwarding
CFB “CFB” To deactivate/when deactivated: <busy/><rule-
Busy
deactivated/>

5.2.4.2 Behavior
The following describes various aspects of Xsi-MMTel behavior with respect to
Communication Diversion:
 According to the MMTel specification, there is an active flag at the collective
Communication Diversion level. Its definition in the Technical Specification Group
Core Network and Terminals, Communication Diversion (CDIV) using IP Multimedia
(IM) Core Network (CN) subsystem Protocol Specification [11] is that if the service is
enabled, then it has a value of “true”. In Cisco BroadWorks, there is no overall
Communication Diversion service, but rather four individual services (Call Forwarding
Not Reachable, Call Forwarding Always, Call Forwarding Busy, and Call Forwarding
No Answer). These cannot be controlled as a collection but they can be controlled

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 511 OF 521
 individually. Thus, it is assumed that the Call Diversion feature set is available for all
users and therefore, CDIV active in Cisco BroadWorks is always “true”. A “false”
value for this active flag is ignored.
 When receiving an update request any rule-condition combination that is not expected
results in an error response.
 All service rules are included in a GET response if the service is assigned to the
subscriber. If the service is not assigned, the corresponding service rule is not
present.
 If the service is not active on Cisco BroadWorks, then “rule-deactivated” is the
condition in the GET response.
 The “target” is included in the GET response and set to the forwardToPhoneNumber
in the service. The target is left empty if no number is defined in the service.
 In the PUT request, the service is deactivated if “rule-deactivated” and the correct
condition according to the rule value is included in the service request.
 If “rule-deactivated” is not included in the PUT request and the proper condition is
present, the service is activated on Cisco BroadWorks.
 The forward-to phone number in services is updated with the target received in the
PUT request.
 Duplicate rules are not ignored and they are processed according to their order.
 The number of rings in the Call Forwarding No Answer service is updated with the
“no-answer-timeout” divided by 4 received in the PUT request. The result is rounded
to the next integer value.
 The “no-answer-timeout” in Call Forwarding No Answer is in the GET response and
set to the number of rings multiplied by 4 to populate the value in seconds.
Method Description:
URI http(s)://<host:port>/com.broadsoft.xsi-mmtel/user/<userid>/mmtel/cdiv
Methods GET, PUT
GET
Request No Content Sent
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 512 OF 521
 GET <communication-diversion active="true">
Response <ruleset>
Content
<rule id="CFNR">
<conditions>
<not-registered/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFU">
<conditions>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFB">
<conditions>
<busy/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFNA">
<conditions>
<no-answer/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
<no-answer-timeout>36</no-answer-timeout>
</rule>
</ruleset>
</communication-diversion>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 513 OF 521
 PUT <communication-diversion active="true">
Request <ruleset>
Content
<rule id="CFNR">
<conditions>
<not-registered/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFU">
<conditions>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFB">
<conditions>
<busy/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
</rule>
<rule id="CFNA">
<conditions>
<no-answer/>
</conditions>
<actions>
<forward-to>
<target>9958773340</target>
</forward-to>
</actions>
<no-answer-timeout>36</no-answer-timeout>
</rule>
</ruleset>
</communication-diversion>

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 514 OF 521
 PUT <? xml version="1.0" encoding="ISO-8859-1"?>
Response <xcap-error xmlns="urn:ietfaramsml:nscap-error">
Content
<cannot-insert phrase="Partial Execution. Error in
(In case of
400 error)
processing one or more rules”>
<communication-diversion>
<ruleset>
<rule id="CFNR" status=”Success”/>
<rule id="CFB" status=”Failure”/>
<rule id="CFU" status=”Failure”/>
<rule id="CFNA" status=”Success”/>
</ruleset>
</communication-diversion>
</cannot-insert>
</xcap-error>

5.2.5 Communication Waiting

The Communication Waiting (CW) service allows the configuration of call waiting and is
provided by the Call Waiting service in Cisco BroadWorks. The CW MMTel document
allows the retrieval and setting of the service.
The following table lists response scenarios for this command.
HTTP Method Scenario Action/Response

GET Valid request 200 OK – CW element as defined in the schema.

GET Unauthorized user 401 – XCAP Error.

Service not assigned

GET 400 – XCAP Error.
to user

200 OK – Enables or disables the user’s Call Waiting

PUT Valid request
service as per the Boolean value received.

PUT Unauthorized user 401 – XCAP Error.

Service not assigned

PUT 400 – XCAP Error.
to user

Method Description:
URI http(s)://<host:port>/com.broadsoft.xsi-mmtel/user/<userid>/mmtel/cw
Methods GET, PUT
GET
Request No Content Sent
Content
GET
Response <call-waiting active="true"/>
Content
PUT
Request <call-waiting active="true"/>
Content
PUT
Response No Content Received
Content

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 515 OF 521
 5.3 Management

5.3.1 Authentication
Authentication is provided via the standards-based Hypertext Transfer Protocol (HTTP)
Authentication mechanism. HTTP Basic authentication is supported by this application.

5.3.1.1 Cisco BroadWorks-based Authentication

The Xtended Services Platform provides authentication capabilities via the
BwCommunicationUtility library. Once a basic digest is received via the HTTP
Authorization header, the Xtended Services Platform uses the Cisco BroadWorks Open
Client Interface-Provisioning (OCI-P) interface to verify the supplied credentials. A
successful verification response from Cisco BroadWorks is stored against the HTTP
session identification cookie. Successive HTTP requests with this cookie do not trigger re-
authentication. However, note that the Authorization header must be supplied on every
HTTP request. Subscriber credentials in this scenario are the user ID and web portal
password as defined on Cisco BroadWorks.

5.3.1.2 External Authentication

External Authentication is performed by a carrier-provided authentication server. All
authorizations are performed on this server before the request is processed by the Cisco
BroadWorks server. For more information, see the Cisco BroadWorks External Portal
Integration Guide Developer’s Guide [4].

5.3.2 Error Codes

The following table lists various error codes that are returned by this application.
Code Response Format Description Scenario(s)

400 xcap-error Bad request Cannot understand request, bad syntax.

Incorrect/invalid/unknown username or
401 xcap-error Unauthorized
password.

404 xcap-error Not found Unknown URL.

405 xcap-error Method not allowed Unsupported HTTP method is received.

Could not fulfill request due to resource

409 xcap-error Conflict
conflict.

412 xcap-error Precondition failed Precondition given by client failed.

500 http-error Internal server error Unexpected server errors.

503 http-error Service unavailable Requested resource is not available.

5.3.3 Test Web Page Toolkit

This application exposes a set of web pages that can be used to exercise its provided
functionality. These pages allow the execution of all supported methods and display the
methods’ content sent to/received from Cisco BroadWorks.
Web Toolkit URI:
http(s)://<host:port>/com.broadsoft.xsi-mmtel/test/

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 516 OF 521
 6 XML Schema

The Release 21.0 XML schema is made available through the

Rel22.0_XsiCTISchema_612099.zip file. This file contains three archive files:
 Rel22.0_XSISchema_612099.zip: Contains the Xtended Services Interface (Xsi)
schema files.
 Rel22.0_CTISchema_612099.zip: Contains the Computer Telephony Interface (CTI)
schema files.
 Rel22.0_XSPXMLSchema_612099.zip: Contains the XspXMLInterface schema file
required by the CTI interface.
The Rel22.0_XSISchema_612099.zip file contains the various types that are used in the
message body of requests and responses of the Xtended Services Interface version 22.0.
The following files are available in this archive file:
 XSISchema.xsd – This file is the base file for the Xtended Services Interface XML
schema files. This file references all included files.
 XSIDataTypes.xsd – This file contains the base definitions for types that are used in
other schema files.
 XSIBaseEvent.xsd – This file contains the base definitions for types that are used in
events.
 System/XSISystem.xsd – This file contains the types that are used in application
controller requests and responses.
 Events/XSIChannel.xsd – This file contains the types that are used in event channel
requests and responses.
 Events/XSISubscription.xsd – This file contains the types that are used in event
subscription requests and responses.
 CallSession/XSICallSession.xsd – This file contains the types that are used in call and
conference requests, responses, and events.
 CallSession/Events/XSICallSessionEvents.xsd – This file contains the events that are
sent in the context of a basic call, standard call, or advanced call subscription.
 ACD/XSIACD.xsd – This file contains the types that are used in ACD requests,
responses, and events.
 ACD/Events/XSIACDEvents.xsd – This file contains the events that are sent in the
context of a call center queue subscription and call center monitoring subscription.
 RoutePoint/XSIRoutePoint.xsd – This file contains the types that are used in route
point requests, responses, and events.
 RoutePoint/Events/XSIRoutePointEvents.xsd – This file contains the events that are
sent in the context of a route point queue subscription.
 Agent/XSIAgent.xsd – This file contains the types that are used in agent requests,
responses, and events.
 Agent/Events/XSIAgentEvents.xsd – This file contains the events that are sent in the
context of a call center agent subscription and call center agent monitoring
subscription.
 MeetMeConference/XSIMeetMeConference.xsd – This file contains the types that are
used in Meet-Me Conferencing requests, responses, and events.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 517 OF 521
  MeetMeConference/Events/XSIMeetMeConferenceEvents.xsd – This file contains the
events that are sent in the context of a Meet-Me Conferencing subscription.
 Services/XSI<x>.xsd – This file the types that are used in requests, responses, and
events that are related to service x configuration.
 Services/Events/XSI<XXX>.xsd – These files contain the events that are sent in the
context of the various service configuration.
 Directory/XSIDirectories.xsd – This file contains the types that are used in directory
requests and responses.
 Profile/XSIProfile.xsd – This file contains the types that are used in profile requests
and responses.

6.1 Schema Updates

Enhancements and fixes to the schema are provided through new version of the archive
file. Each schema file is named using the following convention:
Rel<x>_XsiCTISchema_<y>.zip
Where x is the Xsi interface version number and y is a unique identifier internal to
Cisco/BroadSoft.
For example, if a new feature is made available in Release 21.0 through a feature patch
and that a new schema file, Rel21.sp3_XsiCTISchema_471212, is published with it. A
remote application can make use of this new Xsi functionality by using the XML types
defined in this new file and setting the version number to 21.sp3 in the associated Xsi
requests.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 518 OF 521
Acronyms and Abbreviations

ACD Automatic Call Distribution

ADP AAPI Application Programming Interface
BA BroadWorks Anywhere
CDR Call Detail Record
CFA Call Forwarding Always
CLID Calling Line Identity
CPD Call Progress Detection
CPE CommPilot Express
CTI Computer Telephony Interface
DN Directory Number
DNIS Dialed Number Identification Service
DTMF Dual-Tone Multi-Frequency
FAC Feature Access Code
FMFM Find-me/Follow-me
FQDN Fully Qualified Domain Name
GCP Group Call Park
HTTPS Hypertext Transfer Protocol Secure Sockets
IM&P Instant Messaging and Presence
IMRN IP Multimedia Routing Number
IVR Interactive Voice Response
JSON JavaScript Object Notation
LDAP Lightweight Directory Access Protocol
MGCP Media Gateway Control Protocol
MOH Music On Hold
MWI Message Waiting Indicator
SIP Session Initiation Protocol
SSID Shared Subscription ID
SSL Secure Sockets Layer
TAS Telephony Application Server
UCaaS Unified Communications as a Service
UMS Messaging Server
URI Uniform Resource Identifier
URL Uniform Resource Locator
UTC Coordinated Universal Time

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 519 OF 521
 XS Execution Server
Xsi Xtended Services Interface

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 520 OF 521
References

[1] Richardson, L., Ruby, S. RESTful Web Services. O’Reilly Media, Inc. 2007.
Available from http://www.crummy.com/writing/RESTful-Web-Services/.
[2] Cisco Systems, Inc. 2020. Cisco BroadWorks Computer Telephony Integration
Interface Specification. Available from Cisco at cisco.com.
[3] Cisco Systems, Inc. 2020. Call Center Reporting Feature Description, Release 18.0.
Available from Cisco at cisco.com.
[4] Cisco Systems, Inc. 2020. Cisco BroadWorks External Portal Integration Guide
Developer’s Guide. Available from Cisco at cisco.com.
[5] W3C. 2004. W3C Recommendation 28, XML Schema Part 2: Datatypes Second
Edition. Available at http://www.w3.org/TR/xmlschema-2/#dateTime.
[6] Cisco Systems, Inc. 2020. Cisco BroadWorks Xtended Services Interface
Configuration Guide. Available from Cisco at cisco.com.
[7] Cisco Systems, Inc. 2020. Cisco BroadWorks Feature Overview. Available from
Cisco at cisco.com.
[8] Cisco Systems, Inc. 2020. Cisco BroadWorks XS Mode Configuration Guide.
Available from Cisco at cisco.com.
[9] BadgerFish. 2017. What is BadgerFish? Available from BadgerFish at
badgerfish.ning.com.
[10] Cisco Systems, Inc. 2020. Simplify Notifications to UCaaS and Collaborate Feature
Description, Release 23.0. Available from Cisco at cisco.com.
[11] 3rd Generation Partnership Project. Technical Specification Group Core Network and
Terminals, Communication Diversion (CDIV) using IP Multimedia (IM) Core Network
(CN) subsystem Protocol Specification, Release 8. Available at http://www.3gpp.org/.

CISCO BROADWORKS XTENDED SERVICES INTERFACE – INTERFACE SPECIFICATION

©
2021 CISCO SYSTEMS, INC. PAGE 521 OF 521