CreateExtension (v2)

Owned by Kiss, Mate
May 25, 2022
3 min read

Overview

Creates an extension.

The function is available as a Web Service request.

Request

Parameters of the API request:

ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
extension ExtensionDefines the new extension's properties.Mandatory

Response

Parameters of the API response:

ParameterType

Description

returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
    • ERROR_ALREADY_EXISTS

Examples

 

 Example CreateExtension transaction where the extension's recording mode is on-demand, voice-video-im-screen recorded and is associated with the user who's id is 4.
Example CreateExtension transaction where the extension's recording mode is on-demand, voice-video-im-screen recorded and is associated with the user who's id is 4.
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:createExtension>
         <token>tbESeqhBDsevSwi4HZdYAz8mKbBg8f6j</token>
         <extension>
            <eid>0000</eid>
            <!--  Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->
            <extension>verbatestuser2@verbalabs.com</extension>
            <recordingMode>ON_DEMAND</recordingMode>
            <im>1</im>
            <video>1</video>
            <voice>1</voice>
            <screenCaptureEnabled>1</screenCaptureEnabled>
            <user>
               <id>4</id>
            </user>
         </extension>
      </v2:createExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <statusCode>OK</statusCode>
         </return>
      </ns2:createExtensionResponse>
   </S:Body>
</S:Envelope>
 Example CreateExtension transaction where the extension's recording mode is full, only voice recorded and is associated with the user who's id is 3.
Example CreateExtension transaction where the extension's recording mode is full, only voice recorded and is associated with the user who's id is 3.
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:createExtension>
         <token>tbESeqhBDsevSwi4HZdYAz8mKbBg8f6j</token>
         <extension>
            <eid>0000</eid>
            <!--  Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->
            <extension>verbatestuser@verbalabs.com</extension>
            <recordingMode>FULL</recordingMode>
            <im>0</im>
            <video>0</video>
            <voice>1</voice>
            <screenCaptureEnabled>0</screenCaptureEnabled>
            <user>
               <id>3</id>
            </user>
         </extension>
      </v2:createExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <statusCode>OK</statusCode>
         </return>
      </ns2:createExtensionResponse>
   </S:Body>
</S:Envelope>
 Example CreateExtension with already exists response.
Example CreateExtension with already exists response.
Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v2.provisioning.ws.web.verba.com/">
         <return>
            <message>This extension already exists in the database: 0000:verbatestuser@verbalabs.com</message>
            <statusCode>ERROR_ALREADY_EXISTS</statusCode>
         </return>
      </ns2:createExtensionResponse>
   </S:Body>
</S:Envelope>