Get FoneNumbers

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

This will return a listing of all the FoneNumbers belonging to the FracTEL account associated with the API token being used. By default, the endpoint will return a basic listing of FoneNumbers:

{
  "fonenumbers": [
    "8005556562",
    "8555552835",
    "3215556727",
    "3215552240",
    "3215551005"
  ]
}

If more information is required, you can pass a filter parameter with a value of all, which will return an array of FoneNumber.

{
  "fonenumbers": [
    {
      "fonenumber": "8005556562",
      "label": "Test Number",
      "group": "Test Group",
      "record_calls": "Default",
      "message_options": {
        "receive": {
          "type": "None",
          "email": "",
          "device": "",
          "forward": "",
          "url": null,
          "url_method": null
        },
        "receive_notify": {
          "url": null,
          "method": null
        },
        "send_notify": {
          "url": null,
          "method": null
        },
        "messaging_enabled": "no"
      },
      "call_options": {
        "receive": {
          "type": "Forward",
          "email": "3215551111"
        },
        "receive_notify": {
          "url": null,
          "method": null
        },
        "send_notify": {
          "url": null,
          "method": null
        }
      },
      "fax_options": {
        "receive_notify": {
          "url": null,
          "method": null
        },
        "send_notify": {
          "url": null,
          "method": null
        }
      },
      "is_active": "yes",
      "state": "US",
      "rate_center": "TOLLFREE"
    },
    {
      "fonenumber": "8555552835"...

Use query parameter active to filter response by FoneNumber's activation status. Don't use this parameter to get all FoneNumbers.

  • yes: Active FoneNumbers only
  • no: Disconnected FoneNumbers only
  • cancel: Cancelled FoneNumbers only

🚧

A request for all information may take a while to process if many numbers are involved.

Language
Authentication
Header
Response
Click Try It! to start a request and see the response here!