Gets the list of inbound faxes owned by authenticated user.
GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/Mine
Name |
Type |
Required |
Description |
Default |
Example |
---|---|---|---|---|---|
page |
int |
optional |
The number of the page which we want to retrieve. It must be greater or equal than 1. |
1 |
3 |
pageSize |
int |
optional |
The size of the page where the results will be stored in. It must be greater or equal than 0. If 0, page will be ignored and will be returned all inbound faxes of the user. |
0 |
10 |
date |
string |
optional |
The time interval of the faxes to be retrieved. It must be specified via RHS colon syntax using one of the following operators: "between", "after", "before". |
null |
between:2018-01-01T00:00:00;2018-12-31T23:59:59 |
The list of incoming faxes is returned.
Response body is a JSON object representing inbound faxes list:
Name | Type | Description |
---|---|---|
FaxList | Fax | The inbound faxes list |
Name |
Type |
Description |
---|---|---|
faxId |
string |
The fax id |
username |
string |
The username of the user the fax belongs to |
recipient |
Recipient |
The fax recipient |
sender |
Sender |
The fax sender |
status |
Status |
The status of the fax. Possible values are:
|
date |
string |
The ISO date when the fax has started to be received |
Name |
Type |
Description |
---|---|---|
name |
string |
The complete name (first and last name) of the sender |
faxNumber |
string |
The sender’s fax number |
Name | Type | Description |
---|---|---|
name | string | The complete name (first and last name) of the recipient |
faxNumber | string | The recipient's fax number |
GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/Mine