List Phone Number Details for Multiple Numbers

Use this endpoint to retrieve detailed information associated with a group of phone numbers, including billing method, primary route, and failover route, etc.

Endpoint

POST /numbers/details

Body Parameters

  • numbers
    required

    A comma separated list of the phone numbers to research.

Response Fields

On success, the HTTP status code in the response header is 200 OK and the response body contains a list of number details in JSON format. On error, the header status code is an error code and the response body contains an array of error objects.

  • data
    list

    List of Number Detail Records:

    • attributes
      object

      Object composed of Phone Number details.

      See List Phone Number Details for a full list of the data values returned.

Example Request

POST /v2/numbers/details HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "numbers": ["+1XXXXXXXXXX", "+1XXXXXXXXXX"]
}

Example Request

curl -X POST https://api.flowroute.com/v2/numbers/details -u accessKey:secretKey -d "numbers": ["+12067452233", "+12068732211"]

Example Response

200 OK

{
  "data": [{
    "attributes": {
      "alias": "",
      "cnam_lookups_enabled": true,
      "number_type": "longcode",
      "rate_center": "seattle",
      "state": "wa",
      "value": "12064201234"
    },
    "id": "12064201234",
    "links": {
      "self": "https://api.flowroute.com/v2.1/numbers/12064201234"
    },
    "relationships": {
      "cnam_preset": {
        "data": {
          "id": "6272",
          "type": "cnam"
        }
      },
      "e911_address": {
        "data": null
      },
      "voice_failover_route": {
        "data": {
          "id": "48112",
          "type": "route"
        }
      },
      "voice_primary_route": {
        "data": {
          "id": "0",
          "type": "route"
        }
      },
      "sms_primary_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      },
      "sms_failover_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      },
      "mms_primary_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      },
      "mms_failover_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      },
      "dlr_primary_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      },
      "dlr_failover_route": {
        "data": {
          "id": "asdf1234",
          "type": "route"
        }
      }
    },
    "type": "number"
  },
  "included": [
    {
      "attributes": {
        "alias": "31eb6f7ddc950590d712fe4c4090ca92",
        "route_type": "sip-uri",
        "value": "sip:12562993422@54.213.241.113"
      },
      "id": "48112",
      "links": {
        "self": "https://api.flowroute.com/v2.1/routes/48112"
      },
      "type": "route"
    },
    {
      "attributes": {
        "alias": "debug_message_route",
        "route_type": "webhook",
        "value": "http://api.doug.com/debug"
      },
      "id": "48112",
      "links": {
        "self": "https://api.flowroute.com/v2.1/routes/48112"
      },
      "type": "route"
    },
    {
      "attributes": {
        "alias": "sip-reg",
        "route_type": "sip-reg",
        "value": null
      },
      "id": "0",
      "links": {
        "self": "https://api.flowroute.com/v2.1/routes/0"
      },
      "type": "route"
    },
    {
      "attributes": {
        "value": "SCW"
      },
      "id": "6272",
      "type": "cnam"
    }
  ],
  "links": {
    "self": "https://api.flowroute.com/v2.1/numbers/12064201234"
  }
}