v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Phone Numbers

Parse Phone Number(s)

Returns one or more parsed and/or formatted phone numbers that are passed as strings.

post/restapi/v1.0/number-parser/parse

Query parameters

homeCountrystring
Example:US

ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself. By default, this parameter is preset to the current user's home country or brand country if the user is undefined

nationalAsPriorityboolean

The default value is false. If true, the numbers that are closer to the home country are given higher priority

Request body

originalStringsstring[]

The list of phone numbers passed as an array of strings (not more than 64 items). The maximum size of each string is 64 characters

Example request

{
  "originalStrings": [
    "(650) 722-1621"
  ]
}

Response

Successful response

uristring uri

Canonical URI of a resource

Example response

{
  "homeCountry": {
    "callingCode": "1",
    "isoCode": "US",
    "name": "United States"
  },
  "phoneNumbers": [
    {
      "originalString": "(650) 722-1621",
      "country": {
        "callingCode": "1",
        "isoCode": "US",
        "name": "United States"
      },
      "areaCode": "650"
    }
  ]
}