Developers

GET/v3/numberinfo/{number}

Read one purchased number

Read stored configuration, capability flags and legacy reference fields for a purchased telephone number.

On this page
  1. Request
  2. Response
  3. No matching number
  4. Use the result

Read one purchased-number record and its stored configuration. This operation returns an object rather than the inventory endpoint’s array.

Request

Use server-side API credentials over HTTPS. The examples read credentials from environment variables; they contain no working credentials. Inspect status.code in the JSON body as well as the HTTP status. These legacy handlers do not consistently set an HTTP error status for an application error.

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/numberinfo/12025550100"

The required path segment is the stored international telephone number, not its UUID or a PBX extension. No query parameters or request body are used by this handler.

Response

This is an illustrative response shape, not account data or a current price quote.

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550100",
    "uuid": "NUMBER_UUID",
    "description": "Main reception",
    "isocode": "US",
    "config": {
      "uri": "sip:reception@example.com",
      "uri2": "",
      "uri3": "",
      "forward_destination": "",
      "sms_uri": "",
      "sms_forward_destination": ""
    },
    "features": {
      "voice": "1",
      "sms": "1",
      "mms": "0"
    },
    "status": {
      "capacity": {
        "assigned_channels": "2",
        "used_channels": "0",
        "overflow": "0",
        "overage_charge": "0.01"
      },
      "origination": {
        "origination_trunk_id": "ORIGINATION_ID",
        "origination_trunk_name": "ORIGINATION_NAME",
        "origination_country_iso": "US",
        "origination_continent_iso": "NA",
        "origination_continent_name": "North America"
      },
      "service_active": "1",
      "force_codec": "",
      "force_dtmf": ""
    },
    "billing": {
      "cnam": "0",
      "overflow": "0",
      "autorenew": "1",
      "persistent": "0",
      "date_created": "2026-01-01 00:00:00"
    },
    "price": {
      "setup_price": "0.00",
      "monthly_price": "1.00",
      "per_minute": "0.01",
      "free_minutes": "0",
      "remaining_minutes": "0",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}
Returned number fields
FieldMeaning
number, uuid, description, isocodeThe stored telephone number, opaque number identifier, description and country code.
configStored voice destinations, external forwarding, SMS destination and SMS forwarding fields. This endpoint does not edit them.
featuresStored voice, SMS and MMS capability flags. Legacy stored flags are not guaranteed to be JSON booleans.
status.capacityAssigned and used channel values, overflow setting and stored overage charge. This is stored metadata, not a fresh capacity quotation or a live call test.
status.originationStored origination metadata. Treat identifiers as opaque; do not derive application logic from internal names.
status.service_active, force_codec, force_dtmfStored activation and media configuration fields. A flag alone does not prove successful inbound delivery.
billingStored CNAM, overflow, renewal, persistence and creation values. Reading them does not change renewal or other billing settings.
priceStored setup/monthly/per-minute prices and minute allowances. The handler supplies no currency field or fresh quote. Do not infer currency from the sample values or use them as a current purchase quotation.

Compared with inventory, this endpoint also returns needs_registration, vrating, country_id, area_id, provider_id and price.perminute_charges. These are legacy stored values, not a separate identity-approval response. Reference IDs should be treated as opaque; do not construct discovery URLs or infer provider mappings from them without the appropriate discovery response.

No matching number

If no matching non-void record is found for the authenticated account, the JSON body has status.code 404 and a message containing number not found. Do not rely on its source-line suffix. Check the stored number and inventory before retrying.

Use the result

This is a read of saved data. It does not buy a number, approve identity documents, change a destination or guarantee that a call, fax or message will be delivered. Test each enabled service separately when configuring a number.