VoxAPI.Methods.PurchaseTollfreeCredit

From voxbone-client

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

PurchaseTollfreeCredit

Description:

Place an order for a specific TollfreeCreditPackage

Method Definition:

**<wsdl:operation name="PurchaseTollfreeCredit">
    <wsdl:input name="PurchaseTollfreeCreditRequest" message="tns:PurchaseTollfreeCreditRequest">
        </wsdl:input>
    <wsdl:output name="PurchaseTollfreeCreditResponse" message="tns:PurchaseTollfreeCreditResponse">
        </wsdl:output>
    <wsdl:fault name="VoxAPIFault" message="tns:VoxAPIFault">
        </wsdl:fault>
</wsdl:operation>**

Request:

The request is composed by the following elements:

• UserToken
• TollfreeCreditPackageID that can be obtained using the GetTollfreeCreditPackageList method and is the unique identifier of a TollfreeCreditPackage
• Quantity which is the quantity of package you want to purchase.

Request definition:

<xsd:element name="PurchaseTollfreeCredit">
    <xsd:complexType>
        <xsd:all>
            <xsd:element maxOccurs="1" minOccurs="1" ref="tns:UserToken"/>
            <xsd:element maxOccurs="1" minOccurs="1" name="TollfreeCreditPackageID" nillable="false" type="tns:ID"/>
            <xsd:element maxOccurs="1" minOccurs="1" name="Quantity" nillable="false" type="tns:ID"/>
        </xsd:all>
    </xsd:complexType>
</xsd:element>

Sample request:

      <vox:PurchaseTollfreeCredit xmlns:vox="http://www.voxbone.com/VoxAPI">
         <vox:UserToken>
            <vox:Username>wanna</vox:Username>
            <vox:Key>key</vox:Key>
            <vox:Hash>hash</vox:Hash>
         </vox:UserToken>
         <vox:TollfreeCreditPackageID>1</vox:TollfreeCreditPackageID>
         <vox:Quantity>1</vox:Quantity>
      </vox:PurchaseTollfreeCredit>

Response:

The response will contains the following elements:

• OrderReference which is the reference of the order you just placed.
• OrderStatus

Response definition:

<xsd:element name="PurchaseTollfreeCreditResponse">
    <xsd:complexType>
        <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="1" name="OrderReference" type="xsd:string"/>
            <xsd:element maxOccurs="1" minOccurs="1" name="OrderStatus" type="tns:OrderStatus"/>
        </xsd:sequence>
    </xsd:complexType>
</xsd:element>

Sample response:

      <PurchaseTollfreeCreditResponse xmlns="http://www.voxbone.com/VoxAPI">
         <OrderReference>987PC24321</OrderReference>
         <OrderStatus>FULFILLED</OrderStatus>
      </PurchaseTollfreeCreditResponse>