Get fax info

Method

GET

Path

faxes/ID

where ID is the ID number of the fax

Request Parameters

None

Response

A JSON object with success, message, and data attributes. The data attribute holds a Fax Object.

Sample Call

curl -u 'API_KEY:API_SECRET' https://api.phaxio.com/v2.1/faxes/123456

Sample Response

{
    "success":true,
    "message":"Metadata for fax",
    "data":{
        "id":123456,
        "barcodes": [],
        "caller_name": null,
        "direction":"sent",
        "num_pages":3,
        "status":"success",
        "is_test":true,
        "created_at":"2015-09-02T11:28:02.000-05:00",
        "caller_id":null,
        "from_number":null,
        "completed_at":"2015-09-02T11:28:54.000-05:00",
        "cost":21,
        "tags":{
            "order_id":"1234"
        },
        "recipients":[
            {
                "phone_number":"+14141234567",
                "status":"success",
                "retry_count":0,
                "completed_at":"2015-09-02T11:28:54.000-05:00",
                "bitrate":14400,
                "resolution":8040,
                "error_type":null,
                "error_id":null,
                "error_message":null
            }
        ],
        "to_number":null,
        "error_id":null,
        "error_type":null,
        "error_message":null
    }
}