Skip to content

Fetch the status report for a single job

Request

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).

Security
httpBasicAuth
Path
custNrstringrequired

Customer Number

jobIdstringrequired
curl -i -X GET \
  -u '<username>:<password>' \
  'https://developers.retarus.com/_mock/fax/fax4a-api/{custNr}/fax/reports/{jobId}'

Responses

Fax job status retrieved

Bodyapplication/json
jobIdstringrequired

The Job ID.

Example:"FJJ66GHGX105ZZBIELVCN1"
recipientStatusArray of objects(Fax Recipient With Status)required
Example:
[
  {
    "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"
  }
]
pagesintegerrequired

Number of pages in the fax.

Example:1
referenceobject(Reference)
Example:
{
  "customerDefinedId": "2017-08-10T13:05:09Z_customerDefinedId",
  "billingCode": "2017-08-10T13:05:09Z_billingCode",
  "billingInfo": "2017-08-10T13:05:09Z_billingInfo"
}
Response
{
  "jobId": "FJJ66GHGX105ZZBIELVCN1",
  "recipientStatus": [
    { … }
  ],
  "pages": 1,
  "reference": {
    "customerDefinedId": "2017-08-10T13:05:09Z_customerDefinedId",
    "billingCode": "2017-08-10T13:05:09Z_billingCode",
    "billingInfo": "2017-08-10T13:05:09Z_billingInfo"
  }
}