Skip to content

Retrieve fax jobs from a topic and confirm the receipt.

Request

This endpoint is used for two types of processes:

On the one hand, you can retrieve a list of unlocked and non-acknowledged fax jobs from a topic owned by the authenticated user. The amount of fetched faxes is limited by the fetch parameter. On the other hand, you should acknowledge faxes that you successfully received by specifying an URL-encoded list of fax job ids.

You retrieve the list of available faxes for a topic via a POST request to the corresponding URL. The response consists of two parts: meta and results.

The meta part contains information about the request and two URLs that the client should call after retreiving the jobs, the next URL or the exit URL. Retrieving the faxes themselves is described in the GET operation below.

The next URL is used to retrieve an additional batch of available faxes. The request also confirms that the previous jobs were successfully retrieved by the client through the ids parameter.

The exit URL is just another call to the same URL with the fetch parameter set to 0. It is used to confirm the reception of the previous jobs without retreiving information about new ones, for example in case a shutdown of the client is requested.

The response to the next and exit URLs has the identical structure and function as the ones described here.

The results part contains information about the available fax jobs. This includes both the metadata for the fax and the transmission and the URLs from which the client can retrieve the fax images.

Security
httpBasicAuth
Path
topicstringrequired

Topic to be polled

Query
fetchinteger

Number of fax jobs requested by the customer to be fetched from the topic

idsstring

List of fax job ids to be acknowledged in this request. It must be comma-separated and presented in URL encoding, e.g. 365%2C366%2C367%2C368.

timeoutinteger

Lock timeout in seconds for a fax (by default 60). Once the metadata for a fax has been provided to a client, it will be marked as "locked" and not be returned again in subsequent requests. If the timeout expires without the client having acknowledged the correct receipt, the server will assume that a problem has occurred and it will make the fax available again in the next response.

Default:60
curl -i -X POST \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax2ws-pull-api/topics/{topic}?fetch=10&ids=365%252C366%252C367%252C368&timeout=60'

Responses

OK

Bodyapplication/json
metaobject(meta)required
resultsArray of objects(results)required
Response
{
  "meta": {
    "version": 1,
    "next": "https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=10&timeout=60&ids=29%2C30",
    "exit": "https://api.us1.retarus.com/faxin/rest/v1/topics/abc123?fetch=0&timeout=60&ids=29%2C30",
    "topic": "abc123",
    "resultSize": 2,
    "parameters": { … }
  },
  "results": [
    { … },
    { … }
  ]
}