VoxAPI.Methods.LimitDIDChannels

From voxbone-client

Contents 1 LimitDIDChannels 1.1 Description: 1.2 Requirements: 1.3 Method Definition: 1.4 Request: 1.5 Response:

LimitDIDChannels

Description:

Limit the usage of capacity for specific DID to specified amount of channels(simultaneous calls received)

Requirements:

One must be enrolled under "wholesales" pricing and have the DIDs placed on a trunk. The maximum number of simultaneous call will not exceed the capacity of your trunk.

Method Definition:

<wsdl:operation name="LimitDIDChannels">
  <wsdl:input name="LimitDIDChannelsRequest" message="tns:LimitDIDChannelsRequest"></wsdl:input>
  <wsdl:output name="LimitDIDChannelsResponse" message="tns:LimitDIDChannelsResponse"></wsdl:output>
  <wsdl:fault name="VoxAPIFault" message="tns:VoxAPIFault"></wsdl:fault>
</wsdl:operation>

Request:

The request is composed by the following elements:

• UserToken
• DIDsID that can be obtained using the GetDIDsInfo method and is the unique identifier of a DID
• LimitCapacity that specify the number of simultaneous call accepted (an integer value)
• UseMaximum a boolean that assigns the maximum capacity of a trunk(default value)

Request Definition:

<xsd:element name="LimitDIDChannels">
  <xsd:complexType>
   <xsd:all>
    <xsd:element maxOccurs="1" minOccurs="1" ref="tns:UserToken"/>
    <xsd:element maxOccurs="1" minOccurs="1" name="DIDsID" nillable="false" type="tns:ID"/>
    <xsd:element maxOccurs="1" minOccurs="0" name="LimitCapacity" nillable="false" type="xsd:int"/>
    <xsd:element default="true" maxOccurs="1" minOccurs="1" name="UseMaximum" nillable="false" type="xsd:boolean"/>
   </xsd:all>
  </xsd:complexType>
</xsd:element>

Sample request

  <vox:LimitDIDChannels>
        <vox:UserToken>
            <vox:Username>login</vox:Username>
            <vox:Key>key</vox:Key>
            <vox:Hash>hash</vox:Hash>
        </vox:UserToken>
        <vox:DIDsID>88210</vox:DIDsID>
        <vox:LimitCapacity>3</vox:LimitCapacity>
        <vox:UseMaximum>false</vox:UseMaximum>
  </vox:LimitDIDChannels>

Response:

The response will contains the following elements:

• Capacity which is an integer that will indicate the current capacity set for your DID.
• UseTrunkMaximum a boolean that acknowlege the maximum usage of trunk capacity

Response definition:

<xsd:element name="LimitDIDChannelsResponse">
  <xsd:complexType>
  <xsd:all>
    <xsd:element maxOccurs="1" minOccurs="1" name="Capacity" type="xsd:int"/>
    <xsd:element maxOccurs="1" minOccurs="1" name="UseTrunkMaximum" type="xsd:boolean"/>
  </xsd:all>
  </xsd:complexType>
</xsd:element>

Sample response:

<LimitDIDChannelsResponse xmlns="http://www.voxbone.com/VoxAPI">
      <Capacity>3</Capacity>
      <UseTrunkMaximum>false</UseTrunkMaximum>
</LimitDIDChannelsResponse>