VoxAPI.Methods.GetPOPList

From voxbone-client

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

GetPOPList

Description:

Retrieve the list of available POPs and their associated IP addresses.

Method Definition:

<wsdl:operation name="GetPOPList">
	<wsdl:input name="GetPOPListRequest" message="tns:GetPOPListRequest">
		</wsdl:input>
	<wsdl:output name="GetPOPListResponse" message="tns:GetPOPListResponse">
		</wsdl:output>
	<wsdl:fault name="VoxAPIFault" message="tns:VoxAPIFault">
		</wsdl:fault>
</wsdl:operation>

Request:

The request is composed by the following elements:

• UserToken

Request definition:

<xsd:element name="GetPOPList">
	<xsd:complexType>
		<xsd:all>
			<xsd:element maxOccurs="1" minOccurs="1" ref="tns:UserToken"/>
		</xsd:all>
	</xsd:complexType>
</xsd:element>

Sample request:

      <vox:GetPOPList 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>
      </vox:GetPOPList>

Response:

The response will contains the following elements:

• an array of POP

Request definition:

<xsd:element name="GetPOPListResponse">
	<xsd:complexType>
		<xsd:sequence>
			<xsd:element maxOccurs="1" minOccurs="1" ref="tns:ArrayOfPOPs"/>
		</xsd:sequence>
	</xsd:complexType>
</xsd:element>

Sample request:

      <GetPOPListResponse xmlns="http://www.voxbone.com/VoxAPI">
         <ArrayOfPOPs>
            <POP>
               <DeliveryID>2</DeliveryID>
               <Name>BE</Name>
               <ArrayOfIPs>
                  <IP>81.201.82.21</IP>
                  <IP>81.201.82.22</IP>
                  <IP>81.201.82.23</IP>
                  <IP>81.201.82.24</IP>
                  ...
               </ArrayOfIPs>
            </POP>
            <POP>
               <DeliveryID>6</DeliveryID>
               <Name>US</Name>
               <ArrayOfIPs>
                  <IP>81.201.84.21</IP>
                  <IP>81.201.84.22</IP>
                  <IP>81.201.84.23</IP>
                  <IP>81.201.84.24</IP>
                  ...
               </ArrayOfIPs>
            </POP>
         </ArrayOfPOPs>
      </GetPOPListResponse>