get_phone_destinations

A get_phone_destinations request will display and allow a user to choose from all the telephones currently accessible. The request will return all telephones owned by the current user and display the name, description, seven digit uniqueid, the three or four digit extension number (callerIDint), and the default callerID.


Parameter
Purpose
usernameThe user's login name.
passwordThe user's login password.
all_destinationsAll telephones accessible to the current user.
nameA telephone's seven digit identifying name.
descriptionA particular telephone's human-readable description (i.e., "Reception Desk").
callerIDThe caller ID associated with the phone line that is to be displayed to outside callers. 
callerIDintA telephone's three or four digit extension number.



Sample Request
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:TelebroadWebServices">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:get_phone_destinations soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <username xsi:type="xsd:string">usernamehere</username>
         <password xsi:type="xsd:string">passwordhere</password>
         <all_destinations xsi:type="xsd:int">?</all_destinations>
      </urn:get_phone_destinations>
   </soapenv:Body>
</soapenv:Envelope>



Sample Response
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="urn:TelebroadWebServices">
   <SOAP-ENV:Body>
      <ns1:get_phone_destintationsResponse xmlns:ns1="urn:TelebroadWebServices">
         <return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:phone_destintation_item[2]">
            <item xsi:type="tns:phone_destination_item">
               <name xsi:type="xsd:string">2212555</name>
               <description xsi:type="xsd:string">John Doe</description>
               <callerID xsi:type="xsd:string">12125550000</callerID>
               <callerIDint xsi:type="xsd:string">101</callerIDint>
            </item>
            <item xsi:type="tns:phone_destination_item">
               <name xsi:type="xsd:string">2250000</name>
               <description xsi:type="xsd:string">Mark Newt</description>
               <callerID xsi:type="xsd:string">12125550000</callerID>
               <callerIDint xsi:type="xsd:string">102</callerIDint>
            </item>
         </return>
      </ns1:get_phone_destinationsResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.