---
title: "Parse Phone Number(s)"
method: POST
path: "/restapi/v1.0/number-parser/parse"
tags: ["Phone Numbers"]
---

# Parse Phone Number(s)

`POST /restapi/v1.0/number-parser/parse`

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

## Query parameters

- `homeCountry` string
- `nationalAsPriority` boolean

## Request body

- ParsePhoneNumberRequest
  - `originalStrings` string[] — 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

## Response `200`

Successful response

- ParsePhoneNumberResponse
  - `uri` string, uri — Canonical URI of a resource
  - `homeCountry` GetCountryInfoNumberParser, required
    - `id` string — Internal identifier of a country
    - `uri` string, uri — Canonical URI of a country resource
    - `callingCode` string — Country calling code defined by ITU-T recommendations `E.123` and `E.164`, see Calling Codes
    - `isoCode` string — Country code in `ISO 3166` alpha-2 format
    - `name` string — The official name of the country.
  - `phoneNumbers` PhoneNumberInfoNumberParser[], required — Parsed phone numbers information
    - `originalString` string — Original phone number string as it was passed in the request
    - `country` GetCountryInfoNumberParser
      - `id` string — Internal identifier of a country
      - `uri` string, uri — Canonical URI of a country resource
      - `callingCode` string — Country calling code defined by ITU-T recommendations `E.123` and `E.164`, see Calling Codes
      - `isoCode` string — Country code in `ISO 3166` alpha-2 format
      - `name` string — The official name of the country.
    - `areaCode` string — Area code of location. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a specific geographic region/numbering area of the national numbering plan (NANP); that can be summarized as `NPA-NXX-xxxx` and covers Canada, the United States, parts of the Caribbean Sea, and some Atlantic and Pacific islands. See [North American Numbering Plan](https://en.wikipedia.org/wiki/North_American_Numbering_Plan) for details
    - `dialable` string — Dialing format of a phone number
    - `e164` string — Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format
    - `formattedInternational` string — The formatted phone number string in international format
    - `formattedNational` string — The formatted phone number string in domestic format
    - `special` boolean — Indicates if the number is in a special format (for example N11 code)'
    - `normalized` string — Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format without plus sign ('+')
    - `tollFree` boolean — Indicates if the number is toll free
    - `subAddress` string — Sub-Address. The portion of the number that identifies a subscriber into the subscriber internal (non-public) network.
    - `subscriberNumber` string — Subscriber number. The portion of the [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) number that identifies a subscriber in a network or numbering area.
    - `dtmfPostfix` string — DTMF (Dual Tone Multi-Frequency) postfix

## Other responses

- `400` — General response with **HTTP 400 "Bad request"** status.<br> Reasons: unparsable request, path, query or body parameters are invalid. The error description may contain reference to particular parameter(s) which haven't passed the validation.
- `500` — General response with **HTTP 500 "Internal Server Error"** status.<br> Reasons: general server-side error.
- `503` — General response with **HTTP 503 "Service not available"** status.<br> Reasons: server cannot process the request because of being overloaded, misconfiguration or other issues.

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)