CreateExtension (v3)

Overview

Creates an extension.

The function is available as a Web Service request.

Request

Parameters of the API request:

Parameter	Type	Description	Requirements

Parameter	Type	Description	Requirements
token	String	API authentication token	Mandatory
extension	Extension	Defines the new extension's properties.	Mandatory

Response

Parameters of the API response:

Parameter	Type	Description

Parameter	Type	Description
return	Status	Possible return values:

Examples

Example CreateExtension transaction where voice modality is added with incoming and outgoing recorded direction.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:createExtension>
         <token>tbESeqhBDsevSwi4HZdYAz8mKbBg8f6j</token>
         <extension>
            <eid>0000</eid>
            <!--  Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->
            <extensionId>verbatestuser3@verbalabs.com</extensionId>
            <modalities>
               <modalitiesForWS>
                  <directionsForWS>
                     <id>1</id>
                  </directionsForWS>
                  <directionsForWS>
                     <id>2</id>
                  </directionsForWS>
                  <id>voice</id>
               </modalitiesForWS>
            </modalities>
         </extension>
      </v3:createExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v3.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 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:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:createExtension>
         <token>tbESeqhBDsevSwi4HZdYAz8mKbBg8f6j</token>
         <extension>
            <eid>0000</eid>
            <!--  Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->
            <extensionId>verbatestuser2@verbalabs.com</extensionId>
            <recordingModeType>ON_DEMAND</recordingModeType>
            <modalities>
               <modalitiesForWS>
                  <directionsForWS>
                     <id>-1</id>
                  </directionsForWS>
                  <id>voice</id>
               </modalitiesForWS>
               <modalitiesForWS>
                  <directionsForWS>
                     <id>-1</id>
                  </directionsForWS>
                  <id>im</id>
               </modalitiesForWS>
               <modalitiesForWS>
                  <directionsForWS>
                     <id>-1</id>
                  </directionsForWS>
                  <id>video</id>
               </modalitiesForWS>
            </modalities>
            <screenCaptureEnabled>1</screenCaptureEnabled>
            <user>
               <id>4</id>
            </user>
         </extension>
      </v3:createExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v3.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.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v3="http://v3.provisioning.ws.web.verba.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <v3:createExtension>
         <token>tbESeqhBDsevSwi4HZdYAz8mKbBg8f6j</token>
         <extension>
            <eid>0000</eid>
            <!--  Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->
            <extensionId>verbatestuser@verbalabs.com</extensionId>
            <recordingModeType>FULL</recordingModeType>
            <modalities>
               <modalitiesForWS>
                  <directionsForWS>
                     <id>-1</id>
                  </directionsForWS>
                  <id>voice</id>
               </modalitiesForWS>
            </modalities>
            <screenCaptureEnabled>0</screenCaptureEnabled>
            <user>
               <id>3</id>
            </user>
         </extension>
      </v3:createExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <statusCode>OK</statusCode>
         </return>
      </ns2:createExtensionResponse>
   </S:Body>
</S:Envelope>

Example CreateExtension with already exists response.

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:createExtensionResponse xmlns:ns2="http://v3.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>