Description
The GetDocChunk method enables the retrieval of an inbound fax (image) by providing the requested file type and page number.
Note: This method only works for users with active RX service.
Formal definition
https://ws.interfax.net/inbound.asmx?op=GetDocChunk
Input
| Name |
Type |
Comments |
| Username |
String |
The name of the user authenticating to the API |
| Password |
String |
The password for the Username |
| MessageID |
Integer |
Message ID of the transaction to download |
| Pages |
String |
A page number or a page range, for example: “1-6”. When left empty (“”), the method returns all pages. |
| Format |
String |
The file format: PDF or TIF or PNG |
| ChunkSize |
Long |
Buffer size to download. Maximum download size is defined in System Limitations |
| Offset |
Long |
Offset (zero-based) in bytes to start reading the buffer from |
Output
|
Name |
Type |
Comments |
| GetDocChunkResult |
|
|
|
buffer |
Byte array |
Byte array of the image part that was requested |
|
ResultCode |
Integer |
Returns 0 for success, otherwise an error code indicating what went wrong; see the Error Codes, below. All errors are listed in Appendix A |
|
RequestTotalSize |
Long |
Message size in bytes |
Error Codes
| Value |
Description |
| -150 |
Internal System Error. An exception occurred at any point in the execution of the web service method. |
| -732 |
The Format does not contain TIF, PDF or PNG |
| -1003 |
Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user. |
| -3001 |
Invalid MessageID |
| -3003 |
Image doesn’t exist |
| -3005 |
Requested chunk size is invalid (less than 1 or greater than the maximum value defined under “System Limitations“) |
| -3016 |
The account has been suspended |