v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB

Phone Numbers

Get phone number

Get a phone number.

get/numbers/{number}

Path parameters

numberstring required

A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"

Example:+33199001234

Response

Phone number

e164string required

A phone number in ITU-T E.164 format https://en.wikipedia.org/wiki/E.164, prefixed by "+"

class'gold' | 'classic' required

Number class. "gold" is for premium (rare) numbers, "classic" is for regular numbers.

Type of number

assignedstring date-time required

RFC 3339, section 5.6

countrystring required

ISO 3166-1 alpha-2 country code

Example response

{
  "e164": "+33199001234",
  "class": "classic",
  "type": "geographic",
  "assigned": "2024-04-24T17:42:28Z",
  "country": "FR",
  "scenario": {
    "sid": "callrsid",
    "name": "My Call Flow",
    "type": {
      "name": "Actions",
      "version": "1.0"
    }
  },
  "compliance": {
    "blockedAfter": "2024-04-24T17:42:28Z"
  },
  "contract": {
    "ends": "2024-04-24T17:42:28Z"
  },
  "pricing": {
    "minute": "5.50",
    "mrc": "5.50",
    "nrc": "5.50",
    "setup": "5.50"
  },
  "enduser": {
    "name": "French Corp",
    "address": {
      "country": "FR",
      "city": "Paris"
    },
    "comment": "French Subsidiary",
    "sid": "callrsid",
    "type": "third-party",
    "created": "2024-04-24T17:42:28Z",
    "updated": "2024-04-24T17:42:28Z",
    "deletable": true,
    "freeze": {
      "unfreeze": "2024-04-24T17:42:28Z",
      "frozen": true
    },
    "compliance": {
      "status": "no-rules-required",
      "compliant": true
    }
  }
}