Broadworks-OCIP

 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 AuthenticationVerifyRequest14sp8

C<AuthenticationVerifyRequest14sp8> is used to authenticate a user either by
userId/password, userId/sip username/sip password, dn/passcode or a token
previously authorized with the C<ExternalAuthenticationAuthorizeTokenRequest>.
The phone number may be any DN associated with a user.

The response is a C<AuthenticationVerifyResponse14sp8> or an C<ErrorResponse>

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 AvailabilityTestRequest

C<AvailabilityTestRequest> is for high-availability support. Response is either
C<SuccessResponse> or C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

=head3 DeviceManagementFileAuthLocationGetRequest18

Get the address and credentials of the File Repository hosting the requested
access device file. Also get the file name and path on the File Repository.

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

Fixed parameters are:-

=over 4

=item B<deviceAccessProtocol> - I<DeviceAccessProtocol16>

=item B<deviceAccessMethod> - I<FileRepositoryAccessType>

=item B<deviceAccessURI> - I<DeviceManagementAccessURI>

=back

Additionally there are generic tagged parameters.

=head3 DeviceManagementPutFileRequest

Informs C<BroadWorks> that a file was uploaded to the repository.

The response is always a C<SuccessResponse>.

Fixed parameters are:-

=over 4

=item B<deviceAccessURI> - I<DeviceManagementAccessURI>

=item B<ipAddress> - I<NetAddress>

=back

=head3 ExternalAuthenticationAuthorizeTokenRequest

This command is part of the Portal API. Sent when a Web or CLI user logs in
using external authentication. The password must be hashed. The password
hashing algorithm is: 1) The message digest of the user's plain password is
calculated using the SHA algorithm. 2) For every four bits in the 160-bit
digest, starting from the first bit, it is converted into a character in ASCII
Hex format (0 through 9, a through f). The result is a 40-character string, for
example, f7a9e24777ec23212c54d7a350bc5bea5477fdbb. 3) The above string then is
used to populate the password field in the request.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<loginToken> - I<LoginToken>

=back

Additionally there are generic tagged parameters.

=head3 ExternalAuthenticationCreateLoginTokenRequest

This command allows a C<BroadWorks> or Third-Party Client Application to create
a Single Sign-On token for a user.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 LoginRequest14sp4

C<LoginRequest14sp4> is 2nd stage of the 2 stage OCI login process. The
C<signedPassword> is not required for external authentication login from a
trusted host (ACL).

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

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.

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

Fixed parameters are:-

=over 4

=item B<alternateCallIndicator> - I<NetworkServerAlternateCallIndicator>

=back

=head3 SystemExpensiveCallTypeGetListRequest16sp1

Request to get the list of expensive alternate call indicators in the system.

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

Fixed parameters are:-

=over 4

=back

=head3 SystemExpensiveCallTypeModifyRequest

Modify an existing call indicator in 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 SystemExportAddressingDataRequest

Request to export Application Server addressing data, such as DNs, extensions,
alias and user ids to a file so they can be uploaded to a Network Server.

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

Fixed parameters are:-

=over 4

=item B<fileName> - I<FileName>

=back

=head3 SystemExportBroadCloudDataRequest

Request to export all users that have C<BroadCloud> services, such as user
profile information and C<BroadCloud> services related information for that
user to a file so they can be uploaded to a C<BroadCloud> .

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

Fixed parameters are:-

=over 4

=item B<fileName> - I<FileName>

=back

=head3 SystemExtensionLengthGetRequest

Request the system's extension range.

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

Fixed parameters are:-

=over 4

=back

=head3 SystemExtensionLengthModifyRequest

Modify the group's extension length range.

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

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 SystemExternalAuthenticationAddACLEntryRequest14sp2

Add an entry to the external authentication access control list.

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

Fixed parameters are:-

=over 4

=item B<netAddress> - I<IPAddress>

=back

Additionally there are generic tagged parameters.

=head3 SystemExternalAuthenticationDeleteACLEntryRequest14sp2

Delete an entry from the external authentication access control list.

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

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

=head2 User

=head3 UserAccessDeviceFileGetListRequest

Request to get the list of Device Management user modifiable files.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=back

=head3 UserAccessDeviceFileGetRequest

Request to get a user modifiable file.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=item B<fileFormat> - I<DeviceManagementFileFormat>

=back

=head3 UserAccessDeviceFileModifyRequest

Request to modify a user modifiable access device file.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=item B<fileFormat> - I<DeviceManagementFileFormat>

=item B<uploadFile> - I<FileResource>

=back

=head3 UserAccessDeviceResetRequest

Reset a specific user SIP device that supports the reset operation.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=back

=head3 UserAccessDeviceTagsGetRequest

Request to get all the device tag names and values for a specific device. The
resolved tags are returned only if the device is the main device for this user.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<accessDevice / deviceLevel> - I<Unknown>

=item B<accessDevice / deviceName> - I<Unknown>

=back

=head3 UserAddRequest17sp4

Request to add a user. The domain is required in the userId. The password is
not required if external authentication is enabled.

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>

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

=item B<announcementFileKey / name> - I<Unknown>

=item B<announcementFileKey / mediaFileType> - I<Unknown>

=back

=head3 UserAnnouncementFileGetListRequest

Get the list of announcement names with associated media type and filesize for
a User and given Announcement Repository Type

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 UserAnnouncementFileGetAvailableListRequest

Get the list of available announcement files for a User from the Announcement
Repository, for Virtual subscribers the list will also include the
announcements for it's group.

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

Additionally there are generic tagged parameters.

=head3 UserAnnouncementFileGetRequest

Request to get the announcement repository file information.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<announcementFileKey / name> - I<Unknown>

=item B<announcementFileKey / mediaFileType> - I<Unknown>

=back

=head3 UserAnnouncementFileModifyRequest

This command is used to change the name of the file or upload a new
announcement file for an existing announcement in the user repository. When
modifying the file type the command will fail if the media type of the new file
changes the announcement from audio to video (or vice versa).

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=item B<announcementFileKey / name> - I<Unknown>

=item B<announcementFileKey / mediaFileType> - I<Unknown>

=back

Additionally there are generic tagged parameters.

=head3 UserAssignedServicesGetListRequest

Get the list of assigned User and Group Services for the specified user.

The response is either an C<UserAssignedServicesGetListResponse> or an
C<ErrorResponse>.

Fixed parameters are:-

=over 4

=back

Additionally there are generic tagged parameters.

=head3 UserDeleteRequest

Request to delete a user.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>

=back

=head3 UserDnGetActivationListRequest

Request to get a list of DNs associated with a user and their activation state.

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

Fixed parameters are:-

=over 4

=item B<userId> - I<UserId>