Overview
Create a new Environment.
The function is available as a Web Service request.
Request
Parameters of the API request:
| Parameter | Type | Description | Requirements |
|---|
| token | String | API authentication token | Mandatory |
| environment | Environment | Environment parameters | Mandatory |
| archiveAtAgeHours | Integer | Creates a default storage policy that archives after X hours | |
| deleteAtAgeHours | Integer | Creates a default storage policy that deletes after X hours | |
| archivePath | String | Configures the archive path for the environment
If empty, the system uses a default based on these rules:- if the [Verba\Storage\Archiving\DestinationPath] registry parameter is not empty,
the value will be [Verba\Storage\Archiving\DestinationPath]\EnvShortName - if above is empty it becomes:
[parent folder of AudioPath]\VerbaArchive\EnvShortName
| |
Response
Parameters of the API response in getGroupsResponse type called return:
| Parameter | Type | Description |
|---|
| status | Status | Possible return values: - OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED
|
Examples
Example CreateEnvironment transaction.
Request:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v2="http://v2.provisioning.ws.web.verba.com/">
<soapenv:Header/>
<soapenv:Body>
<v2:createEnvironment>
<token>9QckC2nVeO3JM8qL6DVHFo3p0Mt7ytuD</token>
<environment>
<displayName>API test Environment</displayName>
<eid>0001</eid>
<helpdeskURL>http://help-menu-link.net</helpdeskURL>
<inactive>0</inactive>
<ondemandMaxCallAgeHoursInBuffer>72</ondemandMaxCallAgeHoursInBuffer>
<ondemandMaxRowsInBufferPerUser>24</ondemandMaxRowsInBufferPerUser>
<shortName>Tenant test shortname</shortName>
</environment>
<archiveAtAgeHours>12</archiveAtAgeHours>
<!-- <archivePath></archivePath> Use default path -->
<!-- <deleteAtAgeHours></deleteAtAgeHours> Don't delete recordings -->
</v2:createEnvironment>
</soapenv:Body>
</soapenv:Envelope>
Response:
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
<S:Body>
<ns2:createEnvironmentResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
<return>
<statusCode>OK</statusCode>
</return>
</ns2:createEnvironmentResponse>
</S:Body>
</S:Envelope>