![]() |
Openscape Voice V10 - SOAP Interface Documentation
|
Subscriber Definitions and Methods. More...
Classes | |
| struct | unsp__GetSubscriberDataOptionList |
| List of subscriber profile data options. More... | |
| struct | unsp__GetSubscriberDataOptions |
| List of all data information from the subscriber profile. More... | |
| struct | unsp__HotDeskingStatusInfo |
| Hot Desking Status Information. More... | |
| struct | unsp__Status |
| Subscriber Status data. More... | |
| struct | unsp__MlhgList |
| List of ML Hunt Group Pilot DNs. More... | |
| struct | unsp__MlhgListInfoEntry |
| MLHG Information Entry. More... | |
| struct | unsp__MlhgListInfo |
| List of MLHGs that a subscriber if member of. More... | |
| struct | unsp__SubMlhgInfo |
| Subscriber ML Hunt Group Information. More... | |
| struct | unsp__SIPSecurity |
| Subscriber SIP Security Information. More... | |
| struct | unsp__IPMediaType |
| Contact Media Type. More... | |
| struct | unsp__ContactInfo |
| Subscriber Contact Information. More... | |
| struct | unsp__ContactInfoList |
| Contact Information List. More... | |
| struct | unsp__ContactRequest |
| Add Contact request. More... | |
| struct | unsp__IPPhoneAttribute |
| subscriber Endpoint Attributes More... | |
| struct | unsp__LicenseType |
| Subscriber License Type. More... | |
| struct | unsp__IPPhone |
| Subscriber IP Phone Information. More... | |
| struct | unsp__ConnectionInfo |
| Subscriber Connection Information. More... | |
| struct | unsp__Features |
| Features. More... | |
| struct | unsp__KeysetUseListElement |
| Keyset Use List Element. More... | |
| struct | unsp__KeysetUseList |
| Multiple filter value selection for KeysetUse. More... | |
| struct | unsp__BGDeptNameListEntry |
| BG Department List Entry. More... | |
| struct | unsp__BGDeptNameList |
| Multiple filter value selection for BG Department Name. More... | |
| struct | unsp__NumberPlanNameEntry |
| Number Plan Name Entry. More... | |
| struct | unsp__NumberPlanNameList |
| Number Plan Name List. More... | |
| struct | unsp__GetSubListSortElement |
| Get Subscriber List Sort Element. More... | |
| struct | unsp__GetSubListSortList |
| List of Sorting Elements. More... | |
| struct | unsp__GetSubscriberListDataOptionItem |
| Get Subscriber List Data Option Item. More... | |
| struct | unsp__GetSubscriberListDataOptionList |
| List of Data Option elements. More... | |
| struct | unsp__ExcludedBGNamesListEntry |
| Excluded Business Group Name Entry. More... | |
| struct | unsp__ExcludedBGNamesList |
| List of excluded Business Group Names. More... | |
| struct | unsp__GetSubscriberListRequest |
| Get Subscriber List request. More... | |
| struct | unsp__OfficeCodeParts |
| Office Code Data. More... | |
| struct | unsp__FeatureInfo |
| Feature Assigned Information. More... | |
| struct | unsp__HuntGroupInfoEntry |
| ML Hunt Group Information Entry. More... | |
| struct | unsp__HuntGroupInfoList |
| ML Hunt Group Information List. More... | |
| struct | unsp__GetSubscriberListEntry |
| Get Subscriber List Entry. More... | |
| struct | unsp__GetSubscriberListData |
| Get Subscriber List Data. More... | |
| struct | unsp__GetSubscriberListResult |
| Get Subscriber List result. More... | |
| struct | unsp__GetKeysetPrimaryListRequest |
| Get Keyset Primary List request. More... | |
| struct | unsp__GetKeysetPrimaryListEntry |
| Get Keyset Primary List Entry. More... | |
| struct | unsp__GetKeysetPrimaryListData |
| Get Keyset Primary List Data. More... | |
| struct | unsp__GetKeysetPrimaryListResult |
| Get Keyset Primary List result. More... | |
| struct | unsp__DnChangeRequest |
| Change DN request. More... | |
| struct | unsp__CreateSubscriberReq2 |
| Create Subscriber request 2. More... | |
| struct | unsp__CreateSubscriberResult |
| Create Subscriber result. More... | |
| struct | unsp__DeleteSubscriberRequest |
| Delete Subscriber request. More... | |
| struct | unsp__DeleteSubscriberResult |
| Delete Subscriber result. More... | |
| struct | unsp__UpdateSubscriberStatusRequest |
| Update Subscriber Status request. More... | |
| struct | unsp__UpdateSubscriberStatusResult |
| Update Subscriber Status result. More... | |
| struct | unsp__UpdateSubscriberAccountMgtInfoRequest |
| Update Subscriber Account Management Information request. More... | |
| struct | unsp__UpdateSubscriberAccountMgtInfoResult |
| Update Subscriber Account Management Information result. More... | |
| struct | unsp__UpdateSubscriberBGInfoRequest |
| Update Subscriber Business Group Information request. More... | |
| struct | unsp__UpdateSubscriberBGInfoResult |
| Update Subscriber Business Group Information result. More... | |
| struct | unsp__UpdateSubscriberAccountUserInfoRequest |
| Update Subscriber Account User Information request. More... | |
| struct | unsp__UpdateSubscriberAccountUserInfoResult |
| Update Subscriber Account User Information result. More... | |
| struct | unsp__UpdateKeysetInfoRequest |
| Update Subscriber Keyset Information request. More... | |
| struct | unsp__UpdateKeysetInfoResult |
| Update Subscriber Keyset Information result. More... | |
| struct | unsp__UpdateSubscriberDnRequest |
| Update Subscriber DN request. More... | |
| struct | unsp__UpdateSubscriberDnResult |
| Update Subscriber DN result. More... | |
| struct | unsp__UpdateConnectionInfoRequest |
| Update Subscriber Connection Information request. More... | |
| struct | unsp__UpdateConnectionInfoResult |
| Update Subscriber Connection Information result. More... | |
| struct | unsp__UpdateMobileInfoRequest |
| Update Mobile Information request. More... | |
| struct | unsp__UpdateMobileInfoResult |
| Update Mobile Information result. More... | |
| struct | unsp__UpdateSubscriberFeatureProfileRequest |
| Update Subscriber Feature Profile request. More... | |
| struct | unsp__UpdateSubscriberFeatureProfileResult |
| Update Subscriber Feature Profile result. More... | |
| struct | unsp__AddContactListResult |
| Add Contact List result. More... | |
| struct | unsp__DeleteContactListResult |
| Delete Contact List result. More... | |
| struct | unsp__GetContactListRequest |
| Get Contact List request. More... | |
| struct | unsp__GetContactListResult |
| Get Contact List result. More... | |
| struct | unsp__HotDeskingLogOffRequest |
| Hot Desking Log Off request. More... | |
| struct | unsp__HotDeskingLogOffResult |
| Hot Desking Log Off result. More... | |
| struct | unsp__GetTombStoneSubscriberListRequest |
| Get Tombstone Subscriber List request. More... | |
| struct | unsp__GetTombStoneSubscriberListEntry |
| Get Tombstone Subscriber List entry. More... | |
| struct | unsp__GetTombStoneSubscriberListData |
| Get Tombstone Subscriber List data. More... | |
| struct | unsp__GetTombStoneSubscriberListResult |
| Get Tombstone Subscriber List result. More... | |
Functions | |
| int | unsp__GetSubscriberList (struct unsp__GetSubscriberListRequest GetSubListReq, struct unsp__GetSubscriberListResult *SubListResult) |
| The GetSubscriberList method is used to retrieve the list of subscribers on the switch. More... | |
| int | unsp__GetKeysetPrimaryList (struct unsp__GetKeysetPrimaryListRequest GetKeysetPrimaryListReq, struct unsp__GetKeysetPrimaryListResult *KeysetPrimaryListResult) |
| Given a particular DN, this method returns a list of all subscribers that are Keyset Primary Lines having the given DN as a Secondary Line Appearance. More... | |
| int | unsp__CreateSubscriber2 (struct unsp__CreateSubscriberReq2 CreateSubRequest, struct unsp__CreateSubscriberResult *CreateSubscriberResult) |
| Creates a SIP or Profile-Only Subscriber. More... | |
| int | unsp__DeleteSubscriber2 (struct unsp__DeleteSubscriberRequest DeleteSubscriberRequest, struct unsp__DeleteSubscriberResult *DeleteSubscriberResult) |
| This method is used to remove the subscriber entry. More... | |
| int | unsp__UpdateSubscriberStatus2 (struct unsp__UpdateSubscriberStatusRequest UpdateSubscriberStatusRequest, struct unsp__UpdateSubscriberStatusResult *UpdateSubscriberStatusResult) |
| This method is used to change the status of a subscriber. More... | |
| int | unsp__UpdateSubscriberAccountMgtInfo2 (struct unsp__UpdateSubscriberAccountMgtInfoRequest UpdateSubscriberAccountMgtInfoRequest, struct unsp__UpdateSubscriberAccountMgtInfoResult *UpdateSubscriberAccountMgtInfoResult) |
| This method changes the management information of the subscriber's basic profile. More... | |
| int | unsp__UpdateSubscriberBGInfo2 (struct unsp__UpdateSubscriberBGInfoRequest UpdateSubscriberBGInfoRequest, struct unsp__UpdateSubscriberBGInfoResult *UpdateSubscriberBGInfoResult) |
| This method enables the user to change the Business Group information related to the subscriber. More... | |
| int | unsp__UpdateSubscriberAccountUserInfo2 (struct unsp__UpdateSubscriberAccountUserInfoRequest UpdateSubscriberAccountUserInfoRequest, struct unsp__UpdateSubscriberAccountUserInfoResult *UpdateSubscriberAccountUserInfoResult) |
| This method changes the user-controlled information of the subscriber's basic profile. More... | |
| int | unsp__UpdateKeysetInfo2 (struct unsp__UpdateKeysetInfoRequest UpdateKeysetInfoRequest, struct unsp__UpdateKeysetInfoResult *UpdateKeysetInfoResult) |
| This method is used to update the keyset-related data for a keyset subscriber. More... | |
| int | unsp__UpdateSubscriberDn2 (struct unsp__UpdateSubscriberDnRequest UpdateSubscriberDnRequest, struct unsp__UpdateSubscriberDnResult *UpdateSubscriberDnResult) |
| This method is used to change the DN of a subscriber. More... | |
| int | unsp__UpdateConnectionInfo2 (struct unsp__UpdateConnectionInfoRequest UpdateConnectionInfoRequest, struct unsp__UpdateConnectionInfoResult *UpdateSubResult) |
| This method is used to change the subscriber's connection information. More... | |
| int | unsp__UpdateMobileInfo (struct unsp__UpdateMobileInfoRequest UpdateMobileInfoRequest, struct unsp__UpdateMobileInfoResult *UpdateMobileInfoResult) |
| This method updates the mobile information of a subscriber. More... | |
| int | unsp__UpdateSubscriberFeatureProfile2 (struct unsp__UpdateSubscriberFeatureProfileRequest UpdateSubscriberFeatureProfileReq, struct unsp__UpdateSubscriberFeatureProfileResult *unsp__UpdateSubscriberFeatureProfileResult) |
| This method associates a subscriber with a Feature Profile. More... | |
| int | unsp__AddContactList2 (struct unsp__ContactRequest AddContactListReq, struct unsp__AddContactListResult *AddContactListResult) |
| This method adds contacts to a SIP Subscriber. More... | |
| int | unsp__DeleteContactList2 (struct unsp__ContactRequest DeleteContactListReq, struct unsp__DeleteContactListResult *unsp__DeleteContactListResult) |
| This method deletes contacts from a SIP Subscriber. More... | |
| int | unsp__GetContactList (struct unsp__GetContactListRequest GetContactListReq, struct unsp__GetContactListResult *GetContactListResult) |
| This method retrieves the list of contacts of a SIP Subscriber. More... | |
| int | unsp__HotDeskingLogOff2 (struct unsp__HotDeskingLogOffRequest *HotDeskingLogOffRequest, struct unsp__HotDeskingLogOffResult *HotDeskingLogOffResult) |
| This method log offs a Hot Desking Session of a Subscriber. More... | |
| int | unsp__GetTombStoneSubscriberList (struct unsp__GetTombStoneSubscriberListRequest TombStoneSubListRequest, struct unsp__GetTombStoneSubscriberListResult *TombStoneSubListResult) |
| This method provides the ability to display a list of subscribers deleted after a specified date and/or the list of subscribers that has had a specific service unassigned (currently only CSTA is supported) after a specified date. More... | |
Subscriber Definitions and Methods.
Subscribers are identified by their DN. The subscriber may have many attributes and the following methods are used to manipulate the subscriber and any of their attributes. Subscribers must be associated with a Business Group and Private Number Plan. A Subscriber may be:
| enum unsp__ConnectionType |
| enum unsp__Feature |
Feature Type.
Get Subscriber List Sort Type.
Subscriber profile data option.
Provides selection of additional data fields to be included in the result structure.
| enum unsp__IPConnRegTypes |
Registered Subscriber License Type.
Provisioned Subscriber License Type.
| unsp__AddContactList2 | ( | struct unsp__ContactRequest | AddContactListReq, |
| struct unsp__AddContactListResult * | AddContactListResult | ||
| ) |
This method adds contacts to a SIP Subscriber.
| AddContactListReq | API request |
| AddContactListResult | API result |
MP2 command: CTINFOADD [Attributes]
| unsp__CreateSubscriber2 | ( | struct unsp__CreateSubscriberReq2 | CreateSubRequest, |
| struct unsp__CreateSubscriberResult * | CreateSubscriberResult | ||
| ) |
Creates a SIP or Profile-Only Subscriber.
| CreateSubRequest | API request |
| CreateSubscriberResult | API result |
MP2 commands:
| unsp__DeleteContactList2 | ( | struct unsp__ContactRequest | DeleteContactListReq, |
| struct unsp__DeleteContactListResult * | unsp__DeleteContactListResult | ||
| ) |
This method deletes contacts from a SIP Subscriber.
| DeleteContactListReq | API request |
| unsp__DeleteContactListResult | API result |
MP2 command: CTINFOREMOVE [Attributes]
| unsp__DeleteSubscriber2 | ( | struct unsp__DeleteSubscriberRequest | DeleteSubscriberRequest, |
| struct unsp__DeleteSubscriberResult * | DeleteSubscriberResult | ||
| ) |
This method is used to remove the subscriber entry.
This method removes any aliases, lines, services and other data that are associated with the DN. If there is a failure, it will continue and delete everything that it can (in case the tables are inconsistent). It will set the HomeDn entry to vacant and remove any existing profile or services data for the subscriber.
If a subscriber is set to be the callback number of a BG subnet, any attempt to delete the subscriber fails. Additionally any attempt to remove a DN number which is used as a default callback number in a Bg subnet is prohibited.
The method may return warnings if it encounters problems.
| DeleteSubscriberRequest | API request |
| DeleteSubscriberResult | API result |
MP2 command: RS [Attributes]
| unsp__GetContactList | ( | struct unsp__GetContactListRequest | GetContactListReq, |
| struct unsp__GetContactListResult * | GetContactListResult | ||
| ) |
This method retrieves the list of contacts of a SIP Subscriber.
| GetContactListReq | API request |
| GetContactListResult | API result |
| unsp__GetKeysetPrimaryList | ( | struct unsp__GetKeysetPrimaryListRequest | GetKeysetPrimaryListReq, |
| struct unsp__GetKeysetPrimaryListResult * | KeysetPrimaryListResult | ||
| ) |
Given a particular DN, this method returns a list of all subscribers that are Keyset Primary Lines having the given DN as a Secondary Line Appearance.
A maximum of 40 subscribers are returned, since that is the maximum number of devices on which a particular DN can appear as a Secondary Line Appearance.
| GetKeysetPrimaryListReq | API request |
| KeysetPrimaryListResult | API result |
| unsp__GetSubscriberList | ( | struct unsp__GetSubscriberListRequest | GetSubListReq, |
| struct unsp__GetSubscriberListResult * | SubListResult | ||
| ) |
The GetSubscriberList method is used to retrieve the list of subscribers on the switch.
A starting subscriber can be provided or part of a subscriber ID containing the wildcard character (%), and a maximum count to be retrieved.
The default behavior is that subscribers are returned in numerical order from lowest DN to highest. Sorting can also be performed on several other characteristics that can be filled in the GetSubListSortElement list of the request. A number of filter criteria are possible so that a particular subset of existing subscribers can be retrieved. When a specific filter is implemented as a list, multiple filter value selection is available. Wildcarding is also available for string attributes and range/min/max is implemented for the CpuID attribute. All conditions specified are AND-ed together.
However, the total number of existing subscribers that meet the given filter criteria is returned in the TotalSubsFound field so that if there are more than 1000 existing subscribers, the client application can send multiple requests, each one with starting subscriber greater than the last one returned and thus obtain all existing subscribers.
| GetSubListReq | API request |
| SubListResult | API result |
| unsp__GetTombStoneSubscriberList | ( | struct unsp__GetTombStoneSubscriberListRequest | TombStoneSubListRequest, |
| struct unsp__GetTombStoneSubscriberListResult * | TombStoneSubListResult | ||
| ) |
This method provides the ability to display a list of subscribers deleted after a specified date and/or the list of subscribers that has had a specific service unassigned (currently only CSTA is supported) after a specified date.
| TombStoneSubListRequest | API request |
| TombStoneSubListResult | API result |
| unsp__HotDeskingLogOff2 | ( | struct unsp__HotDeskingLogOffRequest * | HotDeskingLogOffRequest, |
| struct unsp__HotDeskingLogOffResult * | HotDeskingLogOffResult | ||
| ) |
This method log offs a Hot Desking Session of a Subscriber.
| HotDeskingLogOffRequest | API request |
| HotDeskingLogOffResult | API result |
| unsp__UpdateConnectionInfo2 | ( | struct unsp__UpdateConnectionInfoRequest | UpdateConnectionInfoRequest, |
| struct unsp__UpdateConnectionInfoResult * | UpdateSubResult | ||
| ) |
This method is used to change the subscriber's connection information.
| UpdateConnectionInfoRequest | API request |
| UpdateSubResult | API result |
MP2 command: UCS [Attributes]
| unsp__UpdateKeysetInfo2 | ( | struct unsp__UpdateKeysetInfoRequest | UpdateKeysetInfoRequest, |
| struct unsp__UpdateKeysetInfoResult * | UpdateKeysetInfoResult | ||
| ) |
This method is used to update the keyset-related data for a keyset subscriber.
| UpdateKeysetInfoRequest | API request |
| UpdateKeysetInfoResult | API result |
MP2 command: UK [Attributes]
| unsp__UpdateMobileInfo | ( | struct unsp__UpdateMobileInfoRequest | UpdateMobileInfoRequest, |
| struct unsp__UpdateMobileInfoResult * | UpdateMobileInfoResult | ||
| ) |
This method updates the mobile information of a subscriber.
| UpdateMobileInfoRequest | API request |
| UpdateMobileInfoResult | API result |
MP2 command: UMI [Attributes]
| unsp__UpdateSubscriberAccountMgtInfo2 | ( | struct unsp__UpdateSubscriberAccountMgtInfoRequest | UpdateSubscriberAccountMgtInfoRequest, |
| struct unsp__UpdateSubscriberAccountMgtInfoResult * | UpdateSubscriberAccountMgtInfoResult | ||
| ) |
This method changes the management information of the subscriber's basic profile.
| UpdateSubscriberAccountMgtInfoRequest | API request |
| UpdateSubscriberAccountMgtInfoResult | API result |
MP2 command: UM [Attributes]
| unsp__UpdateSubscriberAccountUserInfo2 | ( | struct unsp__UpdateSubscriberAccountUserInfoRequest | UpdateSubscriberAccountUserInfoRequest, |
| struct unsp__UpdateSubscriberAccountUserInfoResult * | UpdateSubscriberAccountUserInfoResult | ||
| ) |
This method changes the user-controlled information of the subscriber's basic profile.
| UpdateSubscriberAccountUserInfoRequest | API request |
| UpdateSubscriberAccountUserInfoResult | API result |
MP2 command: UU [Attributes]
| unsp__UpdateSubscriberBGInfo2 | ( | struct unsp__UpdateSubscriberBGInfoRequest | UpdateSubscriberBGInfoRequest, |
| struct unsp__UpdateSubscriberBGInfoResult * | UpdateSubscriberBGInfoResult | ||
| ) |
This method enables the user to change the Business Group information related to the subscriber.
| UpdateSubscriberBGInfoRequest | API request |
| UpdateSubscriberBGInfoResult | API result |
MP2 command: UMB [Attributes]
| unsp__UpdateSubscriberDn2 | ( | struct unsp__UpdateSubscriberDnRequest | UpdateSubscriberDnRequest, |
| struct unsp__UpdateSubscriberDnResult * | UpdateSubscriberDnResult | ||
| ) |
This method is used to change the DN of a subscriber.
The new DN must have been defined as available on the switch and Available (vacant).
Calls to the old number will produce either a disconnect or NewNumber announcement. A flag is used to control the announcement, because the new number may not be published.
If a subscriber is changed to a DN number that already exists as a callback number of a BG subnet, any attempt to delete the subscriber fails. Additionally any attempt to change a DN number which is used as a default callback number in a Bg subnet is prohibited.
| UpdateSubscriberDnRequest | API request |
| UpdateSubscriberDnResult | API result |
MP2 command: UD [Attributes]
| unsp__UpdateSubscriberFeatureProfile2 | ( | struct unsp__UpdateSubscriberFeatureProfileRequest | UpdateSubscriberFeatureProfileReq, |
| struct unsp__UpdateSubscriberFeatureProfileResult * | unsp__UpdateSubscriberFeatureProfileResult | ||
| ) |
This method associates a subscriber with a Feature Profile.
To remove a subscriber's association with a feature profile, specify a blank Feature Profile Name and do not specify a Feature Profile Business Group Name.
| UpdateSubscriberFeatureProfileReq | API request |
| unsp__UpdateSubscriberFeatureProfileResult | API result |
MP2 command: UFP [Attributes]
| unsp__UpdateSubscriberStatus2 | ( | struct unsp__UpdateSubscriberStatusRequest | UpdateSubscriberStatusRequest, |
| struct unsp__UpdateSubscriberStatusResult * | UpdateSubscriberStatusResult | ||
| ) |
This method is used to change the status of a subscriber.
| UpdateSubscriberStatusRequest | API request |
| UpdateSubscriberStatusResult | API result |
MP2 command: US [Attributes]
1.8.6