Fetch the status report for a single job (getStatusReport)

NONE

GET /{custNr}/fax/reports/{jobId}

Description

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 be automatically be deleted upon the expiration of the configurable time frame (by default 6 months).

If you have sent the fax job requests via a high availability URL, you must send a status query request to both data centers in the processing domain, e.g. US1 and US2 in case of the USA processing domain. Please do not send a status query or delete request directly to an HA URL, but use the URLs for the specific data centers.

Parameters

Type	Name	Description	Schema
Path	custNr required	Customer Number	string
Path	jobId required		string

Responses

HTTP code	Description	Schema
200	Status report available and delivered	FaxReport
400	BAD_REQUEST: Client authorization is missing	No Content
401	AUTHENTICATION_FAILURE: Bad or missing authentication	No Content
404	NOT_FOUND: No job report available for the given jobId; no recipient report available for the given jobId	No Content
500	INTERNAL_SERVER_ERROR: Cannot accept job, cannot query jobReport, cannot list jobs, cannot query recipient report, cannot apply transliteration in the send job	No Content
503	SERVICE_UNAVAILABLE: The server cannot handle the request due to a temporary overloading or maintenance of the server.	No Content
520	UNKNOWN_ERROR: Server signals that there was an unknown problem, most likely with the backend adaptor	No Content

Example HTTP response

Response 200

JSON

{
   "jobId":"FJJ66GHGX105ZZBIELVCN1",
   "recipientStatus":[
      {
         "number":"+49 89 1234567-8900",
         "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"
   }
}