view release on metacpan or  search on metacpan

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserAttendantConsoleModifyRequest

Modify user's attendant console settings.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head2 ServiceAuthentication

=head3 UserAuthenticationGetRequest

Get the user's authentication service information.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserAuthenticationModifyRequest

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head2 ServiceAutoAttendant

=head3 GroupAutoAttendantAddInstanceRequest20

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<firstDigitTimeoutSeconds> - I<FirstDigitTimoutSeconds>

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

=back

Additionally there are generic tagged parameters.

=head3 GroupAutoAttendantDeleteInstanceRequest

Delete a Auto Attendant instance from a group.

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupAutoAttendantGetInstanceListRequest

Get a list of Auto Attendant instances within a group.

The response is either C<GroupAutoAttendantGetInstanceListResponse> or
C<ErrorResponse>. It is possible to get the instances within a specified
department.

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=item B<groupId> - I<GroupId>

=back

Additionally there are generic tagged parameters.

=head3 GroupAutoAttendantGetInstanceRequest20

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

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupAutoAttendantModifyActiveInstanceListRequest

Request to set the active status of Auto Attendant instances.

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

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 GroupAutoAttendantModifyInstanceRequest20

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 elements
are 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 GroupAutoAttendantSubmenuGetListRequest

Get a list of Auto Attendant Submenus.

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=back

=head3 GroupAutoAttendantSubmenuGetUsageListRequest

Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu
and Submenus that use this submenu.

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=item B<submenuId> - I<AutoAttendantSubmenuId>

=back

=head3 GroupAutoAttendantSubmenuGetRequest20

Request to get an Auto Attendant submenu instance.

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=item B<submenuId> - I<AutoAttendantSubmenuId>

=back

=head3 GroupAutoAttendantSubmenuModifyRequest20

Request to modify an Auto Attendant submenu instance.

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

Fixed parameters are:-

=over 4

=item B<serviceUserId> - I<UserId>

=item B<submenuId> - I<AutoAttendantSubmenuId>

=back

Additionally there are generic tagged parameters.

=head3 GroupAutoAttendantSubmenuAddRequest20

Request to add an Auto Attendant submenu instance.

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

Fixed parameters are:-

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

=back

Additionally there are generic tagged parameters.

=head3 ServiceProviderVoiceMessagingGroupModifyVoicePortalRequest

Request to change the service provider's or enterprise's voice portal settings.

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

Fixed parameters are:-

=over 4

=item B<serviceProviderId> - I<ServiceProviderId>

=back

Additionally there are generic tagged parameters.

=head3 SystemVoiceMessageSummaryUpdateGetRequest

Requests system voice mail message summary update parameter settings.

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

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessageSummaryUpdateModifyRequest

Modify the system level data associated with Voice Messaging.

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

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 SystemVoiceMessagingGroupGetRequest20

Request the system level data associated with Voice Messaging.

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

Fixed parameters are:-

=over 4

=back

=head3 SystemVoiceMessagingGroupGetVoicePortalMenusRequest20

Requests the system voice portal Menus setting.

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

Fixed parameters are:-

=over 4

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

=back

=head3 SystemVoiceMessagingGroupModifyRequest16

Modify the system level data associated with Voice Messaging.

The response is either a C<SuccessResponse> or an C<ErrorResponse>. The
following elements are only used in AS data mode: C<realDeleteForImap>
C<useDnInMailBody> C<useShortSubjectLine> C<maxMessageLengthMinutes>
C<maxMailboxLengthMinutes> C<doesMessageAge> C<holdPeriodDays>
C<mailServerNetAddress> C<mailServerProtocol> C<defaultDeliveryFromAddress>
C<defaultNotificationFromAddress> C<useOutgoingMWIOnSMDI> C<mwiDelayInSeconds>
C<voicePortalScope> C<enterpriseVoicePortalLicensed> C<networkWideMessaging>
C<useExternalRouting> C<defaultExternalRoutingAddress> C<vmOnlySystem>
C<clientInitiatedMailServerSessionTimeoutMinutes>

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 SystemVoiceMessagingGroupModifyVoicePortalMenusRequest19

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 UserVoiceMessagingUserAddAliasListRequest

Add one or more voice mail aliases to a users voice message.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 UserVoiceMessagingUserDeleteAliasListRequest

Delete one or more voice mail aliases from a users voice message.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 UserVoiceMessagingUserGetAdvancedVoiceManagementRequest14sp3

Get the user's voice messaging advanced voice management service setting.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserVoiceMessagingUserGetAliasListRequest

Get the voice mail aliases for a users voice message.