Get Inbound Faxes List

Article ID: 802

Last updated: 17 Dec, 2020

Gets the list of inbound faxes owned by authenticated user.

Resource URL

GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/Mine

Resource Information

Response Content-Type: application/json
Requires authentication: Yes

URL Parameters

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

Response

200 OK

The list of incoming faxes is returned.

Response body

Response body is a JSON object representing inbound faxes list:

Name	Type	Description
FaxList	Fax	The inbound faxes list

Fax

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: Completed Failed Queued InProgress Canceled
date	string	The ISO date when the fax has started to be received

Sender

Name	Type	Description
name	string	The complete name (first and last name) of the sender
faxNumber	string	The sender’s fax number

Recipient

Name	Type	Description
name	string	The complete name (first and last name) of the recipient
faxNumber	string	The recipient's fax number

Error response

400 Forbidden

The filters are not valid

401 Unauthorized

No authentication provided
Wrong credentials

403 Forbidden

Insufficient privilege level

Examples

GET fw/Apps/StoneFax/WebAPI/Faxes/Inbound/Mine


{
    "faxList": [
        {
            "__type": "LessInfoInboundFax:StoneFax.Faxes",
            "date": "2020-12-02T16:33:31.0000000",
            "faxId": "IAS-N1_401d6c8c07d6b7a_0",
            "recipient": {
                "faxNumber": "200",
                "name": "user2"
            },
            "status": "Completed",
            "username": "user2",
            "sender": {
                "faxNumber": "100",
                "name": null
            }
        }
    ]
}

Article ID: 802

Last updated: 17 Dec, 2020

Revision: 6

Print Export to PDF Subscribe Share

This article was:

Prev		Next
Get Outbound Faxes List		Get Inbound Fax Details