VoxAPI.Methods.GetDIDsInfo

From voxbone-client

Contents 1 GetDIDsInfo 1.1 Description: 1.2 Method Definition: 1.3 Request: 1.4 Response:

GetDIDsInfo

Description:

Retrieve information about DIDs.

Method Definition:

<wsdl:operation name="GetDIDsInfo">
	<wsdl:input name="GetDIDsInfoRequest" message="tns:GetDIDsInfoRequest">
		</wsdl:input>
	<wsdl:output name="GetDIDsInfoResponse" message="tns:GetDIDsInfoResponse">
		</wsdl:output>
	<wsdl:fault name="VoxAPIFault" message="tns:VoxAPIFault">
		</wsdl:fault>
</wsdl:operation>

Request:

The request is composed by the following elements:

• UserToken
• DIDsFilter

Request definition:

<xsd:element name="GetDIDsInfo">
	<xsd:complexType>
		<xsd:all>
			<xsd:element maxOccurs="1" minOccurs="1" ref="tns:UserToken"/>
			<xsd:element maxOccurs="1" minOccurs="0" name="Filter" nillable="false" type="tns:DIDsFilter"/>
		</xsd:all>
	</xsd:complexType>
</xsd:element>

Sample request:

      <vox:GetDIDsInfo xmlns:vox="http://www.voxbone.com/VoxAPI">
         <vox:UserToken>
            <vox:Username>login</vox:Username>
            <vox:Key>key</vox:Key>
            <vox:Hash>hash</vox:Hash>
         </vox:UserToken>
         <!--Optional:-->
         <vox:Filter>
            <!--Optional:-->
            <vox:E164>3228080355</vox:E164>
            <!--Optional:-->
            <vox:OrderReference>987DS24239</vox:OrderReference>
         </vox:Filter>
      </vox:GetDIDsInfo>

Response:

The response will contains the following elements:

• an array of DID

Response definition:

<xsd:element name="GetDIDsInfoResponse">
	<xsd:complexType>
		<xsd:sequence>
			<xsd:element maxOccurs="1" minOccurs="0" ref="tns:ArrayOfDIDs"/>
		</xsd:sequence>
	</xsd:complexType>
</xsd:element>

Sample response:

      <GetDIDsInfoResponse xmlns="http://www.voxbone.com/VoxAPI">
         <ArrayOfDIDs>
            <DID>
               <DIDsID>88211</DIDsID>
               <DID>8080355</DID>
               <E164>3228080355</E164>
               <Type>GEOGRAPHIC</Type>
               <CountryName>BELGIUM</CountryName>
               <CountryCode>32</CountryCode>
               <CityName>BRUSSELS</CityName>
               <AreaCode>2</AreaCode>
               <mapping>sip:test@myuri.com</mapping>
               <OrderReference>987DS24239</OrderReference>
               <Channels>2</Channels>
               <Delivery>BE</Delivery>
               <TrunkID>-1</TrunkID>
            </DID>
         </ArrayOfDIDs>
      </GetDIDsInfoResponse>