Skip to content

Fax Machines

List all fax machines

This method allows you to retrieve a list of all fax machines in your unit.

URL

/api/v2/fax_machines/list

Supported Paramaters

There are no supported parameters for this method.

Example JSON

{
    "status":"success",
    "time":0.0,
    "flags":{},
    "data":
    [
        {
            "id":106,
            "name":"Alex",
            "created_at":"2015-10-07T14:27:54.000Z",
            "updated_at":"2015-10-07T14:27:54.000Z",
            "email_address":"[email protected]"
        }
    ]
}

Get fax machine properties

This method allows you to retrieve information about a specific fax machine in your unit.

URL

/api/v2/fax_machines/info

Supported Parameters

  • id - the ID of the fax machine you wish to view (required)

Example JSON

{
    "status":"success",
    "time":0.01,
    "flags":{},
    "data":
        {
            "id":106,
            "name":"Alex",
            "created_at":"2015-10-07T14:27:54.000Z",
            "updated_at":"2015-10-07T14:27:54.000Z",
            "email_address":"[email protected]"
        }
}