Retrieve a fax document
GET {{baseUrl}}/mra/v1/inbound/documents/next?hold_sec=occaecat ip&group_no=consequat dolore sint voluptate&customer=false&domain=XDDS
Inbound faxes can be retrieved from OpenText messaging service using this method. This method returns success (with error code 200) when there is a document available for retrieval. Also returns success (with error code 204) when there is no document available for retrieval.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
hold_sec | string | The number of seconds a retrieved document should be held waiting for a "delete" operation before it is returned to the queue for retrieval. Currently, values between 5 and 3600 can be used, and the default value is 900. | |
group_no | string | Optional Fax2Mail Group entity number. Fax2Mail administrators may request documents from jobs belonging to any user in the specified group. | |
| Note that only jobs for users who are actually members of the named group will be looked for. Jobs for users of sub-groups of the named group will not be found. | |||
| Also note that only Fax2Mail jobs will be retrieved using this method - if Fax2Mail users create non-Fax2Mail jobs (which is not usual), such jobs will not be associated with the group for the purposes of this function. | |||
customer | boolean | Just as the GroupNo option allows group-wide retrieval of documents, this option allows customer-wide retrieval. If this is included and set to "True (or) Yes" (case insensitive values), then documents from jobs for any user under the requester's customer account will be looked for. The requester must have the permission setting that permits accessing customer-wide job data. | |
| Use of this feature can significantly reduce the number of polling requests necessary for certain applications. | |||
domain | string | Optional string specifying a particular domain to look for waiting documents. By default, retrieving a fax document will randomly poll all domains the user might have jobs in, returning once a document is found or the list of domains is exhausted. It may improve performance and reliability to limit the scope of that search by specifying a particular domain name, or the generic "XDDS" or "MR" names (which will limit the search to switches of the appropriate type.) Fax2Mail traffic, for instance, will only appear in "XDDS" switches, so if that is the only type of delivery expected, there is no point in polling the MR domains. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MRA-SubmitId | string | A client-supplied string to identify request. | |
Accept | string |
RESPONSES
status: OK
{"document_class":"Inbound Fax","job_id":"xsi-1234567","doc_id":"ZGV99996666","user_id":"dev/abcd","customer_reference_base64":"Nzg5NjY=","billing_code_base64":"Nzg5NjY=","previous_retrieval":"12ab1234-1234-2021232425266","transaction_info":{"fax_mode":"FINE","tsid":"TSID","ani":"ANI","dnis":"DNIS","call_date":"2020-03-17T11:27:34.000Z","connect_time":45,"baud_rate":9600,"page_count":2,"internal_fax_id":"qasiplgc1-0120000000000001-12345678","partial_fax":true},"document":{"data":"QSB0ZXh0IGRvYyBmb3IgZGVsaXZlcnkgdmlhIHFkb2M=","type":"TIFF","name_base64":"dGVzdF9maWxlLmRvYw=="}}