Broadworks-OCIP

 view release on metacpan or  search on metacpan

lib/Broadworks/OCIP/Deprecated.pod  view on Meta::CPAN

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=back

=head3 SystemSpeedDial100GetRequest

Get the speed dial 100 system-wide default setting.

The response is either a C<SystemSpeedDial100GetResponse> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemSubscriberGetCallProcessingParametersRequest17

Get the system call processing configuration for all subscribers

The response is either a
C<SystemSubscriberGetCallProcessingParametersResponse17> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemSubscriberGetCallProcessingParametersRequest17sp3

Get the system call processing configuration for all subscribers

The response is either a
C<SystemSubscriberGetCallProcessingParametersResponse17sp3> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessagingGroupGetRequest16

Request the system level data associated with Voice Messaging.

The response is either a C<SystemVoiceMessagingGroupGetResponse16> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest14

Requests the system voice portal Menus setting.

The response is either
C<SystemVoiceMessagingGroupGetVoicePortalMenusResponse14> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<getDefaultMenuKeys> - I<xs:boolean>

=back

=head3 UserAddRequest14sp9

Replaced by: C<UserAddRequest17sp4> Request to add a user. The domain is
required in the userId. The password is not required if external authentication
is enabled. The C<officeZoneName> and C<primaryZoneName> elements are ignored
and provided here for backwards compatibility only.

The response is either C<SuccessResponse> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=item B<userId> - I<UserId>

=item B<lastName> - I<LastName>

=item B<firstName> - I<FirstName>

=item B<callingLineIdLastName> - I<CallingLineIdLastName>

=item B<callingLineIdFirstName> - I<CallingLineIdFirstName>

=back

Additionally there are generic tagged parameters.

=head3 UserBusyLampFieldGetRequest

Request the settings for the busy lamp field service.

The response is either a C<UserBusyLampFieldGetResponse> or an
C<ErrorResponse>. Replaced by: C<UserBusyLampFieldGetRequest16sp2>

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserCallProcessingGetPolicyRequest17

Request the user level data associated with Call Processing Policy.

The response is either a C<UserCallProcessingGetPolicyResponse17> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

lib/Broadworks/OCIP/Deprecated.pod  view on Meta::CPAN

C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 UserMeetMeConferencingAddConferenceRequest

Add a Meet-Me conference.

The response is either C<UserMeetMeConferencingAddConferenceResponse> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<bridgeId> - I<UserId>

=item B<title> - I<MeetMeConferencingConferenceTitle>

=item B<muteAllAttendeesOnEntry> - I<xs:boolean>

=item B<endConferenceOnModeratorExit> - I<xs:boolean>

=item B<moderatorRequired> - I<xs:boolean>

=item B<attendeeNotification> - I<MeetMeConferencingConferenceAttendeeNotification>

=item B<conferenceSchedule> - I<MeetMeConferencingConferenceSchedule>

=back

Additionally there are generic tagged parameters.

=head3 UserMeetMeConferencingGetConferenceRequest

Get the information of a conference owned by the user.

The response is either C<UserMeetMeConferencingGetConferenceResponse> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<conferenceKey / bridgeId> - I<Unknown>

=item B<conferenceKey / conferenceId> - I<Unknown>

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest18

Requests the system voice portal Menus setting.

The response is either
C<SystemVoiceMessagingGroupGetVoicePortalMenusResponse18> or C<ErrorResponse>.
Replaced by C<SystemVoiceMessagingGroupGetVoicePortalMenusRequest19>

Fixed parameters are:-

=over 4

=item B<getDefaultMenuKeys> - I<xs:boolean>

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest18sp1

Requests the system voice portal Menus setting.

The response is either
C<SystemVoiceMessagingGroupGetVoicePortalMenusResponse18sp1> or
C<ErrorResponse>. Replaced by
C<SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1>

Fixed parameters are:-

=over 4

=item B<getDefaultMenuKeys> - I<xs:boolean>

=back

=head3 SystemVoiceMessagingGroupModifyVoicePortalMenusRequest

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 GroupPortalPasscodeRulesGetRequest

Requests the group's passcode rules setting.

The response is either C<GroupPortalPasscodeRulesGetResponse> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=back

=head3 ServiceProviderPortalPasscodeRulesGetRequest

Requests the service provider's passcode rules setting.

The response is either C<ServiceProviderPortalPasscodeRulesGetResponse> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=back

=head3 SystemPortalPasscodeRulesGetRequest

Requests the system passcode rules setting.

The response is either C<SystemPortalPasscodeRulesGetResponse> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemSIPDeviceTypeAddRequest18sp1V2

Request to add a sip device type.

The response is either C<SuccessResponse> or C<ErrorResponse>. The following
elements are only used in HSS data mode: C<enable3G4GContinuity>, use value

lib/Broadworks/OCIP/Deprecated.pod  view on Meta::CPAN

The response is either C<GroupAdminGetPolicyResponse18> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 GroupAdminGetPolicyRequest19sp1

Requests the Group administrator's policy settings.

The response is either C<GroupAdminGetPolicyResponse19sp1> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 GroupAutoAttendantGetInstanceRequest19

Request to get all the information of a Auto Attendant instance.

The response is either C<GroupAutoAttendantGetInstanceResponse19> or
C<ErrorResponse>. Replaced by: C<GroupAutoAttendantGetInstanceRequest19sp1>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupAutoAttendantGetInstanceRequest19sp1

Request to get all the information of a Auto Attendant instance.

The response is either C<GroupAutoAttendantGetInstanceResponse19sp1> or
C<ErrorResponse>. Replaced by: C<GroupAutoAttendantGetInstanceRequest20>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupAutoAttendantModifyInstanceRequest17sp1

Request to modify an Auto Attendant instance. Only Group and Enterprise level
schedules are accepted.

The response is either C<SuccessResponse> or C<ErrorResponse>. The following
elements are only used in AS data mode: C<holidayMenu>. The following
elementsare only valid for Standard Auto Attendants: C<holidayMenu>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 GroupBroadWorksAnywhereGetInstanceRequest17

Request to get all the information of a C<BroadWorks> Anywhere instance.

The response is either C<GroupBroadWorksAnywhereGetInstanceResponse17> or
C<ErrorResponse>. Replaced by:
C<GroupBroadWorksAnywhereGetInstanceRequest19sp1>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupCallCenterGetInstanceRequest19

Request to get all the information of a Call Center instance.

The response is either C<GroupCallCenterGetInstanceResponse19> or
C<ErrorResponse>. Replaced by: C<GroupCallCenterGetInstanceRequest19sp1>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupDirectoryNumberHuntingGetRequest

Request to get the properties of the DNH service for a specified
C<serviceUserId>. It gets the agents of a call center or hunt group that are
members of a directory number hunting group.  They are agents that are not
already assigned to any other directory number hunting group.

The response is either C<GroupDirectoryNumberHuntingGetResponse> or
C<ErrorResponse>. Replaced by: C<GroupDirectoryNumberHuntingGetRequest17sp1>

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

lib/Broadworks/OCIP/Deprecated.pod  view on Meta::CPAN

=back

Additionally there are generic tagged parameters.

=head3 SystemSIPDeviceTypeGetRequest19

Request to get a sip device type. See Also: C<SystemDeviceTypeGetRequest>

The response is either C<SystemSIPDeviceTypeGetResponse19> or C<ErrorResponse>.
Replaced by: C<SystemSIPDeviceTypeGetRequest19sp1>

Fixed parameters are:-

=over 4

=item B<deviceType> - I<AccessDeviceType>

=back

=head3 SystemSIPDeviceTypeGetRequest19Sp1

Request to get a sip device type. See Also: C<SystemDeviceTypeGetRequest>

The response is either C<SystemSIPDeviceTypeGetResponse19Sp1> or
C<ErrorResponse>. Replaced by: C<SystemSIPDeviceTypeGetRequest20>

Fixed parameters are:-

=over 4

=item B<deviceType> - I<AccessDeviceType>

=back

=head3 SystemTimeZoneGetListRequest

Requests the list of time zone names.

The response is either C<SystemTimeZoneGetListResponse> or C<ErrorResponse>.
Replaced by C<SystemTimeZoneGetListRequest20>.

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessagingGroupGetRequest16sp2

Request the system level data associated with Voice Messaging.

The response is either a C<SystemVoiceMessagingGroupGetResponse16sp2> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest19

Requests the system voice portal Menus setting.

The response is either
C<SystemVoiceMessagingGroupGetVoicePortalMenusResponse19> or C<ErrorResponse>.
Replaced by C<SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1>

Fixed parameters are:-

=over 4

=item B<getDefaultMenuKeys> - I<xs:boolean>

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest19sp1

Requests the system voice portal Menus setting.

The response is either
C<SystemVoiceMessagingGroupGetVoicePortalMenusResponse19sp1> or
C<ErrorResponse>. Replaced by
C<SystemVoiceMessagingGroupGetVoicePortalMenusRequest20>

Fixed parameters are:-

=over 4

=item B<getDefaultMenuKeys> - I<xs:boolean>

=back

=head3 GroupSessionAdmissionControlGroupAddRequest

Request to add a session admission control group for the group.

The response is either a C<SuccessResponse> or an C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=item B<name> - I<SessionAdmissionControlGroupName>

=item B<maxSession> - I<NonNegativeInt>

=back

Additionally there are generic tagged parameters.

=head3 GroupSessionAdmissionControlGroupGetRequest

Request to get a session admission control group for the group.

The response is either a C<GroupSessionAdmissionControlGroupGetResponse> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=item B<name> - I<SessionAdmissionControlGroupName>

=back

=head3 ServiceProviderCommunicationBarringProfileAddRequest17sp3

Add a new Communication Barring Profile. The priorities for
C<OriginatingRules>, C<RedirectingRules>, C<CallMeNowRules> and
C<IncomingRules> are requantized to consecutive integers as part of the add.

The response is either a C<SuccessResponse> or an C<ErrorResponse>. The
following elements are only used in AS data mode: C<callMeNowDefaultAction>,
use value "Block" in HSS data mode C<callMeNowDefaultCallTimeout>
C<callMeNowRule>

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

lib/Broadworks/OCIP/Deprecated.pod  view on Meta::CPAN

=item B<userId> - I<UserId>

=back

=head3 UserGetRequest19

Request to get the user information.

The response is either C<UserGetResponse19> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 GroupPolicyGetRequest17

Requests the Group's policy settings.

The response is either C<GroupPolicyGetResponse17> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=back

=head3 UserMeetMeConferencingGetConferenceRequest19

Get the information of a conference owned by the user.

The response is either C<UserMeetMeConferencingGetConferenceResponse19> or
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<conferenceKey / bridgeId> - I<Unknown>

=item B<conferenceKey / conferenceId> - I<Unknown>

=back

=head3 GroupAutoAttendantAddInstanceRequest19

Add a Auto Attendant instance to a group. The domain is required in the
C<serviceUserId>. Only Group and Enterprise level schedules are accepted.

The response is either C<SuccessResponse> or C<ErrorResponse>. The following
elements are only used in AS data mode: type, use C<AutoAttendantType>.BASIC in
HSS mode. C<holidayMenu>. The following elements are only valid for Standard
Auto Attendants: C<holidayMenu>

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=item B<serviceUserId> - I<UserId>

=item B<serviceInstanceProfile> - I<ServiceInstanceAddProfile>

=item B<type> - I<AutoAttendantType>

=item B<enableVideo> - I<xs:boolean>

=back

Additionally there are generic tagged parameters.

=head3 SystemCallingNameRetrievalGetRequest17sp4

Request the system's calling name retrieval attributes.

The response is either a C<SystemCallingNameRetrievalGetResponse17sp4> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 SystemCallingNameRetrievalModifyRequest16sp1

Modifies the system's calling name retrieval attributes.

The response is either a C<SuccessResponse> or an C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 GroupAutoAttendantSubmenuGetRequest

Request to get an Auto Attendant submenu instance.

The response is either C<GroupAutoAttendantSubmenuGetResponse> or
C<ErrorResponse>. This request is only valid for Standard auto attendants.

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>



( run in 0.475 second using v1.01-cache-2.11-cpan-5b529ec07f3 )