NoveroNumberSearch


Search

Description

Search for numbers available to purchase.

Parameters

string Range The 3-6 digit area code (STD). For example; '020', '0800', '01234'.
string Value A string of digits which should appear within the number.
string Band A two digit string identifying the memorability level for the number.
'00' Standard
'10' Bronze
'20' Silver
'30' Gold
'40' Platinum
'50' Diamond

For pricing, please refer to your pricing agreement or contact sales@ttnc.co.uk.
Offset Will cause the function to return a number set starting from the Offset index.
Limit Will cause the function to return a maximum amount of number equal to Limit.
RequiredOptional

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
            <Request target="NoveroNumberSearch" name="Search" id="Request1">
                <Range>0800</Range>
                <Value>468</Value>
                <Band>00</Band>
                <Offset>10</Offset>
                <Limit>6</Limit>
            </Request>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroNumberSearch', 'Search', 'Request1');
            $Request->SetData('Range', '0800');
            $Request->SetData('Value', '468');
            $Request->SetData('Band', '00');
            $Request->SetData('Offset', '10');
            $Request->SetData('Limit', '6');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('Request1');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroNumberSearch', 'Search', 'Request1')
        request.setdata('Range', '0800')
        request.setdata('Value', '468')
        request.setdata('Band', '00')
        request.setdata('Offset', '10')
        request.setdata('Limit', '6')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroNumberSearch', 'Search', 'Request1')
        request.setdata('Range', '0800')
        request.setdata('Value', '468')
        request.setdata('Band', '00')
        request.setdata('Offset', '10')
        request.setdata('Limit', '6')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroNumberSearch", "Search", "Request1");
                request.setData("Range", "0800");
                request.setData("Value", "468");
                request.setData("Band", "00");
                request.setData("Offset", "10");
                request.setData("Limit", "6");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
      <Response target="NoveroNumberSearch" name="Search" Code="200" RequestId="Request1">
          <Numbers>
              <Number>
              <RawNumber>08001182523</RawNumber>
              <alpha></alpha>
              <band>00</band>
              <code>free</code>
              <range>0800</range>
              <tariff>Freephone</tariff>
              <number>0800 118 2523</number>
              </Number>

              ...

          </Numbers>
          <BandCounts>
              <BandCount Band="00">8,867</BandCount>
              <BandCount Band="10">2,866</BandCount>
              <BandCount Band="20">227</BandCount>
              <BandCount Band="30">167</BandCount>
              <BandCount Band="40">154</BandCount>
              <BandCount Band="50">10</BandCount>
          </BandCounts>
          <BandPrice>&pound;10</BandPrice>
          <BandRewnewalPrice>&pound;10</BandRewnewalPrice>
          <BandRewnewalFreq>yearly</BandRewnewalFreq>
      </Response>
  <NoveroResponse>

ListRanges

Description

Retrieve a list of all available ranges.

Parameters

This function takes no parameters.

Request


  • XML
  • PHP
  • Ruby
  • Python
  • C#
        <?xml version="1.0"?>
        <NoveroRequest>
            <Request target="NoveroNumberSearch" name="ListRanges" id="Request1"/>
        </NoveroRequest>
      
        <?php
            require_once('TTNCApi.php');
            $Api = new TTNCApi('<username>', '<password>', '<VKey>');
            $Request = $Api->NewRequest('NoveroNumberSearch', 'ListRanges', 'Request1');
            $Api->MakeRequests();
            $Response = $Api->GetResponseFromId('Request1');
        ?>
      
        require TTNCApi
        api = TTNCApi.new('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroNumberSearch', 'ListRanges', 'Request1')
        api.makerequest()
        p request.getresponse()
      
        api = TTNCApi('<username>', '<password>', '<vkey>')
        request = api.newrequest('NoveroNumberSearch', 'ListRanges', 'Request1')
        api.makerequest()
        p request.getresponse()
      
        using System;
        using TTNCApi;

        class Program
        {
            static void Main(string[] args)
            {
                TTNCApi api = new TTNCApi("<username>", "<password>", "<vkey>");
                TTNCRequest request = api.NewRequest("NoveroNumberSearch", "ListRanges", "Request1");
                api.MakeRequests();
                TTNCParser dic = request.GetResponse();
             }
        }

Response

  <?xml version="1.0"?>
  <NoveroResponse>
      <Response target="NoveroNumberSearch" name="ListRanges" Code="200" RequestId="Request1">
          <Ranges>
              <Range>
                  <RangeId>1389</RangeId>
                  <range>01224</range>
                  516
                  <tariff>Aberdeen</tariff>
                  <code>g</code>
                  <number_type>Aberdeen</number_type>
              </Range>
              <Range>
                  <RangeId>1915</RangeId>
                  <range>01887</range>
                  47
                  <tariff>Aberfeldy</tariff>
                  <code>g</code>
                  <number_type>Aberfeldy</number_type>
              </Range>

              ...

              <Range>
                  <RangeId>20</RangeId>
                  <range>0800</range>
                  1182
                  <tariff>Freephone</tariff>
                  <code>free</code>
                  <number_type>Freephone</number_type>
              </Range>

              ...

          </Ranges>
      </Response>
  </NoveroResponse>

Allocate a number

Purchasing a number via the API is a multi step process. Firstly you need to search for the number you'd like to buy and add it to your basket. You'll then need to add a credit card to your account if you have already done so to pay for the number. Finally you can purchase the number and forward it to your chosen destination.

Authenticate and perform a number search.

Request

  <?xml version="1.0"?>
  <NoveroRequest>
    <Request target="Auth" name="SessionLogin" id="SessionRequest">
      <Username>user@domain.com</Username>
      <Password>MySuperSecretPassword</Password>
      <VKey>a75ac3289b7a145579bec8ad5ec60a</VKey>
    </Request>
    <Request target="NoveroNumberSearch" name="Search" id="Request1">
      <Range>01245</Range>
      <Limit>1</Limit>
      <Band>00</Band>
    </Request>
  </NoveroRequest>

Response

  <?xml version="1.0"?>
  <NoveroResponse>
    <Response target="Auth" name="SessionLogin" Code="200" RequestId="SessionRequest">
      <SessionId>75ad4013e0ea4340c0b5c28b4aad96a9</SessionId>
    </Response>
    <Response target="NoveroNumberSearch" name="Search" Code="200" RequestId="Request1">
      <Numbers>
        <Number>
          <RawNumber>01245835013</RawNumber>
          <alpha></alpha>
          <band>00</band>
          <code>g</code>
          <range>01245</range>
          <tariff>Chelmsford</tariff>
          <number>01245 835 013</number>
        </Number>
      </Numbers>
      <BandCounts>
        <BandCount Band="00">7,859</BandCount>
        <BandCount Band="10">1,115</BandCount>
        <BandCount Band="20">324</BandCount>
        <BandCount Band="30">266</BandCount>
        <BandCount Band="40">39</BandCount>
        <BandCount Band="50">12</BandCount>
      </BandCounts>
      <BandPrice>£10</BandPrice>
      <BandRewnewalPrice>£10</BandRewnewalPrice>
      <BandRewnewalFreq>yearly</BandRewnewalFreq>
    </Response>
  </NoveroResponse>

Add the number to the basket, and exchange a card for a TokenId.

Request

  <NoveroRequest>
    <SessionId>75ad4013e0ea4340c0b5c28b4aad96a9</SessionId>
    <Request target="Order" name="AddToBasket" id="Request1">
      <number>01245835013</number>
      <type>number</type>
    </Request>
    <Request target="NoveroUser" name="AddCard" id="Request2">
      <CardName>Mr Joe Blogs</CardName>
      <CardNumber>44012345678901234</CardNumber>
      <ExpiryMonth>05</ExpiryMonth>
      <ExpiryYear>15</ExpiryYear>
      <CV2>123</CV2>
      <Type>VISA</Type>
      <Address1>10 Some Street</Address1>
      <City>London</City>
      <Postcode>E1 1AB</Postcode>
      <Country>UK</Country>
    </Request>
  </NoveroRequest>

Response

  <?xml version="1.0"?>
  <NoveroResponse>
    <Response target="Order" name="AddToBasket" Code="200" RequestId="Request1">
      <ResponseMessage>Added to Basket</ResponseMessage>
      <Success>Added to Basket</Success>
    </Response>
    <Response target="NoveroUser" name="AddCard" Code="200" RequestId="Request2">
      <Token>
        <TokenId>12345</TokenId>
      </Token>
    </Response>
  </NoveroResponse>

Purchase the number using the TokenId from the previous request, and route it to a destination.

Request

  <NoveroRequest>
    <SessionId>75ad4013e0ea4340c0b5c28b4aad96a9</SessionId>
    <Request target="Order" name="PlaceOrder" id="Request1">
      <TokenId>12345</TokenId>
      <CV2>123</CV2>
    </Request>
    <Request target="NoveroNumbers" name="SetDestination" id="Request2">
      <Number>01245835013</Number>
      <Destination>08004681000</Destination>
    </Request>
  </NoveroRequest>

Response

  <NoveroResponse>
    <Response target="Order" name="PlaceOrder" Code="200" RequestId="Request1">
      <OrderStatus>OK</OrderStatus>
      <InvoiceId>12345</InvoiceId>
    </Response>
    <Response target="NoveroNumbers" name="SetDestination" Code="200" RequestId="Request2">
      <ResponseMessage>Destination Set Successfully</ResponseMessage>
      <Success>Destination Set Successfully</Success>
    </Response>
  </NoveroResponse>