Operations (sample payloads)

Main operations
Copy

Format phone number
Copy

Given a country and a phone number, this operation will return a phone number with the country code in the desired format.

Sample Input

1{
2    "source_number": "+1 (555) 123-4567",
3    "format": "e164",
4    "region": "United States of America"
5}

Sample Output

1{
2    "result": "+15551234567"
3}

Get details
Copy

Takes a phone number and outputs information on its characteristics, e.g. if it's valid, if it can be internationally dialed, if it's a mobile phone number, etc.

Sample Input

1{
2    "source_number": "+1 (555) 123-4567",
3    "region": "United States of America"
4}

Sample Output

1{
2    "number": {
3        "input": "+1 (555) 123-4567",
4        "international": "+1 555-123-4567",
5        "national": "(555) 123-4567",
6        "e164": "+15551234567",
7        "rfc3966": "tel:+1-555-123-4567",
8        "significant": "5551234567"
9    },
10    "regionCode": "US",
11    "valid": true,
12    "possible": true,
13    "canBeInternationallyDialled": true,
14    "type": "FIXED_LINE_OR_MOBILE",
15    "possibility": "IS_POSSIBLE"
16}

Operations (sample payloads)

Main operationsCopy

Format phone numberCopy

Get detailsCopy

Overview

Operations

Main operations
Copy

Format phone number
Copy

Get details
Copy