List faxes in date range

Operation

faxList

Parameters

Name	Type	Description
`start`	Unix Timestamp	The beginning of the range. Defaults to one week ago.
`end`	Unix Timestamp	The end of the range. Defaults to now.
status	string	Limits results to faxes with the specified status.
`tag[TAG_NAME]`	string	A tag name and value that you want to use to filter results. (e.g. You could pass a parameter called `tag`</code> with value `123` to retrieve faxes for a user in your application that has ID 123.)
`number`	Phone Number	A phone number in E.164 format that you want to use to filter results. The phone number must be an exact match, not a number fragment.
api_key	string	Your api key
api_secret	string	Your api secret

This operation also accepts paging parameters.

Response

A JSON object with success, message, paging, and data attributes.

The paging attribute holds information about the length of the data for your query.

The data attribute holds an array of Fax Objects in ascending order of request time.

By default, up to 50 records will be returned per call. This can be changed by providing paging parameters.

Sample Call

curl https://api.phaxio.com/v1/faxList \
    -F 'start=1293861600' \
    -F 'end=1294034400' \
    -F 'api_key=API_KEY' \
    -F 'api_secret=API_SECRET'

Sample Response

{
    "success":true,
    "message":"Retrieved faxes successfully",
    "paging":{
        "max_per_page":1000,
        "page":1,
        "total_pages":1,
        "total_results":3
    },
    "data":[{
            "id":123456,
            "num_pages":3,
            "cost":21,
            "direction":"sent",
            "status":"success",
            "is_test":true,
            "requested_at":1293910680,
            "completed_at":1293911100,
            "recipients":[{
                    "number":"4141234567",
                    "status":"success",
                    "bitrate":"14400",
                    "resolution":"8040",
                    "completed_at":1293911100
            }]
        },
        {
            "id":123457,
            "num_pages":1,
            "cost":7,
            "direction":"sent",
            "status":"success",
            "is_test":false,
            "requested_at":1293984720,
            "completed_at":1293985800,
            "recipients":[{
                    "number":"4145554567",
                    "status":"success",
                    "bitrate":"14400",
                    "resolution":"8040",
                    "completed_at":1293985800
            }]
        },
        {
            "id":123458,
            "num_pages":1,
            "cost":14,
            "direction":"sent",
            "status":"success",
            "is_test":false,
            "requested_at":1294094700,
            "completed_at":1294095000,
            "recipients":[{
                    "number":"4145554568",
                    "status":"success",
                    "bitrate":"9600",
                    "resolution":"8040",
                    "completed_at":1294095000
            },
            {
                    "number":"4145554567",
                    "status":"success",
                    "bitrate":"14400",
                    "resolution":"8040",
                    "completed_at":1293985800
            }]
        }
    ]
}