Novero Class Reference

Novero Platform API Manual. More...

List of all members.

Public Member Functions

 Find ($Object, $Type, $Value, $Recursive, $Limit, $Offset, $OrderBy)
 GroupReRoute ($GroupId, $Service, $Destination, $Position, $FailOnFirstError=0)
 NumberActivate ($Number)
 NumberAllocate ($Number, $User)
 NumberDeAllocate ($Number)
 NumberReRoute ($Number, $Service, $Destination, $Position, $Alias)
 NumberSearch ($Type, $Range= '', $Value= '', $Limit= '30', $Offset= '0')
 NumberStatus ($Number)
 NumberSuspend ($Number, $Reason=false)
 Status ()
 UserActivate ($UID)
 UserCreate ($Type, $Name, $Company, $Address0, $Address1, $City, $County, $Postcode, $Country, $Phone, $Fax, $Mobile, $Web, $Email, $Password)
 UserDeAllocate ($UID)
 UserModify ($UID, $Type, $Name, $Company, $Address0, $Address1, $City, $County, $Postcode, $Country, $Phone, $Fax, $Mobile, $Web, $Email, $Password)
 UserSuspend ($UID, $DisableAccount= '1', $Reason= '')
 NumberCDR ($Identifier, $QueryType= '', $Mode= 'CSV', $CDRId=0, $Limit=10)

Public Attributes

 $Vkey
 $Version

Detailed Description

Novero Platform API Manual.

This document describes how to make use of the TTNC Resellers API Version 1.0

Each API call is executed by opening a URL in this way: 

http://api.noveroplatform.com/<Version>/<Vkey>/_<Function>(<Argument 1>,<Argument 2>...<Argument n>);

Here is an example on how to get some details and the current status of a number using the NumberStatus() API call: 

http://api.noveroplatform.com/1.0/somevkey/_NumberStatus(MDgwMDQ2ODEwMDA%3D);
Note:
Each argument must be BASE64 Encoded then URL Encoded.

The API will then respond with plain text XML data as follows: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>3888</UID>
    <Reference>C303888</Reference>
    <IP>87.238.75.195</IP>
  </Client>
  <Data>
    <Status>Ok</Status>
    <StatusDetail></StatusDetail>
    <Number>08704680399</Number>
    <Destination1>441234567890</Destination1>
    <Destination2>442345678901</Destination2>
    <Destination3></Destination3>
    <DateOfService>2006-09-06</DateOfService>
    <Alias>Main Office Number</Alias>
    <Band>4</Band>
    <CallsTotal>3062</CallsTotal>
    <CallsMonth>288</CallsMonth>
    <DurationTotal>12,889:29</DurationTotal>
    <DurationMonth>1,281:53</DurationMonth>
    <CostTotal>607.149</CostTotal>
    <CostMonth>44.545</CostMonth>
  </Data>
  <TxID>6334025</TxID>
</TxResponse>

Every API call will respond with at least the following tags: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>...</UID>
    <Reference>...</Reference>
    <IP>...</IP>
  </Client>
  <Data>
    <Status>...</Status>
    <StatusDetail>...</StatusDetail>
    ...
  </Data>
  <TxID>...</TxID>
</TxResponse>
Note:
TxResponse contains the entire reply from the API, there will be no other data outside this element.
Version contains the current version of the API, any changes in the version number (as long as it is still in the 1.0 series) will contain only bug fixes.
Client contains information on the user currently logged in.
Data will be present in every call, and contains the result of the call.
TxID is the transaction identifier for every call, if problems arise, please email support@ttnc.co.uk providing this number, and a description of the problem.

Member Function Documentation

Find ( $  Object,
$  Type,
$  Value,
$  Recursive,
$  Limit,
$  Offset,
$  OrderBy 
)

Find a number or a user

Parameters:
$Object What to look for, possible values are: 

User
Number
$Type Type of search to conduct. Possible values when Object = User: 

List
Address
Company
Surname
Name
Email
UID
Reference

Possible values when Object = Number: 

Alias
List
Number
$Value The search string.
$Recursive Whether to recursively search through customers, this only applies to resellers who have reseller customers ('0' by default)
$Limit How many results to give. (10 by default)
$Offset How many results to skip.
$OrderBy Which column to sort the data by. (multiple columns can be used, simply separate each column with comma [,] without a space. eg. name,company) 

address0
address1
company
name
county
postcode
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
CountTotal Total users available in account.
CountResult Total users found.
Result All the users found and their details.

Example Response: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>3888</UID>
    <Reference>C303888</Reference>
    <IP>87.238.75.195</IP>
  </Client>
  <Data>
    <Status>Ok</Status>
    <StatusDetail></StatusDetail>
    <CountTotal>5382</CountTotal>
    <CountResult>1</CountResult>
    <Result>
      <Customer>
        <UID>1234</UID>
        <Name>John Smith</Name>
        <Company>Smith Construction co.</Company>
        <Address1>123 Some street</Address1>
        <Address2></Address2>
        <City>Chelmsford</City>
        <Postcode>CM12AB</Postcode>
        <County>Essex</County>
        <Country>GB</Country>
        <Email>john.smith@example.com</Email>
        <Web>www.example.com</Web>
        <Phone>01245 123456</Phone>
        <Fax></Fax>
        <Mobile></Mobile>
        <Reference>C301234</Reference>
      </Customer>
    </Result>
  </Data>
  <TxID>6377647</TxID>
</TxResponse>
GroupReRoute ( $  GroupId,
$  Service,
$  Destination,
$  Position,
$  FailOnFirstError = 0 
)

Re-route a group of numbers to a new destination or set of destinations.

Parameters:
$GroupId The name of the group.
$Service The type of service on the number. 

Auto
Clear
FaxToEmail
VoiceToEmail
H323
SIP
IAX
Number
$Destination The new terminating destination for the number. This should be the destination number without the leading 00 and with country code.
$Position The position of the terminating destination.
$FailOnFirstError Whether to ignore errors on individual numbers ( 0 ), or to stop on the first encountered error ( 1 )
Return values:
VerboseResult The result of re-routing the individual numbers.
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberActivate ( $  Number  ) 

Activate a number and re-route it to it's original destination(s) prior to being suspended by NumberSuspend().

Parameters:
$Number The number to be activated.
Note:
This number must be allocated using NumberAllocate() first.
If the number is newly allocated the number will be active but not routing anywhere.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberAllocate ( $  Number,
$  User 
)

Allocate a number to a user, this will take the number out of the pool of numbers into a user's account, but will be inactive until NumberActivate() and NumberReRoute() are called.

Parameters:
$Number The number to be allocated.
$User The user to allocate the number to.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberCDR ( $  Identifier,
$  QueryType = '',
$  Mode = 'CSV',
$  CDRId = 0,
$  Limit = 10 
)

Retrieve CDR Data

Parameters:
$Identifier Either the UID of the user, or the Number to retrieve CDR data for.
$QueryType The type of query to run; 

Latest	Will return the latest $Limit records of CDR data.
LastID	Will return all records after $CDRId up to date.
$Mode The type of result expected, currently only CSV is supported.
$CDRId The UID of the last received record. (this is ignored when $QueryType is 'Latest')
$Limit The maximum number of records to return. (this is ignored when $QueryType is 'LastID')
NumberDeAllocate ( $  Number  ) 

De-allocate a number from a user. This will remove the number from the user's account and return it into the pool of numbers.

Parameters:
$Number The number to be de-allocated.
Note:
Once a number is de-allocated another charge will incur if the same number is allocated again. If this is done by accident please contact support@ttnc.co.uk and the number will be returned to the original account.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberReRoute ( $  Number,
$  Service,
$  Destination,
$  Position,
$  Alias 
)

Re-route a number to a new destination or set of destinations.

Parameters:
$Number The number to be re-routed.
$Service The type of service on the number. 

Auto
Clear
FaxToEmail
VoiceToEmail
H323
SIP
IAX
Number
$Destination The new terminating destination for the number. This should be the destination number without the leading 00 and with country code.
$Position The position of the terminating destination.
$Alias The Alias (also known as Service Name on the Novero Platform) of the number

  • This parameter is only used when $Position == 1.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberSearch ( $  Type,
$  Range = '',
$  Value = '',
$  Limit = '30',
$  Offset = '0' 
)

Search the pool of numbers for available numbers.

Parameters:
$Type The type of search to be executed. 

Contains
Ends
Whole
ByBand
Seq
ListRanges
$Range The range to be searched, available ranges can be retrieved using $Type = ListRanges.
$Value The search string (this can be either digits or letters for alpha numbers).
$Limit The maximum number of results to respond with per call.
$Offset The number of results to skip.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
NumberStatus ( $  Number  ) 

Get the status and some details of a number.

Parameters:
$Number The number to get information on.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
Number The telephone number.
Destination1 The first destination (if this is the only one hunt group is deactivated)
Destination2 The second destination
Destination3 The third destination
DateOfService The date the number was allocated.
Alias The alias of the number, this is a name given to a number at the time of routing.
Band The memorability level of the number.
CallsTotal The total number of calls the number has received since allocation.
CallsMonth The total number of calls the number has received during the current month.
DurationTotal The total duration in minutes the number has received since allocation.
DurationMonth The total duration in minutes the number has received during the current month.
CostTotal The total cost in pounds the number has incurred since allocation.
CostMonth The total cost in pounds the number has incurred during the current month.
NumberSuspend ( $  Number,
$  Reason = false 
)

Suspend a number and disable the routing on it.

Parameters:
$Number The number to be suspended.
$Reason The reason the number was suspended, this can be any string of text and is optional.
Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
Status (  ) 

Test connection to API.

Return values:
Status The result of the API call.
StatusDetail Some extra information on the result of the API call.
UserActivate ( $  UID  ) 

Activate a user and all of their numbers.

Example Response: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>3888</UID>
    <Reference>C303888</Reference>
    <IP>87.238.75.195</IP>
  </Client>
  <Data>
    <Status>Ok</Status>
    <StatusDetail>Account successfully modified.</StatusDetail>
  </Data>
  <TxID>6379723</TxID>
</TxResponse>
UserCreate ( $  Type,
$  Name,
$  Company,
$  Address0,
$  Address1,
$  City,
$  County,
$  Postcode,
$  Country,
$  Phone,
$  Fax,
$  Mobile,
$  Web,
$  Email,
$  Password 
)

Create a new user

Parameters:
$Type The type of user to create. Possible values are: 

Customer
$Name Name
$Company Company
$Address0 Address0
$Address1 Address1
$City City
$County County
$Postcode Postcode
$Country Country
$Phone Phone
$Fax Fax
$Mobile Mobile
$Web Web
$Email Email
$Password Password
UserDeAllocate ( $  UID  ) 

Delete a user and all of their numbers.

Parameters:
$UID The UID of the user to delete.
Note:
Once numbers are deleted they will return to the pool of numbers, and can be purchased by any one else.
A new charge will incur if the same number is allocated again.

Example Response: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>3888</UID>
    <Reference>C303888</Reference>
    <IP>87.238.75.195</IP>
  </Client>
  <Data>
    <Status>Ok</Status>
    <StatusDetail>Account successfully modified.</StatusDetail>
  </Data>
  <TxID>6379917</TxID>
</TxResponse>
UserModify ( $  UID,
$  Type,
$  Name,
$  Company,
$  Address0,
$  Address1,
$  City,
$  County,
$  Postcode,
$  Country,
$  Phone,
$  Fax,
$  Mobile,
$  Web,
$  Email,
$  Password 
)

Modify an existing user

Parameters:
$UID The ID of the user being modified.
$Type The new type of user. Possible values are: 

Customer
$Name Name
$Company Company
$Address0 Address0
$Address1 Address1
$City City
$County County
$Postcode Postcode
$Country Country
$Phone Phone
$Fax Fax
$Mobile Mobile
$Web Web
$Email Email
$Password Password
UserSuspend ( $  UID,
$  DisableAccount = '1',
$  Reason = '' 
)

Suspend a user and all of their numbers.

Parameters:
$UID The UID of the user to be suspended.
$DisableAccount Whether to disable the account as well as the numbers. 0 = no, 1 = yes (default)
$Reason The reason the account is being suspended, this can be any text.

Example Response: 

<?xml version="1.0"?>
<TxResponse>
  <Version>1.5</Version>
  <Client>
    <UID>3888</UID>
    <Reference>C303888</Reference>
    <IP>87.238.75.195</IP>
  </Client>
  <Data>
    <Status>Ok</Status>
    <StatusDetail>Account successfully modified.</StatusDetail>
  </Data>
  <TxID>6379823</TxID>
</TxResponse>
Generated on Thu Sep 24 12:57:25 2009 for Novero-API by  doxygen 1.6.1