📞
API Docs
  • Welcome
  • NUMBERS / ORDERING
    • List Areas
    • List Numbers
    • Order Numbers - No Cart
    • Delete Numbers
    • Vanity Tollfree - Search
    • Vanity Toll Free - Order
  • Shopping Cart Ordering
    • Add Number to Cart
    • List Numbers in Cart
    • Delete Number from Cart
    • Complete Order Cart
  • MY INVENTORY
    • List My Nmbers
    • List Call Flows
    • Change CallFlow
    • CDR Records
  • SMS/MMS
    • Send SMS
    • Send MMS
    • Receive SMS/MMS
    • Receive Delivery Receipts
  • Campaigns
    • Submit TollFree Campaign
  • CALL APIS
    • Calls
    • Set Incoming URL
    • Incoming Calls
    • Listing Calls
    • Making Calls
      • Example Code
        • Outbound to Tel#
        • Outbound to SIP Device
        • Example Responses
    • Modifying Live Calls
      • Examples
    • Recordings
      • Get List of Recordings
      • Delete a Recording
  • CALL API MARKUP
    • API Call Markup Language
      • Say
      • Dial
        • Number
        • Client
        • SIP
      • Play
      • Gather
      • Record
      • Hangup
      • Pause
      • Reject
      • Redirect
  • LOOKUPS
    • Carrier and CNAM
  • Number Portability
    • Validate Portability
    • Lookup Port Request
    • Submit Port Request
  • FAXING
    • Create Outbound Fax
    • Lookup Outbound Fax Status
    • List Faxes
    • Download File
Powered by GitBook
On this page
  1. FAXING

List Faxes

List all outbound faxes

GET or POST Request

https://v1.api19.com/fax/list

Send us a GET or POST request with your key and fax id.

This will list all outbound faxes with status and other information

Argument

Required

Type

key

yes

api key

limit

no

int - how many replies

offset

no

int - for pagination

did

no

show only faxes for this number

date_from

no

2024-05-03 00:00:00

date_to

no

2024-05-06 00:00:00

direction

no

inbound or outbound (default both)

source

no

source number

destination

no

destination number

curl -X POST https://v1.api19.com/fax/list\
 -d "limit=1000" \
 -d 'key=your-key'
{
  "status": "ok",
  "data": [
    {
      "fax_id": 1234812123
      "source": "7209274255",
      "destination": "7207746293",
      "direction": "outbound",
      "send_status": "success",
      "long_status": "Success",
      "seconds": "201",
      "pages": "2"
      "send_time": "2024-05-10 04:22:24",
      "complete_time": "2024-05-10 04:22:57"
    },
    {
      "fax_id": 1234812124
      "source": "7209274255",
      "destination": "7207746293",
      "direction": "outbound",
      "send_status": "success",
      "long_status": "Success",
      "seconds": "222",
      "pages": "1"
      "send_time": "2024-05-10 04:22:24",
      "complete_time": "2024-05-10 04:22:57"
    }
  ]
}

OR

{
  "status": "error",
  "error": "invalid information"
}

OR

{
  "status": "ok",
  "data": []
}
PreviousLookup Outbound Fax StatusNextDownload File

Last updated 28 days ago