Provisioning API version 3

AVAILABLE IN 9.6.7 AND LATER

Overview

This web services API allows service providers to automatically create users and tenants. The interface is implemented using Web Services.

Requirement

Make sure that the version 3 API is enabled.

API Calls

The Provisioning API provides the following Web Services calls:

Authentication

Page:

ReleaseToken (v3) — Releases a token
Page:

RequestToken (v3) — Requests an authentication token

Users

Page:

CreateUser (v3) — Creates a user.
Page:

DeleteUser (v3) — Deletes a User.
Page:

GetUserByLoginNameAndEnvironment (v3) — Returns a user.
Page:

ListUsers (v3) — Lists users.
Page:

UpdateUser (v3) — Updates a user.

Groups

Page:

CreateGroup (v3) — Creates a new Group.
Page:

DeleteGroup (v3) — Deletes a Group.
Page:

GetGroupByNameAndEnvironment (v3) — Reads a Group.
Page:

ListGroups (v3) — Lists groups.
Page:

UpdateGroup (v3) — Updates a group.

Extensions

Page:

ApplyExtensionConfiguration (v3) — Applies the extension configuration.
Page:

CreateExtension (v3) — Creates an extension.
Page:

DeleteExtension (v3) — Delete an extension.
Page:

GetExtension (v3) — Reads an extension.
Page:

ListExtensions (v3) — Returns an extension list.
Page:

UpdateExtension (v3) — Updates an extension.

Environments

Page:

CreateEnvironment (v3) — Create a new Environment.
Page:

GetEnvironmentByEid (v3) — Reads a tenant based on its ID.
Page:

GetEnvironmentByShortName (v3) — Reads a tenant based on its short name.
Page:

ListEnvironments (v3) — Returns an environment list.
Page:

UpdateEnvironment (v3) — Updates an environment.

Miscellaneous

Page:

GetStatistics (v3) — Reads user and tenant statistics.
Page:

GetVersion (v3) — Returns the API version.
Page:

ListAnnouncements (v3) — Returns a list of announcement audio files for an announcement type.
Page:

ListExtensionRules (v3) — Returns a list of recording rules.
Page:

ListForwardTypes (v3) — Returns a list of forwarding types.
Page:

ListImportSources (v3) — Returns a list of import sources.
Page:

ListSites (v3) — Returns a list of sites.
Page:

ListSourcePlatforms (v3) — Returns a list of recorded platforms.
Page:

ListWorkflows (v3) — Returns a list of announcement audio files for an announcement type.

Storage

Page:

CreateStorageFolder (v3) — Creates a new Storage Folder.
Page:

CreateStoragePolicy (v3) — Creates a new Storage Policy.
Page:

GetStorageFolderById (v3) — Returns a Storage Folder information by id.
Page:

GetStorageFolderByName (v3) — Returns a Storage Folder information by name.
Page:

GetStoragePolicyById (v3) — Returns a Storage Policy information by id.
Page:

GetStoragePolicyByName (v3) — Returns a Storage Policy information by name.
Page:

ListStorageFolders (v3) — Lists Storage Folders.
Page:

ListStorageFoldersByEid (v3) — Lists Storage Folders by eid.
Page:

ListStoragePolicies (v3) — Lists Storage Policies.
Page:

ListStoragePoliciesByEid (v3) — Lists Storage Policies by eid.
Page:

UpdateStorageFolder (v3) — Updates a Storage Folder.
Page:

UpdateStoragePolicy (v3) — Updates a Storage Policy.

Data types

The Provisioning Web Service uses three fundamental data types, that represent user provisioning related entities:

Main entities

Page:

ApplyExtensionConfigurationResponseServer (v3) — Represents the extension configuration.
Page:

CallStatistic (v3) — Represents a call statistic.
Page:

Environment (v3) — Represents a tenant.
Page:

Extension (v3) — Represents a phone extension.
Page:

Group (v3) — Represents a group.
Page:

GroupMembership (v3) — Represents a user.
Page:

Location (v3) — Represents the location.
Page:

Status (v3) — Return status of API calls.
Page:

StorageFolder (v3) — Represents a storage folder.
Page:

StoragePolicy (v3) — Represents a storage policy.
Page:

User (v3) — Represents a user.

Reponse types

Page:

ApplyExtensionConfigurationResponse (v3) — Returned extension configuration information.
Page:

CreateOrUpdateGroupResponse (v3) — Returned group create/update information.
Page:

CreateOrUpdateStorageFolderResponse (v3) — Returned storage folder create/update information.
Page:

CreateOrUpdateStoragePolicyResponse (v3) — Returned storage policy create/update information.
Page:

CreateOrUpdateUserResponse (v3) — Returned user create/update information.
Page:

GetAnnouncementsResponse (v3) — Returned list of announcement files for one announcement type.
Page:

GetEnvironmentResponse (v3) — Returned tenant information.
Page:

GetEnvironmentsResponse (v3) — Returned tenant information for all tenants.
Page:

GetExtensionResponse (v3) — Returned extension information.
Page:

GetExtensionRulesResponse (v3) — Returned a list of recording rules.
Page:

GetExtensionsResponse (v3) — Returned extension information for all extensions.
Page:

GetForwardTypeResponse (v3) — Returned list of forwarding types
Page:

GetGroupMembershipResponse (v3) — Returned group membership information.
Page:

GetGroupMembershipsResponse (v3) — Returned group membership information for all group memberships.
Page:

GetGroupResponse (v3) — Returned group information.
Page:

GetGroupsResponse (v3) — Returned group information.
Page:

GetImportSourcesResponse (v3) — Returned list of import sources
Page:

GetSitesResponse (v3) — Returned list of sites.
Page:

GetSourcePlatformResponse (v3) — Returned list of recorded platforms
Page:

GetStorageFolderResponse (v3) — Returned storage folder information.
Page:

GetStorageFoldersResponse (v3) — Returned storage folder information for all storage folders.
Page:

GetStoragePoliciesResponse (v3) — Returned storage policies information for all storage policies.
Page:

GetStoragePolicyResponse (v3) — Returned storage policy information.
Page:

GetUserResponse (v3) — Returned user information.
Page:

GetUsersResponse (v3) — Returned user information for all users.
Page:

GetVersionResponse (v3) — Returned Provision API version information.
Page:

GetWorkflowsResponse (v3) — Returned a list of approval workflows.
Page:

StatisticsResponse (v3) — Response of call statistic requests.
Page:

TokenResponse (v3) — Response of token requests.

Miscellaneous

Page:

AnnouncementTypeEnum (v3) — Possible announcement types.
Page:

CallSourceType (v3) — Possible call source types.
Page:

CallStatisticsFilter (v3) — Used to filter call statistic.
Page:

CallStatisticsType (v3) — Possible call statistic types.
Page:

Direction (v3) — Represents a recorded direction entity.
Page:

EnvironmentFilter (v3) — Used to filter tenants.
Page:

ExtensionFilter (v3) — Used to filter extensions.
Page:

ExtensionRule (v3) — Represents a recording rule entity.
Page:

ForwardType (v3) — Represents call forwarding types.
Page:

GroupFilter (v3) — Used to filter groups.
Page:

GroupMembershipFilter (v3) — Used to filter group memberships.
Page:

ImportSource (v3) — Represents an import source entity.
Page:

Modality (v3) — Represents a modality entity.
Page:

PasswordFormat (v3) — Possible password format type values.
Page:

RecordingModeType (v3) — Possible recording mode types.
Page:

Site (v3) — Represents a site entity.
Page:

SourcePlatform (v3) — Represents a source platform entity for the Recorded platforms.
Page:

StatusCode (v3) — Return code for API calls.
Page:

StorageFolderFilter (v3) — Used to filter storage folders.
Page:

StoragePolicyAction (v3) — Possible storage policy action types.
Page:

StoragePolicyFilter (v3) — Used to filter storage policies.
Page:

UserFilter (v3) — Used to filter users.
Page:

Workflow (v3) — Represents an approval workflow entity.

Tips for developers

To make things faster during development we recommend using SoapUI which offers functional testing for SOAP and REST APIs.

Once you downloaded and installed it, simply create a new SOAP Project from the File menu and enter the http://MediaRepositoryIpAddress:7003/provisioning?wsdl for HTTP connection or https://MediaRepositoryIpAddress:443/verba/ws-provisioning-3?wsdl for HTTPS connection.

In the case of SOAP XML-based communication don't forget to remove the unused optional tags from the request XML.