/devices (unread)

Returns the number of unread faxes waiting for the associated device. Since the default device is selected as part of the authentication request, the {id} parameter is not required. This function behaves similarly to the inbox controller, except an additional action value is provided in the response.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Note: Devices return an extra element called Action and indicates which DeviceActions should be performed.

Example: Get unread fax count with wait timeout

The following example queries the number of unread faxes available. If no unread faxes are available at the time this function is called, it will wait up to 120 seconds for a new fax to arrive. If a new fax arrives during the wait/timeout period, this function will return immediately allowing the application to retrieve the new fax the instant it arrives within the etherFAX network.

[GET] https://na.connect.etherfax.net/rest/3.0/api/devices?a=unread&wait=120
Query Params
string
Defaults to unread

Action to perform.

int32

Specifies the timeout in seconds to wait for a new fax to arrive. This wait method is only valid when using the unread action. When waiting, the function will return immediately if unread faxes are available for download or a new fax has arrived during the wait period.

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json