Author image Ivan Kohler
and 1 contributors

NAME

Net::Vitelity - Interface to Vitelity API

SYNOPSIS

    use Net::Vitelity;

    my $vitelity = Net::Vitelity->new(
                                       'login' => $your_login,
                                       'pass'  => $your_pass,
                                     );

METHODS

new

Create a new Net::Vitelity object. login and pass are required.

listtollfree

List ALL available toll free numbers

Possible Results: none OR [list of tf numbers]

callfromclick

Sends someone a phone call that then connects them to customer service/another number.

Options: number=number AND servicenumber=number

Possible Results:OK or INVALID

listlocal

Lists ALL available local numbers in a specific state and ratecenter

Requires: state=STATE

Options: type=unlimited OR type=pri OR withrates=yes ratecenter=RATECENTER

Possible Results: unavailable or missing or [list of dids]

gettollfree

Orders a specific toll free number in our available list (SLOW) Requires: did=TOLL-FREE-NUMBER Options: routesip=route_to_this_subaccount Possible Results: success or unavailable or missingdid

getlocaldid

Orders a specific local number from our available list

Requires: did=AVAILABLE-LOCAL-NUMBER

Options: type=perminute OR type=unlimited OR type=your-pri OR routesip=route_to_this_subaccount

Possible Results: invalid or success or missingdid

removedid

Remove Local or Toll Free DID from account

Requires: did=AVAILABLE-LOCAL-NUMBER

Possible Results: success OR unavailable OR missingdid

listratecenters

Lists all of the available rate centers for a specific state line by line

Requires: state=STATE (ie, state=CO)

Options: type=perminute OR type=unlimited OR type=pri

Possible Results: unavailable OR missingdata OR [list of ratecenters]

listavailratecenters

Lists all available rate centers DIDs are currently in stock for a specific state line by line

Requires: state=STATE (ie, state=CO)

Options: type=unlimited OR type=pri

Possible Results: missingdata OR unavailable or [list of ratecenters]

requestvanity

Orders a specific available toll free number from the SMS database.

Requires: did=8009879891 (number can be any available number)

Possible Results: missingdata OR exists OR success

searchtoll

Searches the SMS/800 database for an available number matching the specific data you provide

Requires: did=8**333****

Possible Results: none OR missingdata OR [list of avail numbers]

listavailstates

Lists all states that have DIDs which are currently in stock

Options: type=perminute OR type=unlimited OR type=pri

Possible Results: unavailable OR [list of states]

liststates

Lists all available DID states line by line

Options: type=perminute OR type=unlimited OR type=pri

Possible Results: unavailable OR [list of states]

cnam

Lookup a specific caller id number for the name

Requires: did=3037855015 (number)

Possible Results: missingdata OR [cnam value]

searchtoll

Searches the SMS/800 database for an available number matching the specific data you provide

Requires: did=8**333****

Possible Results: none OR missingdata OR [list of avail numbers]

localbackorder

Orders a specific local number from our available list

Requires: ratecenter=RATECENTER and state=STATE

Options: type=perminute OR type=unlimited

Possible Results: invalid OR ok OR missing

reroute

Changes the sub account a DID rings to.

Requires: did=DID_NUMBER & routesip=SIP_SUB_ACCOUNT

Possible Results: missingdata OR ok OR invalid

balance

Reports back your current account balance

listdids

Lists all current Local and Toll free DIDs

Options: extra=yes

Results: number,ratecenter,price_per_minute,subaccount

extra=yes adds STATE,MONTHLY_DID_RATE

routeall

Changes the routing on all dids to a specific sip account

Requires: routesip=sub_account OR routesip=login (routes to main)

Possible Results: ok OR invalid

getrate

Gets a rate on a specific domestic or International call

Requires: number=[countrycode_thenumber] ex: 01144.. or 1303..

Results: invalid OR the_rate_per_minute

subaccounts

Lists sub accounts

Requires: do=list

Possible Results: subaccount list separated by return OR invalid

All Possible Result Return Codes

success

The request you made was successful

missingdata

You are missing login= or pass= or cmd= or other in your URL string

invalidauth

You have submitted an invalid login or password

missingrc

You are missing the ratecenter or state for a specific local did order

unavailable

The number you requested is not available

none

There are no numbers available

missingdid

you are missing &did=number

list of data

If you asked for a list of numbers and we had some available, they will be listed.

In a list contect, all entries will be returned in a list. In a scalar scalar context, entries will be separated by newlines.

AUTHOR

Ivan Kohler, <ivan-vitelity at freeside.biz>

BUGS

Please report any bugs or feature requests to bug-net-vitelity at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-Vitelity. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Net::Vitelity

You can also look for information at:

ADVERTISEMENTS

This module was developed by Freeside Internet Services, Inc. Need a complete, open-source back-office and customer self-service solution? The Freeside software includes Vitelity integration, CDR rating, invoicing, credit card and electronic check processing, integrated trouble ticketing and customer signup and self-service web interfaces.

http://freeside.biz/

Development sponsored by Voice Carrier LLC. If you need a hosted or on-site PBX, please visit http://www.voicecarrier.com/

COPYRIGHT & LICENSE

Copyright 2009-2012 Freeside Internet Services, Inc. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.