REretarus
Fax reports

Fetch available status reports for this account

This URL returns a list of available status reports for completed fax jobs for the current account.

Status reports are available for up to 30 days or until deleted.

IMPORTANT: The results are limited to the oldest 1000 entries. It is recommended to delete the status reports after fetching them in order to retrieve the following ones.

Please note: This endpoint should only be used with a data center specific URL. This endpoint would return "inconsistent" results depending on the data center the request is processed by.

get/{custNr}/fax/reports

Request

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

Path parameters

custNrstring required

Customer Number

Response

Status reports delivered

Example response

{
  "reports": [
    {
      "jobId": "FJJ5Y09UM505ZZBIELCRYC",
      "recipientStatus": [
        {
          "number": "+498912345678900",
          "properties": null,
          "status": "OK",
          "reason": "OK",
          "sentTs": "2017-08-04T15:09:10Z",
          "durationInSecs": 19,
          "sentToNumber": "00498912345678900",
          "remoteCsid": "+49/89/1234567-8900"
        }
      ],
      "pages": 1,
      "reference": {
        "customerDefinedId": "2017-08-04T15:09:10Z_customerDefinedId",
        "billingCode": "2017-08-04T15:09:10Z_billingCode",
        "billingInfo": "2017-08-04T15:09:10Z_billingInfo"
      }
    },
    {
      "jobId": "FJJ5WA23UO05ZZBIEL0JY5",
      "recipientStatus": [
        {
          "number": "+498912345678901",
          "properties": null,
          "status": "OK",
          "reason": "OK",
          "sentTs": "2017-08-03T10:07:31Z",
          "durationInSecs": 21,
          "sentToNumber": "00498912345678901",
          "remoteCsid": "Retarus Faxolution"
        }
      ],
      "pages": 2,
      "reference": {
        "customerDefinedId": "2017-08-03T10:07:31Z_customerDefinedId",
        "billingCode": "2017-08-03T10:07:31Z_billingCode",
        "billingInfo": "2017-08-03T10:07:31Z_billingInfo"
      }
    }
  ]
}

Changes

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