Broadworks-OCIP
view release on metacpan or search on metacpan
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
=back
=head3 GroupDomainGetAssignedUserListRequest
Request a list of users within in a group that have a given domain assigned.
The response is either C<GroupDomainGetAssignedUserListResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<groupId> - I<GroupId>
=item B<domain> - I<NetAddress>
=back
Additionally there are generic tagged parameters.
=head3 GroupDomainGetAssignedListRequest
Requests the list of all domains assigned to a group.
The response is either C<GroupDomainGetAssignedListResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<groupId> - I<GroupId>
=back
=head3 GroupDomainUnassignListRequest
Unassign a list of domains from a group.
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<domain> - I<NetAddress>
=back
=head3 GroupEndpointGetListRequest
Request to search endpoints in the group.
The response is either C<GroupEndpointGetListResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<groupId> - I<GroupId>
=back
Additionally there are generic tagged parameters.
=head3 GroupExchangeIntegrationGetRequest
Request the group level configuration for Exchange Integration.
The response is either a C<GroupExchangeIntegrationGetResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<groupId> - I<GroupId>
=back
=head3 GroupExchangeIntegrationModifyRequest
Modify the group level configuration for Exchange Integration.
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>
=back
Additionally there are generic tagged parameters.
=head3 GroupExistingUsersAssignUserServiceListRequest
Request to assign the user services and service packs to all existing users
within the group. C<BroadSoft> recommends using this command only for small
groups with less than 100 users. This command will return an error if the
group has over 500 users. The recommended way to bulk assign/unassign services
is Service Pack Migration.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<domain> - I<NetAddress>
=back
=head3 ServiceProviderDomainGetAssignedGroupListRequest
Requests a list of groups within a service provider that have a given domain
assigned. It is possible to search by various criteria to restrict the number
of rows returned. Multiple search criteria are logically C<ANDed> together.
The response is either a C<ServiceProviderDomainGetAssignedGroupListResponse>
or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<domain> - I<NetAddress>
=back
Additionally there are generic tagged parameters.
=head3 ServiceProviderDomainGetAssignedListRequest
Requests the list of all domains assigned to a service provider.
The response is either C<ServiceProviderDomainGetAssignedListResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=back
=head3 ServiceProviderDomainUnassignListRequest
Unassign a list of domains from a service provider.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<domain> - I<NetAddress>
=back
=head3 ServiceProviderEndpointGetListRequest
Request to search endpoints in the service provider/enterprise.
The response is either C<ServiceProviderEndpointGetListResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=back
Additionally there are generic tagged parameters.
=head3 ServiceProviderFeatureAccessCodeGetListRequest20
Get the list of feature access codes for a service provider or enterprise.
The response is either a C<ServiceProviderFeatureAccessCodeGetListResponse20>
or an C<ErrorResponse>. In release 20 the "Call Recording" FAC name is changed
to "Call Recording - Start".
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=back
=head3 ServiceProviderFeatureAccessCodeModifyListRequest20
Modify a list of feature access codes for a service provider or enterprise.
The response is either a C<SuccessResponse> or an C<ErrorResponse>. In release
20 the "Call Recording" FAC name is changed to "Call Recording - Start".
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=back
Additionally there are generic tagged parameters.
=head3 ServiceProviderFileRepositoryDeviceUserAddRequest
Add a new service provider file repository user.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<serviceProviderId> - I<ServiceProviderId>
=item B<fileRepositoryName> - I<FileRepositoryName>
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
=back
=head3 SystemApplicationControllerDeleteRequest
Delete an application controller.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<name> - I<ApplicationControllerName>
=back
=head3 SystemApplicationControllerGetListRequest
Get a list of application controllers that are configured for the system.
The response is either C<SystemApplicationControllerGetListResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemASRParametersGetRequest14sp7
Request to get the list of Application Server Registration system parameters.
The response is either C<SystemASRParametersGetResponse14sp7> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemASRParametersModifyRequest14sp7
Request to modify Application Server Registration system parameters.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemAuthenticationLockoutExportDataGetRequest
Request to export system wide authentication lockout data to a file. All locked
out device profiles, sip endpoints, and sip trunk groups are returned.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<fileName> - I<FileName>
=back
=head3 SystemAuthenticationLockoutSettingsGetRequest
Request to get the authentication lockout settings in the system.
The response is either a C<SystemAuthenticationLockoutSettingsResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemAuthenticationLockoutSettingsModifyRequest
Request to modify the system level device password lockout settings
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemBroadCloudGetRequest
Get the system interface attributes for C<BroadCloud>.
The response is either C<SystemBroadCloudGetResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemBroadCloudModifyRequest
Modify the system interface attributes for C<BroadCloud>.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
=over 4
=back
=head3 SystemDomainParametersGetRequest
Request to get the list of system Domain parameters.
The response is either C<SystemDomainParametersGetResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemDomainParametersModifyRequest
Request to modify system Domain parameters.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemDTMFTransmissionGetRequest
Get the system DTMF transmission configurations.
The response is either C<SystemDTMFTransmissionGetResponse> or
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemDTMFTransmissionModifyRequest
Modify the DTMF transmission settings.
The response is either C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemEndpointGetListRequest
Request to search endpoints in the system.
The response is either C<SystemEndpointGetListResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemExpensiveCallNotificationGetRequest
Request to get the expensive call notification service parameters.
The response is either a C<SystemExpensiveCallNotificationGetResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemExpensiveCallNotificationModifyRequest
Modify the expensive call notification service parameters.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemExpensiveCallTypeAddRequest
Add an alternate call indicator to the list of expensive alternate call
indicators.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<alternateCallIndicator> - I<NetworkServerAlternateCallIndicator>
=back
Additionally there are generic tagged parameters.
=head3 SystemExpensiveCallTypeDeleteRequest
Delete an alternate call indicator from the list of expensive alternate call
indicators.
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
node.
The response is either a C<SystemShInterfaceRefreshTaskGetResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemShInterfaceRefreshTaskTerminateRequest
Terminates the system refresh task in progress on the local Application Server
node.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemSIPAddACLEntryRequest14sp2
Add an entry to the SIP access control list.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<netAddress> - I<IPAddress>
=item B<transportProtocol> - I<SIPACLTransportProtocol>
=back
Additionally there are generic tagged parameters.
=head3 SystemSIPAddContentTypeRequest
Add a content type for the SIP interface.
The response is either C<SuccessResponse> or C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<contentType> - I<SystemSIPContentType>
=item B<interface> - I<SystemSIPSupportedInterface>
=back
=head3 SystemSIPAuthenticationLockoutClearAllRequest
Request to clear all sip authentication lockouts (both endpoint and trunk
group) in the system.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemSIPAuthenticationEndpointLockoutClearRequest
Request to clear sip authentication endpoint lockouts in the system.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemSIPAuthenticationEndpointLockoutGetRequest
Request to get sip authentication endpoint lockout data in the system.
The response is either a C<SystemSIPAuthenticationEndpointLockoutGetResponse>
or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemSIPAuthenticationTrunkGroupLockoutGetRequest
Request to get sip authentication trunk group lockout data in the system.
The response is either a C<SystemSIPAuthenticationTrunkGroupLockoutGetResponse>
or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemSIPAuthenticationTrunkGroupLockoutClearRequest
Request to clear sip authentication trunk group lockouts in the system.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
Additionally there are generic tagged parameters.
=head3 SystemSIPAuthenticationPasswordRulesGetRequest
Request to get the system level SIP authentication password rule settings.
The response is either a C<SystemSIPAuthenticationPasswordRulesGetResponse> or
an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=back
=head3 SystemSIPAuthenticationPasswordRulesModifyRequest
Request to modify the system level SIP authentication password rule settings
The response is either C<SuccessResponse> or C<ErrorResponse>.
lib/Broadworks/OCIP/Methods.pod view on Meta::CPAN
=back
=head3 UserServiceScriptsUserGetRequest
Request the user level data associated with Service Scripts User Configuration.
The response is either a C<UserServiceScriptsUserGetResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<userId> - I<UserId>
=back
=head3 UserServiceScriptsUserModifyRequest
Modify the user level data associated with Service Scripts User Configuration.
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 ServiceSharedCallAppearance
=head3 UserSharedCallAppearanceAddEndpointRequest14sp2
Associate an access device instance to the user's Shared Call Appearance.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<userId> - I<UserId>
=item B<accessDeviceEndpoint> - I<AccessDeviceEndpointAdd>
=item B<isActive> - I<xs:boolean>
=item B<allowOrigination> - I<xs:boolean>
=item B<allowTermination> - I<xs:boolean>
=back
=head3 UserSharedCallAppearanceDeleteEndpointListRequest14
Disassociate one or more of a user's Shared Call Appearance endpoints.
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 UserSharedCallAppearanceGetEndpointRequest
Get the user's Shared Call Appearance endpoint setting.
The response is either a C<UserSharedCallAppearanceGetEndpointResponse> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<userId> - I<UserId>
=item B<accessDeviceEndpoint / accessDevice> - I<Unknown>
=item B<accessDeviceEndpoint / linePort> - I<Unknown>
=back
=head3 UserSharedCallAppearanceGetRequest16sp2
Get the user's Shared Call Appearance service setting.
The response is either a C<UserSharedCallAppearanceGetResponse16sp2> or an
C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<userId> - I<UserId>
=back
=head3 UserSharedCallAppearanceModifyEndpointRequest
Associate/Disassociate an access device instance to the user's Shared Call
Appearance.
The response is either a C<SuccessResponse> or an C<ErrorResponse>.
Fixed parameters are:-
=over 4
=item B<userId> - I<UserId>
=item B<accessDeviceEndpoint / accessDevice> - I<Unknown>
=item B<accessDeviceEndpoint / linePort> - I<Unknown>
=back
Additionally there are generic tagged parameters.
=head3 UserSharedCallAppearanceModifyRequest
Modify the user's Shared Call Appearance service setting.
The response is either a C<SuccessResponse> or an C<ErrorResponse>. The
following elements are only used in AS data mode: C<enableCallParkNotification>
Fixed parameters are:-
( run in 0.499 second using v1.01-cache-2.11-cpan-524268b4103 )