{
  "opencollection": "1.0.0",
  "info": {
    "name": "Telnyx Access Tokens Programmable Fax Commands API",
    "version": "2.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Programmable Fax Commands",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "View a list of faxes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/faxes",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Consolidated filter parameter (deepObject style). Originally: filter[created_at][gte], filter[created_at][gt], filter[created_at][lte], filter[created_at][lt], filter[direction][eq], filter[from][eq], filter[to][eq]"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Consolidated pagination parameter (deepObject style). Originally: page[size], page[number]"
              }
            ]
          },
          "docs": "View a list of faxes"
        },
        {
          "info": {
            "name": "Send a fax",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/faxes",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with `file_size_limit_exceeded` and `page_count_limit_exceeded` respectively. \n\n**Expected Webhooks:**\n\n- `fax.queued`\n- `fax.media.processed`\n- `fax.sending.started`\n- `fax.delivered`\n- `fax.failed`\n"
        },
        {
          "info": {
            "name": "View a fax",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telnyx.com/v2/faxes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a fax."
              }
            ]
          },
          "docs": "View a fax"
        },
        {
          "info": {
            "name": "Delete a fax",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telnyx.com/v2/faxes/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a fax."
              }
            ]
          },
          "docs": "Delete a fax"
        },
        {
          "info": {
            "name": "Cancel a fax",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/faxes/:id/actions/cancel",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a fax."
              }
            ]
          },
          "docs": "Cancel the outbound fax that is in one of the following states: `queued`, `media.processed`, `originated` or `sending` "
        },
        {
          "info": {
            "name": "Refresh a fax",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telnyx.com/v2/faxes/:id/actions/refresh",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The unique identifier of a fax."
              }
            ]
          },
          "docs": "Refreshes the inbound fax's media_url when it has expired"
        }
      ]
    }
  ],
  "bundled": true
}