Fax

List Fax for extension

Get a list of Fax for extension.

get/v4/accounts/{voip_id}/extensions/{extension_id}/fax

Request

  • Base URL: https://api.phone.com
  • URL: https://api.phone.com/v4/accounts/{voip_id}/extensions/{extension_id}/fax
  • Auth: HTTP bearer

Path parameters

voip_idinteger required
extension_idinteger required

Query parameters

offsetinteger

The number of items to skip before starting to collect the result set

limitinteger

The number of items to return

sort[id]'asc' | 'desc'

Sort response

filters[is_new]string

List only un-read Fax

filters[from]string

Caller ID filter, the E.164 phone number from which Fax was sent. Note: you must encode the + as %2B

filters[to]string

Callee ID filter, the E.164 phone number to which Fax was sent. Note you must encode the + as %2B

filters[created_at]string

Date string representing the UTC time that sms was created. Expected value is UNIX timestamp with operator like "gt" (greater than), "gte" (greater than or equals), "lt" (lesser than), "lte" (lesser than or equals). Example: "gt:1597778180".

filters[extension]string

Extension id where Fax is stored

filters[deleted]string

Deleted filter: only=Gives only the not deleted messages; with=Gives the messages no matter if they are deleted; ignore=Gives only the soft deleted messages;

mode'brief' | 'full'

Defines mode of the data output (brief or full)

Response

OK

filtersobject
sortobject
totalinteger
limitinteger
offsetinteger
itemsobject[]

Changes

No operation changes recorded.