etherFAX Outbox API

openapi: 3.2.0
info:
  title: etherfax-rest-api-30 Outbox API
  version: '3.0'
servers:
- url: https://na.connect.etherfax.net/rest/3.0/api
security:
- sec0: []
tags:
- name: Outbox
paths:
  /outbox:
    post:
      summary: /outbox
      description: This resource is used to send faxes through the etherFAX network to a destination fax number (or etherFAX endpoint).
      operationId: outbox
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                DialNumber:
                  type: string
                  description: Specifies the number to be dialed. This may be a long distance human readable number or E.164 (+18005551234) format.
                LocalId:
                  type: string
                  description: (Optional) Sets the fax id (CSID) for the send request. This is the fax CSID displayed by the remote fax system. This field supports up to 21 characters.
                CallerId:
                  type: string
                  description: (Optional) Sets the caller id for this send request. Where possible, this number will appear as the calling party/id to the remote system. For maximum effectiveness within carrier networks, a "toll" DID is highly recommended.
                TotalPages:
                  type: integer
                  description: Specifies the total number of pages in the fax image file.
                  format: int32
                TimeZoneOffset:
                  type: string
                  description: Specifies the time zone offset of the originator. This value is used to maintain the local time of the originator in the fax header (i.e. -5 for Eastern Standard Time).
                Tag:
                  type: string
                  description: "Tag\t(Optional) Sets a user defined string associated with the fax request. This string will appear in [FaxStatus](ref:faxstatus) responses making it easier for applications to track their fax messages. This field supports up to 64 characters."
                FaxImage:
                  type: string
                  description: Contains the base64 encoded string representing the binary image data (tiff, pdf or other supported document format).
                HeaderString:
                  type: string
                  description: Specifies the header format string displayed at the top of each page of this fax job. Keywords and examples are shown below.
                TZ:
                  type: string
                  description: Specifies the time zone offset of the originator and functions similar to TimeZoneOffset. However, this parameter also supports Linux style time zones such as "America/Chicago", "America/New_York", etc. Using this parameter overrides the TimeZoneOffset value (if specified) and automatically adjusts for daylight savings for the time zone.
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                DialNumber:
                  type: string
                  description: Specifies the number to be dialed. This may be a long distance human readable number or E.164 (+18005551234) format.
                LocalId:
                  type: string
                  description: (Optional) Sets the fax id (CSID) for the send request. This is the fax CSID displayed by the remote fax system. This field supports up to 21 characters.
                CallerId:
                  type: string
                  description: (Optional) Sets the caller id for this send request. Where possible, this number will appear as the calling party/id to the remote system. For maximum effectiveness within carrier networks, a "toll" DID is highly recommended.
                TotalPages:
                  type: integer
                  description: Specifies the total number of pages in the fax image file.
                  format: int32
                TimeZoneOffset:
                  type: string
                  description: Specifies the time zone offset of the originator. This value is used to maintain the local time of the originator in the fax header (i.e. -5 for Eastern Standard Time).
                Tag:
                  type: string
                  description: "Tag\t(Optional) Sets a user defined string associated with the fax request. This string will appear in [FaxStatus](ref:faxstatus) responses making it easier for applications to track their fax messages. This field supports up to 64 characters."
                FaxImage:
                  type: string
                  description: Contains the base64 encoded string representing the binary image data (tiff, pdf or other supported document format).
                HeaderString:
                  type: string
                  description: Specifies the header format string displayed at the top of each page of this fax job. Keywords and examples are shown below.
                TZ:
                  type: string
                  description: Specifies the time zone offset of the originator and functions similar to TimeZoneOffset. However, this parameter also supports Linux style time zones such as "America/Chicago", "America/New_York", etc. Using this parameter overrides the TimeZoneOffset value (if specified) and automatically adjusts for daylight savings for the time zone.
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"JobId\": \"aa52f281-44dd-45bf-a586-d12d127dd733\",\n  \"FaxResult\": 2,\n  \"State\": 0,\n  \"PagesDelivered\": 0,\n  \"ConnectTime\": 0,\n  \"ConnectSpeed\": 0,\n  \"RemoteId\": null,\n  \"Tag\": null,\n  \"CompletedOn\": null,\n  \"DeliveredOn\": null\n}"
              schema:
                type: object
                properties:
                  JobId:
                    type: string
                    example: aa52f281-44dd-45bf-a586-d12d127dd733
                  FaxResult:
                    type: integer
                    example: 2
                    default: 0
                  State:
                    type: integer
                    example: 0
                    default: 0
                  PagesDelivered:
                    type: integer
                    example: 0
                    default: 0
                  ConnectTime:
                    type: integer
                    example: 0
                    default: 0
                  ConnectSpeed:
                    type: integer
                    example: 0
                    default: 0
                  RemoteId: {}
                  Tag: {}
                  CompletedOn: {}
                  DeliveredOn: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Outbox
    get:
      summary: /outbox (pending)
      description: Returns the number of active/pending events in the outbox for the given account, including the number of channels available for sending.
      operationId: outbox-pending
      parameters:
      - name: a
        in: query
        description: Action to perform.
        schema:
          type: string
          default: pending
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"PendingFaxes\": 0,\n  \"AvailableChannels\": 4\n}"
              schema:
                type: object
                properties:
                  PendingFaxes:
                    type: integer
                    example: 0
                    default: 0
                  AvailableChannels:
                    type: integer
                    example: 4
                    default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Outbox
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.etherfax.net/reference
  harvested: '2026-10-26'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.etherfax.net/reference/accounts-pkino.md
  - https://docs.etherfax.net/reference/accounts.md
  - https://docs.etherfax.net/reference/devices-actionreset.md
  - https://docs.etherfax.net/reference/devices-list.md
  - https://docs.etherfax.net/reference/devices-pkinfo.md
  - https://docs.etherfax.net/reference/devices-register.md
  - https://docs.etherfax.net/reference/devices-setaddr.md
  - https://docs.etherfax.net/reference/devices-setconfig.md
  - https://docs.etherfax.net/reference/devices-status.md
  - https://docs.etherfax.net/reference/devices-unread.md
  - https://docs.etherfax.net/reference/inbox-get.md
  - https://docs.etherfax.net/reference/inbox-getnext.md
  - https://docs.etherfax.net/reference/inbox-list.md
  - https://docs.etherfax.net/reference/inbox-received.md
  - https://docs.etherfax.net/reference/inbox-unread.md
  - https://docs.etherfax.net/reference/outbox-pending.md
  - https://docs.etherfax.net/reference/outbox.md
  - https://docs.etherfax.net/reference/routes-enable.md
  - https://docs.etherfax.net/reference/routes-info.md
  - https://docs.etherfax.net/reference/routes-list.md
  - https://docs.etherfax.net/reference/routes-parse.md
  - https://docs.etherfax.net/reference/status-post.md
  - https://docs.etherfax.net/reference/status.md
  merge:
    pages: 23
    deduped: 22
    conflicts_kept_first: 0