Fetch available status reports for this account (getAllStatusReports)
GET /{custNr}/fax/reports
Description
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.
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.
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.
Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path | custNr | Customer Number | string |
Responses
HTTP code | Description | Schema |
---|---|---|
200 | Status reports delivered | |
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 |
ExampleHTTP response
Response 200
{
"reports":[
{
"jobId":"FJJ5Y09UM505ZZBIELCRYC",
"recipientStatus":[
{
"number":"+498912345678900",
"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",
"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"
}
}
]
}