REretarus
Fax reports

Fetch the status report for a single job

With the assistance of this URL resource, a status report for a fax job can be requested by jobId.

A job's status can be queried until its report data is deleted. You can initiate deletion of the data by calling deleteStatusReport, and in any case the data will automatically be deleted upon the expiration of the configurable time frame (by default 30 days).

get/{custNr}/fax/reports/{jobId}

Request

  • Base URL
    https://faxws.de1.retarus.com/rest/v1
  • Auth
    HTTP basic

Path parameters

custNrstring required

Customer Number

jobIdstring required

Response

Fax job status retrieved

jobIdstring required

The Job ID.

pagesinteger required

Number of pages in the fax.

Example response

{
  "jobId": "FJJ66GHGX105ZZBIELVCN1",
  "recipientStatus": [
    {
      "number": "+49 89 1234567-8900",
      "properties": null,
      "status": "OK",
      "reason": "OK",
      "sentTs": "2017-08-10T13:05:09Z",
      "durationInSecs": 19,
      "sentToNumber": "00498912345678900",
      "remoteCsid": "+49/89/1234567-8900"
    }
  ],
  "pages": 1,
  "reference": {
    "customerDefinedId": "2017-08-10T13:05:09Z_customerDefinedId",
    "billingCode": "2017-08-10T13:05:09Z_billingCode",
    "billingInfo": "2017-08-10T13:05:09Z_billingInfo"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.