Get status for a specific faxId

Operation

faxStatus

Parameters

Name Type Description
id integer The fax id of the fax you wish to retrieve
api_key string Your api key
api_secret string Your api secret

Response

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

Sample Call

curl https://api.phaxio.com/v1/faxStatus \
    -F 'id=123456' \
    -F 'api_key=API_KEY' \
    -F 'api_secret=API_SECRET'

Sample Response

{
    "success":true,
    "message":"Retrieved fax successfully",
    "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
            }
        ]
    }
}