Get FoneNumbers

Get a list of all FoneNumbers, or a selection based on a filter.

get/fonenumbers

Request

Base URL: https://api.fonestorm.com/v2
URL: https://api.fonestorm.com/v2/fonenumbers
Auth: API key in header token

Query parameters

filter'fonenumbers' | 'all'

Filter the response attributes. Allowed values are FoneNumbers or all. See Notes for additional information.

active'yes' | 'no' | 'cancel'

Filter the response attributes based on FoneNumber's activation status. Allowed values are yes or no or cancel.

offnet'yes' | 'no' | 'only'

Filter the response attributes if FoneNumber is offnet or not. Allowed values are yes or no or only.

Response

Success

Example response

{
  "fonenumbers": [
    {
      "label": "Main Office IVR",
      "group": "Main Office",
      "type": "Local",
      "record_calls": "yes",
      "state": "FL",
      "rate_center": "ORLANDO",
      "is_active": "yes",
      "message_options": {
        "receive": {
          "type": "Device"
        },
        "receive_notify": {
          "type": "URL",
          "url": "https://example.com/receive_notify",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Email",
          "email": "support@fractel.net"
        },
        "messaging_enabled": "yes",
        "messaging_campaign": "CXX11XX11"
      },
      "call_options": {
        "receive": {
          "type": "Device"
        },
        "receive_notify": {
          "type": "URL",
          "url": "https://example.com/send_notify",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Email",
          "email": "support@fractel.net"
        }
      },
      "fax_options": {
        "receive_notify": {
          "type": "URL",
          "url": "https://example.com/send_notify",
          "method": "JSON"
        },
        "send_notify": {
          "type": "Email",
          "email": "support@fractel.net"
        }
      },
      "e911location_options": {
        "location_id": "LO12341234",
        "e911location_id": "EN12341234",
        "e911location_default": "no",
        "e911location_active": "yes"
      },
      "activation_date": "2022-03-30",
      "is_offnet": "no"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.