VoxAPI.Methods.GetDIDGroupList

From voxbone-client

Contents 1 GetDIDGroupList 1.1 Description: 1.2 Method Definition: 1.3 Request: 1.4 'Possible Errors'

GetDIDGroupList

Description:

This method retrieve a list of DIDGroup ( area code ).

Method Definition:

<wsdl:operation name="GetDIDGroupList">
	<wsdl:input name="GetDIDGroupListRequest" message="tns:GetDIDGroupListRequest">
		</wsdl:input>
	<wsdl:output name="GetDIDGroupListResponse" message="tns:GetDIDGroupListResponse">
		</wsdl:output>
	<wsdl:fault name="VoxAPIFault" message="tns:VoxAPIFault">
		</wsdl:fault>
</wsdl:operation>

Request:

The request is composed by the following elements:

• UserToken
• CountryID that can be obtained using the GetCountriesList method and is the unique identifier of a Country
• DIDType
• an optional DIDGroupFilter

Request definition:

<xsd:element name="GetDIDGroupList">
	<xsd:complexType>
		<xsd:all>
			<xsd:element maxOccurs="1" minOccurs="1" ref="tns:UserToken"/>
			<xsd:element maxOccurs="1" minOccurs="1" name="CountryID" nillable="false" type="tns:ID"/>
			<xsd:element maxOccurs="1" minOccurs="1" name="Type" type="tns:DIDType"/>
			<xsd:element maxOccurs="1" minOccurs="0" name="Filter" type="tns:DIDGroupFilter"/>
		</xsd:all>
	</xsd:complexType>
</xsd:element>

Sample request:

      <vox:GetDIDGroupList 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:CountryID>225</vox:CountryID>
         <vox:Type>GEOGRAPHIC</vox:Type>
         <!--Optional:-->
         <vox:Filter>
         <!--Optional:-->
            <vox:HideEmpty>true</vox:HideEmpty>
            <!--Optional:-->
            <vox:StateID>3</vox:StateID>
         </vox:Filter>
      </vox:GetDIDGroupList>

Response:
The response will contains the following elements:

• an array of DIDGroup

Response definition:

<xsd:element name="GetDIDGroupListResponse">
	<xsd:complexType>
		<xsd:sequence>
			<xsd:element maxOccurs="1" minOccurs="1" name="ArrayOfDIDGroups" type="tns:ArrayOfDIDGroups"/>
		</xsd:sequence>
	</xsd:complexType>
</xsd:element>

Sample response:

      <GetDIDGroupListResponse xmlns="http://www.voxbone.com/VoxAPI">
         <ArrayOfDIDGroups>
            <DIDGroup>
               <DIDGroupID>5167</DIDGroupID>
               <CountryName>UNITED STATES</CountryName>
               <CityName>NOGALES</CityName>
               <stock>98</stock>
               <CountryCode>1</CountryCode>
               <AreaCode>520</AreaCode>
               <Setup100>700</Setup100>
               <Monthly100>600</Monthly100>
               <RequirePurchaseInfo>false</RequirePurchaseInfo>
            </DIDGroup>
            <DIDGroup>
               <DIDGroupID>297</DIDGroupID>
               <CountryName>UNITED STATES</CountryName>
               <CityName>PHOENIX</CityName>
               <stock>177</stock>
               <CountryCode>1</CountryCode>
               <AreaCode>480</AreaCode>
               <Setup100>700</Setup100>
               <Monthly100>600</Monthly100>
               <RequirePurchaseInfo>false</RequirePurchaseInfo>
            </DIDGroup>
            <DIDGroup>
               <DIDGroupID>4879</DIDGroupID>
               <CountryName>UNITED STATES</CountryName>
               <CityName>PRESCOTT</CityName>
               <stock>98</stock>
               <CountryCode>1</CountryCode>
               <AreaCode>928</AreaCode>
               <Setup100>700</Setup100>
               <Monthly100>600</Monthly100>
               <RequirePurchaseInfo>false</RequirePurchaseInfo>
            </DIDGroup>
            ...
         </ArrayOfDIDGroups>
      </GetDIDGroupListResponse>

'Possible Errors'

• Malformed XML
• Authentication