Get fax status
GET {{baseUrl}}/mra/v1/outbound/faxes/status/?job_id=xsi-1234567
Once a fax request has been successfully accepted and a job ID is returned, this method allows users to request the information about the job as it is being processed by the OpenText messaging service.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
job_id | string | (Required) A string consists of xdn-mrn.Where xdn is domain name and mrn is job number. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-MRA-SubmitId | string | A cleint-supplied string to identify request. | |
Accept | string |
RESPONSES
status: OK
{"job_id":"xsi-1234567","job_state":["Complete","Posted"],"billing_code_base64":"dGVtcF9iaWxsX2NvZGU=","customer_reference_base64":"bXJhX2N1c3RfcmVm","entry_time":"2020-04-21T10:50:51.000Z","deliveries":[{"ref_base64":"RkFYT1VU","fax":"1234567891","delivery_attempts":[{"state":"InProcess","gamma_code":5000,"first_attempt":"2020-04-21T10:51:00.000Z","delivery_time":"2020-04-21T10:56:29.000Z","delivery_sec":28,"pages_delivered":3,"baud_rate":9600,"rcsid":"123-123-1234"},{"state":"Sent","gamma_code":5000,"first_attempt":"2020-04-21T10:51:00.000Z","delivery_time":"2020-04-21T10:56:29.000Z","delivery_sec":28,"pages_delivered":3,"baud_rate":9600,"rcsid":"123-123-1234"}]},{"ref_base64":"RkFYT1VU","fax":"1234567891","delivery_attempts":[{"state":"Error","gamma_code":5000,"first_attempt":"2020-04-21T10:51:00.000Z","delivery_time":"2020-04-21T10:56:29.000Z","delivery_sec":28,"pages_delivered":3,"baud_rate":9600,"rcsid":"123-123-1234"},{"state":"Pending","gamma_code":5000,"first_attempt":"2020-04-21T10:51:00.000Z","delivery_time":"2020-04-21T10:56:29.000Z","delivery_sec":28,"pages_delivered":3,"baud_rate":9600,"rcsid":"123-123-1234"}]}]}