Difference between revisions of "Freeside:3:Documentation:Developer/FS/svc phone"

Revision as of 20:06, 27 June 2012

NAME

FS::svc_phone - Object methods for svc_phone records

SYNOPSIS

 use FS::svc_phone;

 $record = new FS::svc_phone \%hash;
 $record = new FS::svc_phone { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

 $error = $record->suspend;

 $error = $record->unsuspend;

 $error = $record->cancel;

DESCRIPTION

An FS::svc_phone object represents a phone number. FS::svc_phone inherits from FS::Record. The following fields are currently supported:

svcnum

primary key

countrycode; phonenum; sip_password; pin

Voicemail PIN

phone_name; pbxsvc

Optional svcnum from svc_pbx

forwarddst

Forwarding destination

email

Email address for virtual fax (fax-to-email) services

lnp_status

LNP Status (can be null, native, portedin, portingin, portin-reject, portingout, portout-reject)

portable; lrn; lnp_desired_due_date; lnp_due_date; lnp_other_provider

If porting the number in or out, name of the losing or winning provider, respectively.

lnp_other_provider_account

Account number of other provider. See lnp_other_provider.

lnp_reject_reason

See lnp_status. If lnp_status is portin-reject or portout-reject, this is an optional reject reason.

METHODS

new HASHREF

Creates a new phone number. To add the number to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

search_sql STRING

Class method which returns an SQL fragment to search for the given string.

label

Returns the phone number.

insert

Adds this phone number to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

suspend

Called by the suspend method of FS::cust_pkg (see FS::cust_pkg).

unsuspend

Called by the unsuspend method of FS::cust_pkg (see FS::cust_pkg).

cancel

Called by the cancel method of FS::cust_pkg (see FS::cust_pkg).

check

Checks all fields to make sure this is a valid phone number. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

_check duplicate

Internal method to check for duplicate phone numers.

check_pin

Checks the supplied PIN against the PIN in the database. Returns true for a sucessful authentication, false if no match.

radius_reply; radius_check; phone_device

Returns any FS::phone_device records associated with this service.

psearch_cdrs OPTIONS

Returns a paged search (FS::PagedSearch) for Call Detail Records associated with this service. By default, "associated with" means that either the "src" or the "charged_party" field of the CDR matches the "phonenum" field of the service. To access the CDRs themselves, call "->fetch" on the resulting object.

Accepts the following options:

for_update => 1: SELECT the CDRs "FOR UPDATE".

status => "" (or "processing-tiered", "done"): Return only CDRs with that processing status.

inbound => 1: Return CDRs for inbound calls. With "status", will filter on inbound processing status.

default_prefix => "XXX": Also accept the phone number of the service prepended with the chosen prefix.

begin, end: Start and end of a date range, as unix timestamp.

cdrtypenum: Only return CDRs with this type number.

disable_src => 1: Only match on "charged_party", not "src".

by_svcnum: not supported for svc_phone

billsec_sum: Instead of returning all of the CDRs, return a single record (as an FS::cdr object) with the sum of the 'billsec' field over the entire result set.

get_cdrs (DEPRECATED)

Like psearch_cdrs, but returns all the FS::cdr objects at once, in a single list. Arguments are the same as for psearch_cdrs. This can take an unreasonably large amount of memory and is best avoided.

BUGS

SEE ALSO

FS::svc_Common, FS::Record, FS::cust_svc, FS::part_svc, FS::cust_pkg, schema.html from the base documentation.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 660:

You can't have =items (as at line 664) unless the first thing after the =over is an =item