This defines the incoming faxes for specific recipient API:
A Fax API request looks like:
https://fax.to/api/v2/incoming-faxes/{recipient}?api_key=xxxxx
This request contains:
The following table shows the parameters you use in the request:
Parameter | Description | Required |
---|---|---|
limit | The number of record to return. For example, limit=10 . |
No. |
page | The page you want to get. Basically its pagination. For example, page=1 . |
No. |
recipient | The recipient fax number. | Yes. |
The following table shows the information for authentication:
Parameter | Description | Required |
---|---|---|
api_key | Your Key. For example, api_key=f@x2r0ckkz . |
Yes. |
You find your Key in Dashboard.
To ensure privacy, you must use HTTPS for all Faxto API requests.
You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values.
We support JSON ONLY responses
{
"status": "success",
"inbox": [
{
"id": 775,
"did_id": 7745147,
"filename": "597ef3a78a2dd.pdf",
"filesize": "120.45 KB",
"number": "+918111922344",
"sender": "919245657633",
"total_pages": 5,
"created_at": {
"date": "2017-08-01 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"preview_file": "https://fax.to/receivefax/api/v1/inbox/4/preview?api_key=abd1ebe0-62d5-11e7-91c7-8590f436fefa",
"file_url": "https://fax.to/receivefax/api/v1/inbox/4/file?api_key=abd1ebe0-62d5-11e7-91c7-8590f436fefa"
},
{
"id": 776,
"did_id": 7745147,
"filename": "597ef3a78a2dd.pdf",
"filesize": "120.45 KB",
"number": "+918111922344",
"sender": "919245657633",
"total_pages": 5,
"created_at": {
"date": "2017-08-01 00:00:00.000000",
"timezone_type": 3,
"timezone": "UTC"
},
"preview_file": "https://fax.to/receivefax/api/v1/inbox/4/preview?api_key=abd1ebe0-62d5-11e7-91c7-8590f436fefa",
"file_url": "https://fax.to/receivefax/api/v1/inbox/4/file?api_key=abd1ebe0-62d5-11e7-91c7-8590f436fefa"
}
],
"meta": {
"pagination": {
"total": 7,
"count": 2,
"per_page": 2,
"current_page": 2,
"total_pages": 4,
"links": {
"previous": "https://fax.to/api/v2/incoming-faxes/918111922311?page=1",
"next": "https://fax.to/api/v2/incoming-faxes/918111922311?page=3"
}
}
}
}
Key | Value | Response Type |
---|---|---|
data | Array containing numbers | JSON |
meta | Meta containing paginations links | JSON |
HTTP Status Code | Reason |
---|---|
200 | Successful response |
401 | Unauthorized. |
403 | Rate limit exceeded |
404 | Resource not Found |
500 | Internal server error |