hoiio.service.fax

class hoiio.service.fax.Fax

Provide Fax services such as sending and querying for Fax.

Usage: Hoiio.fax.send(...), Hoiio.fax.history(...), etc.

history(**kwargs)

Retrieve the history of Fax. There is pagination, and each page returns up to 100 entries.

Parameters:
  • from (string) – Fax sent/received after this date. In “YYYY-MM-DD HH:MM:SS” (GMT+8) format.
  • to (string) – Fax sent/received before this date. In “YYYY-MM-DD HH:MM:SS” (GMT+8) format.
  • page (int) – The page number. Count starts from 1.
  • type (incoming, outgoing or all) – The type of fax. Default to all.
Returns:

Return hoiio.service.Response
rate(dest, **kwargs)

Retrieve the cost of sending a fax

Parameters:dest – The fax number to send to
Returns:Return hoiio.service.Response
rate_in(dest, **kwargs)

Retrieve the cost of receiving a fax

Parameters:dest – The fax number to receiving at
Returns:Return hoiio.service.Response
send(dest, filename, **kwargs)

Send a fax to a fax number

Parameters:
  • dest – The fax number to send fax to
  • file – The path to the pdf file to fax
  • caller_id – The caller ID when connected to the fax number
  • filename – The filename to store on Hoiio. If omitted, the filename of the file will be used.
  • tag – Your own reference tag for this transaction
  • notify_url – A notification URL for Hoiio to call to your web server
Returns:

Return hoiio.service.Response
status(txn_ref, **kwargs)

Retrieve the status and various information about a fax

Parameters:txn_ref – The transaction reference for the fax
Returns:Return hoiio.service.Response