Fax for Agents Numbers API

openapi: 3.2.0
info:
  title: Faxforagents Numbers API
  version: 1.4.3
  contact:
    name: Fax for Agents
    url: https://faxforagents.com/contact/
    email: hello@faxforagents.com
  termsOfService: https://faxforagents.com/terms/
  x-refined-note:
  - x-snapshot differs across the merged source definitions and was not carried
  description: 'Operations tagged numbers across 2 of this provider''s published API definitions: faxforagents-api-openapi.json, faxforagents-site-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.faxforagents.com
  description: Production
tags:
- name: Numbers
paths:
  /v1/coverage:
    get:
      tags:
      - Numbers
      summary: Where we send and where we host numbers
      operationId: get_coverage
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Coverage'
  /v1/number-inventory:
    get:
      tags:
      - Numbers
      summary: Fax-capable numbers for sale
      operationId: get_number_inventory
      parameters:
      - name: country
        in: query
        required: false
        schema:
          type: string
          minLength: 2
          maxLength: 2
          default: US
          title: Country
      - name: locality
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 80
          - type: 'null'
          title: Locality
      - name: type
        in: query
        required: false
        schema:
          enum:
          - local
          - toll_free
          type: string
          default: local
          title: Type
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 50
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Inventory'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/number-orders:
    post:
      tags:
      - Numbers
      summary: Buy a number (the first month is held now, charged on activation)
      operationId: create_number_order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberOrderCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberOrder'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/number-orders/{order_id}:
    get:
      tags:
      - Numbers
      summary: Read a number order
      operationId: get_number_order
      parameters:
      - name: order_id
        in: path
        required: true
        schema:
          type: string
          title: Order Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberOrder'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/numbers:
    get:
      tags:
      - Numbers
      summary: Your numbers
      operationId: list_numbers
      parameters:
      - name: include_released
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Released
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NumberList'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/numbers/{number_id}:
    get:
      tags:
      - Numbers
      summary: One number
      operationId: get_number
      parameters:
      - name: number_id
        in: path
        required: true
        schema:
          type: string
          title: Number Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Number'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Numbers
      summary: Label and inbound route of a number
      operationId: update_number
      parameters:
      - name: number_id
        in: path
        required: true
        schema:
          type: string
          title: Number Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NumberUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Number'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/numbers/{number_id}/release-requests:
    post:
      tags:
      - Numbers
      summary: Release a number (confirm with the number itself; 30-day quarantine follows)
      operationId: create_release_request
      parameters:
      - name: number_id
        in: path
        required: true
        schema:
          type: string
          title: Number Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReleaseRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Number'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/portability-checks:
    post:
      tags:
      - Numbers
      summary: Can these numbers port in
      operationId: create_portability_check
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortabilityCheckCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortabilityCheck'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/port-orders:
    get:
      tags:
      - Numbers
      summary: Port orders and port-out requests
      operationId: list_port_orders
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortOrderList'
    post:
      tags:
      - Numbers
      summary: Request a port-in (handled with you)
      operationId: create_port_order
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortOrderCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortOrder'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/port-orders/{port_id}:
    get:
      tags:
      - Numbers
      summary: One port order
      operationId: get_port_order
      parameters:
      - name: port_id
        in: path
        required: true
        schema:
          type: string
          title: Port Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortOrder'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/port-out-requests:
    post:
      tags:
      - Numbers
      summary: Note a port-out of one of your numbers
      operationId: create_port_out_request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PortOutRequestCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PortOrder'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/sender-verifications:
    post:
      tags:
      - Numbers
      summary: Verify a number of yours as a sender (only numbers you own)
      operationId: create_sender_verification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SenderVerificationCreate'
        required: true
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SenderVerification'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PortabilityCheck:
      properties:
        items:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Items
        checked_at:
          type: string
          title: Checked At
      additionalProperties: true
      type: object
      required:
      - items
      - checked_at
      title: PortabilityCheck
    NumberUpdate:
      properties:
        label:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Label
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        inbound_webhook_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Inbound Webhook Id
      additionalProperties: false
      type: object
      title: NumberUpdate
    PortOrderCreate:
      properties:
        numbers:
          items:
            type: string
          type: array
          maxItems: 50
          minItems: 1
          title: Numbers
        note:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Note
      additionalProperties: false
      type: object
      required:
      - numbers
      title: PortOrderCreate
    NumberOrder:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        status:
          type: string
          title: Status
        e164:
          anyOf:
          - type: string
          - type: 'null'
          title: E164
        country:
          anyOf:
          - type: string
          - type: 'null'
          title: Country
        number_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Number Type
        number_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Number Id
        number:
          anyOf:
          - $ref: '#/components/schemas/Number'
          - type: 'null'
        provider:
          type: string
          title: Provider
        recurring_charge_micro:
          type: integer
          title: Recurring Charge Micro
          description: Charged every month on the activation day.
        recurring_period:
          type: string
          title: Recurring Period
        first_month_hold_micro:
          type: integer
          title: First Month Hold Micro
          description: Held now, captured when the number activates.
        currency:
          type: string
          title: Currency
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        created_at:
          type: string
          title: Created At
        completed_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Completed At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - status
      - e164
      - country
      - number_type
      - number_id
      - number
      - provider
      - recurring_charge_micro
      - recurring_period
      - first_month_hold_micro
      - currency
      - error
      - created_at
      - completed_at
      title: NumberOrder
    PortOrderList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PortOrder'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: PortOrderList
    Coverage:
      properties:
        coverage_version:
          anyOf:
          - type: string
          - type: 'null'
          title: Coverage Version
        generated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Generated At
        orderable_now:
          items:
            type: string
          type: array
          title: Orderable Now
        outbound:
          additionalProperties: true
          type: object
          title: Outbound
        inbound:
          additionalProperties: true
          type: object
          title: Inbound
        excluded:
          additionalProperties: true
          type: object
          title: Excluded
        note:
          anyOf:
          - type: string
          - type: 'null'
          title: Note
      additionalProperties: true
      type: object
      required:
      - coverage_version
      - generated_at
      - orderable_now
      - outbound
      - inbound
      - excluded
      - note
      title: Coverage
    SenderVerificationCreate:
      properties:
        from:
          type: string
          title: From
          description: A number your organization owns, E.164.
      additionalProperties: false
      type: object
      required:
      - from
      title: SenderVerificationCreate
    InventoryNumber:
      properties:
        e164:
          type: string
          title: E164
        country:
          type: string
          title: Country
        number_type:
          type: string
          title: Number Type
        locality:
          anyOf:
          - type: string
          - type: 'null'
          title: Locality
        monthly_micro:
          type: integer
          title: Monthly Micro
        currency:
          type: string
          title: Currency
        setup_micro:
          type: integer
          title: Setup Micro
      additionalProperties: true
      type: object
      required:
      - e164
      - country
      - number_type
      - locality
      - monthly_micro
      - currency
      - setup_micro
      title: InventoryNumber
    SenderVerification:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        from:
          type: string
          title: From
        status:
          type: string
          title: Status
        method:
          type: string
          title: Method
        number_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Number Id
        created_at:
          type: string
          title: Created At
        verified_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Verified At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - from
      - status
      - method
      - number_id
      - created_at
      - verified_at
      title: SenderVerification
    NumberList:
      properties:
        items:
          items:
            $ref: '#/components/schemas/Number'
          type: array
          title: Items
      additionalProperties: true
      type: object
      required:
      - items
      title: NumberList
    PortOutRequestCreate:
      properties:
        number_id:
          type: string
          title: Number Id
        note:
          anyOf:
          - type: string
            maxLength: 500
          - type: 'null'
          title: Note
      additionalProperties: false
      type: object
      required:
      - number_id
      title: PortOutRequestCreate
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PortabilityCheckCreate:
      properties:
        numbers:
          items:
            type: string
          type: array
          maxItems: 50
          minItems: 1
          title: Numbers
      additionalProperties: false
      type: object
      required:
      - numbers
      title: PortabilityCheckCreate
    NumberOrderCreate:
      properties:
        e164:
          type: string
          title: E164
          description: A number from GET /v1/number-inventory, E.164.
        label:
          anyOf:
          - type: string
            maxLength: 120
          - type: 'null'
          title: Label
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
          description: Inbound faxes are filed under this project.
        inbound_webhook_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Inbound Webhook Id
          description: 'The webhook that receives fax.received for this number (default: all).'
      additionalProperties: false
      type: object
      required:
      - e164
      title: NumberOrderCreate
    PortOrder:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        direction:
          type: string
          title: Direction
        status:
          type: string
          title: Status
        numbers:
          items:
            type: string
          type: array
          title: Numbers
        request:
          additionalProperties: true
          type: object
          title: Request
        milestones:
          items:
            additionalProperties: true
            type: object
          type: array
          title: Milestones
        provider:
          type: string
          title: Provider
        created_at:
          type: string
          title: Created At
        updated_at:
          type: string
          title: Updated At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - direction
      - status
      - numbers
      - request
      - milestones
      - provider
      - created_at
      - updated_at
      title: PortOrder
    ReleaseRequest:
      properties:
        confirm:
          anyOf:
          - type: string
          - type: 'null'
          title: Confirm
          description: The number itself, typed out, to confirm.
      additionalProperties: false
      type: object
      title: ReleaseRequest
    Number:
      properties:
        id:
          type: string
          title: Id
        environment:
          type: string
          enum:
          - live
          - test
          title: Environment
        e164:
          type: string
          title: E164
        country:
          type: string
          title: Country
        number_type:
          type: string
          title: Number Type
        locality:
          anyOf:
          - type: string
          - type: 'null'
          title: Locality
        status:
          type: string
          title: Status
        label:
          anyOf:
          - type: string
          - type: 'null'
          title: Label
        project_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
        inbound_webhook_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Inbound Webhook Id
        inbound_status:
          type: string
          title: Inbound Status
        provider:
          type: string
          title: Provider
        monthly_micro:
          type: integer
          title: Monthly Micro
        currency:
          type: string
          title: Currency
        order_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Order Id
        created_at:
          type: string
          title: Created At
        activated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Activated At
        renews_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Renews At
        released_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Released At
      additionalProperties: true
      type: object
      required:
      - id
      - environment
      - e164
      - country
      - number_type
      - locality
      - status
      - label
      - project_id
      - inbound_webhook_id
      - inbound_status
      - provider
      - monthly_micro
      - currency
      - order_id
      - created_at
      - activated_at
      - renews_at
      - released_at
      title: Number
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    Inventory:
      properties:
        country:
          type: string
          title: Country
        number_type:
          type: string
          title: Number Type
        locality:
          anyOf:
          - type: string
          - type: 'null'
          title: Locality
        items:
          items:
            $ref: '#/components/schemas/InventoryNumber'
          type: array
          title: Items
        recurring_period:
          type: string
          title: Recurring Period
        note:
          type: string
          title: Note
      additionalProperties: true
      type: object
      required:
      - country
      - number_type
      - locality
      - items
      - recurring_period
      - note
      title: Inventory
x-refined-from:
- faxforagents-api-openapi.json
- faxforagents-site-openapi.json