---
title: "Parse, validate and format a phone number"
method: GET
path: "/format-number/"
tags: ["Utilities"]
---

# Parse, validate and format a phone number

`GET /format-number/`

## Request

- Base URL: `http://api.smsfusion.com.au`
- URL: `http://api.smsfusion.com.au/format-number/`
- Auth: one of:
  - API key in query parameter `key`
  - HTTP basic

Free syntactic validation - no lookup is performed and nothing is written. carrier is empty for number-portability countries such as Australia

## Query parameters

- `key` string, required
- `num` string
- `cc` string, string

## Response `200`

Successfull response

- FormatNumberResult
  - `msisdn` string
  - `countryCode` integer: Emitted as a JSON number
  - `nationalNumber` string
  - `intlNumber` string
  - `region` string
  - `type` string
  - `isMobile` boolean
  - `validNumber` boolean
  - `carrier` string: Empty for number-portability countries such as Australia

## Other responses

- `400`: BAD_REQUEST - num missing or unparseable

---

[API](https://skmtc.dev/smsfusion/apis/sms-fusion-api.md) · [All operations](https://skmtc.dev/smsfusion/apis/sms-fusion-api/llms.txt) · [OpenAPI document](https://skmtc.dev/smsfusion/apis/sms-fusion-api/revisions/a88b2793a6e9?raw)