Method: Telapi::Fax.list

Defined in:
lib/telapi/fax.rb

.list(optional_params = {}) ⇒ Object

Returns a resource collection containing Telapi::Fax objects See www.telapi.com/docs/api/rest/faxes/list/

Optional params is a hash containing:

To

mobile phone number

From

TelAPI or mobile phone number

StartTime

date in the following format: YYYY-MM-DD

Status

sending, queued, receiving, comm-error, call-dropped

Page

integer greater than 0

PageSize

integer greater than 0



16
17
18
19
 
# File 'lib/telapi/fax.rb', line 16

def list(optional_params = {})
  response = Network.get(['Faxes'], optional_params)
  ResourceCollection.new(response, 'faxes', self)
end