Skip to end of metadata
Go to start of metadata

Overview

Reads an extension.

The function is available as a Web Service request.

Request

Parameters of the API request:


ParameterType

Description

Requirements
tokenStringAPI authentication tokenMandatory
environmentFilterEnvironmentFilterSpecifies the environmentMandatory
extensionStringSpecifies the extensionMandatory

Response

Parameters of the API response:

ParameterType

Description

returnStatus

Possible return values:

    • OK
    • ERROR_GENERAL
    • ERROR_ILLEGAL_ARGUMENT
    • ERROR_UNAUTHORIZED
 extensionGetExtensionResponseExtensions

Examples


 Example GetExtension transaction.
Example GetExtension 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:getExtension>
         <token>vpAWrB4SIQk7NNuHGvRLv2FM7rjLQjB6</token>
         <environmentFilter>
            <eid>0000</eid>
            <eidExact>0</eidExact>
            <inactive>0</inactive>
            <!-- Needed if eid is not present
            <shortName></shortName>
            <shortNameExact></shortNameExact>
            -->
         </environmentFilter>
         <extension>verbatestuser2@verbalabs.com</extension> <!-- Mandatory! -->
      </v3:getExtension>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns2:getExtensionResponse xmlns:ns2="http://v3.provisioning.ws.web.verba.com/">
         <return>
            <extension>
               <eid>0000</eid>
               <environmentShortName>Ref.</environmentShortName>
               <extension>verbatestuser2@verbalabs.com</extension>
               <id>56</id>
               <im>false</im>
               <recordingMode>ON_DEMAND</recordingMode>
               <screenCaptureEnabled>false</screenCaptureEnabled>
               <user>
                  <agentId/>
                  <apiAccessOnly>false</apiAccessOnly>
                  <crmUserId/>
                  <customDateFormat/>
                  <customTimeFormat/>
                  <displayName>strange-emailx</displayName>
                  <eid>0000</eid>
                  <email>louise.o'donnell@verbalabs.com</email>
                  <environmentShortName>Ref.</environmentShortName>
                  <externalId/>
                  <id>4</id>
                  <language>en</language>
                  <locked>false</locked>
                  <loginName>strange-email</loginName>
                  <needChangePassword>false</needChangePassword>
                  <nonModifiable>false</nonModifiable>
                  <passwordExpires>false</passwordExpires>
                  <passwordHash>.....................</passwordHash>
                  <timeZone>Europe/Budapest</timeZone>
                  <userType>user_type_verba</userType>
                  <validFrom>2015-09-03T11:56:00Z</validFrom>
                  <validTo>2099-12-31T00:00:00Z</validTo>
               </user>
               <video>false</video>
               <voice>true</voice>
            </extension>
            <status>
               <statusCode>OK</statusCode>
            </status>
         </return>
      </ns2:getExtensionResponse>
   </S:Body>
</S:Envelope>