| Openscape Voice V10 - SOAP Interface Documentation

Change Log

Summary of Changes in Version 8.0.

### V8.00.01.01

- Added Call Forwarding Override feature
- Mutual Authentication Endpoint Attribute for TLS/MTLS authentication
- Version returned in Fit4More Format
- EZIP Changes without Reboot
- AlphanumericSipUri support for features.
- AlphanumericSipUri field for subscriber.
- Endpoint and Subscriber attributes.
- Support for AlphanumericSipUri in translation APIs.
- Added Domain Codes support.
- Control Support of Alphanumeric SIP URI per CSTA Application
- SOAP Subscriber/EP Profile Interface Cleanup

### V8.00.01.02

- Added ContactMe method
- Removal of deprecated licensing types (EndUser, TrunkingSession and ClientAccess)

### V8.00.01.03

- CentralSBC field introduced for endpoints.
- RegistViaCentralSBC field introduced for subscribers.
- Validate Time Limited License Support
- Added QueryResponsibleDomains method
- SecureConnected and BG ACL per CSTA Application -Trusted field introduced for BGs.
- UseBillingNumberForDP field introduced for endpoints.

### V8.00.01.04

- Add CFLoopExtended to non subscriber endpoints
- BG option to send call rejected by a subscriber (603 Decline) to voicemail
- Added FwdOnCallReject And FwdOnDND In Call Forwarding Voice Mail (CfVM)

### V8.00.01.05

- Removed residential FP and unused connection types
- Removal of Endpoint Default Resource Management Type
- Wrong certificate status.
- BGDeptVariant field introduced for BG Departments.
- EmergencyBGDeptName field introduced for BG Subnets.
- ScanRate, ScanResponseTimeout, Passcode, ALIDBID fields removed from BG Subnets.
- BGEmergencyDeptName field introduced for Subscribers.

### V8.00.01.06

- Removal of configurable MLHG Max Queue Size
- Bulk Treatment Management

### V8.00.02.01

- Endpoint and subscriber SIP Timer Control and Audit Enhancements

### V8.00.03.01

- OSV trace configuration via MP2

### V8.00.04.01

- Allow unregistration of SBC Stale registrations

### V8.00.05.01

- Added VideoCallIsAllowed endpoint attribute
- Added MTPEnabled endpoint attribute

### V8.00.06.01

- Removed Web and Phone options from CFV,CFB,CFDA. Removed USCFV feature.

### V8.00.07.01

- New query filter for aliases (Account Authentication)

### V8.00.08.01

- Added new fields in Create/Modify/Get MLHG to support Hunt Group Conditional-Unconditional for Linear, Circular, UCD types

### V8.00.09.01

- Added ICESupport to subscribers/endpoints

### V8.00.10.01

- Re-purposed Trusted Subscriber attribute

### V8.00.11.01

- SLES Time Limited Licenses

### V8.00.12.01

- Call Pickup Groups - Automatic assignment of CPU ID

### V8.00.13.01

- Incorrect BW for GTG CAC policies

### V8.00.14.01

- Added support for up to 10000 Business Groups, 12000 Number Plans, 12000 CAC Groups

### V8.00.15.01

- Added ACID and CIDSU features.
- New CSTA Interface Options EnableCIDSuppressionStatus, EnableAlternativeCIDList, DisableApplicationPopulatedCID, Reserved_1, Reserved_2, Reserved_3

### V8.00.16.01

- CFSIE control for phones and CSTA applications

### V8.00.17.01

- Added CSTA attribute EnableConsultCallForConnectOnHold.

### V8.00.18.01

- Removed CSTA and ONS deprecated data ONSType:OutboundOnly CSTAType:CstaTypeMGCPResidential, CstaTypeMGCPBusiness, CstaTypeSpecial2, CstaTypeSpecial3, CstaTypeSpecial4, CstaTypeSpecial5

### V8.00.19.01

- Added AllowSubProvidedCallingID subscriber attribute

### V8.00.20.01

- Added HMB support per hunt group. New BG option to reverse HMB toggle key led. New CSTA interface options.

### V8.00.21.01

- Added DoNotPublishRegistrationToE911DM Endpoint attribute

### V8.00.22.01

- Added IsSystemDefault field in Intercepts, Class Services, Traffic Type etc

### V8.00.23.01

- Added Parallel SA MLHG Type.

### V8.00.24.01

- Added Enable fast connect early media for SIP-Q Endpoints.

### V8.00.25.01

- Added OPUS Codec support for CAC Policies.

### V8.00.26.01

- Removed obsolete definitions.

### V8.00.27.01

- Added Security - OSV Support for MTLS Subscribers.

### V8.00.28.01

- Added support for new service namespace "openscape-voice".

### V8.00.29.01

- Added new OpenSSL verification facilities.

### V8.00.30.01

- Added new endpoint AnsibleConnectorAppliance".

### V8.00.31.01

- Added EnablePrivateDataPresentationV8 on CSTA Interface Options.
- Removed AllowExtendedAgentStates from CSTA Interface Options.
- Removed EnableAllMembersBusyNotification from CSTA Interface Options.
- Removed EnableCIDSuppressionStatusfrom CSTA Interface Options.
- Removed EnableAlternativeCIDList from CSTA Interface Options.
- Removed DisableApplicationPopulatedCID from CSTA Interface Options.
- Removed EnableCFPrivilegeChangeNotification from CSTA Interface Options.
- Removed Reserved_1 from CSTA Interface Options.
- Removed Reserved_2 from CSTA Interface Options.
- Removed Reserved_3 from CSTA Interface Options.

### V8.00.32.01

- New CSTA Interface Option EnableInternalServiceEvents

### V8.00.33.01

- Support Access Tokens.
- Introduce public, key stores and trusted CA certificates.
- Introduce new APIs to Add/ Create/ Get/ Modify/ Delete Certificates.

### V8.00.34.01

- Increase number of supported Keyset Appearances from 29 to 299.

### V8.00.35.01

- Support Unknown certificate type and Unknown key size of a certificate.

### V8.00.36.01

- Upgrade gsoap to 2.8.21 and support for TLS1.2

### V8.00.37.01

- Introduce New Generation E911 and LoST Servers

### V8.00.38.01

- IPv6 changes and some changes in wsdl form

### V8.01.01.01

- Fix SOAP services that don't expose a Header in the request (which resolves multi-ref issue)

### V9.00.01.01

- Merge Display name and unicode display name, also, external display name and unicode display name
- Support unicode for BG Department

### V9.00.01.02

- New endpoint attribute "AddToRouteHeader" and new PAC types

### V9.00.01.03

- Introduce AEI Support for subscribers
- Introduce AS-SIP Interface for endpoints
- Introduce Precedence and Preemption feature
- Introduce new CAC policy fields
- Introduce Precedence Call Diversion feature

### V9.00.01.04

- New endpoint attribute "TreatAsSecure"

### V9.00.01.05

- Added NIDCallControlOption enumeration to feature CfCNIM

### V9.00.01.06

- Enhancement in Modify Certificates (CertificateType field was added, Issuer/Serial Number fields were removed)

### V9.00.01.07

- Support DTLS for subscriber and non-subscriber endpoints

### V9.00.01.08

- Endpoint, Allow the inclusion of the User-Agent header when communicating with SIP provider

### V9.00.01.09

- URISupportAllowed endpoint attribute was removed from WSDL.

### V9.00.02.01

- Support searching in Country Code, Home Area Code and Home Exchange Codes fields in regards to Local Toll table

### V9.00.03.01

- Introduce DisableSTRP attribute for subscribers and NNI endpoints
- Introduce the Encryption License type

### V9.00.04.01

- Reserved5 endpoint attribute was renamed to IgnoreReceipt181CallsIsBeingForwarded (applicable only to NNI endpoints)
- ImsFor3GPP endpoint attribute was renamed to Reserved8 (for subscribers and NNI endpoints)
- Remove Reserved4 endpoint attribute from NNI endpoints
- Add Reserved7 endpoint attribute on NNI endpoints

### V9.00.05.01

- OSMO per BG, Mobile Client Profiles (FRN4863),

### V9.00.06.01

- Introduce OverwriteNAMwithLIN enumerator on Emergency Subnets

### V9.00.07.01

- Support UseXChannelHeader endpoint attribute (only for NNI endpoints).

### V9.00.08.01

- Use TIAS for BW Calculation,

### V9.00.09.01

- Single Load Line, check FRNs, productVersion

### V9.00.10.01

- Fallback Routing keeping the modified number

### V9.00.11.01

- Introduce SuppressSPEInSIPQ TO suppress SPE in SIPQ calls

### V9.00.12.01

- Support ELA Voice Only (IPT) Licenses (FRN10417)

### V9.00.13.01

- Offer demo capabilities for SLL OSV through OSV Assistant

### V9.00.14.01

- Introduce HELD servers for NG911, Introduce ESRP functionality

### V9.00.15.01

- Introduce "Do not allow URNs in R-URI/TO header for NG911 calls" attribute for SIP endpoints and NNI endpoints
- Introduce Reserved 9 attribute for SIP endpoints and NNI endpoints

### V9.00.16.01

- CSTA shared bridge appearance support for keysets ,

### V9.00.17.01

- New eZip commands introduced for linux account and role management

### V9.00.18.01

- Introduce "Do not allow NG911 headers" attribute for NNI endpoints (not SIPQ) and subscriber endpoints (Reserved 9 attribute was renamed to DoNotAllowNG911Headers)
- Introduce Reserved 10 attribute for subscriber endpoints and NNI endpoints

### V9.00.19.01

- Introduce Enable911PrivateDataPresentation in CSTA Interface Options

### V9.00.20.01

- FRN10806 distinctive ringing addition for NG911

### V9.00.21.01

- Introduce ALI DB Servers

### V9.00.22.01

- Add DnReverse filter for queryDns

### V9.00.23.01

- Introduce "ACD Call Distribution Device" attribute for subscriber endpoints and NNI endpoints

### V9.00.24.01

- Introduce "Time of Last State Change" in ALI DBs

### V9.00.25.01

- DeleteBGSuite (cascade bg delete) implementation

### V9.00.26.01

- Introduce SIP UA Forking Support mechanism
- Introduce SRTP mode for subscribers and non-subscriber endpoints

### V9.00.27.01

- Introduce "Is TLS" in ALI DBs

### V9.00.28.01

- Include port at CreateFSBackup

### V9.00.29.01

- Introduce RetrieveCBNFromPAIHeader to indicate if an endpoint retrieves CBN from PAI header

### V9.00.30.01

- Introduce FRN10824 Periodic Option Ping Audit for Proactive Alternate Routing

### V9.00.31.01

- Introduce OSV-4442 ESRP Licensing

### V9.00.32.01

- Introduce New Rtp parameter: Srx/Usc/EnableQoSCDRs for FRN10825

### V9.00.33.01

- Introduce OSV-7694 Operational Status and Inactivity Audit for LoST and HELD servers

### V9.00.34.01

- OSV-7977 Change in Licensing IDs

### V9.00.35.01

- Introduce FRN11007 Support of emergency calling through OSCloud

### V9.00.36.01

- OSV-6831 Support different realms and credentials for sip entities with same IP but different port

### V9.00.37.01

- Introduce Multiple ALI DBs - ALI Selection based on the incoming trunk number

### V9.00.38.01

- Introduce FRN10978 Enable Group Pickup for CSTAApplications

### V9.00.39.01

- Introduce Element state, supported Event Packages per client/subscriber

### V9.00.40.01

- OSV-7664 Introduce "Associated Subscriber DN" for non-subscriber endpoints

### V9.00.41.01

- Introduce Queue state (server/client)

### V9.00.42.01

- Introduce Service state per client/server

### V9.00.43.01

- Introduce ServGrpMemberTypeUndefined and ServGrpMemberMonitorUndefined enum values

### V9.00.44.01

- OSV-8440 -SIPREC Recording

### V9.00.45.01

- Override option in element state

### V9.00.46.01

- FRN10225 E911 Emergency Calling - allow multiple subnets to share LINs and Callback numbers

### V9.00.47.01

- EENA support for Element/Service state

### V9.00.48.01

- Introduce PSAP license

### V9.00.49.01

- Deprecate Reserved10 attribute
- Introduce "Add EP Name in SIP URI" attribute for NNI endpoints
- Introduce Reserved11 attribute for both subscriber and NNI endpoints for future use

### V9.00.50.01

- FRN11086 Enable Backup Preferred Device Routing CSTA Interface Option

### V9.00.51.01

- MSRP support (AllowNonAudioCalls, Send182QueuedResponse)

### V9.00.52.01

- Introduce "Do not allow Geolocation Headers for NG911 calls" attribute for subscriber endpoints and NNI endpoints
- Support Held Servers at Trunk (Dual mode functionality)
- Held Servers return a list of Trunks

### V9.00.53.01

- CSTA Application Interface. Introduce AllowCancellationSingleStepTransfer field.

### V9.00.54.01

- PSAP-861: ESRP-GUI enhancements for ServiceState and ElementState functionality

### V9.00.55.01

- OSV-13174: Introduce "Ignore Location By Value" attribute for subscriber endpoints and NNI endpoints

### V9.00.56.01

- Introduce Location Services in ESRP mode

### V9.00.57.01

- Introduce Service Group Name/Identifier
- Introduce subscription count per service group
- Query client FE entries based on Event Package Identifier
- Introduce FE Identifier at a Service Group Member entry

### V9.00.58.01

- Introduce HideIsFocus option

### V9.00.59.01

- OSV-14767: Introduce "Add Pif Parameter" attribute applicable to non-SIPQ NNI endpoints

### V9.00.60.01

- OSV-13260: Introduce Paging for unsp__GetMlhgInfo3

### V9.00.61.01

- OSV-14188: Introduce Logging Clients

### V9.00.62.01

- Introduce Logging Servers

### V9.00.63.01

- Remove AddPifParameter endpoint attribute from WSDL. This is a very very special case. It is allowed as none Assistant has implemented it and additionally the PS this attribute was introduced is not GA.

### V9.00.64.01

- Introduce Abandoned Call event package in Server Side

### V10.00.01.01

- V10 Release

### V10.00.02.01

- Logical Partitioning to Isolate Users

### V10.00.03.01

- OSV-17167: Introduce "Simultaneous calls not allowed from multiple contacts" attribute

### V10.00.04.01

- OSV-18790: Introduce "Support Foreign Peer Domains" attribute

### V10.00.05.01

- OSV-18762: Introduce "Suppress Alert-Info: Auto-Answer" Endpoint Attribute

### V10.00.06.01

- OSV-19111: Introduce "Enable Remote Attended Call Transfer" Endpoint Attribute

### V10.00.07.01

- OSV-19282: Rename "Enable Remote Attended Call Transfer" Endpoint Attribute to "Support Replaces Header"
- OSV-19282: Introduce "Ignore Receipt/Do not send Privacy Header" Endpoint Attribute

### V10.00.08.01

- OSV-19590: Create sip Endpoint Attribute "Enable REFER Notifications"

### V10.00.09.01

- FRN10770 : Create EP Attribute "History-Info Supported"

### V10.00.10.01

- OSV-20683 : Prevent OSV Upgrade after end of life

### V10.00.11.01

- OSV-20987 : Unify Phone License"

### V10.00.12.01

- OSV-21453 : Incrementing SDP o-line in Trunk-Trunk scenarios

### V10.00.13.01

- OSV-22097 : OSV-22036: GPC support for UC Soft client

### V10.00.14.01

- OSV-22529 : OSV-22036: SOAP changes to support Hunt Type filtering in ListHGMembers API

### V10.00.15.01

- OSV-22903 : OSV-22033: Provisioning for Feature Call Transfer on Busy

### V11.00.01.01

- V11 Release

### V11.00.02.01

- OSV-23277 : Handling of queued calls in failover scenarios

### V11.00.03.01

- OSV-23840 : Support DynamicONS License

### V11.00.04.01

- OSV-24173 : Zoom User

### V11.00.05.01

- OSV-24356 : Configuration Impact to Exclude urn:service:sos and GRUU from outgoing message

### V10.00.20.01

- OSV-24315 : Auto-Reconnect on Blind Transfer Failure with no Hold

### V11.00.06.01

- OSV-24486 : Enhance GetSubscriberList to include ZoomUser attribute

### V11.00.07.01

- OSV-24547 : OSV-20170 (DUL.FMD): Introduce V11 DemoFeaturesSet - Exclude DUL feature

### V11.00.08.01

- OSV-24658 : OSV-20170 (DUL.FMD): Retrieve the OND clients of an ONS subscriber

### V11.00.09.01

- OSV-24315 : Auto-Reconnect on Blind Transfer Failure with no Hold

### V11.00.10.01

- OSV-24606 : New endpoint attribute is required to block SIP Session Timers using SIP UPDATE method if not supported

### V11.00.11.01

- OSV-24892 : OSV-20170 (DUL.FMD): Support "enabled" field at Dynamic ONS license

### V11.00.12.01

- OSV-24997 : OSV-20170 (DUL.FMD): Remove provisioning restrictions for OND Only subscribers

### V11.00.13.01

- OSV-25027 : Enhance GetBGDeptList to sorting, filtering at DB (Variant, Department name)

### V11.00.14.01

- OSV-25127 : Enhance GetSubscriberList to support isExecAssistantGroupsDN filter

### V11.00.15.01

- OSV-25377 : Enhance GetSubscriberList to support RecordAllCalls filter

### V11.00.16.01

- OSV-25229 : SOAP: Subscribers should be able to support multiple hash algorithms for Digest Authentication
- OSV-25240: SOAP: Realms should support multiple hash algorithms for Digest Authentication

### V11.00.17.01

- OSV-27026: Introduce Contract End License Type