UpdateExtension (v3)

Overview

Updates an extension.

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
extension	Extension	Specifies the extension	Mandatory

Response

Parameters of the API response:

Parameter

Type

Description

return

Status

Possible return values:

- OK
- ERROR_GENERAL
- ERROR_ILLEGAL_ARGUMENT
- ERROR_UNAUTHORIZED

Examples

Example UpdateExtension transaction.

Example UpdateExtension transaction.

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:updateExtension>
         <token>FipASZ3Y336Kvmv7W1BV7aXY7hDFeMxq</token>
         <extension>
            <eid>0000</eid>
            <!-- Needed if eid is not present
            <environmentShortName></environmentShortName>
            -->


            <!-- The ID of the existing Extension can be queried with the GetExtension call -->
            <id>20100</id>
 
            <extension>verbatestuser2@verbalabs.com</extension>

            <recordingMode>CONTROLLED</recordingMode>
           
            <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>

            <!--
               If the user tag is not present then the extension-user association will be deleted (if) any.
               You should always be sure that you have a user tag with a valid ID in it!!
            -->
            <user>
               <id>25</id>
            </user>
            
         </extension>
      </v3:updateExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

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