Transcription
OpenScape Contact Center Enterprise V10 R4REST SDK FrameworkProgramming GuideA31003-S2293-R104-02-7620
Provide feedback to further optimize this document to edoku@unify.com.As reseller please address further presales related questions to the responsible presales organization at Unify or at yourdistributor. For specific technical inquiries you may use the support knowledgebase, raise - if a software support contract is inplace - a ticket via our partner portal or contact your distributor.Our Quality and Environmental Management Systems areimplemented according to the requirements of the ISO9001 andISO14001 standards and are certified by an external certificationcompany.Copyright Unify Software and Solutions GmbH & Co. KG 10/2021All rights reserved.Reference No.: A31003-S22A4-R102-02-7620The information provided in this document contains merely general descriptions orcharacteristics of performance which in case of actual use do not always apply asdescribed or which may change as a result of further development of the products.An obligation to provide the respective characteristics shall only exist if expressly agreed inthe terms of contract.Availability and technical specifications are subject to change without notice.Unify, OpenScape, OpenStage and HiPath are registered trademarks of Unify Software andSolutions GmbH & Co. KG. All other company, brand, product and service names aretrademarks or registered trademarks of their respective holders.unify.com
Contents1.About the REST SDK Framework. 81.1. REST SDK Framework solution overview . 82.REST SDK Framework prerequisites . 93.REST SDK Principles. 103.1. Functional Description . 103.2. Configuration . 103.3. Simple REST SDK flow examples. 113.4. HTTP Messages . 134.REST SDK Messages. 154.1. Main . 154.1.1. Main Commands . 154.1.1.1. RegisterApplication . 154.1.1.2. UnregisterApplication . 164.1.1.3. Logon . 164.1.1.4. KeepAlive . 174.1.1.5. GetServerState . 184.1.2. Main Commands (old versions) . 184.1.2.1. UnregisterApplication (v1) . 184.2. Admin . 204.2.1. Admin Commands . 204.2.1.1. GetUsers . 204.2.1.2. GetQueues . 214.2.1.3. GetGroups . 224.2.1.4. GetDepartments . 234.2.1.5. GetAggregates . 244.2.1.6. GetUnavailableReasons . 254.2.1.7. GetWrapUpReasons . 264.2.1.8. GetWorkReasons . 274.2.1.9. GetPostProcessingReasons . 274.2.1.10. GetCallbackRetryReasons . 284.2.1.11. GetCallbackDeleteReasons . 294.2.1.12. GetOpenMediaConnectors . 304.2.1.13. GetOpenMediaDiscardReasons . 304.2.1.14. StartListenForEvents. 314.2.1.15. StopListenForEvents . 324.2.2. Admin Events . 324.2.2.1. OnUserUpdateEvent . 324.2.2.2. OnQueueUpdateEvent . 344.2.2.3. OnGroupUpdateEvent. 354.2.2.4. OnDepartmentUpdateEvent . 364.2.2.5. OnAggregateUpdateEvent . 364.2.2.6. OnPostProcessingReasonUpdateEvent . 374.2.2.7. OnUnavailableReasonUpdateEvent . 384.2.2.8. OnWrapUpReasonUpdateEvent . 39A31003-S22A4-R102-02-7620, 10/2021OpenScape Contact Center Enterprise V10 R4, REST SDK Framework, Programming Guide3
4.2.2.9. OnCallbackReasonUpdateEvent . 404.2.2.10. OnOpenMediaDiscardReasonUpdateEvent . 414.2.2.11. OnDeleteEvent . 424.2.2.12. OnServerConnectedEvent . 434.2.2.13. OnServerDisconnectedEvent . 434.2.3. Admin Events (old versions) . 444.2.3.1. OnUserUpdateEvent (v1) . 444.2.3.2. OnQueueUpdateEvent (v1). 454.2.3.3. OnGroupUpdateEvent (v1) . 464.2.3.4. OnDepartmentUpdateEvent (v1). 474.2.3.5. OnAggregateUpdateEvent (v1) . 474.2.3.6. OnPostProcessingReasonUpdateEvent (v1) . 484.2.3.7. OnUnavailableReasonUpdateEvent (v1) . 494.2.3.8. OnWrapUpReasonUpdateEvent (v1) . 494.2.3.9. OnCallbackReasonUpdateEvent (V1) . 504.2.3.10. OnDeleteEvent (v1) . 514.3. Presence . 534.3.1. Presence Commands . 534.3.1.1. SetRoutingState . 534.3.1.2. RequestPostProcessing . 534.3.1.3. ExitPostProcessing . 544.3.1.4. SetPrimary. 544.3.1.5. CancelMandatoryWrappingUp . 554.3.1.6. SetWrapUpReason . 554.3.1.7. StartListenForEvents . 564.3.1.8. StopListenForEvents . 564.3.2. Presence Events . 574.3.2.1. OnUserMediaEvent . 574.3.2.2. OnRoutingStateEvent . 584.3.2.3. OnUserHandlingStateEvent . 594.3.2.4. OnUserMediaReadyEvent . 614.3.2.5. OnUserMediaNotReadyEvent . 614.3.2.6. OnServerConnected . 624.3.2.7. OnServerDisconnected . 624.4. Routing . 644.4.1. Routing Commands . 644.4.1.1. QueryCall . 644.4.1.2. UpdateCall. 654.4.1.3. EnqueueCall . 664.4.1.4. DequeueCall. 674.4.1.5. AddContactData . 674.4.1.6. RemoveContactData . 684.4.1.7. ClearContactData . 684.4.1.8. StartListenForEvents . 684.4.1.9. StopListenForEvents . 694.4.2. Routing Events. 694.4.2.1. OnAssignCallEvent . 694.4.2.2. OnUnassignCallEvent . 704.4.2.3. OnEnqueueCallEvent. 714.4.2.4. OnDequeueCallEvent . 724.4.2.5. OnRoutingUpdateInformationEvent . 724.4.2.6. OnTimeoutCallEvent . 744.4.2.7. OnServerConnected . 744.4.2.8. OnServerDisconnected . 754A31003-S22A4-R102-02-7620, 10/2021OpenScape Contact Center Enterprise V10 R4, REST SDK Framework, Programming Guide
4.5. Telephony . 774.5.1. Telephony Commands . 774.5.1.1. Logon . 774.5.1.2. Logoff . 774.5.1.3. Dial . 784.5.1.4. Answer . 784.5.1.5. Disconnect. 784.5.1.6. Consult . 794.5.1.7. Hold . 794.5.1.8. Retrieve . 794.5.1.9. Reconnect . 804.5.1.10. Conference . 804.5.1.11. Transfer . 804.5.1.12. SingleStepTransfer . 814.5.1.13. TransferToVoiceMail . 814.5.1.14. Divert . 824.5.1.15. SetUserPreferredDevice . 824.5.1.16. RemoveUserPreferredDevice . 824.5.1.17. UpdateContactData . 834.5.1.18. QueryLine . 834.5.1.19. QueryCall . 844.5.1.20. StartListenForEvents. 864.5.1.21. StopListenForEvents . 874.5.2. Telephony Events . 884.5.2.1. OnDeliveredEvent . 884.5.2.2. OnDisconnectedEvent . 904.5.2.3. OnQueuedEvent . 914.5.2.4. OnEstablishedEvent . 924.5.2.5. OnDivertedEvent . 934.5.2.6. OnHeldEvent . 954.5.2.7. OnRetrievedEvent . 964.5.2.8. OnConferencedEvent. 974.5.2.9. OnFailedEvent . 994.5.2.10. OnOriginatedEvent . 1004.5.2.11. OnServiceInitiatedEvent. 1024.5.2.12. OnTransferredEvent. 1034.5.2.13. OnNetworkReachedEvent. 1054.5.2.14. OnServicesEnabled . 1064.5.2.15. OnServerConnectedEvent . 1074.5.2.16. OnServerDisconnectedEvent . 1084.5.3. Telephony Common Objects . 1094.5.4. Telephony Commands (old versions) . 1094.5.4.1. Logon (v1) . 1094.5.4.2. Logoff (v1) . 1094.5.4.3. QueryLine (v1) . 1104.6. Callback . 1124.6.1. Callback Commands . 1124.6.1.1. Logon . 1124.6.1.2. Logoff . 1124.6.1.3. Accept . 1124.6.1.4. Complete . 113A31003-S22A4-R102-02-7620, 10/2021OpenScape Contact Center Enterprise V10 R4, REST SDK Framework, Programming Guide5
4.6.1.5. Create. 1134.6.1.6. Delete . 1144.6.1.7. QueryNewCallbacks. 1154.6.1.8. Update . 1154.6.1.9. StartListenForEvents . 1164.6.1.10. StopListenForEvents . 1174.6.2. Callback Events . 1174.6.2.1. OnDeliveredCallbackEvent . 1174.6.2.2. OnDivertedCallbackEvent . 1184.6.2.3. OnMakeCallFailedCallbackEvent. 1194.6.2.4. OnServerConnected . 1204.6.2.5. OnServerDisconnected . 1204.6.3. Callback Common Objects . 1214.6.3.1. Schedule Object . 1214.6.3.2. Schedules Object . 1214.6.3.3. ContactData Object . 1224.7. Web Collaboration . 1234.7.1. Web Collaboration Commands . 1234.7.1.1. Logon . 1234.7.1.2. Logoff . 1234.7.1.3. Accept . 1244.7.1.4. Disconnect. 1244.7.1.5. InviteAgent . 1244.7.1.6. DeclineInvite . 1254.7.1.7. CallMe . 1254.7.1.8. RequeueToQueue . 1264.7.1.9. RequeueToAgent . 1264.7.1.10. AddContent . 1274.7.1.11. UpdateContactData . 1274.7.1.12. StartListenForEvents. 1284.7.1.13. StopListenForEvents . 1284.7.2. Web Collaboration Events . 1284.7.2.1. OnDeliveredWebChatEvent . 1294.7.2.2. OnDivertedWebChatEvent . 1304.7.2.3. OnContentWebChatEvent. 1314.7.2.4. OnDisconnectedWebChatEvent . 1324.7.2.5. OnEstablishedWebChatEvent. 1334.7.2.6. OnConferencedWebChatEvent. 1344.7.2.7. OnCallMeAnswerWebChatEvent . 1354.7.2.8. OnServerConnectedEvent . 1364.7.2.9. OnServerDisconnectedEvent . 1364.7.3. Web Collaboration Common Objects . 1374.7.3.1. ChatContent Object . 1374.7.3.2. ContactData Object . 1374.8. OpenMedia . 1384.8.1. OpenMedia Commands . 1384.8.1.1. Logon . 1384.8.1.2. Logoff . 1384.8.1.3. Accept . 1394.8.1.4. Disconnect. 1394.8.1.5. QueryEligibleUsers . 1394.8.1.6. Reply . 1404.8.1.7. Defer. 1414.8.1.8. Res
OpenScape Contact Center Enterprise V10 R4, REST SDK Framework, Programming Guide 1. About the REST SDK Framework The REST SDK Framework allows the development of multimedia applications that integrate with the OpenScape Contact Center system. The framework consists of a REST interface, which allows sending commands from the application to the
